Creating a parameter

Creating a parameter

576a2e8d-1dc6-4166-88ce-fe1eebec9f82.png

To create a global parameter:

  1. Select the Global parameters button on the left panel to open the Global parameters page.

    gp-going-to.png
    Selecting Global parameters
  2. If no parameters have been created, the page will look like this:

    gp-no-params.png
    No parameters in the Global parameters page
  3. Click on Create parameter to open the Create parameter window. Enter the following details:

    gp-create-param.png
    Creating a parameter

Setting

Description

Requirement

Setting

Description

Requirement

Name

 

Enter a unique name to identify the parameter.

Example - Recommended format using hierarchy and levels

Using hierarchy levels in parameter names makes your configuration easier to understand and maintain. For more details, see Hierarchy level.

We recommend using the following hierarchical name format when you create parameters, as it keeps them structured and easier to navigate:

service/application/category/name

Examples:

s3/reporting/logging/bucket-name auth/customer-portal/security/jwt-secret notification/sms/delivery/sender-id

The examples above use this hierarchical naming structure:

  • service - logical service or domain (s3, auth)

  • application - sub-system, feature, or context (customer-portal, sms)

  • category - grouping of related parameters (logging, security)

  • name - specific parameter (jwt-secret, sender id)

  • Unique and case-sensitive

  • No spaces

  • Maximum length of 900 characters

  • Allowed characters are: a–z, A–Z, 0–9, underscore, period, and hyphen

  • For hierarchical names: leading forward slash, maximum hierarchy depth of ten levels

  • Required field

Description

Enter a description for the parameter.

  • Maximum length allowed is 1024 characters

  • Optional field

Value

Enter the value for the parameter.

  • Maximum length of 8192 characters

  • Required field

Sensitive value

Use the Sensitive value checkbox to clearly separate sensitive data from normal configuration values.

  • Standard: For non-sensitive configuration values, for example, URLs and database names. These are stored as plain text String.

  • Sensitive: For sensitive or secret values (like passwords, tokens, API keys). These are encrypted and stored safely.

Note!

Use Standard parameters for non-sensitive configuration data such as URLs and database names. From a security perspective, be deliberate and responsible in how you use Sensitive value, select Sensitive only for truly sensitive data, and ensure you reference them only in sensitive fields such as passwords and authentication tokens when you need to keep them hidden.

  • Sensitive value option is unselected by default.

  • When the Sensitive value option is not selected, the parameter is saved as a Standard parameter.

  • When the Sensitive value option is selected, the parameter is saved as a Sensitive parameter.

  • A parameter’s value type can be viewed in the Global parameters page.

  1. Click Confirm to create the parameter. The system displays a Parameter has been created message at the top left of the page.

  2. The new parameter appears in the Global parameters page.

    intro-create-parameter .png
    Parameters shown in the Global parameters page
  3. Click on the Copy icon next to the parameter to copy the parameter name in reference format: {{param:parameter_name}}.

Example - Reference format

Using the image above as an example, if you copy the “s3/bucket/credentials/secretkey” parameter. The format you will have copied the parameter, will look like this:

{{param:s3/bucket/credentials/secretkey}}

Note!

Each account can have a maximum of 100 parameters.