10.4 Log Activity

The Log activity is a system activity that writes messages to a log. The Workflow Administration Console uses CEF formatted events to log information about the state of a workflow process, and then publishes the log to the audit server.

During the course of its processing, a workflow can log information about various events that occurred. Users can then use the reporting tools to look at logged data.

Before you can use logging, you must enable logging in the user application.

NOTE:During the course of workflow execution, many system events are logged that are not controlled by the Log activity. For example, the Workflow Administration Console writes a message to the log whenever a workflow starts or stops, or when it is approved, denied, or refused.

10.4.1 Properties

The Log activity includes the following properties:

Table 10-14 Log Activity Properties

Property Name

Description

Identifier

A unique string value that identifies the activity. Workflow Builder generates this value automatically in the <Activity>_<N> format, where <Activity> represents the name of the activity and <N> represents an alphanumeric value that contains seven characters.

Name

Provides a name for the activity.

Audit

Specifies whether log messages should be sent. When this property is set to “True”, messages are sent to all log4j channels. When this property is set to False, no log messages are sent.

Author

Defines the author for the message. By default, the author is the initiator of the provisioning request. This field value may not exceed 255 characters.

Message

Specifies an ECMA expression that defines text for the log message. Typically, this text indicates where within the process this Log activity is executed and provides other information that makes the log easy to understand.

For details on building ECMA expressions, see Section 11.0, Working with ECMA Expressions. For descriptions of the system variables available in a workflow, see Understanding Workflow Data.

Comment

Specifies an ECMA expression that defines text that can be displayed in the user comments. You can use the comment to record the reason for a request, or the completed approval status of request. Some examples include:

"Reason for request: "+ flowdata.get('reason')

or

"Process has been " + flowdata.get(IDM_COMPLETED_APPROVAL_STATUS')

10.4.2 Data Items

Data items are not supported with this activity.

10.4.3 Email Template

Email templates are not supported with this activity.

10.4.4 Problems

The Problems tab provides details of the errors and warnings associated with the activity in a workflow. For more information about validating workflow activities, see Validating a Workflow.