Circuits are visual workflows that help automate tasks across various modules in Qntrl. You can create circuits in two ways:

• Using pre-built templates: Qntrl provides ready-to-use templates designed for common use cases. These templates come with predefined states and logic to help you get started quickly.
• Creating from scratch: Build your own circuit from the ground up and configure it using either Builder View or Code View. 

Common Circuit Functionalities  

• Maximum of 500 Circuits can be created per organization.

• A Circuit can contain 1 to 50 states.

• Each circuit has a unique circuit ID, used in SDKs, APIs, and when nesting or batching circuits.

• Circuits are configured using either Builder View (visual) or Code View (JSON). Changes in one view automatically reflect in the other.
  

Access Circuits

1. Login to Qntrl.
   

2. Navigate to Circuits in the left panel.
   

3. Click the New Circuit button at the top-left corner.

4. Choose to either Choose from templates or Start from scratch.
   

      

Create a Circuit Using Templates  

Pre-built templates help you launch automation flows quickly with minimal setup.

1. Click Explore under the Choose from template option.

2. Browse the list of available templates under Circuit Templates.

3. Use the left pane to filter templates by category, if needed.

4. Select a template that suits your requirement and preview its components.

5. Click Use this Template button at the top right corner to install.

The installed Template will appear under My Circuits in the left pane.

1. Click Create under the Start from scratch option.

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

3. Click Save. 
   

A sample circuit with the Pass state and name as 'State1' will be created by default, and displayed as a visual workflow in Builder View. You can click on the default state and configure in the builder view.

Similarly, in Code View, an equivalent JSON will be created by default. In the Editor, we can view either the workflow graph alone or both the graph and code view simultaneously.

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 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

• States

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

Constructing a circuit in Builder View involves two steps:

1. Add a State

2. Define a State
   

1. Drag and drop them from the left pane onto the visual workflow. This action prompts a pop-up window to appear.

2. Enter a unique name for the state.

3. Select the Previous State and Next State between which the new state needs 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. In the right pane, under Configuration, you have the option to edit the state name in the Name field.
3. By default, the Type field displays the state type based on the state you have dropped in Builder View. You can either retain the created state type or change it in the dropdown list. If the state type is modified in the dropdown list, the previously-saved state definitions, if any, will be reset according to the state selected.
• For Flow Controls, select the states from the list and configure the related fields to the state.
  
• 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.
  
• Similarly, for Bridge Controls, select the name of the Bridge to be associated with the state to define the error-handling option
  

      

4. Under Input / Output, configure the paths and parameters required for input and output processing. Learn more about I/O paths.
   

      

5. Click Save.
   

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, Parallel state requires Add Path and Branch state needs Add Condition.
• All states except Success and Failure have the 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   

In Code View, you can define your state machine in a simple JSON-based, structured language. Once a circuit is created, a sample workflow with the Pass state as 'State 1' is created by default. You can click the icon in the top right to view the auto-generated JSON code of the Circuit.

A state name is a JSON object, and its properties are the key-value pairs of that object. Properties like type and next are commonly used for all states. If a state does not mention the next key, it is the last state in the Circuit. If a state is not referred to as next in any other state, it is the first state of the Circuit. You must follow the standard JSON syntax while coding a circuit.

Click the Code View icon in the Builder View page to switch to the code editor, where you can build your circuit using JSON.

Constructing a circuit in code view involves the following steps:

1. States are made up of 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 the 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 will be displayed.

Types of Values You Can Use in Circuit Configuration   

Whenever you configure a Circuit, whether defining Parameters, Input Path, Result Selector, or Output Path, you can supply values in any of the following ways:

Static Values

A fixed value provided directly in the configuration field.

Example:

"api_url": "https://swerio.com/employee/update"

Use static values for constants such as URLs, string literals, flags, or tokens.

Config Store Values

Retrieve centrally managed configuration values stored in Qntrl’s Config Store using variable references.

Example:

"base_url": "${<config_linkname>}"	

Refer to Config Store to learn how to create and use these variables.

State Input Values

Extract values directly from the state input using JSONPath.

Example Input JSON:

{
  "employee_details": {
      "emp_name": "John Doe",
      "emp_id": "357"
  }
}

Parameter usage:

"name": "$.employee_details.emp_name",
"ID": "$.employee_details.emp_id"

Retrieve dynamic execution metadata such as circuit ID, execution ID, timestamps, origin, or requestor details.

Example

 "execution_id": "$$.execution.id",
 "requested_by": "$$.requestor.email"

These values reflect live execution context and allow building highly dynamic automations.

Refer to Context Object for full structure.

Faker  Values

Generate randomized test values during execution, useful for test runs, demos, or simulating data.

Faker method names must be in lower underscore case.

"phone_number": "${#random.phone_number.cell_phone}",
"city_name": "${#random.address.city}"

Refer to the Faker Methods guide for the complete list of supported generators.