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 fields will be used to replace variables in the body before rendering. Form values can be provided as follows:

  1. User interaction - a user inputs data into the fields 
  2. Using Pre-defined variables
  3. Including 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. 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.

...

Info
titleMacro Security

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

Configuring the Run Macro

The following steps will help demonstrate how to configure the run macro. In the following example, we will create a simple form that prompts the user to provide responses to example security questions.

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.






Insert the Run Macro using the Insert Markup Menu

Edit the Incredible Form page and:

  1. Select Other macros from the top menu.
  2. In the search box type "Run" and select "Run with a user form and parameters

  3. Click the Run macro from the list of available macros.



Image Added




Image Added

Add Fields to Your Form

  1. Click on "+Add my first field"
  2. Under form element, let's select the text field type.
  3. Let's set the value of the unique field key to "text-1".
  4. The field label will be visible to the user, so let's use "Name of your first pet".
  5. We can leave the field value empty.  This is where we could provide a default value or example. 
  6. Next, let's add another example