What does it do? 

This extensions provides the possibility to integrate parts of Service BW (https://www.service-bw.de/) to your website.

You can integrate the following parts:

• Departments (Organisationseinheiten)
• Circumstance (Lebenslagen)
• Services (Leistungen)

Composer 

If your TYPO3 installation works in composer mode, please execute following command:

composer req jweiland/service-bw2
vendor/bin/typo3 extension:setup --extension=service_bw2

If you work with DDEV please execute this command:

ddev composer req jweiland/service-bw2
ddev exec vendor/bin/typo3 extension:setup --extension=service_bw2

ExtensionManager 

On non composer based TYPO3 installations you can install service_bw2 still over the ExtensionManager:

1. Login

   Login to backend of your TYPO3 installation as an administrator or system maintainer.

2. Open ExtensionManager

   Click on Extensions from the left menu to open the ExtensionManager.

3. Update Extensions

   Choose Get Extensions from the upper selectbox and click on the Update now button at the upper right.

4. Install service_bw2

   Use the search field to find service_bw2. Choose the service_bw2 line from the search result and click on the cloud icon to install service_bw2.

Next step 

Configure service_bw2.

Tab: Basic 

View 

Settings 

Indexing Configuration 

Here are the included solr indexing configuration included with the extension.

plugin.tx_solr.index.queue {
  tx_servicebw2_organisationsEinheiten {
    indexer {
      detailPage = {$plugin.tx_servicebw2.solr.organisationsEinheiten.detailPage}
    }
    fields {
      title = name
      content = processed_textbloecke
      organisationseinheit_textM = processed_organisationseinheit
      url = TEXT
      url {
        typolink.parameter = {$plugin.tx_servicebw2.solr.organisationsEinheiten.detailPage}
        typolink.additionalParams = &tx_servicebw2_organizationalunitsshow[id]={field:uid}&tx_servicebw2_organizationalunitsshow[action]=show&tx_servicebw2_organizationalunitsshow[controller]=Organisationseinheiten
        typolink.additionalParams.insertData = 1
        typolink.useCacheHash = 1
        typolink.returnLast = url
      }
    }
  }

  tx_servicebw2_lebenslagen {
    indexer {
      detailPage = {$plugin.tx_servicebw2.solr.lebenslagen.detailPage}
    }

    fields {
      title = name
      content = processed_textbloecke

      url = TEXT
      url {
        typolink.parameter = {$plugin.tx_servicebw2.solr.lebenslagen.detailPage}
        typolink.additionalParams = &tx_servicebw2_lifesituationsshow[id]={field:uid}&tx_servicebw2_lifesituationsshow[action]=show&tx_servicebw2_lifesituationsshow[controller]=Lebenslagen
        typolink.additionalParams.insertData = 1
        typolink.useCacheHash = 1
        typolink.returnLast = url
      }
    }
  }

  tx_servicebw2_leistungen {
    indexer {
      detailPage = {$plugin.tx_servicebw2.solr.leistungen.detailPage}
    }

    fields {
      title = name
      content = processed_textbloecke

      url = TEXT
      url {
        typolink.parameter = {$plugin.tx_servicebw2.solr.leistungen.detailPage}
        typolink.additionalParams = &tx_servicebw2_servicesshow[id]={field:uid}&tx_servicebw2_servicesshow[action]=show&tx_servicebw2_servicesshow[controller]=Leistungen
        typolink.additionalParams.insertData = 1
        typolink.useCacheHash = 1
        typolink.returnLast = url
      }
    }
  }
}

plugin.tx_solr.logging.indexing.queue.tx_servicebw2_organisationsEinheiten = 1
plugin.tx_solr.logging.indexing.queue.tx_servicebw2_lebenslagen = 1
plugin.tx_solr.logging.indexing.queue.tx_servicebw2_leistungen = 1

|

The above configuration is related to the TYPO3 extension Solr, which is used for integrating Solr search functionality into a TYPO3 website. Let's break down the configuration:

Type specific configuration 

There may be some additional configuration for a type. In this section you can take a look at those settings.

Departments (Organisationseinheiten) 

List view 

Choose items to display (recursive)

Most time it´s not necessary to display all departments with all children in one list. You can define one or more start points with this setting. For example: Your city is a department and all city related departments are children of the city department. In this case you select the city department as starting point to get a cleaner list.

Detail view 

This extension has a ext:maps2 integration for departments. The address provided by the Service BW API will be used to create maps2 records for a department.

Where to store maps2 records of Organisationseinheit items?

The folder where maps2 records for service_bw2 have to stay.

Detail page for maps2 poi collection

The detail page to display maps2 records coming from a department detail view.

Services (Leistungen) 

Detail view 

Region IDs (comma separated list)

The region id will be used to display forms (API name: Externe Formulare) by region and service (Leistung)

Hide selected assigned life situations

In this case assigned life situations are departments (Organisationseinheiten). Maybe you don´t want that your cities "main" department will be listed on every page. Then you can add those department(s) to the list.

Declaration of Innocence 

All endpoints of the Service BW API are in German. Every method, every property, every explanation, every thing is in German. We have tried our best, but as we have a request class for each API endpoint, we had trouble finding the right request class for the German API endpoint. That's why we have adapted the German API endpoint to our request classes. That's why you will find German PHP classes in our extension. We are not happy with this situation, but it does reduces our support and simplifies the extensibility of service_bw2 a lot.

Service BW API 

Service BW REST API comes with two API versions: V1 and V2.

V1 contains a note, that you should use V2, if possible. V2 contains a note, that it is still in active development.

Currently, service_bw2 uses the Service BW REST API in version 2.

Here are the official links to the API documentation:

• REST API V1
• REST API V2

If you're interested you can authorize there and test the API endpoints.

Version 8.0.0 

In this release, we've addressed compatibility issues with TYPO3 13 LTS and have streamlined compatibility by removing support for lower versions.

Version 7.0.0 

In this release, we've addressed compatibility issues with TYPO3 12 LTS and have streamlined compatibility by removing support for lower versions. A crucial step in this version upgrade is to execute the upgrade wizard, ensuring a smooth transition of all switchable controller actions to separate plugins.

Version 6.0.0 

We have migrated the Solr Indexer Task into a command. Please copy the values of the old tasks, delete the tasks, create new scheduler tasks of type Execute console command, choose servicebw2::preparesolrindex and save the task. After the reload new fields for the chosen command will be visible. Fill in the values from above and save again.

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.

Important notes 

We are using the german method names of the Service BW API in our extension to make it easier to extend/understand the extension.

API 

This extension provides APIs to use departments (Organisationseinheiten) in other extensions.

Use departments in TCA 

The TCAUtility makes the usage of departments in TCA very easy. You just need to use the static method getOrganisationseinheitenFieldTCAConfig in your TCA like shown below.

'organisationseinheiten' => [
    'exclude' => true,
    'label' => 'LLL:EXT:foo/Resources/Private/Language/locallang_db.xlf:tx_foo_domain_model_bar.organisationseinheiten',
    'config' => \JWeiland\ServiceBw2\Utility\TCAUtility::getOrganisationseinheitenFieldTCAConfig()
],

Copied!

You can customize the default department TCA configuration even if you´re using the utility. For example if you only want one item maximum:

'organisationseinheit' => [
    'exclude' => true,
    'label' => 'LLL:EXT:foo/Resources/Private/Language/locallang_db.xlf:tx_foo_domain_model_bar.organisationseinheit',
    'config' => \JWeiland\ServiceBw2\Utility\TCAUtility::getOrganisationseinheitenFieldTCAConfig(['maxitems' => 1])
],

Copied!

/**
 * Department (API name: Organisationseinheit)
 * Initially a string but will be converted to an array when
 * calling getter the first time!
 *
 * @var string
 */
protected $organisationseinheit = '';

/**
 * Returns Organisationseinheit
 *
 * @return array
 */
public function getOrganisationseinheit(): array
{
    return $this->organisationseinheit = ModelUtility::getOrganisationseinheit($this->organisationseinheit);
}

/**
 * Departments (API name: Organisationseinheiten)
 * Initially a string but will be converted to an array with records when
 * calling getter the first time!
 *
 * @var string
 */
protected $organisationseinheiten = '';

/**
 * Returns Organisationseinheiten
 *
 * @return array
 */
public function getOrganisationseinheiten(): array
{
    return $this->organisationseinheiten = ModelUtility::getOrganisationseinheiten($this->organisationseinheiten);
}

Hooks / Events 

<?php

declare(strict_types=1);

namespace ThisIs\MySitePackage\Listener;

use JWeiland\ServiceBw2\Client\Event\ModifyServiceBwResponseEvent;
use TYPO3\CMS\Core\Utility\StringUtility;

class ModifyServiceBwResponseListener
{
    public function __invoke(ModifyServiceBwResponseEvent $event): void
    {
        if (StringUtility::beginsWith($event->getPath(), '/portal/leistungsdetails/')) {
            $responseBody = $event->getResponseBody();
            foreach ($responseBody['prozesse'] as &$prozess) {
                $prozess['url'] = str_replace('www.', 'cityname.', $prozess['url']);
            }
            $event->setResponseBody($responseBody);
        }
    }
}

# EXT:my_site_package/Configuration/Services.yaml
services:
  ThisIs\MySitePackage\Listener\ModifyServiceBwResponseListener:
    tags:
      - name: event.listener
        identifier: 'ext-mysitepackage/servicebw-modifyrequest'
        event: JWeiland\ServiceBw2\Client\Event\ModifyServiceBwResponseEvent

Version 8.0.6 

• [Task] Implement an indexer, aligned with the approach used in the "solr" extension.

Version 8.0.5 

• [TASK] Do not execute unit/func tests on push (main)
• [TASK] Mark OrganisationseinheitenItems as public
• [TASK] Make ServiceBwClient stateless

Version 8.0.4 

• [TASK] Repair Solr implementation for indexing service bw records
• [TASK] Update version to 8.0.4 and require typo3/cms-install
• [TASK] Prevent Solr class loading in Command constructors
• [TASK] Refactor commands to use local variables instead of class properties
• [TASK] Modernize code using readonly classes and constructor promotion
• [TASK] Register LeistungenListener via PHP attributes and rename to EventListener
• [TASK] Improve SolrIndexService visibility and manual instantiation
• [TASK] Remove CompileableRenderStatic trait from ViewHelpers
• [TASK] Clean up TokenHelper (remove Singleton) and update logger injection
• [TASK] Repair warmup command and functional tests
• [TASK] Remove indexItem from Indexer (alignment with EXT:solr)
• [TASK] Apply Coding Guidelines (CGL) and clean up test messages

Version 8.0.3 

• [TASK] Updated wizard title with [extension] name format

Version 8.0.2 

• [BUGFIX] Fixed DB Call with invalid PDO argument

Version 8.0.1 

• [BUGFIX] Removed internal_type from FlexForm configuration
• [BUGFIX] Removed enableMultiSelectFilterTextfield from FlexForm configuration
• [TASK] Documentation updated migration from Settings to guides.xml

Version 8.0.0 

• [TASK] Compatibility for TYPO3 13 LTS
• [TASK] Removed Compatibility for lower versions from 12 LTS

Version 7.0.2 

• [BUGFIX] Activate default configuration for solr index queue

Version 7.0.1 

• [BUGFIX] Cast maps2Uid in ViewHelper to INT

Version 7.0.0 

• [TASK] Compatibility for TYPO3 12 LTS
• [TASK] Migrated Test Cases to TYPO3 Testing Framework
• [TASK] Replaced all the deprecated internal API calls to core
• [TASK] Implemented new Test Suite for git actions
• [TASK] Added new upgrade wizard for migrating old switchable controller actions to separate plugins
• [TASK] Removed TYPO3 Compatibility for lower versions from 11 LTS

Version 6.0.3 

• [DOCU] Update section how to configure service_bw2
• [TASK] Set TYPO3 scheduler as dependency
• [TASK] Update .gitignore and .editorconfig

Version 6.0.2 

• Do not try to index (EXT:solr) empty records
• Create own TYPO3 log file (var/log/typo3_servicebw2_[hash])
• Add flash messages to show actions, if a record could not be found

Version 6.0.1 

• Convert all parent IDs for filtering to int

Version 6.0.0 

• Add TYPO3 11 compatibility
• Remove TYPO3 9 compatibility
• We keep PHP 7.3 compatibility for better migration
• Check TS path in OrganisationseinheitPoiCollectionUidViewHelper before using it
• Migrate scheduler task to Symfony command
• Remove old repo2model mapping
• Rename TSConfig files to *.tsconfig
• Better structure for WarmUpCommand
• Set indent size in docs to 4 spaces
• Rename DataHandler Hook class

Version 5.0.7 

• Add .gitattributes
• Use correct structure for headlines in documentation

Version 5.0.6 

• Implement new structure to documentation
• Check value for string before calling setPageTitle()

Version 5.0.5 

• Catch and log exceptions while requesting Service BW API

Version 5.0.4 

• Add exclude argument for textbloecke

Version 5.0.3 

• Add lang attribute to all fluid templates
• Use full set of method arguments to build cache identifier
• Show textbloacke of type preamble in frontend again

Version 5.0.2 

• Remove deprecated TCA option enableMultiSelectFilterTextfield

Version 5.0.1 

• Delete solr documents for all other languages, too

Version 5.0.0 

Text in quotation marks are original terms from Service BW and therefore in German language.

• Rewrite ServiceBwClient to be easier to understand and easier to use
• Remove ServiceBwClient PostProcessors and ServiceBwClient PostProcessor hook
• Remove all repositories that has been used for API requests
• Remove all API v1 request classes
• Replace all repository usages by the new request classes
• Update fluid templates to work with latest jweiland musterprojekt template
• Update fluid templates to work with API v2
• Add contact persons to "Organisationseinheiten" detail view
• Add electronic forms "Prozesse" to "Leistung" detail view
• Update "Lebenslagen" list view from glossar to a tree
• Remove TYPO3 v9 compatibility
• Add event to modify Service BW API responses before they get cached (Hook)

Version 4.0.1 

• Add missing Aspect Mapper for RouteEnhancer

Version 4.0.0 

• Remove TYPO3 8 compatibility
• Add TYPO3 10 compatibility

Version 3.0.1 

• Region IDs will internally be used as arrays instead of comma separated values
• If Region IDs are not known you can add AGS or ZIP to help finding Region IDs.
• Update Documentation

Version 3.0.0 

• Breaking: Switched Plugin Namespace in TS from plugin.tx_servicebw2_servicebw to plugin.tx_servicebw2
• Add TypoScriptService to merge filled TS settings into empty FlexForm settings.
• Add Fluid Namespace to all Fluid Templates
• Use AbstractViewHelper of Typo3Fluid package
• Add FlexForm overview to Page->show module
• Add configuration for newContentElementWizard
• Move tt_content changing TCA into TCA/Overrides

Version 2.1.1 

• Remove strict type from processRequest in ServiceBwClient, as this method can also return null, array and string
• Switch over from StringFrontend to VariableFrontend. You have to clear Cache completely.
• Update Documentation