...
Overview
The Run variable macro is used to access the field values provided in other macros on the same page. This macro can be used with other macros such as Wiki, Markup, Groovy, SQL for Confluence macros, and so on.
...
- Identify the form and the variable to be accessed through the macro editor.
- Access the variable value using the '$' prefix in any other macro on the same page. See Field types to learn more about the supported field types.
...
| Parameter | Description |
|---|---|
| Form ID | Enter the form ID of either the Run with a user form and parameters and or the Run without user form macro. This value must be the same as specified in Run settings > Parameters > Unique form id of the macro editor. |
| Variable name | Enter the variable name as specified in the Field settings tab in the Run with a user form and parameters/Run without user form macro editor. Use this value in other macros using the '$' sign prefixed to the specified variable. |
...
Select the macro on the page to either edit or delete it from the page.
Examples
Let's consider the following scenarios:
...
Example
This section demonstrates how to access a field defined in the Run a user form and parameters macro and display this value through a Groovy macro. For this scenario, perform the following:
- Define field value within a Run a user form and parameters macro
- Access field value defined in another macro
| Info |
|---|
The query, database, field names and other values are for demonstrative purposes only. Please customize these values as per your instance. |
...
Define field value
...
within a Run a user form and parameters macro
First, let's populate two select list boxes using the Dynamic Select and Dynamic Multi Select field type types in a Run a user form and parameters macro. To do so, the relevant profile and SQL query must be provided. See Field types for for more information.
In the image:
- A Run a user form and parameters macro has defined two select lists with IDs DYNSEL01 and DYNMULSEL01. Both lists are dynamically populated using an SQL query.
- Two Run variable macros are defined. One to access the DYNSEL01 value and the second to access the DYNMULSEL01 value.
- Note that both Run variable macros access the same form ID, DocTestForm01, same as specified in the Run a user form and parameters macro.
The Result section shows how the variable values are displayed on the page.
Access field value defined in another macro
Let's build this example using In the previous scenario. A section, a Run a user form and parameters macro is defined with two dynamic select lists and now, the list selection is to be used in a Groovy macro that's available on the same page.
In this image:
- A Groovy macro contains a two Run variable macro macros defined to access the form with DocTestForm01 ID, same as that of the Run a user form and parameters macro defined in the previous example.
- Variable F12 stores F11 stores the value of DYNSEL01 in form ID DocTestForm01. For and variable F12 stores the value of DYNMULSEL01 from the same form.
For this example,
...
these values are simply displayed but
...
these can be processed further as required.
...
The Result section shows how the variable value is displayed on the page.
...
Here, the image shows how the selected options of the lists can be accessed and displayed. As shown in the images of the previous sections, the numbered positions illustrate exactly how the variable values are displayed on the page.
In this image:
- Rochester is selected in DYNSEL01 and 'Chicago' in DYNMULSEL01 and the form is run.
- From the first example:
- The Run variable macros returned the selected options in the lists.
- The text below the Run variable macros shows how using the '$' sign the variable values can be accessed.
- From the second example:The selection The selections made in the first and second select list with ID as DYNSEL01 is shown lists are shown using the Groovy script.