clsLogError Step

Use this step to log errors to FlowWright system log.

Last published at: May 14th, 2024

Description:

This step logs errors to the FlowWright System log.

 

Inputs

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

 

Returns

  • 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 "clsErrorInfo" step to the canvas
  • Connect the dots between the start and "clsErrorInfo" step
  • Click on the "clsErrorInfo" step to configure its “Settings” properties. Provide a name to the step. Provide the source of error message. Provide the text message to log. 
  • Click on the "clsErrorInfo" step to configure its “Advanced” properties. Select a priority from the dropdown list (low, medium, high).
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived 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. The process step should log the error message to System log, as configured. Navigate to Status - System log page and select log by type and information.