Write To Log

Depending upon whether you are using a process engine in testing mode or a deployed process engine, the logs are stored in different locations. During test mode, the logs are stored in the TIBCO ActiveMatrix BusinessWorks working directory under the logs subdirectory. See TIBCO Designer User’s Guide for more information about specifying the working directory. For deployed process engines, the log location is specified by custom engine properties. See TIBCO ActiveMatrix BusinessWorks Administration for more information about custom engine properties.

The Configuration tab has the following fields.

Field	Description
Name	The name to appear as the label for the activity in the process definition.
Description	Short description of the activity.
Role	The user-defined role name for this log entry. Roles can be used to filter the log entries when displaying them. For example, if you set the role as Debug, you can choose to view or not view all log entries that have the role set to Debug. You can enable or disable system or user-defined roles using custom engine properties at deployment time. See Custom Properties for the Write To Log Activity for more information.
Suppress Job Info	If checked, no additional information is added to the log entry. If unchecked, each log message has the Job number, process definition name, and activity name prepended to the message text.

Field

Description

Name

The name to appear as the label for the activity in the process definition.

Description

Short description of the activity.

Role

The user-defined role name for this log entry.

Roles can be used to filter the log entries when displaying them. For example, if you set the role as Debug, you can choose to view or not view all log entries that have the role set to Debug.

You can enable or disable system or user-defined roles using custom engine properties at deployment time. See Custom Properties for the Write To Log Activity for more information.

Suppress Job Info

If checked, no additional information is added to the log entry.

If unchecked, each log message has the Job number, process definition name, and activity name prepended to the message text.

See TIBCO ActiveMatrix BusinessWorks Process Design for more information about mapping and transforming input data.

The input for the activity is the following.

Input Item	Datatype	Description
message	string	The message that you would like to appear in the log. Logs are stored in the TIBCO ActiveMatrix BusinessWorks installation directory under the logs subdirectory. Note: When the message contains non-ASCII data, the default encoding of the Java Virtual Machine used by the TIBCO ActiveMatrix BusinessWorks process engine is used to encode the text when writing to the log file.
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.

The message that you would like to appear in the log.

Logs are stored in the TIBCO ActiveMatrix BusinessWorks installation directory under the logs subdirectory.

Note: When the message contains non-ASCII data, the default encoding of the Java Virtual Machine used by the TIBCO ActiveMatrix BusinessWorks process engine is used to encode the text when writing to the log file.

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.

This activity produces no output.

In some situations, you may want to specify which messages are sent to the log file. You can use custom engine properties to specify which roles are enabled or disabled for log messages. You may configure the following properties:

•

Trace.<roleName>.Log — Setting this property to false disables writting messages for the specified role name to the log.

•

Trace.<roleName>.* — Setting this property to false disables all messages for the specified role. The specified role can be one of the following system roles: ERROR, WARN, DEBUG, or INFO.

•

Trace.Role.<roleName> — Setting this property to false disables all messages for the specified user-defined role. Setting Trace.Role.* to false disables all messages to all user-defined roles.

You can also specify the character encoding of the log file by using the log.file.encoding property.

See TIBCO ActiveMatrix BusinessWorks Administration for more information about setting custom engine properties.