XA Log Message Service (com.ibi.agents.XDXALogMsg)

Syntax:

com.ibi.agents.XDXALogMsg

iIT Service Object:

operations: XALOG Message

xalog: XALOG Message

Description:

This XA Log Message service writes a message to the transaction activity log system.

The message is handled by the activity log system accordingly for the installed driver. In iWay Business Activity Monitor (BAM), the message will appear in the transaction display.

Parameters:

Parameter	Description
Message level	Determines the type of message that will be written to the log at the selected trace level. Select one of the following message levels from the drop-down list: Information (info) Business Error (bizerr) Debug (debug) Checkpoint (checkpoint) The available message levels are described in more detail following this table.
Transactional	If set to true, then this message is written only as part of a rollback of the process flow.
Message text	The descriptive text of the message to be written in the transaction activity log.
Include contents	If set to true, then the contents of the current message (document) are included in the record. This parameter must be set to true for checkpoints. The contents of the message are not carried when the message is written as a transaction.

The following message levels relate to the type of message that is created and the current state of the server:

Information (info). This is an informational message. These messages are always written to the transaction activity log, provided that information messages are not masked by the system.
Business Error (bizerr). This is an error message and cannot be masked. It should be used only to record business errors or situations that relate to the purposes of the application. This service supersedes other services that write business error messages, but performs the same service.
Debug (debug). These messages are written only if the process flow is running in debug mode. Under normal circumstances, the debug mode is not set, and this level causes no message to be written.
Checkpoint (checkpoint). A checkpoint message is used only for iWay BAM recovery. It allows you to store the current contents of the document being processed for later recovery. Checkpoint messages require that the Include contents parameter is set to true.

The message contents include the entire state of the process flow document. This can constitute a large amount of data, and would normally not be included for informational or debugging messages.

Edges:

The edges returned by the XA Log Message Service (com.ibi.agents.XDXALogMsg) are listed and described in the following table.

Edge	Description
success	A message was issued or a debug message was requested and the channel was not in debug mode.
fail_parse	The message contained iFL, which resulted in a syntax or execution error.