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 Object is a unique JSON entity containing details about the state's execution. For further insights, refer to the Context Object section.
Parameters are available for the following states:
Function
Webhook
Task Engine
For better understanding, let's consider the following standard JSON input as an example:
{
"employee_details": {
"emp_name": "John Doe",
"emp_id": "357",
"email": "john.doe@example.com",
"position": "Software Engineer"
},
"department": "Engineering",
"start_date": "2024-04-01",
"manager": "Jane Smith"
}
To extract specific information, you can define these parameters as given below in the code view:
{
"get_employee_details": {
"type": "function",
"next": "End",
"start": true,
"function_id": "<function_name>",
"parameters": {
"name": "$.employee_details.emp_name",
"ID": "$.employee_details.emp_id"
"execution_id": "$$.execution.id",
"auth_key": "ec20c6b7-e117-4551-8395-e9189b0b738d"
}
}
}
With the given parameter configuration, the following JSON will be passed:
{
"name": "John Doe",
"ID": "357",
"execution_id": "<execution_id of state>",
"auth_key": "ec20c6b7-e117-4551-8395-e9189b0b738d"
}
Related Articles
Parameters in CodeX Script
In the CodeX script, you can perform CRUD (Create, Read, Update, Delete) operations on the Parameters in Qntrl through the SDK. Instead of defining a URL or other values directly in your CodeX script, you can define them in ConfigStore and reference ...
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 ...
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 ...
Other actions in Projects
Free up a sandbox You can unassociate a project from the sandbox when you want to free up a sandbox. To unassociate a sandbox: Navigate to and select Projects under Advanced. Click the Sandbox button at the top band. All sandboxes will be listed ...
Manage Webhooks
Webhooks Overview Webhooks facilitate automated HTTP notifications. Notifications are triggered in third-party applications as per the business requirements when a predefined action is performed by the user in the organization. Business Use Cases of ...