X4 Produktdokumentation
Breadcrumbs

X4 Adapter

Adapter

Keycloak Management

This adapter has been revised internally with secure libraries and has been added to the X4 adapter database as a new adapter called Keycloak Management 2. The old Keycloak Management adapter is still available so that you can migrate to the new adapter.

image-20260223-092256.png

Action required

You must migrate to the new adapter in your X4 projects that use the Keycloak Management Adapter. To do this, follow the steps in X4 Adapter | Migration.

Keycloak Token

This adapter has been revised internally with secure libraries and has been added to the X4 adapter database as a new adapter called Keycloak Token 2. The old Keycloak Token adapter is still available so that you can migrate to the new adapter.

image-20260223-095725.png

Action required

You must migrate to the new adapter in your X4 projects that use the Keycloak Token Adapter. To do this, follow the steps in X4 Adapter | Migration.

Migration

Note:

The migration for the Keycloak Management Adapter and the Keycloak Token Adapter takes place after the same procedure. In the following steps, only the Keycloak Management Adapter is mentioned as an example and shown in the screenshots. Transfer the steps to the Keycloak Token Adapter accordingly.

How to add the new adapter

  1. In your X4 project, right-click the Adapters folder.

  2. Select New > Adapter.

    image-20260223-093906.png
  3. In the File Creation Wizard dialog, locate the Keycloak Management 2 adapter.

    image-20260319-132648.png
  4. In the File name field, enter any temporary name.

  5. Select Finish.
    => The adapter will be added to your X4 project.

How to migrate the adapter parameters

  1. In your project, open both Keycloak Management Adapters and view them side by side.

    image-20260319-132700.png
  2. Manually transfer all parameters from the old adapter to the new adapter.

Note:

The following parameters are mandatory in X4 BPMS 7.5:

  • url

  • realm

  • clientID

  • clientSecret

  1. Save your changes.

  2. In the X4 project, right-click the old adapter named Keycoak Management.

    image-20260319-132722.png
  3. Select Delete.

  4. In the X4 project, right-click the new adapter with the temporary name (Keycloak Management 2).

    image-20260319-132743.png
  5. Select Rename/Refactor.
    => The X4 Rename Repository Resource Wizard dialog opens.

    image-20260319-132755.png
  6. Rename the adapter to the old adapter name, in this case Keycloak_Management.fa.

Note:

  • Use the exact name of the previously used adapter.

  • Ensure that the Update References check box is cleared.

  1. Select Finish.
    => The migration is complete.

Google Maps

The previous Google Maps adapter is outdated and is internally based on the HTTP adapter.
For new implementations, it is recommended to use the Google Maps SDK for Java.

As part of the development, the adapter has been revised and released as Vversion 2.0.0.

Note:
The documentation for the new Google Maps Adapter is currently in progress and will be added to the online help at a later date.

Changes to adapter parameters

Some parameters have been cleaned or adjusted.
The most important current parameters are:

  • apiKey (mandatory) – API key used to authenticate to Google Maps

  • privateKey (optional, for CreateGoogleURL only) – key used to sign URLs

  • outputFormat (xml or json) – the output format of the API response

  • timeout (Integer) – maximum time to establish a connection in milliseconds

Changes to authentication

Authentication is now performed via:

  • API Key

  • OAuth 2.0 (if supported)

The API key is stored in the apiKey parameter.

Available adapter operations

The adapter provides the following operations:

  • Geocode — converts addresses to geographic coordinates (longitude/latitude).

  • ReverseGeocode — converts coordinates to a readable address.

  • GetRoutes — replaces the previous GetDirections operation.
    Calculates routes between two or more locations, taking into account traffic, driving mode, etc.

  • CreateGoogleURL xreates URLs for Google APIs, for example, for static map images.
    Optionally, a signature can be generated using the privateKey parameter.

IBM Websphere MQ Integration

X4 BPMS provides an adapter for communicating with IBM Websphere MQ. For licensing reasons, the required IBM JAR files are not included.

Action required

You must include the JAR files as an expansion module in X4 BPMS. To do this, follow the steps below.

  1. Download the com.IBM.mq.allclient artifact and all required dependencies from a Maven repository of your choice:

    XML
    <dependency>
        <groupId>com.ibm.mq</groupId>
        <artifactId>com.ibm.mq.allclient</artifactId>
        <version>9.4.4.1</version>
        <scope>compile</scope>
    </dependency>
    

Note:

The version may be different and must be compatible with your MQ server. For more information, see the MQ specification (https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT).

  1. Create the module.xml file as follows:

    XML
    <module xmlns="urn:jboss:module:1.1" name="com.ibm.wmq.allclient">
        <resources>
            <resource-root path="com.ibm.mq.allclient-9.4.1.0.jar"/>
            <!-- weitere JARs hier einfügen -->
        </resources>
        <dependencies>
            <module name="javax.api"/>
            <module name="javax.transaction.api"/>
            <module name="javax.xml.bind.api"/>
            <module name="javax.resource.api"/>
        </dependencies>
    </module>
    
  2. In the WildFly modules folder, create the com/ibm/mq/allclient/main folder.

  3. Copy all downloaded JAR files and the created module.xml file to this directory.

  4. Open the module.xml file in the de/softproject/x4/adapter/ibmMQ/main folder.

  5. Add the following line to the <dependencies> section:

    <module name="com.ibm.wmq.allclient"/>
    
  6. (Re-)Start the X4 Server.
    => The adapter should now be able to communicate with your MQ server.

PDF to PDF/A Converter

The PDF to PDF/A Converter is not included in the standard X4 BPMS package, but must be installed manually as an external adapter.

Note:

You can request the adapter from our website after the official release date of the X4 BPMS 7.5.

Action required

For instructions on installing the adapter, see PDF to PDF/A Converter | Installing the Third-Party Libraries.

PDF Compression

The PDF Compression Adapter is not included in the standard X4 BPMS package, but must be installed manually as an external adapter.

Note:

You can request the adapter from our website after the official release date of the X4 BPMS 7.5.

Action required

For instructions on installing the adapter, see PDF Compression | Installing the Third-Party Libraries.