Functions and Operations

This adapter outputs a log message with a user-defined status text to the X4 Process Monitor in the X4 Control Center or stores data in the PostgreSQL or MS SQL database.

Note:

When 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 on the BAM Log tab. On this tab, you can view the key, the level, and the message for the respective adapter execution.

For more information about the X4 Control Center and the X4 Process Monitor Web App, see the X4 Control Center manual.

Properties

Operation

Describes which operation the adapter performs.

Possible values:

Log Status: Outputs a user-defined status text specified in the Status parameter
Log Data: Saves data from the previous process step as a file whose filename is specified in the filename parameter
Log Message: Outputs a log message with data from the previous process step
Log Batch Messages: Outputs multiple log messages that are passed via a specific input structure
Read Status: Retrieves a list of all PIDs or PUIDs and their respective statuses that have been updated since a specific date. This allows you to check the status of multiple processes at once and show which processes have recently been updated.
Read Messages: Retrieves a list of all stored messages for a specific PID or PUID to view the history of messages for a specific process and resolve any problems that have occurred.
Read Data: Retrieves a list of all stored documents for a specific PID or PUID to view the history of the documents associated with a particular process and to access the information stored in the documents.

Parameters

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