Overview

 The Run variable macro 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.

Description

Allows user defined values in the Run with a user form and parameters and Run without user form macros to be accessible to other macros on the Confluence page. The notable points for this macro are:

• 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.

Parameters

The following table lists the parameters available in the Run variable macro editor:

Usage

You can add, update or delete the macro from the page.

1. On the required page, type '{' to view the Macro browser.
2. Type "Run" and select the Run variable macro from the list that appears, or type "Run variable" and select the macro.

Select the macro on the page to either edit or delete it from the page.

Examples

Let's consider the following scenarios:

1. Access field value within the same macro
2. Access field value defined in another macro

Access field value within the same macro

In this example, let's populate two select list boxes using the Dynamic Select field type 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 more information.

In the image:

• A Run a user form and parameters macro has 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 the previous scenario. A Run a user form and parameters macro is defined with two dynamic select lists and the selection is to be used in a Groovy macro that's available on the same page. 

In this image:

• A Groovy macro contains a Run variable macro 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 the value of DYNSEL01 in form ID DocTestForm01. For this example, this value is simply displayed but it can be processed further as required.

The Result section shows how the variable value is displayed on the page.

Result

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 made in the second select list with ID as DYNSEL01 is shown using the Groovy script.

Additional references

• Run macro
• Run-now macro
• Tutorials