The Log Message action writes a custom
message to the Exceptions log with a
specified message level.
System components also record messages in the
Exceptions log.
Parameter descriptions
| Parameter | Description |
|---|---|
| Message Type | Currently, this action only supports system exception messages logged to the Exceptions log. |
| Message Level | The severity of the message. The
message level for user messages written
to the Exceptions log can be used as
appropriate. This is one of the
parameters that can be used when
filtering the display of messages using
the Workbench. The options are:
|
| Component | The application defined component
for this log message. This value will be shown under the Component column when the Exceptions Log is displayed. This is one of the parameters that can be used when filtering the display of messages using the Workbench. |
| Message | A compound string substitution variable for the log message. The substitution variables entered in this parameter are then defined in the corresponding parameters in the Input tab. |
Input tab
| Parameter | Description |
|---|---|
| Message | The value for the substitution variables entered for the Message parameter. You can define them to reference any started device, constant, trigger macro, trigger local variable, trigger static variable, or event variable available from the pull down list displayed for the Value cell for that row. |
Example Exceptions Log messages
An example of the Exceptions log with messages created using the Log Message action is shown below.
Note the Filter options for the Message Level (Type) and
Component parameters: