Log system function

Use the Log system function to record a custom message in the event log when this system step executes.

About this task

To specify a Log system function

1. Enable the event log category User-defined message 1.
   See Configuring event logging options.
2. From the General System Palette, drag a Log step onto the workflow map where you want to record a message in the event log.
3. In Event Type Expression, enter a number such as an integer or integer expression that identifies this message.

   Specify a number above 1000; integers in the range 1 - 1000 are reserved for other events.

   If you enter an integer in the range 1 - 1000, the system will add 1000 to your entry and use this new number for your event log entry.

4. In Event Message Expression, enter a string expression that will be recorded in the event log.

Results

For example, to record the value of the data field my_string_field in the event log, you specify the following:

• Event Type Expression: 2000
• EventMessage Expression: my_string_field

When the workflow runs and the Log system step executes, use the administration console to find the message in the event log:

• ---

  Look for:	Events
  In:	Event Log
  Select one:	Choose your event log
  Results Options:	Specify F_Text (the data field that holds the message)
  Criteria:	F_EventType=2000

  ---