X4 Produktdokumentation

Manuelle Installation


The BAM Logging adapter requires you to configure the database and manually install the adapter.

How to configure the database

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

  2. Insert the following content:

    XML
    <?xml version="1.0"?>
    <Configuration>
    	<ConnectionString>JDBC-CONNECTION</ConnectionString>
    	<UserName>USERNAME</UserName>
    	<Password>PASSWORD</Password>
    	<KeepLogs>
    		<Duration>1</Duration>
    		<TimeUnit>DAYS</TimeUnit> 
    	</KeepLogs>
    	<RunCleanUp>
    		<Duration>1</Duration>	
    		<TimeUnit>HOURS</TimeUnit>
    	</RunCleanUp>
    </Configuration>
    


  3. Save the bam_log_configuration.xml file.

How to manually install the adapter

  1. Unpack the ZIP folder of the adapter.

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

  3. Make sure that 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 according to the BAM Log adapters:

    1. Names of the *.jar files:

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

    2. Contents of the module.xml file:

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

  4. Insert the name of the adapter in 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 adapter name into the <dependencies> tag:

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

    3. Save the module.xml file.

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

You can now choose and use the adapter in the X4 Designer.