Docs » Advanced test configurations » Global variables

Global variables 🔗

Global variables are pre-saved, reusable variables that you define once and use across all your browser and API tests.

How can you use a global variable? 🔗

Use global variables to store non-sensitive information for your browser and API tests. Splunk Synthetic Monitoring saves your global variables, but note that their values are visible to all users in your account.

To preserve your account’s security, don’t use global variables to store sensitive information such as login credentials, API keys, or credit card information.

What happens when you conceal a global variable? 🔗

When you conceal a global variable, Splunk Synthetic Monitoring encrypts the variable’s value in its database and scrubs its value from the Splunk Synthetic Monitoring UI, from test results, and from alert messages. However, concealed global variables were not designed to safeguard sensitive information or critical data; do not misuse them for such purposes.

Create a global variable 🔗

There are two ways to create a global variable:

  • Add a new global variable in the vault:

    1. From the Splunk Synthetic Monitoring landing page, select Synthetics configuration. The Synthetics configuration page opens, on the Global variables tab.

    2. Select + Add to open the creation dialog box.

  • Add a new global variable while editing a test:

    In the right-hand Variables column, scroll to Global variables and select Add.

When you’re in the Add global variable dialog box, enter the following:

  1. In the env field, enter the name of the variable. You will use this key to access your variable within a test.

  2. In the value field, enter the value that will replace the variable when the test is run.

  3. (Optional) In the Description field, enter a description to explain the purpose of the variable for future reference. A description is particularly helpful when you conceal the variable and cannot reveal its value.

  4. (Optional) Select Conceal value.

  5. Select Add.

Edit a global variable 🔗

To edit the key or description of a global variable, visit the Global variables page and edit within the field. Select Save when you’re finished editing.

Editing the value of a saved concealed global variable clears the previous value. You must provide a new value and select Save to apply it.

Use a global variable in a synthetic test 🔗

You can use a global variable to fill in fields in the Steps and synthetic transactions of a browser test, or in the requests of an API test. Global variables cannot be used in cookies.

While creating or editing a test, the right-hand Variables tab provides list of built-in variables and global variables you can use. Select the name of a variable to copy it to your keyboard.

Use a global variable in a browser test 🔗

Follow these steps to add a variable to your browser test:

  1. While creating or editing a transactional browser test, go to your Steps.

  2. Under Action, select Fill in field from the dropdown menu.

  3. Under Value, enter the key for the global variable you want to use, prefixed with env. and enclosed in double curly braces. For example, to use a global variable with the key dev-username, enter {{env.dev-username}} in the Value field.

  4. Finish editing or creating the test.

  5. Save your test.

Use a global variable in an API Test 🔗

You can also use a global variable to fill in any field in an API test. For instance, you can use a global variable to provide a URL for any request, a header value, or any other value.

Follow these steps to add a variable to your API test:

  1. While creating or editing an API test, go to your Requests.

  2. In a variable field for any setup, request, or validation step, enter the key for the global variable you want to use, prefixed with env. and enclosed in double curly braces. For example, to use a global variable with the key staging-url, enter {{env.staging-url}} in the field.

  3. Finish editing or creating the test.

  4. Save your test.

This page was last updated on Dec 20, 2024.