Skip to main content

Workflow Exceptions

Follow the below steps to create a new workflow exception:

  1. From the explorer menu, right-click Workflow Exceptions and select Add.
  2. In the properties panel, configure the properties as required and then click save.
PropertyDescriptionComments
Name*Provide the name of an exception.Name must start with a character followed by alphanumeric or ''. No spaces are allowed. Except underscore (), no other special characters are allowed. Name cannot start with a number.
ErrorCode*Provide the status code.-
Message Template*Provide the message that corresponds to the exception.-
DescriptionProvide the summary.-
Is ActiveSpecify whether the exception is active for accessing or not. Either Yes or No.By default, it is set to Yes.

Note: An asterisk (*) denotes that the property is mandatory for creating a workflow exception.

The "Workflow Exception added successfully" message displays upon successful creation. Handler folder is created by default within the exception.

Add Exception Handlers​

Users can add the exception handlers to an exception as applicable. To add, follow the below steps:

  1. Right-click Handlers and select Add.
  2. In the properties panel, configure the below properties as required and the click Save.
PropertyDescriptionComments
Name*Provide the name of the exception.Name must start with a character followed by alphanumeric or ''. No spaces are allowed. Except underscore (), no other special characters are allowed. Name cannot start with a number.
DescriptionProvide the summary.-
Is ActiveSpecify whether the handler is active for accessing or not. Either Yes or No.By default, it is set to Yes.

Note: An asterisk (*) denotes that the property is mandatory for adding a handler.

The "Handler added successfully" message displays upon successful creation.

  1. The handler designer canvas shows the Start and Stop constructs by default. From the ribbon, add the required constructs and configure them as required inside the flow to create an exception handler.
  2. Click save to save a handler.

The "Handler updated successfully" message displays upon successful update.

Structure of a Handler​

The created handler contains the following:

  • Input Params to add input parameters for the flow
  • Output Param
  • Variables

Add Input Parameters, Output Parameter and Variables​

Users can add the parameters and variables to a handler as applicable. To add, follow the below steps:

  1. Right-click the Input Params (or) Output Param (or) Variables and select Add. A pop-up window displays.
  2. Configure the below properties as required and the click Save.
PropertyDescriptionComments
Parameter Name*Provide the name of a parameter.Name must start with a character followed by alphanumeric or ''. No spaces are allowed. Except underscore (), no other special characters are allowed. Name cannot start with a number.
Is ArraySpecify whether the parameter is an array or not.By default, it is set to No.
Data Type*Select the data type of the parameter from the drop-down.-

Note: An asterisk (*) denotes that the property is mandatory for creating a parameter or variable.

The success message displays upon successfully adding a parameter or variable.

Constructs​

The following are the constructs available in an exception handler:

IfAssignmentForeachBreak
ContinueWhileReturnInitialize
SwitchCall REST APIRun QueryRun Query Async
Query Output MappingBegin TransactionComplete TransactionCall ServerFlow
Raise EventC# SnippetLogThrow Exception
Call WorkflowGet Workflow StatusTerminate WorkflowGet Workflow Result
Create Anonymous ObjectJson ParseJson SearchCall Aggregate Function