On this page
Description
Provides a user form with input fields before rendering the body of the macro. Form fields will be used to replace variables in the body prior to rendering. Field values can be provided by user interaction, pre-defined variables, or request parameters. Any text in the macro body that begins with $ immediately followed by a key found in the replace parameter list (see Field types for details) will be replaced by the value. Normally, values will be provided by a user submitting a form from the page based on the replace parameter. Default values can be specified.
This macro may have restricted use for security reasons. See Macro Security for Confluence and consult with your administrator for details.
Variables
List of Pre-defined variables and access to content-properties.
Migration warning
If you continue to use legacy wiki markup, you must assign a unique id (see the id parameter) if there are more than one run macros on the same page. In this case, the default id generated in wiki mode is always 1 which only works correctly if only 1 run macro is on the page. Either convert the macros to rich text or add unique ids.
The run macro provides a form with specified input fields, settings, and parameters that you define within the editor. The values input into the form fields will be used to replace variables in the body of the Confluence page before it is rendered. Form values can be provided as:
- User interaction - a user inputs data into the fields you've defined.
- By using Pre-defined variables.
- By including request parameters (from the URL).
Any text in the body of the run macro will be replaced by:
- the value when the text begins with '$' immediately followed by a key found in the replace parameter list (see Field types for details). Typically, values will be provided by a user submitting a form from the page based on the replace parameter. When defining field types, default values may be specified.
- dynamic text using any Field key parameters that begin with '$' followed by a Field key.
Use the run macro
The following steps will help demonstrate the most common method of introducing the run macro to a Confluence page.
Encode variables
You might want to encode run macro variables before rendering the output. Use urlencode or base64 encoding options with a prefix '$variable_' in the macro body to encode the intended variable. For example, use $alist_base64 to endcode the alist variable.
Work with field settings
With the run macro on our Confluence page, it's time to explore adding fields to a form.
