Creating a parameter
To create a global parameter:
Select the Global parameters button on the left panel to open the Global parameters page.
Selecting Global parametersIf no parameters have been created, the page will look like this:
No parameters in the Global parameters pageClick on Create parameter to open the Create parameter window. Enter the following details:
Creating a parameter
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/nameExamples: s3/reporting/logging/bucket-name
auth/customer-portal/security/jwt-secret
notification/sms/delivery/sender-idThe examples above use this hierarchical naming structure:
|
|
Description | Enter a description for the parameter. |
|
Value | Enter the value for the parameter. |
|
Sensitive value | Use the Sensitive value checkbox to clearly separate sensitive data from normal configuration values.
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. |
|
Click Confirm to create the parameter. The system displays a Parameter has been created message at the top left of the page.
The new parameter appears in the Global parameters page.
Parameters shown in the Global parameters pageClick 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.