Log

Log is a synchronous activity that writes a message to the log file. For each AppNode and application, there is a log file.

General

The General tab has the following fields.

Field Description
Name The name to be displayed as the label for the activity in the process.
Logger Name The name of a logger used in the logback.xml file. The value for the Logger Name is case sensitive and can be a single name or a hierarchical name.
Log Level Select one of the following log levels recognized by the process engine.
  • Error: logs error conditions and messages.
  • Warning: is the warning message of an unexpected error in the process.
  • Info: logs informational messages highlighting the application/engine progress.
  • Debug: can be used for debug-level messages.
Suppress Job Info If selected, no additional information is added to the log entry.

If not selected, each log message appends JobId, ProcessInstanceId, Activity Name, Deployment Unit Name, and Version name to the message text.

Control Logs by Event Type Use this option to group log messages from different Log activities using the same event type.

Select this option to generate a log file with the name <EventType>.log

When you select this option, the Logger Name field is disabled, the loggerName element is removed from the Input tab, and a new element eventType is added to the Input tab.

By default, the check box is clear.

Enhance Log Control

Use this option to group log messages from different Log activities of the same application, or process.

When you select this check box, the Logger Name field is disabled, the loggerName element is removed from the input schema, and the Control By field is displayed.

By default, the check box is clear.

Control By Use this field to select whether messages are to be added to the log file at an application level, or at a process level.
The Control By field has following options:
  • Application: Select this option to generate a log file with the name <ApplicationName>.log
  • Process: Select this option to generate a log file with the name <ApplicationName>.<ProcessName>.log

By default, the Application option is selected.

Description

Provide a short description of the activity.

Input

The following is the input for the activity.

Input Iten Datatype Description
msgCode string The error code of the message. This is used as an identifier for the message so that applications can scan the log for the message.
loggerName string

The name of a logger used in the logback.xml file. The value for loggerName is case sensitive and can be a single name or a hierarchical name.

If you specify a value in the input schema, that value overrides the value specified for the Logger Name field on the General tab.

logLevel string Select one of the following log levels recognized by the process engine.
  • Error: logs error conditions and messages.
  • Warning: is the warning message of an unexpected error in the process.
  • Info: logs informational messages highlighting the application/engine progress.
  • Debug: can be used for debug-level messages.

If you specify a value in the input schema, that value overrides the value specified for the Log Level field on the General tab.

message string The message to be displayed in the log.
Note: If the message contains non-ASCII data, the default encoding of the Java Virtual Machine (JVM) used by the process engine, is used for text encoding, when writing to the log file.
eventType string Specify an event type. This parameter is used to group log messages from different Log activities using the same event type.

This field is mandatory.

The field appears when you select the Control Logs By Event Type check box on the General tab.

The name of the log file depends on the option selected in the Control By field on the General tab, and the event type.

If you select the Application option of the Control By field on the General tab, the name of the log file is: <EventType>.<ApplicationName>.log

If you select Process option of the Control By field on the General tab, the name of the log file is: <EventType>.<ApplicationName>.<ProcessName>.log