X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Installing Adapters and Plugins Manually

Adapters that are not included as standard, as well as adapters or plugins that you have created yourself, can be installed manually in X4 BPMS.

How to install adapters manually

  1. Unpack the ZIP folder of the adapter.

  2. Copy the folder of the adapter to the folder <server_directory>\wildfly\modules\de\softproject\x4\adapter.

  3. Make sure that in the folder <server_directory>\wildfly\modules\de\softproject\x4\adapter\<name of the adapter>\main in the file module.xml in the element <resources> the paths <resource-root path="" /> correspond to the names in the *.jar files.
    Example using the BAM Log Adapter:

    1. Names of the *.jar files:

      FilesName.png?version=2&modificationDate=1701891882053&cacheVersion=1&api=v2&height=150

    2. Content of the file module.xml:

      module.xml-main.png?version=2&modificationDate=1701891882041&cacheVersion=1&api=v2&height=250

  4. Add the adapter name to the module.xml file in the folder  <server_directory>\wildfly\modules\de\softproject\plugins\main: 

    1. Open the module.xml file in the folder <server_directory>\wildfly\modules\de\softproject\plugins\main.

    2. Copy the adapter name in the <dependencies> tag:

      <module name="de.softproject.x4.adapter.<name of the adapter>" export="true"/>

Note on the path and name of the adapter in the module.xml file:

The path below <server_directory>\wildfly\modules... corresponds dot-separated instead of slash-separated to the name of the adapter in the module.xml file.

Example:

Path: <server_directory>\wildfly\modules\de\softproject\x4\adapter​\CustomAdapter

Name of the adapter in the module.xml file: de.softproject.x4.adapter.CustomAdapter

image-20240430-084713.png


c. Save the module.xml file.

  1. Start Keycloak, the X4 Server and the X4 Designer.

The adapter can now be selected and used in the X4 Designer.


Note on the subfolders in <server_directory>\wildfly\modules\de\softproject

Path

Description

<server_directory>\wildfly\modules\de\softproject\extensions

Empty module for custom modules

<server_directory>\wildfly\modules\de\softproject\platform

Contains all module dependencies required by X4 BPMS.

<server_directory>\wildfly\modules\de\softproject\plugins

Contains all preconfigured module dependencies.

info It is recommended to add plugins and adapters here.

<server_directory>\wildfly\modules\de\softproject\x4

All standard X4 BPMS modules

  1. Unpack the ZIP folder of the adapter.

  2. Copy the folder of the adapter to the folder <server_directory>\wildfly\modules\de\softproject\x4\adapter.

  3. Make sure that in the folder <server_directory>\wildfly\modules\de\softproject\x4\adapter\<name of the adapter>\main in the file module.xml in the element <resources> the paths <resource-root path="" /> correspond to the names in the *.jar files.
    Example using the BAM Log Adapter:

    1. Names of the *.jar files:

      FilesName.png?version=2&modificationDate=1701891882053&cacheVersion=1&api=v2&height=150

    2. Content of the file module.xml:

      module.xml-main.png?version=2&modificationDate=1701891882041&cacheVersion=1&api=v2&height=250

  4. Add the adapter in file module.xml in the folder  <server_directory>\wildfly\modules\de\softproject\plugins\main: 

    1. Open the file module.xml in the folder <server_directory>\wildfly\modules\de\softproject\plugins\main.

    2. Copy the adapter name in the tag <dependencies>:

      <module name="de.softproject.x4.adapter.<name of the adapter>" export="true"/>

    3. Save the file module.xml.

  5. Start Keycloak, the X4 Server and the X4 Designer.

The adapter can now be selected and used in the X4 Designer.