Parameters in Circuit

Parameters in Circuit allow you to use dynamic values in your automated workflows, making it easier to customize and control various parts of your process. These parameters are created in the ConfigStore and can be referenced throughout the different states of Circuit using placeholder values.

How to Use Parameters in Circuit

When setting up a workflow in Circuit, you can reference these parameters using a special syntax. The common syntax for referencing a parameter is: ${<link-name of parameter>}

This syntax allows you to insert the value of the parameter wherever it's needed in your workflow.

Where Can Parameters Be Used?

Below is a comprehensive table that outlines how placeholders can be used in different states within Circuit.

State Type	Usage Location (Field/Payload)	Field/Key Name	Placeholder Type	Description
pass	result	result	string	Use this placeholder for passing string values in pass states.
circuit, function, webhook	headers	headers	json	Supports JSON headers for circuits, functions, and webhooks.
circuit, function, webhook	parameters	parameters	json	Use this for passing parameters in JSON format.
branch	branches	condition	string	Supports string conditions for branching logic.
task_engine	payload	method	string	Define the method for task engine payloads using a string value.
task_engine	payload	url	string	Supports URL as a string in task engine payloads.
db_engine	payload	database_name	string	Set the database name in DB engine payloads.
db_engine	payload	query	string	Use a string to define the query in DB engine payloads.
ssh_engine	payload	command	string	Pass the command as a string in SSH engine payloads.
powershell_engine	payload	execution_path	string	Define the execution path for PowerShell engine payloads.
powershell_engine	payload	command	string	Supports string commands for PowerShell engine payloads.
powershell_engine	payload	variables	json	Use JSON to define variables in PowerShell engine payloads.
add_ad_user	payload	object_name	string	Define the object name in Active Directory user payloads.
add_ad_user	payload	organization_unit	string	Specify the organizational unit in AD user payloads.
add_ad_user	payload	properties	json	Use JSON to pass properties for AD user payloads.
add_ad_computer	payload	object_name	string	Supports object name as a string for AD computer payloads.
add_ad_computer	payload	organization_unit	string	Define the organizational unit in AD computer payloads.
add_ad_computer	payload	properties	json	Pass properties using JSON for AD computer payloads.
add_ad_group	payload	object_name	string	Supports object name as a string for AD group payloads.
add_ad_group	payload	organization_unit	string	Define the organizational unit for AD group payloads.
add_ad_group	payload	properties	json	Use JSON for properties in AD group payloads.
add_ad_user_to_ad_group	payload	user_name	string	Specify the user name in AD user-to-group payloads.
add_ad_user_to_ad_group	payload	group_name	string	Define the group name for user-to-group associations in AD.
enable_ad_user	payload	user_name	string	Supports user name as a string for enabling AD users.
disable_ad_user	payload	user_name	string	Specify the user name in payloads for disabling AD users.
unlock_ad_user	payload	user_name	string	Define the user name for unlocking AD users.
reset_ad_password	payload	user_name	string	Supports user name as a string for resetting AD passwords.
reset_ad_password	payload	password	string	Use a string to specify the new password in reset operations.
read_azure_user	-	principle_name	string	Supports principle name as a string for reading Azure users.
update_azure_user	-	principle_name	string	Define the principle name for updating Azure users.
update_azure_user	-	user_name	string	Supports user name as a string for updating Azure users.
update_azure_user	-	email	string	Specify the email address in Azure user updates.
update_azure_user	-	password	string	Define the password for updating Azure user credentials.
delete_azure_user	-	principle_name	string	Supports principle name as a string for deleting Azure users.

Related Articles
Parameters
Parameters provide the ability to customize JSON input by adding a collection of key-value pairs as input to a task. These values can either be static or dynamically selected from the JSON input or the context object using specific paths. Context ...
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 ...
Environment Scope for Parameters in Sandbox
In the Sandbox module, you can assign dynamic values to parameters for different environments (e.g., development, testing, production), ensuring consistent configurations across multiple stages of the deployment process. These parameters can be ...
Create and Configure a Circuit
Create a Circuit Log in to Qntrl. Click Circuit from the left pane, then click New Circuit. Specify a unique Name and add a Description for the Circuit. Click Save. A sample circuit with the Pass state and name as 'State1' will be created by default, ...
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 ...

You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.

Using Parameters in Circuit for Dynamic Workflow Customization | ConfigStore Integration | Online Help

Parameters in Circuit

Related Articles

Parameters

Circuit

Environment Scope for Parameters in Sandbox

Create and Configure a Circuit

Introduction to States of Circuit