Merge pull request #2564 from splunk/adasplunk-O11YDOCS-6660

[O11YDOCS-6660] Custom variables [Feb 4 release]

Author: adasplunk

synthetics/browser-test/set-up-browser-test.rst

@@ -30,7 +30,7 @@ Follow these steps to set up a Browser test:
 
 #. From the landing page of Splunk Observability Cloud, navigate to Splunk Synthetic Monitoring.
 
-#. Under Tests, select :guilabel:`Add New Test` and select :guilabel:`Browser Test` from the drop-down list. The test creation view opens.
+#. Under :guilabel:`Tests`, select :guilabel:`Create new test` and then select :guilabel:`Browser test` from the drop-down list. The test creation view opens.
 
 #. In the :guilabel:`Name` field, enter a name for your test.
 

synthetics/browser-test/set-up-transactional-browser-test.rst

@@ -69,20 +69,23 @@ The following table describes the types of steps you can include for actions:
      - Dismiss an alert that appears on the page.
 
    * - Fill in field
-     - Fill a field you identify under :guilabel:`Selector` with a value you provide under :guilabel:`Value`. Optionally, wait for navigation. For security and reusability, use a built-in, custom, or global variable to provide the value. See :ref:`global-variables` to learn more.
+     - Fill in the field you identify under :guilabel:`Selector` with a value you provide in the :guilabel:`Value` field. For security and reusability, you may want to use a :ref:`built-in  <built-in-variables>`, :ref:`custom <custom-variables>`, or :ref:`global <global-variables>` variable in the :guilabel:`Value` field. Reference a custom variable as ``{{custom.your-variable-name}}``. Optionally, wait for navigation.
 
    * - Go to URL
-     - Navigate to a URL you provide under :guilabel:`Value`. 
+     - Navigate to a URL you provide in the :guilabel:`URL` field. 
 
    * - Execute JavaScript
      - Execute a piece of JavaScript you provide under :guilabel:`Value`. Optionally, wait for navigation. 
 
-   * - Select 
-     - Select an element you identify under :guilabel:`Selector`. Choose the value you identify under :guilabel:`Value`. Optionally, wait for navigation.
+   * - Save return value from Javascript 
+     - Execute a piece of JavaScript you specify in the :guilabel:`JavaScript` field. If the script returns a value you want to save, specify a name for the saved value in the :guilabel:`Variable` field. This creates a custom variable which you can reference in subsequent steps as ``{{custom.your-variable-name}}``. Optionally, wait for navigation.
 
    * - Save text from element 
      - Save the text an element you identify under :guilabel:`Selector`, as the variable you provide under :guilabel:`Variable`. 
 
+   * - Select 
+     - Select an element you identify under :guilabel:`Selector`. Choose the value you identify under :guilabel:`Value`. Optionally, wait for navigation.
+
    * - Switch to iframe
      - Switch focus to an embedded document in an inline frame, identified under :guilabel:`Selector`. 
 

synthetics/test-config/custom-variables.rst

@@ -0,0 +1,37 @@
+.. _custom-variables:
+
+*********************************************************************
+Custom variables 
+*********************************************************************
+
+.. meta::
+    :description: Define a custom variable that you can use in an individual synthetic test.
+
+
+Custom variables are variables you can set and use within a single test. Whereas global variables are static and stored in the env namespace, custom variables are dynamic and are stored in the custom namespace.  You can use them to store and retrieve dynamic values in your browser and API tests. You can't use custom variables in uptime (HTTP or port) tests.
+
+
+How to create a custom variable
+=====================================================================
+
+You can create a custom variable and assign a value to it in a browser test or API test.  For example, in a browser test, you can add a :guilabel:`Save return value from Javascript` step and specify a name for the variable in the :guilabel:`Variable` field. Variable names must be unique within an individual test.
+
+How to use a custom variable
+=====================================================================
+
+You can use a custom variable in a browser test or API test. Always reference a custom variable as ``{{custom.your-variable-name}}``. For example, in a browser test:
+
+* Add a :guilabel:`Go to URL` step and specify the variable name in the :guilabel:`URL` field. 
+
+* Add a :guilabel:`Fill in field` step and specifiy the variable name in the :guilabel:`Value` field.
+
+
+You can only reference custom variables after you've defined them in an earlier step.
+
+
+See also
+=====================================================================
+
+* :ref:`built-in-variables`
+* :ref:`global-variables`
+

synthetics/test-config/test-config.rst

@@ -11,6 +11,7 @@ Advanced test configurations
 
    auth
    built-in-variables
+   custom-variables
    synth-alerts
    devices
    syn-downtimes
@@ -19,6 +20,7 @@ Advanced test configurations
    public-locations
    rum-synth
    try-now
+
 
 
 To simulate diverse types of traffic to your site or application, use a range of configuration options to customize each of your tests.