Success

A Success state can be used to terminate an execution. It is used to represent a successful execution for the user's reference. As Success states are end states, they don't have any configuration or properties, such as Next state or End fields. You cannot configure a Success state as a 'Start' state.

 

In a Branch state, you can use the Success state along with the Failure state to indicate the outcome of two processes based on different conditions or use it to indicate the success of a Function after it has been executed.

 

Example Use Case: In the employee onboarding scenario, when all the necessary states for the onboarding process have been completed, you can utilize the Success state to indicate the successful completion of the employee onboarding, thereby ending the process.

Builder View

To configure a Success state to your circuit:

1. In Builder View, drag and drop the Success state from the left pane into your circuit or click the required Success state in your circuit.
2. Under Configuration, you have the option to update the name of the state.

You will not be able to configure an input path or output path for a Success state.   

      

Code View

  In Code View, the JSON to configure the Success state for the above example is:

"Onboarded Successfully": {
           "type": "success"
}

Next : Failure state

• Related Articles

• Branch

  The Branch state allows you to add conditions to the circuit's workflow and execute tasks based on those conditions. It decides the path of execution based on input to this Branch state. This is similar to having an 'If else' or 'switch' case. A ...

• Introduction to States of Circuit

  States are the building blocks of a circuit that can perform tasks, make decisions, or simply pass the output from one state to another. The state defines a specific task or process that has to be executed in that segment of the circuit. Circuit ...

• Non-orchestration users' transition

  Board owners (admins) can allow a non- board users to perform a particular transition in the board by configuring Organization users in the Before section of the Blueprint transition. An email template will be triggered to the non- board user along ...

• Result Selector and Result Path

  Result Path and Result Selector are employed to extract dynamic data from the state's result when the execution is successful. Result Selector Result Selector lets you retrieve and process the runtime data, enabling flexible and dynamic data ...

• Execute Blueprints

  Execute blueprints Blueprints get executed once they are mapped to cards . When a new card is created, it's mapped to a published blueprint with a matching or no criteria. The mapped blueprint can be viewed using the preview option in the card. ...