States of Circuit   

1. Flow Controls
   
2. Functional States
   
3. Bridge Controls
   

Create a Circuit 

1. Go to Setup > Zoho Circuit > Circuits.
   
2. Click New Circuit.
   
3. Specify a name and a brief description.
   
4. Click Save.
   

 

Configure a Circuit  

1. Builder View
   
2. Code View
   

Builder View 

1. Drag and drop the state from the left pane to the visual workflow.
   
2. Enter a unique name for the state.
   
3. Select the Previous State and the Next State between which the new state has to be added.
   
4. Click Create.
   

1. Click a state in the visual workflow.
   
2. On the right pane, under Configuration, you can edit the state's name.
   
3. The state's type is displayed based on your selection by default. You can still change it in the drop-down, but the previously saved definitions, if any, will be reset.
   
4. In the case of functional states, select the name of the Function or Circuit to be associated with the state and define the error handling options.
   
5. Under Input/Output, enter the Input Path, Output Path, and Result Path.

1. Finally, click Save.
   

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 Paths' and the Branch state needs 'Add Condition'. To learn more, explore Flow Controls.

All states except Success and Failure have Next State. The value End for Next State indicates that it is the final state of the circuit.

You can add dynamic input parameters for Functions using Add Parameter.

1. On Timeout
   
2. On Authorization Failure
   
3. On Execution Failure
   
4. Custom Error
   

1. Retry allows the function to execute again after a failure. You can set the number of attempts the function can retry execution, the time delay between every retry, and the step delay.
   
2. Fallback allows the function to pass the error output to the next state when the function retries still result in an error.
   

Code View  

 Follow the standard JSON syntax while coding a circuit. 

1. States consist of attributes. Enter a state name and define the attributes for the state as key-value pairs.
   
2. Define the common fields of the state: name, type, and next.
   
1. name: All the states must have a unique name to identify them within the circuit.
   
2. type: The actual functionality of the state is referred to by its type. The supported types are pass, branch, parallel, wait, batch, success, failure, function, webhook, and circuit. Click here for more details on states.
   
3. next: The name of the next state to run after the completion of the current state.
   
3. Define the unique fields of the states. Refer to Flow Controls to explore the fields for each state.
   
4. Provide error handling options using the onError attribute for state types, Functions, Webhooks, and Circuits.
   
5. Specify the inputPath, outputPath, and resultPath for input and output processing.
   
6. Click Save.
   

When there is an error in the code, a red mark is displayed beside the error line. Hover over it to display the details of the error.

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 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 are represented in black in the Code View) like type, next, duration, functionName, and collectionPath are expected in the camel case.

Bridge Controls  

1. Task Engine: Connects and accesses an API from a closed space. Know more.
   
2. DB Task: Executes query of the database hosted in a private network. Know more.
   
3. SSH Task: Performs action using the Shell command in a bridge-installed Linux machine. Know more.
   
4. Files: Creates workflows for file management. Know more.
   
1. File Upload
   
2. File Transfer
   
5. AD Task - Integrates and performs action in the AD service of the client application. Know more.
   
1. Add AD User
   
2. Add AD Group
   
3. Add User to Group
   
4. Add AD Computer
   
5. Enable AD User
   
6. Disable AD User
   
7. Reset AD Password
   
8. Unlock AD User
   
9. Remove AD Object
   
10. Update AD Object
    
11. Read AD Object
    
6. PowerShell Task Engine - Performs action using PowerShell command in a bridge-installed Windows machine. Know more.
   
1. PowerShell Engine     
   
2. Install WindowsApp
   
3. Uninstall WindowsApp     
   
4. Start Service
   
5. Stop Service
   
6. Restart WindowsServer
   

States share many common features:       

Each state must have a type field indicating what type of state it is.   

All states except for success and failure states require a next field, or they can be a terminal state by specifying an End field. 

Test and Execute a Circuit 

1. Click Save or Save and Execute.
   
2. When you click Save and Execute, a pop-up will appear with a predefined input. You can either select a value from the existing request or provide the JSON input for the circuit as key-value pairs and click Next.
   

 

    

1. Set or modify the values passed to test the circuit.
   

 

1. Click Test Run. You can view the execution in progress.
   

 

1. In the event of failure or data mismatch, you can repeat the execution by clicking Run Again.
   

 Each circuit can have multiple simultaneous executions. 

Execution Logs 

1. Click Execution Logs on the top of the circuit's page. This opens a list of all the executions of the circuit, along with the Circuit Name, Request ID, Invoked Time, Status, and other details.
   

 

1. View Graph
   
2. View Code
   
3. View Logs
   

 View Graph 

1. Once the circuit has been executed, you can visually observe the Execution Details, such as the input, output, and duration of the execution, from the right panel.
   
2. If the execution takes more than the expected time or seems to run in a loop, you can click Stop Execution to terminate it anytime.
   
3. You can view the paths that were traversed in the circuit, the status of each state represented by a color code mentioned at the top, and the overall status of the circuit execution as well.
   

 

View Code 

View Logs 

 

1. Timeline: The date and time of a particular event in a state, along with icons to indicate the event type.
   
2. State: The name of the state in which a particular event is executed.
   
3. Event: Events that occurred in the states, such as State Entered, State Exited, Input Processing, Result Processing, State Machine Triggered, State Machine Executed, etc.
   
4. Payload: JSON input that was passed to that state of the circuit.
   
5. Parameter: Additional parameters that are provided by the user to the state's input function and batch states.
   
6. Response: Response or the output generated by the state after its execution.
   
7. Exception: Tracks down the errors or any exceptions that occurred while executing the state.