Webhooks    

Create a Webhook

1. Click Webhooks in the left pane and click New Webhook.
2. Fill in the following details:
   
1. Type: Select Standalone (the only supported type for Circuit).
   
2. Name: Enter a name for the webhook.
   
3. URL: Specify the API URL of a third-party or Zoho application.
   
4. Method: Select the API method type (POST/GET). The default is POST.
   
5. Preview: Review the complete webhook URL to be sent to the third-party application (not editable).
   
6. Append Custom Parameters: 
   
1. Specify the parameter name and its corresponding value for the webhook.
   
2. This key/value pair is mainly used to send authentication tokens, API keys, security tokens, etc.
   

• Custom Headers:
  
• Specify the header name and the corresponding value for the webhook.
  
• This can be used to send cookies, User-Agent, Referrer, and so on.  
  

3. Click Save.
   

Once created, the webhook will appear under the Associated Components in the Webhooks section.

Refer to Qntrl's Webhook help page for detailed configuration instructions.

While importing Circuit template, only the associated webhooks will get imported.

Edit a Webhook 

To edit a Webhook:

1. Click on the Webhooks section in the left pane.
2. From the list, click the name of the webhook to be edited.
3. Make modifications and click Save.

Delete a Webhook

1. Click the Webhooks section in the left pane.
2. Hover over the webhook name, click the action menu, and select Delete.
3. In the prompt window, confirm your delete action.
   

Functions 

Create a Function 

1. Create a new Function:
   

• Click on Functions section in the left pane and click Add Function.

• Provide the function details:
  

• Name: Enter a name for the function.
  

• Language: Select the desired programming language from the drop-down. 'Zoho Deluge' is selected by default.
  

• Description: Provide a brief explanation of the function's purpose.
  

• Click Save to proceed.

2. Write Function Script:
• The editor will open where you can write your function script in the cloud IDE or the editor displayed for the selected language.
  
• For more details on writing functions, click here.
  
3. Test and Deploy Function:
   
• Click Save and Execute to test the function with sample input.
• Click Deploy to make the function available for integration into circuits.

• Once deployed, the function will be listed under the Associated Components section within the Function tab.

• Functions must be deployed before use in Circuits.

• While importing a Circuit template, only the associated functions will be imported.

Manage Existing Functions   

1. Click on Functions in the left pane.

2. Hover over the function name and click on the action menu.

3. Choose from the following options:
   

1. Edit: Modify the function code and redeploy. Only the deployed version will be executed in Circuit.
   

2. Preview: View the function script without making changes.
   

3. Delete: Remove the function.

Connections

Connections enable integrations with Qntrl and external services. You can create connections to both pre-configured and custom services.

Create a Connection   

1. Navigate to the Connections section in the left pane.

2. Click the Create Connection button.

3. Pick Your Service:
   

1. Default Service: Select a service from the frequently used services provided.
   

2. Custom Service: Create your own service by selecting the custom service option.
   

For more details about connections in Qntrl, click here.

Connect with a default service:

Choose a pre-configured service from the list of frequently used options.

1. Under the Default Services tab, choose a third-party or internal Zoho service.

2. In the next section, provide the required service details and click Create and Connect.

3. You will be redirected to the service page to authenticate the connection.

4. Once authentication is successful, the service will be ready to use. 

Learn more about Connections.

Connect with a Custom Service:

1. Navigate to the Custom Service tab and click Create Service.

2. Enter the necessary connection and authentication details to set up a new service. 

3. Click Create Service.

Once authentication is successful, the service will be ready to use.

For more detailed information on connecting with custom services, click here.

Edit / Delete a Connection 

You can edit or delete existing connections by hovering over the desired connection.

• To Edit: Click the edit icon, make necessary changes, and then click Update.

• To Delete: Click the delete icon and confirm your action to remove the connection.

Revoke a connection  

To discontinue an integration, you can revoke the associated connection.

1. In the left pane, click My Connections.

2. Hover over the connection you wish to revoke.

3. Select the Revoke option.

Revoking a connection removes authorization but doesn't delete the connection record the service will still be listed on the Connections page. You can re-establish the connection at any time.

Tables 

Create a Table   

1. Navigate to the Tables section in the left pane and click Create Table.
   
2. Define Table Structure:
   
1. Table Name: Enter a name that describes the table.
   
2. Description: Add a brief explanation of the table's purpose.
   
3. Columns:
   
1. Column Name: Enter the name of the column.
   
2. Field Type: Select the field type from the drop-down menu. Supported field types include: single line text, multi-line text, date and time, decimal, number, email address, and link.
   
3. Add or Remove Columns: Click the + or - icon next to the column to add or remove it.
   
4. Column Settings: Click the settings icon and configure column settings (mandatory, default value, minimum/maximum values).
   

3. Click Save to create the table. Once created, you can manually enter data or import it into the table.

For more details on creating and managing tables, visit the Tables help page.

Edit/Delete a Table 

• To Edit: Hover over the table and click the edit icon. Make changes and Update.
• To Delete: Hover over the table and click the delete icon. Confirm the action.
  

Schedules 

Create a Schedule   

1. Navigate to the Schedules section in the left pane and then click the New Schedule button.
2. Define Schedule Details:
   
1. Name: Provide a relevant name for the schedule.
   
2. Frequency: Choose how often the schedule should run (e.g., Weekly).
   
3. Execute On: Specify the day of the week when the function should be executed.
   
4. Start Date and Time: Set the initial start date and time for the schedule execution.
   
5. Expiry: Select the condition after which the schedule should expire.
   
1. Set Execution Limit: Determine the number of times the schedule should run before expiring.
   
2. Set Expiry Date: Select the specific date after which the schedule will expire.
   
3. Never: Allow the schedule to run indefinitely.
   

• Callback Type: Choose whether the schedule should trigger a Function or a Circuit.
• Once selected, a dropdown will display the available functions or circuits. Select the appropriate one from the list.

3. Click Save to create the schedule.

Managing  Schedules

• Edit: Select the desired parameter from the list in the left pane, make the necessary modifications, and click Save.
• Delete: Hover over the name of the schedule, click the delete icon, and confirm your delete action in the prompt window.
  

1. Navigate to the Group section in the left pane and click New Group.
2. Fill in the Group Details:
   
1. Group Name: Provide a descriptive name for the group.
   
2. Description: Provide a brief explanation of the group's purpose.
   

3. Click Save.
   

Manage Existing Groups 

1. Click on Group in the left pane.

2. Hover over the group name and click on the action menu.

3. Choose from the following options:
   

1. Edit: Edit the group name and description and click Save.
   

2. Delete: Remove the group by selecting Delete.

ConfigStore

Adding a Parameter in ConfigStore   

1. Navigate to the ConfigStore in the left pane and click Add Parameter.
2. Fill in the Parameter Details:
   
1. Parameter Name: Assign a unique name to the parameter.
   
2. Value: Enter the parameter value for testing purposes. This value will not be exported.
   
3. Default Value: Specify a default value to prevent failures. Note that only the default value will be exported to a customer org.
   
4. Type: Choose how to store the parameter value in the database
   
1. Default String - String Values will be stored as plain text.
   
2. Encrypted String - String values will be stored encrypted.
   

• Group: Select an existing group from the drop-down list to categorise your parameter.

3. Click Save to store the new parameter.
4. Once created, the created parameters will get listed in the left pane:
   
1. All: All the parameters will get listed
   
2. Grouped: Parameters will be listed category-wise.

Associating Parameters

Use the format ${parameter's_link_name} to associate the created parameter within Circuit.

Managing Parameters 

Edit a Parameter

1. Click the ConfigStore in the left pane.
   
2. Select the desired parameter from the list in the left pane.
   
3. Make the necessary modifications
4. click Save.
   

Delete a Parameter

1. Click the ConfigStore in the left pane.
   
2. Hover over the name of the parameter.
   
3. Click the delete icon next to the parameter name
4. Confirm your delete action in the prompt window.
   

Bridge

Create a Bridge 

To create a new bridge:

1. Click Bridge in the left pane of your circuit template and click New Bridge.
2. Fill in the bridge details:

• Name: Provide a unique name for the bridge.
• Modules: Select one of the modules from the drop-down list. The task related to the selected module alone will be executed through this message. Task Engine and DB Engine modules will be associated by default while creating a bridge.
• Task Engine - To execute API tasks in third-party or internally hosted app
• DB Engine - To perform SQL queries in a database hosted in a closed network
• SSH Engine - To connect a remote Linux/Unix machine and to execute required commands
• PowerShell Engine - To connect a remote Windows machine and to execute required commands
• File Management - To transfer files from one location to another
• AD Engine - Connects and performs secured operations in Active Directory
• Description: Give a detailed description of the bridge purpose.

3. Click Save. 
   

Refer to Qntrl's Bridge help page for detailed configuration instructions.

• If the Bridge is not associating during connector or credential creation, ensure the relevant modules configured in the component are selected.
  

• The created Bridge cannot be exported and is intended solely for template creation purposes.

• After installing the template, a new or existing Bridge must be manually associated.

Edit a  Bridge

To edit a bridge:

1. Click on the Bridge section in the left pane.

2. From the list, click the name of the bridge to be edited.

3. Make modifications and click Save.

Delete a  Bridge

To delete a bridge:

1. Click the Bridge section in the left pane.

2. Hover over the bridge name, click the action menu, and select Delete.

3. In the prompt window, confirm your delete action.
   

Create a Script 

1. Navigate to the Scripts section in the left panel of your circuit template and and click New Script.
2. Fill in the new script details:
   
1. Name: Give a name with a file extension to identify the script (e.g.: display.sh/display.ps1).
   
2. Description: Provide a description that serves for later reference.
   
3. Script Type: Choose the type of script.
   
1. Shell Script - For UNIX OS
   
2. PowerShell Script - For Windows OS
   
4. Script File: If the script is available in a local file, you may attach it in this field, and it will be executed in the message.
   
5. Content: Alternatively, the commands that need to be executed can be given directly in this field.
   
3. Click Save. A new script will be created.
   

For more details on creating and managing tables, visit the Scripts help page.

Edit a Script 

To edit an existing script:

1. In your circuit template, navigate to the Scripts section in the left pane.

2. Click on the script name you want to edit.

3. Make the required modifications and click Save.

Delete a script      

To remove a script:

1. In your Circuit template, navigate to the Scripts section in the left pane.

2. Hover over the name of the script you want to delete, click the action menu, , and click Delete.

3. Confirm the delete action.

Connectors 

Create a  Connector

1. Click Connectors in the left pane and click New Connector.
2. Fill in the new connector details:

• Name: Provide a unique name for the connector.
• Type: Select the Type of connection. Currently Qntrl supports only JDBC.
• Credential: Select the credential name that has the credentials to connect to the intended database.
• SQL Type: Select the type of your SQL database
• SQL Server
• MySQL
• PostgreSQL
• Oracle
• Connection Timeout: Specify the maximum timeout limit beyond which the connection will expire.
• Query Timeout: Specify the maximum timeout limit beyond which the query execution will be suspended.
• Host Name: Enter the hostname in which the DB is hosted.
• Port: Enter the port number in which the DB runs.
• Database Name: Enter the database name to be connected.
• Instance: This field appears if the SQL Type is SQL Server. Enter the DB instance name.

3. Click Save.

Refer to Qntrl's Connectors help page for detailed configuration instructions.

Edit a Connector   

To edit a connector:

1. Click on the Connectors section in the left pane.

2. From the list, click the name of the connector to be edited.

3. Make modifications and click Save.

Delete a Connector 

To delete a connector:

1. Click the Connectors section in the left pane.

2. Hover over the connector name, click the action menu, and select Delete.

3. In the prompt window, confirm your delete action.

Credentials 

Create a Credential 

To create a new credential:

1. Click Credentials in the left pane and click New Credential.
2. Fill in the new credential details:

• Name: Provide a unique name to identify the credential.
• Type: Choose the type of credential.
• API Key - If the Credential type is an API key, mention the API token.
• Append To: Select the Parameter or Header to append the credential   
• Parameter or Header name: Provide a name for the Parameter or Header    
• JDBC - For the JDBC Credential type, the username and password need to be provided.
• OAuth 2.0 - If the Credential type is OAuth 2.0, select the existing DRE connections.
• SSH - Provide the username and password of the machine where the Shell script has to be executed.
• Powershell - Provide the username and password of the machine where the Powershell script will be executed.
• Active Directory - Specify the User DN and Password of the Active Directory.
• Use Credentials from Bridge: Select this if you have previously saved credentials in a bridge.
• Credential Name in Bridge: Mention the saved credential name.

3. Click Save.

Refer to Qntrl's Credentials help page for detailed configuration instructions.

For security reasons, certain properties, such as usernames, tokens, and passwords, cannot be exported. These sensitive fields must be reconfigured manually in the target environment after the component is imported.

Edit a Credential   

To edit a credential:

1. Click on the Credentials section in the left pane.

2. From the list, click the name of the credential to be edited.

3. Make modifications and click Save.

Delete a Credential

To delete a credential:

1. Click the Credentials section in the left pane.

2. Hover over the credential name, click the action menu, and select Delete.

3. In the prompt window, confirm your delete action.