BAM Logging: Manual installation

Note:

You can request the BAM Logging adapter from our support team at the SoftProject website under X4 BPMS > Downloads. Go to the desired X4 BPMS Release, 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

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

Insert the following content.

XML

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
	<ConnectionString>jdbc:postgresql://localhost:5432/postgres</ConnectionString>
  	<!--OPTIONAL-->
    <JndiDatasource>java:/X4TEST_DS</JndiDatasource>
	<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>

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
`JndiDatasource`	Name of the JNDI datasource to be used to establish the database connection. The JNDI datasource is configured directly in the `standalone.xml` file of WildFly. Note: The `<ConnectionString>` element, which can be used to specify a direct database connection from within the configuration, must not be used simultaneously with `<JndiDatasource>`. Connection pool settings (for example, pool size) in the configuration do not affect a JNDI datasource. Make these settings directly in the definition of the JNDI datasource in the `standalone.xml` of WildFly. For more information about setting up a JNDI datasource, see the WildFly documentation.	JNDI name that is configured in the datasource definition in WildFly
`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

Element	Description	Possible values
`Duration`	Time span	Integer
`TimeUnit`	Unit of the time span	`SECONDS` `MINUTES` `HOURS` `DAYS`

RunCleanUp

Element	Description	Possible values
`Duration`	Time span	Integer
`TimeUnit`	Unit of the time span	`SECONDS` `MINUTES` `HOURS` `DAYS`

How to install adapters manually

Unzip the adapter's ZIP folder.
Copy the adapter folder into the <server_directory>\wildfly\modules\de\softproject\x4\adapter folder.
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:
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.
Launch Keycloak, the X4 Server, and the X4 Designer.

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