Functionality and Operations

This adapter outputs a log message with a custom text status to the X4 Process Monitor in the X4 Control Center or saves data into a database of the type PostgreSQL or MS SQL.

Note:

If you use the BAM Log Adapter, the output of the following operations is displayed in the X4 Control Center, in the X4 Process Monitor Web App:

The output of the Log Status operation is displayed in the BAM Status column.
The output of the Log Data, Log Message or Log Batch Message operations is displayed in the BAM Log tab. There you can view the key, level and message for each adapter execution.

For more information about the X4 Control Center, in the X4 Process Monitor Web App, see the X4 Control Center Guide.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

Log Status: Outputs a custom status text specified in the parameter status
Log Data: Saves data from the preceding process action as a file whose file name has been specified in the parameter filename
Log Message: Outputs a log message containing the data of the preceding process action
Log Batch Messages: Logs multiple messages using a specific input XML structure
Read Status: Retrieves a list of all PIDs or PUIDs and their respective status values that have been updated since a given date.
Read Messages: Retrieves a list of all stored messages for a given PID or PUID to view the history of messages for a specific process and troubleshoot issues that occurred.
Read Data: Retrieves a list of all stored documents for a given PID or PUID to view the history of documents associated with a specific process and access the information stored in the documents.

Parameters

`Adapter`	Main adapter class (do not change!) Possible value: de.softproject.integration.nativeadapter.NativeAdapter: Main class (Default)
`repository`	The virtual repository of the adapter project. Possible value: 14b1d90c-495e-44c6-b758-acb80c3c8596
`status`	User-defined status text that will be output in the column BAM Status in the X4 Process Monitor (if operation is set to `Log Status`) Possible values: Any string
`filename`	Name of a file in the database (if operation is set to `Log Data`) Possible values: Any string (e.g. `Data.xml`)
`key`	Marks log entries with a user-defined key in order to be able to analyze the database using these keywords (if operation is set to `Log Message`) Possible values: Any string
`level`	Level of the log message (if operation is set to `Log Message`) Possible values: Any string corresponding to a log level (e.g. DEBUG, INFO, WARNING, ERROR or FATAL)
`synchronous`	Configuration for synchronous or asynchronous logging Possible values: `true` (default) `false`