Centralized Configuration Management in ConfigStore for Qntrl | Parameter Management| Online Help

ConfigStore: Centralized Configuration Management

Alert
Early Access  
This feature is not enabled for all users. If you’d like to try it out, please email our support team for early access.

ConfigStore offers a centralized, secure, organized approach to managing configuration data within Qntrl. It allows you to define parameter values and access them dynamically across different modules and environments in Qntrl, enhancing flexibility, re-usability, and security. Multiple parameters can be organized under a Group for better management.

Key Benefits of ConfigStore

  • Centralized Management: Store configuration data in one place, eliminating the need for hard-coding values in multiple scripts and functions.
  • Dynamic Access: Access parameter values dynamically across various environments, reducing the need for manual updates.
  • Flexibility: Easily update configuration values without modifying each script or function individually.
  • Enhanced Security: Safely manage sensitive data, such as passwords or API keys, centrally within ConfigStore. With encryption support for parameter values, sensitive data can be securely stored as encrypted values.
  • Re-usability: Reference parameters by their unique link names from supported modules or environments in Qntrl, promoting consistency and reducing redundancy.

Use Case Example

If you need to use an API key in multiple requests, store it as a parameter named api_key in ConfigStore instead of hard-coding it. You can then reference this parameter in your requests using  {{api_key}}  or the link name ${<link-name of parameter>}, based on the module where the parameter is used. 

When the key changes, update the parameter value in ConfigStore, and the change will be reflected everywhere the parameter is used. This approach ensures that any repeated data in your requests is managed centrally, simplifying updates and enhancing consistency across your workflows.

Parameter and Group Limits

  • Each group is limited to 25 parameters.
  • Each organization is limited to 100 groups.

Create a Parameter

To create a new parameter,
  1. Login to Qntrl.
  2. Navigate to (settings) >> Advanced >> ConfigStore >> select ConfigStore.
  3. Click the New Parameter button.
  4. Fill in the Parameter Details:
    • Name: Provide a name for the parameter.
    • Value: Enter a value for the parameter. This value will be used wherever the parameter is called.
    • Default Value: Specify a default value. If the parameter value is not defined for any environment instance, this default value will be used to prevent failures due to empty parameter values.
    • Type: Choose how to store the parameter value in the database.
      • Default String - String Values will be stored as plain text.
      • Encrypted String - String values will be stored encrypted.
    • Visibility: Define where the config store variable can be accessed.
      • Internal: Used only within Qntrl (scripts, automation, placeholders).
      • External: Can be accessed via client scripts and APIs, in addition to internal use.
    • Group: Select an existing group from the drop-down or create a new group by clicking the + icon. If no group is selected, the parameter will be stored under the default group. Learn more about groups.
    • Scope: Define the parameter values within the Sandbox environment.
      • Global
      • Environment
Notes
  • The environment scope is applicable only when the Sandbox feature is enabled, allowing you to define parameter values for each environment. If the Sandbox feature is disabled, only the Global scope is available.
  • Changing visibility from Internal to External in a sandbox project and deploying it will update the setting accordingly.
For further details on managing environment-specific parameter values, refer to the Environment Scope section.
  1. Click Save to store the new parameter. 
  1. When a parameter is saved, a link name is auto-generated in the Link Name field, and the parameter gets listed in the left pane.

Config Store – ZDK Support in Client Script    

The external parameters that can be accessed dynamically across different environments can be retrieved using Client script ZDK methods. This enables environment-aware scripting without hard-coding sensitive or environment-specific data.
​
When writing Client Scripts, you may need values like API keys, tokens, or other environment-specific configurations. Instead of embedding these directly in your script, you can store them securely in the Config Store and retrieve them at runtime using ZDK.
​
Benefits:  

  • Keeps scripts clean, secure, and maintainable

  • Allows config changes without updating scripts

  • Supports flexibility across environments

Alert
Only external parameters from the Config Store can be accessed through Client Script ZDK.

Supported ZDK Methods in Client Script   

Below are the supported ZDK methods available for retrieving external parameters in Client Scripts:

Method

Description

ZDK.QntrlParamAPI.getParamByLinkName(array)

Retrieves parameters using their link names.

ZDK.QntrlParamAPI.getParamById(array)

Retrieves parameters using their unique IDs.

ZDK.QntrlParamAPI.getAllParams()

Retrieves all external parameters available in the current environment.

​
These methods return the current value associated with the environment in which the script is executed. Learn more about Config Store ZDks for Client Scripts.

Notes
  • These methods are supported only within Client Scripts.
  • Only parameters marked as External in the Config Store are accessible via these methods.

Edit a Parameter

  1. Click on the parameter name in the left pane.
  2. On the details page, make the necessary modifications.
  3. Click Save to apply the changes.

Delete a Parameter

  1. Hover next to the parameter name in the left pane.

  2. Click the delete icon.

  3. Confirm your delete action. 










    • Related Articles

    • File Management

      Early Access File Management module is not enabled for all users. If you’d like to try it out, please email our support team for early access. The File Management module facilitates file transfer operations across various locations, providing ...

    • Configuring Additional Components

      Early Access Circuit Templates in Qntrl Studio is not enabled for all users. If you’d like to try it out, please email our support team for early access. Webhooks Webhooks enable automated HTTP notifications that are sent to third-party applications ...

    • Credentials

      The Credential module provides a streamlined solution for storing and managing authentication credentials for databases, remote machines, and application servers. Organizations dealing with multiple databases or APIs often face repetitive credential ...

    • Active Directory(AD)

      Active Directory (AD) is a service developed by Microsoft that provides a centralized way to manage all your network machines, users, and resources in one place. Active Directory stores data as Objects, which include users, groups, applications, and ...

    • Business Case: Automating Order Management

      Scenario Consider a retail company that uses Qntrl to manage its order fulfillment process. The company has an external e-commerce platform that receives orders from customers and needs to integrate with Qntrl to process these orders automatically. ...

    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.