Log node

Use the Log node to define an entry to be added to the activity log.

The Log node is available on Windows, AIX®, and Linux® systems.

This topic contains the following sections:

Purpose

You can use the Log node in a message flow to define an entry to be added to the activity log.

The Log node operations are synchronous and non-transactional, which means that, if a message flow fails and rolls back after the Log node, the update to the activity log will not be undone.

The Log node is contained in the Error handling drawer of the message flow node palette, and is represented in the IBM® App Connect Enterprise Toolkit by the following icon:
This image shows the Log node icon.

Terminals and properties

When you have put an instance of the Log node into a message flow, you can configure it. For more information, see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those without a default value) are marked with an asterisk.

The Log node terminals are described in the following table.

Terminal Description
In The input terminal that accepts a message for processing by the node. The Log node is driven by a message arriving on the In terminal.
Out The output terminal from which the message tree is propagated.
Failure If an error occurs in the Log node, the message is sent to the Failure terminal.

The following tables describe the node properties. The columns headed M indicate whether the property is mandatory (marked with an asterisk on the panel if you must enter a value when no default is defined); the columns headed C indicate whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The Log node Description properties are described in the following table:
Property M C Default Description
Node name Yes No The node type, Log The name of the node.
Short description No No   A brief description of the node.
Long description No No   Text that describes the purpose of the node in the message flow.
The Log node Basic properties are described in the following table.
Property M C Default Description
Log level Yes No Info This property shows the level for the activity log entry. You specify the required log level by clicking Configure and then choosing from the options displayed in the configuration wizard:
  • Error (results in an activity log entry at level error)
  • Info (results in an activity log entry at level info)
  • Debug (results in an activity log entry at level info with a debug tag)

Alternatively, you can specify a custom value, as described in Adding entries to the activity log by using a Log node.

Message detail Yes No   This property shows the detail for the activity log entry, which you specify by clicking Configure and then setting the required values in the configuration wizard.

The Log node Map inputs properties are described in the following table.

Property M C Default Description
Map inputs No No   The Map inputs table is used to define the input that is available for use when writing the log entry.
The entries in the Map inputs table describe specific parts of the message assembly and the schemas that define them:
  • Input name is the unique name for the row in the map inputs table.
  • Input location specifies the location in the message assembly.
  • Message domain specifies the parser for the input location.
  • Schema location specifies the JSON schema that describes the message at the input location.
  • Schema root specifies the location in the schema file that describes the message structure. This is required only if the JSON schema is not at the root of the schema document.

By default, the table contains data that describes a generic input message and the structured parts of the local environment tree.

You can add a row to the Map inputs table to specify the location of a message in the message assembly that is described by an associated JSON schema. If there is a preceding message flow node that defines the structure of a JSON message arriving on this node's input terminal, the schema is located and suggested as an option that you can use.

The Log node Monitoring properties are described in the following table.
Property M C Default Description
Events No No None Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources by using monitoring properties for details.

You can enable and disable events that are shown here by selecting or clearing the Enabled check box.