Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Div
idProductTOC

On this page

Table of Contents
maxLevel2
excludeOn this page
typeflat
separator |

Description

The run macro provides a user form with specified input fields. Form , 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 before renderingof the Confluence page before it is rendered. Form values can be provided as follows:

  1. User interaction - a user inputs data into the fields Using fields you've defined.
  2. By using Pre-defined variables.
  3. Including By including request parameters (from the URL).

Any text in the body of the run 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. 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.

Tip
titleVariables

List of Pre-defined variables and access to content-properties.

Info
titleMacro Security

This macro may have restricted use for security reasons. See CMSP and consult with your administrator for details.

Using the Run Macro

The following steps will help demonstrate how to use the most common method of introducing the run macro within to a confluence Confluence page.

Table plus
border0
heading0
multiplefalse
enableHeadingAttributesfalse
columnAttributesstyle="border:0;width=5%;",style="border:0;width=65%;",style="border:0;width=30%;max-width=30% !important;"
idsteps_table
enableSortingfalse
enableHighlightingfalse


Insert the run macro on a Confluence page

Create a Confluence page that will eventually contain the form you would like presented to users within your organization.

  1. Create a page named Incredible Form in a space accessible to the desired audience.
  2. Click Save to save the new page.
  3. Edit the Incredible Form page.
  4. Select Other macros from the top menu.
  5. In the search box type "Run" and select "Run with a user form and parameters

  6. Click the Run macro from the list of available macros.
  7. Click on "Save Settings".





Working with Field Settings

With the run macro now on  on our Confluence page, it's time to explore adding fields to a form.

...