Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 1197784

Browse files
authored
Merge pull request #2726 from splunk/adasplunk-DOCGUILD-28158
[DOCGUILD-28158] Clarify how to navigate to the global variables page
2 parents d72b587 + 5ebb335 commit 1197784

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

synthetics/test-config/global-variables.rst

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,39 @@ Global variables are pre-saved, reusable variables that you define once and use
1111

1212

1313
How can you use a global variable?
14-
===================================
15-
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.
14+
==================================================
15+
16+
Use global variables to store non-sensitive information for your browser and API tests. Splunk Synthetics saves your global variables, but note that their values are visible to all users in your account.
1617

1718
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.
1819

1920
.. _concealed-gv:
2021

2122
What happens when you conceal a global variable?
2223
==================================================
23-
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.
24+
25+
When you conceal a global variable, Splunk Synthetics encrypts the variable's value in its database and scrubs its value from the Splunks 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.
2426

2527

2628
Create a global variable
27-
===============================
29+
==================================================
30+
2831
There are two ways to create a global variable:
2932

3033
* Add a new global variable in the vault:
3134

32-
#. From the Splunk Synthetic Monitoring landing page, select :guilabel:`Synthetics configuration`. The :guilabel:`Synthetics configuration` page opens, on the :guilabel:`Global variables` tab.
33-
#. Select :guilabel:`+ Add` to open the creation dialog box.
35+
#. On the Splunk Synthetics landing page, select the settings icon, and then select :guilabel:`Global variables`. The :guilabel:`Synthetics configuration` page opens onto its :guilabel:`Global variables` tab.
36+
#. Select :guilabel:`Create variable`.
3437

3538
* Add a new global variable while editing a test:
3639

37-
In the right-hand :guilabel:`Variables` column, scroll to :guilabel:`Global variables` and select :guilabel:`Add`.
40+
#. Expand the :guilabel:`Variables` pane on the right.
41+
#. Select :guilabel:`Add`.
42+
3843

39-
When you're in the :guilabel:`Add global variable` dialog box, enter the following:
40-
44+
When you're in the :guilabel:`Add variable` dialog box, enter the following:
45+
46+
#. Set :guilabel:`Variable type` to :guilabel:`Environment`.
4147
#. In the :guilabel:`env` field, enter the name of the variable. You will use this key to access your variable within a test.
4248
#. In the :guilabel:`value` field, enter the value that will replace the variable when the test is run.
4349
#. (Optional) In the :guilabel:`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.
@@ -46,23 +52,26 @@ When you're in the :guilabel:`Add global variable` dialog box, enter the followi
4652

4753

4854
Edit a global variable
49-
====================================
50-
To edit the key or description of a global variable, visit the :guilabel:`Global variables` page and edit within the field. Select :guilabel:`Save` when you're finished editing.
55+
==================================================
56+
57+
To edit the key or description of a global variable, navigate to the :guilabel:`Global variables` page and edit within the field. Select :guilabel:`Save` when you're finished editing.
5158

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

5461
.. _gv-test:
5562

5663
Use a global variable in a synthetic test
57-
=================================================
64+
==================================================
65+
5866
You can use a global variable to fill in fields in the :guilabel:`Steps` and :guilabel:`synthetic transactions` of a browser test, or in the requests of an API test. Global variables cannot be used in cookies.
5967

6068
While creating or editing a test, the right-hand :guilabel:`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.
6169

6270
.. _ gv-browser-test:
6371

6472
Use a global variable in a browser test
65-
--------------------------------------------
73+
--------------------------------------------------
74+
6675
Follow these steps to add a variable to your browser test:
6776

6877
#. While creating or editing a transactional browser test, go to your :guilabel:`Steps`.
@@ -74,7 +83,7 @@ Follow these steps to add a variable to your browser test:
7483
.. _gv-api-test:
7584

7685
Use a global variable in an API Test
77-
----------------------------------------
86+
--------------------------------------------------
7887

7988
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.
8089

0 commit comments

Comments
 (0)