Promoting test variables

You can promote a variable to map it to an environment value or to a secret that protects sensitive data through security groups. You can use the promote option when the value of a variable must be managed centrally across environments. When you promote a variable and mark it as a secret, the value is automatically masked in security group and reports.

Before you begin

You must have completed the following tasks:

About this task

When you promote a variable, the following changes occur based on its type:
If variable type is.. Then..
Value
  • The Source column displays: From Environment
  • The variable is listed in the Variables section for the selected environment.
  • You can manage the value of the variable from the settings of the environment, and the same value is used when you run the test.
Secret
  • The Source column displays: From Secrets Group via Environment
  • The variable is listed in the Variables section of the selected environment and the Secrets section of the selected security group.
  • The value of the variable is blank in the Variables section of the Configure settings and data pane and on the selected environment page. The value of the secret is masked in Secrets section of the selected security group.
  • You can manage the value of the variable from the settings of the security group, and the same value is used when you run the test.

Procedure

  1. Click the Edit button displayed on the Test Editor page.

    The Edit button appears only when no active edit branch is selected.

    Alternatively, right-click the test in the test navigator panel and select Edit.

    The Edit branch dialog is displayed.
    If the Edit branch dialog is not displayed, then go to step 3.
  2. Select an existing branch or create a new branch.
  3. Click the Configure settings and data step in Test Editor.
    The Configure settings and data pane is displayed.
  4. Click the Promote variable to environment icon Promote variable to environment, and then perform the following steps in the Promote Variable <variable_name> dialog:
    1. Select an environment for mapping from the Environment drop-down list.
    2. Select the category as Value or Secret from the Type drop-down list.
      If you select the Secret option, then you must select the security group to add the variable from the Security Group drop-down list.
    3. Click Promote.
      A confirmation message is displayed. The Source column for the promoted variable displays one of the following messages depending on the variable type:
      • From Environment for a text value override from the environment
      • From Secrets Group via Environment for a secret value override from the security group
  5. Close the step details pane.
  6. Click the Save icon to save the modifications.

Results

You have promoted a variable to map it to an environment value or to a secret-backed value.

What to do next

You must run the test in Test Editor and view the Functional Report to verify the values of the promoted variables. See Running a Web UI test.