Create a Circuit

1. Log in to Qntrl. 
   

2. Navigate to (settings) >> Automation >> select Circuit.

3. Click Add New Circuit. Alternatively, you can also select New Circuit at the top-right corner of the home page.

4. Specify a unique Name and add a Description for the Circuit.

5. Click Save. 
   

A sample Circuit with Pass state and name as 'State1' will be created by default, and displayed as a visual workflow in Builder View. Similarly, in Code View, an equivalent JSON will be created by default.

You can configure the Circuit in two different ways.

• Builder View

• Code View
  

Configuring a Circuit in Builder View  

In Builder View, you can construct your Circuit with the readily available states in the left pane. States are the building blocks of a Circuit that can perform tasks, make decisions, or simply pass the output from one state to another.

Circuit states are categorized as follows:

• Flow Controls

• Functional States

• Bridge Controls 

To explore more about the States in the Circuit, check here: States of Circuit.

Constructing a Circuit in Builder View involves two steps:

1. Add a State
2. Define a State
   

Step 1: Add a State in Builder View

1. Drag and drop the state from the left pane to the visual workflow. A pop-up window will open.
2. Enter a unique name for the state.
3. Select the 'Previous State' and 'Next State' between which the new state has to be added. When you create the first state, the previous state and next state will be 'Start' and 'End' by default.
   
4. Click Create. The state will be displayed in the flow diagram.

Step 2: Define a State

1. Click a State in the visual workflow.
2. On the right pane, under Configuration, you can optionally edit the state name in the Name field.
3. The Type field by default displays the state type based on the state you have dropped in the Builder View. You can either retain the created state type or change it in the dropdown list. In case the state type is modified in the dropdown list, the previously saved state definitions, if any, will be reset according to the state selected.
   
1. For Flow Controls, select the states from the list and configure the related fields to the state.
   
2. In the case of Functional states, select the name of the Function, Webhook, or Circuit to be associated with the state and define the error-handling options. 
   
3. Similarly, for Bridge controls select the name of the Bridge to be associated with the state.
   

4. Under Input / Output, configure the Paths and Parameters required for Input and Output Processing. To know more about I/O paths, click here.
5. Click Save. 
   

You can also change the view to horizontal, auto-arrange states in the flow diagram, and zoom in, or zoom out using the icons on the right side of the visual workflow.

  Click Zoom In icon to increase the size of the Circuit.

  Click Zoom Out icon to shrink the Circuit size.

  Click Auto-arrange icon to place the Circuit in the center of the page.

  Click Change view icon to position the vertical Circuit horizontally and vice versa.

Points to ponder

• Some state types have additional parameters. For example, the Wait state contains Duration, and the Batch state includes Collection Path and Collection Variable. Similarly, the Parallel state requires Add Path, and the Branch state needs Add Condition.
• All states except Success and Failure have Next State. The final state of a Circuit is defined by having the Next State value as 'End'.
  
• Dynamic input parameters can be added for Function using Add Parameter and for Webhook using Add Parameter and Add Header.

Configuring a Circuit in Code View   

Constructing a Circuit in Code View involves the following steps:

1. States comprises attributes. Enter a state name. Define the attributes for the state as key-value pairs.
   
2. Define the below common fields of the state
   
1. name: All states must have a unique name to identify them within the Circuit. In the above displayed Circuit, 'Create User' is the name of the Circuit.
2. type: The actual functionality of the state is referred to by its type.
3. next: The name of the next State to run after the completion of the current state. In the above Circuit, 'End' is the next state for 'Create User'.
3. Define the unique fields of the states. Refer to the States of Circuit to explore the fields for each state.
   
1. Provide error handling options using the onError attribute for state types Function, Webhook, and Circuit.
   
2. Provide the Bridge ID and configuration details for Bridge controls.

4. Specify the inputPath, outputPath, and resultPath for Input and Output processing.
   

5. Click Save.
   

In the event of an error in JSON definition, a red cross mark [] will be displayed beside the error line. Upon hovering on the mark, the reason for the error is displayed.