X4 Produktdokumentation

BAM Logging: Manuelle Installation

Hinweis:

Sie können den BAM Logging Adapter auf der SoftProject-Website unter Ressourcen > Ressourcen > Software X4 BPMS bei unserem Support-Team anfragen. Gehen Sie zu X4 BPMS 7.4.1, und wählen Sie auf der Registerkarte X4 Plugins die Schaltfläche Anfragen neben der Plugin-Beschreibung aus.

Für den BAM Logging Adapter ist eine Konfiguration der Datenbank sowie die manuelle Installation des Adapters erforderlich.

So konfigurieren Sie die Datenbank

  1. Erstellen Sie im Ordner <Serververzeichnis>/configurations die Datei bam_log_configuration.xml.

  2. Fügen Sie den folgenden Inhalt ein:

    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. Speichern Sie die Datei bam_log_configuration.xml.

Beschreibung der Elemente in der Datenbank

Element

Beschreibung

Mögliche Werte

ConnectionString

JDBC-Verbindungszeichenfolge zur Verbindung mit der Datenbank

Weitere Einzelheiten finden Sie in der offiziellen JDBC-Datenbank-Dokumentation.


  • Verbindungs-URL für die JDBC-Datenbank

UserName

Benutzername für die Anmeldung bei der Datenbank

  • Beliebiger String

Password

Passwort für die Anmeldung bei der Datenbank

  • Beliebiger String

WriteAsync

Konfiguration für synchrone oder asynchrone Protokollierung

  • true 

  • false (Standard)

asyncQueueSize

Größe der Warteschlange für asynchrone Protokollierung

Wenn die Warteschlange voll ist, wartet der Prozess darauf, die BAM-Protokolle in die Warteschlange zu schieben. Wenn der Server heruntergefahren wird oder abstürzt, gehen alle BAM-Protokolle in der Warteschlange verloren.


  • Beliebige Ganzzahl

  • 65536 (Standard)


KeepLogs

Element

Beschreibung

Mögliche Werte

Duration

Zeitspanne

  • Ganzzahl

TimeUnit

Einheit der Zeitspanne

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS


RunCleanUp

Element

Beschreibung

Mögliche Werte

Duration

Zeitspanne

  • Ganzzahl

TimeUnit

Einheit der Zeitspanne

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS


So installieren Sie den Adapter manuell

  1. Entpacken Sie den ZIP-Ordner des Adapters. 

  2. Kopieren Sie den Ordner des Adapters in den Ordner <Serververzeichnis>\wildfly\modules\de\softproject\x4\adapter.

  3. Stellen Sie sicher, dass im Ordner <Serververzeichnis>\wildfly\modules\de\softproject\x4\adapter\<Names des Adapters>\main in der Datei module.xml im Element <resources> die Pfade <resource-root path="" /> den Namen der *.jar-Dateien entsprechen.
    Beispiel anhand des BAM Log Adapters:

    1. Namen der *.jar-Dateien:

      FilesName.png?version=2&modificationDate=1701891882053&cacheVersion=1&api=v2&height=150
    2. Inhalt der Datei module.xml:

      module.xml-main.png?version=2&modificationDate=1701891882041&cacheVersion=1&api=v2&height=250
  4. Fügen Sie den Namen des Adapters im Ordner <Serververzeichnis>\wildfly\modules\de\softproject\plugins\main in der Datei module.xml hinzu: 

    1. Öffnen Sie die Datei module.xml im Ordner <Serververzeichnis>\wildfly\modules\de\softproject\plugins\main.

    2. Kopieren Sie den Adapternamen in den Tag <dependencies>:

      <module name="de.softproject.x4.adapter.<Name des Adapters>" export="true"/>

    3. Speichern Sie die Datei module.xml.

  5. Starten Sie Keycloak, den X4 Server und den X4 Designer.

Nun kann der Adapter im X4 Designer ausgewählt und genutzt werden.