Log error message to System log

Use this step to log errors to FlowWright system log.

Last published at: August 4th, 2023

clsLogError Step

Description:

This step logs errors to the FlowWright System log.

 

Inputs

  • Source - Error Source
  • MessageData - Error message to log
  • Priority - Priority
 

 

Errors

  • True – step executed successfully
  • False – step failed to execute
 

 

Usage:

 

 

Example:

Let’s build and execute the “clsLogErrorDef” example.         

  • Create a new definition called “clsLogErrorDef”
  • Select the definition and click the “design” button
  • Drag a "clsLogError" step to the canvas
  • Connect the dots between the start and "clsLogError" step
  • Click the "clsLogError" step to configure its “Settings” properties. Provide a name to the step. Provide the source of the error message. Provide the message to log. 

 

  • Click on the "clsLogError" step to configure its “Advanced” properties. Select the priority from the dropdown list (low, medium, high). 

 

  • The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the percent complete. This is achieved by configuring the step state and percent fields individually, as shown in the images below. Configure the “Logging” using the following properties.

 

  • Save the process definition, create a process instance, and execute. As configured, the process step should log the error message to the System log. Navigate to the Status—System log page and select log by type and error.

 

Note: If the error log table exceeds a certain size, it is automatically trimmed (records are deleted). This scheduled job is defined on the server and is event-triggered by the growing table size. 

 

Definition Sample:

You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.

Click here to download the sample file.