Logging tool
Overview
The Logging tool is used to inject custom messages into the project log for diagnostic purposes. You can configure the type (information, warning, error) and content of the messages, as well as the message interval.
Logging tool configuration parameters
The Logging tool has a single set of configuration parameters in addition to the standard execution options.
Parameter | Description |
|---|---|
Log level | The type of message to be generated. One of Information, Warning, or Error. |
Log source | The source for the message text; either Log message or Input field. |
Log message | If Log source is Log message, the text to display in the message. |
Input field | If Log source is Input field, the field containing the value to display in the message. |
Log at first record | If selected, generates message upon reading the first record. |
Log at every Nth record | If selected, generates message upon reading records at the specified Interval. If you use this tool in a real-time web service project, specify an Interval large enough to generate no more than 1 message per second. Setting a too-small interval can generate a very large volume of project log messages, decreasing performance. |
Log at last record | If selected, generates message upon reading the last record. |
Append record count to log message | If selected, appends current count of records read to each message. |
Show total record count | If selected, appends total count of all records read to final message. |
Configure the Logging tool
Select the Logging tool.
Go to the Configuration tab on the Properties pane.
Select Log level and select the type of messages to be generated:
Information: generates informational message logs.
Warning: generates warning messages, and will cause the tool to be highlighted yellow.
Error: generates error messages, and will cause the tool to be highlighted red.
Select Log source and select the source for the message text:
Select Provided below and then enter a Log message, or select Input field, and then select the field containing the value to display in the message.
Configure the message intervals:
Log at first record: generates a message when the first record is read.
Log at every Nth record: generates a message at the specified Intervals.
Log at last record: generates a message when the last record is read.
Append record count to log message: appends the current count of records read to each generated message.
Show total record count: appends the total count of records read to the final generated message.
Optionally, go to the Execution tab, and then set Web service options.