You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: synthetics/test-config/global-variables.rst
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,28 @@
1
1
.. _global-variables:
2
2
3
3
*****************************************
4
-
Create and use Global Variables
4
+
Create and use global variables
5
5
*****************************************
6
6
7
7
.. meta::
8
8
:description: Define a variable that you can use in multiple browser and API tests in Splunk Synthetic Monitoring.
9
9
10
-
Define a global variables once, then you can use the variable across all of your Browser and API tests.
10
+
Define a global variable once, and then you can use the variable across all of your browser and API tests.
11
11
12
12
13
-
How can you use global variables?
13
+
How can you use a global variable?
14
14
===================================
15
-
Global variables are stored securely in the Splunk Synthetic Monitoring platform, but the keys and values of all global variables in your account are visible to all users.
15
+
Global variables are stored securely in Splunk Synthetic Monitoring, but the keys and values of all global variables in your account are visible to all users.
16
16
17
-
To preserve your account's security, don't use production credentials, real credit card information, or other sensitive data in global variables for your checks. Instead, try using placeholder credentials to test workflows that require information to be entered during a test.
17
+
To preserve your account's security, don't use production credentials, real credit card information, or other sensitive data in global variables for your tests. Instead, use placeholder credentials to test workflows that require you to enter information.
18
18
19
-
To use data such as test login credentials, API keys, or other test information, you can permanently conceal the value of a global variable from all users of your account.
19
+
To use information such as login credentials, API keys, or other test data, you can permanently conceal the value of a global variable from all users of your account.
When you :strong:`conceal` a global variable, its value is permanently concealed from all users of the account. This lets you create and save variables such as test login credentials, API keys, and other sensitive information to use in Browser and API tests.
25
+
When you conceal a global variable, its value is permanently concealed from all users of the account. This lets you create and save variables such as test login credentials, API keys, and other sensitive information to use in browser and API tests.
26
26
27
27
To preserve security, the value of a concealed global variable is never revealed to any user of the account after it has been created and saved. The value is scrubbed from the Splunk Synthetic Monitoring UI, from test results, and from alert messages.
28
28
@@ -49,29 +49,29 @@ Once you're in the :guilabel:`Add global variable` dialog box, enter the followi
49
49
#. Once you're satisfied with your global variable, select :guilabel:`Add`.
50
50
51
51
52
-
Edit a Global Variable
52
+
Edit a global variable
53
53
====================================
54
-
To edit the key or description of a global variable, visit the global variables page and edit within the field. Select :guilabel:`Save` when you're finished editing.
54
+
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
55
56
56
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.
57
57
58
58
.. _gv-test:
59
59
60
60
Use a global variable in a synthetic test
61
61
=================================================
62
-
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.
62
+
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.
63
63
64
64
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.
65
65
66
66
.. _ gv-browser-test:
67
67
68
-
Use a global variable in a Browser test
68
+
Use a global variable in a browser test
69
69
--------------------------------------------
70
-
Follow these steps to add a variable to your Browser test:
70
+
Follow these steps to add a variable to your browser test:
71
71
72
-
#. While creating or editing a transactional Browser test, go to your :guilabel:`Steps`.
72
+
#. While creating or editing a transactional browser test, go to your :guilabel:`Steps`.
73
73
#. Under :guilabel:`Action`, select :guilabel:`Fill in field` from the dropdown menu.
74
-
#. Under :guilabel:`Value`, enter the key for the global variable you want to use, use the ``env.`` prefix and enclosed in double curly braces. For example, to reference a global variable with the key dev-username, enter ``{{env.dev-username}}`` in the :guilabel:`Value` field.
74
+
#. Under :guilabel:`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 :guilabel:`Value` field.
75
75
#. Finish editing or creating the test.
76
76
#. :guilabel:`Save` your test.
77
77
@@ -85,7 +85,7 @@ You can also use a global variable to fill in any field in an API test. For inst
85
85
Follow these steps to add a variable to your API test:
86
86
87
87
#. While creating or editing an API test, go to your :guilabel:`Requests`.
88
-
#. In a variable field for any setup, request, or validation step, enter the key for the global variable you want to use, use the ``env.`` prefix and enclosed in double curly braces. For example, to reference a global variable with the key ``staging-url``, enter ``{{env.staging-url}}`` in the field.
88
+
#. 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.
0 commit comments