Versions Compared

Old Version 17

changes.mady.by.user Sireesha Dugginapeddi [Appfire] (Inactive)

Saved on

compared with

New Version 18

changes.mady.by.user Saumya Sunder (Inactive)

Saved on

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

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.

Section


Column


Tip
titleVariables

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



Column


Warning
titleMigration 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:

  1. User interaction - a user inputs data into the fields you've defined.
  2. By using Pre-defined variables.
  3. 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 usingtext using any Field key parameters that begin with '$' followed by a Field key. 
Tip
titleVariables

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

...

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 from the macro suggestions.

  6. Click the Run macro from the list of available macros.
  7. Click Save settings.

Image RemovedImage Added




Info

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.

...