Versions Compared

Key

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

Description

This example shows how to use the Run macro from Run Self-Service Reports for Confluence to configure the user form in Confluence. With the help of an organized form editor, quickly create the form with the required fields, and add buttons with custom button text to enhance the form usability.

Requirements

Macro browser input

Select this macro

Macro name

Run with a user form and parameters

Macro syntax

{Run with a user form and parameters}

Configure macro

Consider a Confluence page which includes the macro Run with a user form and parameters. To configure the macro, follow the macro parameter configuration and the steps below.

Macro parameter

Value

Field settings > Form rows

Add fields to build the form

Display Settings > Buttons > Show run button

Enabled

Display Settings > Buttons > Show a reset button

Enabled

Display Settings > Buttons > Show a clear button

Enabled

  1. Edit the macro, and under Field Settings, add the required field types and provide the field details to build the form. To add fields, click Add field.

Info

To know more about adding fields, field settings and display settings, refer Run macro parameters.

2. Under Display settings > Buttons, enable the buttons and provide the button text for Reset and Clear. <Gif showing an existing macro with few fields added and enabling Reset and clear>

...

3. The form configured is as shown below:

...

...

4. The form actions, Submit, Reset and Clear, are as illustrated below.

Form actions

Description

ViewIllustration

Submit

The Submit button allows you to submit the field values<Gif to show submit action>.

The Run macro will render the newly entered values and replace the old values with the new ones. The Run output displays the values rendered.

Image Added

Reset

The Reset button allows the user to reset all the field values.<Gif to show reset action>

  • If the RUN action has previously not occurred, the field values get reset to the default values.

  • If the RUN action has previously occurred, all the field values get reset to the entries provided for the latest RUN execution.

Image Added

Clear

The Clear button allows the user to clear the input provided for all the form fields. <Gif to show clear action>

  • The values get set to the default field values.

  • It also clears the Run output displayed for the latest RUN execution.

Image Added

Info

To know more about

...

Submit, Reset, and Clear parameters, refer to Run macro parameters.