Create Circuit in Qntrl | Qntrl | Circuit | Online Help | Create workflows with drag and drop interface

Create and configure a Circuit

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.



A Circuit can be created with minimum one state and a maximum of 100 states.
Once a circuit is created, a Circuit ID will be created for the circuit. This ID is used when you nest a circuit using the circuit state, or when you associate a Batch state to a circuit. The Circuit ID is used to refer to the circuit when working with the SDKs and APIs.

Configure a Circuit

You can configure the Circuit in two different ways.

  • Builder View

  • Code View

Circuits are built with states using the drag-and-drop functionality in Builder View or with simple JSON construction in Code View. For every change made in Builder View, the equivalent JSON text is updated automatically in code view, and vice versa. This can be observed by changing one view and then checking out the circuit in the other.

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.

   

  1. Under Input / Outputconfigure the Paths and Parameters required for Input and Output Processing. To know more about I/O paths, click here.
  2. 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   

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 Code View in the top band 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.



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. nameAll 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. typeThe actual functionality of the state is referred to by its type.
    3. nextThe 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 FunctionWebhook, and Circuit.
    2. Provide the Bridge ID and configuration details for bridge controls.
            Refer to the States of Circuit to explore the fields for each state.
  1. Specify the inputPath, outputPath, and resultPath for Input and Output processing.
  2. 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.               

                                       
Points to Ponder
  • Every Circuit must have one state with the field value start: true to represent the beginning state.
  • All States except Success and Failure must have a next state. The terminal state must have the next state value as End.
  • You can define the states in any sequence. The order of execution solely depends on the start and next fields.
  • All fields and their values are case-sensitive. Once you define a value, you must provide the exact value throughout the Circuit.
  • All the standard attribute names of the state (name keys represented in black in code view) like type, next, duration, functionName, and collectionPath are expected in the camel case.





    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Circuit

                                                                                                                Circuit enables you to create automated workflows for IT and business by organizing a sequence of tasks.. In certain cases, a process might include complex sub-processes that can be constructed as separate standalone circuits. These circuits can be ...
                                                                                                              • Features of Circuit

                                                                                                                Configure with or without code Circuit provides a platform to build workflow orchestrations with or without code. You can either visually design the Circuit schematics by dragging and dropping its elements in Builder View, or build its JSON code in ...
                                                                                                              • Custom Function: Create_Job

                                                                                                                This custom function can be used to create a new card in any orchestration. It can also be configured to carry forward necessary field values from the former card to the latter.   Business Scenario Helen is the head of Procurement Management in her ...
                                                                                                              • 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 ...
                                                                                                              • Step 1: Create Form

                                                                                                                Forms are used to capture requests from users that help you collect the data required to kickstart workflows and perform tasks in Qntrl.     There are different departments in an organization providing different solutions. For instance, the finance ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources