BAM Logging: Manual installation

Note:

You can request the BAM Logging adapter from our support team at the SoftProject website under X4 BPMS > Downloads> X4 PLUGINS. Go to X4 BPMS 7.4.1, open the X4 PLUGINS tab, and select the Request button next to the plugin description.

The BAM Logging adapter requires a database configuration and manual adapter installation.

How to configure the database

1. In the <server_directory>/configurations folder, create the bam_log_configuration.xml file.

2. Insert the following content.

   XML

   <?xml version="1.0" encoding="UTF-8"?>
   <Configuration>
   	<ConnectionString>jdbc:postgresql://localhost:5432/postgres</ConnectionString>
   	<UserName>postgres</UserName>
   	<Password>postgres</Password>
   	<KeepLogs>
   		<Duration>10</Duration>
   		<TimeUnit>DAYS</TimeUnit>
   	</KeepLogs>
   	<RunCleanUp>
   		<Duration/>
   		<TimeUnit/>
   	</RunCleanUp>
   	<WriteAsync>true</WriteAsync>
   	<asyncQueueSize>65536</asyncQueueSize>
   </Configuration>

3. Save the bam_log_configuration.xml file.

Description of the elements in the database

Element	Description	Possible values
ConnectionString	JDBC connection string for the connection to the database For more information, see the official JDBC database documentation.	Connection URL for the JDBC database
UserName	User name for the login to the database	Any string
Password	Password for the login to the database	Any string
WriteAsync	Configuration for synchronous or asynchronous logging	true false (default)
asyncQueueSize	Size of the asynchronous logging queue When the queue is full, the process waits for the BAM logs to be queued. If the server shuts down or crashes, all BAM logs in the queue are lost.	Any integer 65536 (default)

KeepLogs

RunCleanUp

How to manually install the adapter

1. Unzip the adapter's ZIP folder.

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

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

   1. Names of *.jar files:
      

      

   2. Contents of the module.xml file:
      

      

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

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

   2. Copy the plugin name into the <dependencies> tag:

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

   3. Save the module.xml file.

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

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