Administrator Manual

Installation

You can install the extension either using the TYPO3 extension manager or using composer.

TYPO3 extension manager

  1. Login to the TYPO3 backend

  2. Navigate to ADMIN TOOLS > Extensions

  3. Click on "Get Extensions" at the top of the frame

  4. Update your extension list if it´s older than 24 hours

  5. Search for service_bw2 and click on the install button

Composer

  1. Add service_bw2 to your composer.json e.g. using composer install jweiland/service-bw2

  2. Activate the extension inside the TYPO3 extension manager

Configuration

You need to edit the extension configuration after the installation. Open the extension manager, search for service_bw2 and click on the settings-icon.

Open extension configuration

You have to fill in at least the following settings:

Username

The username provided by Service BW for API usage. (Mostly starts with ws_)

Password

The password provided by Service BW for API usage.

Mandant

The mandant number of the city.

BaseUrl

The URL where we can access the API of Service BW. Defaults to: https://sgw.service-bw.de:443/

Allowed languages

This is important if your website is multi language. Format: [2 letters language ISO code]=[sys_language_uid]. Assign multiple languages with ";". Example: de=2;en=5. First value will be used as default language.

AGS

Description from Service BW API - Die amtlichen Gemeindeschlüssel, in deren Kontext man diese Operation ausführen möchte. Optional parameter for API requests. Leave empty to not use this filter option.

gebietId

Description from Service BW API - Die IDs der Gebiete, in deren Kontext man diese Operation ausführen möchte. Optional parameter for API requests. Leave empty to not use this filter option.

If not already done then you need to configure maps2, because service_bw2 has a maps2 integration for departments. Take a look into the maps2 documentation for that.

Upgrade

Version 5.0.0

We updated the whole extension because of the Service BW API Version 2. There is a new much simpler ServiceBwClient which can be used for all API requests (even for version 1).

We removed the post processors and post processor hook of ServiceBwClient. If you added a custom or extended an existing one then keep in mind that these no longer work.

If you added your own requests, you have to update them. Use JWeiland\\ServiceBw2\\Request\\AbstractRequest as base and take a look at the other request classes to build your own one. The newer ServiceBwClient is much easier to understand so it should not take very long to migrate your old request classes.

Custom fluid templates must also be updated due to the new object structure from API v2. To do this, use the existing templates and go through the templates piece by piece.

Third party extensions that use JWeiland\\ServiceBw2\\Utility\\TCAUtility and JWeiland\\ServiceBw2\\Utility\\ModelUtility should not be affected. We updated those classes but kept the public methods and properties.

Version 3.0.0

We have simplified the Plugin Configuration. That's why you have to change your TS Setup and TS Constants from

plugin.tx_servicebw2_servicebw

to

plugin.tx_servicebw2

Version 2.1.1

Bugfix Release for TYPO3 9. As there is no StringFrontend in Caching System of TYPO3 9 anymore we had to switch over to VariableFrontend. Now the cache data itself will be stored in another format, that's why you have to Clear all Caches.