Run macro parameters - 6.x
The run macro editor makes it easy for you to configure all the fields with the help of an organized form editor. This interactive editor provides an interface with all the fields logically grouped into the following tabs:
Field settings - Allows you to build the form using various field settings like field type, width, labels etc...
Display settings - Enables defining various display values like form width, form title, run button settings etc...
Run settings - Allows you to define various run, processing and export settings.
Refer to the following table for all the field descriptions of run macro:
Tabs | Macro Editor Label | Default | Description | Macro Parameter |
|---|---|---|---|---|
Field settings | ||||
(No tabs) | Form rows | blank (no fields defined) | Click +Add my first field to add the field to the form. Define the values of the fields by adding the elements group-wise and field-wise in the editor. See Field types to learn more about the available fields. All the fields from this tab combinedly define the replace parameter. Click Add field or Add field group to add another element to the form. Avoid some reserved Confluence values like: pageId, spaceKey, title, wikiMarkup, xHtml. Click the ellipsis (...) next to each field for more actions like adding fields above or below, copying fields, moving the fields up and down etc... | replace |
Display settings | ||||
Form display | Form title | blank | Text that appears as the first row of the field table. Line breaks with leading space ( <br>) and required spaces ( ) are supported. | heading |
Form width | blank | Width of the field table in percent(%) or pixels. | width | |
Text field size | 95% table width | Unless overridden by field specific parameters - see Field types. | inputSize | |
Help page | @self | A page reference by title, spacekey:title or @self, @parent, @home. Used as the target page for help links. If this is specified and is a valid and authorized page reference, a help icon will appear at the top right of the parameter area that links to the help page. In addition, any parameter whose description begins with ? will generate a help icon and link to an anchor on the page specified. The anchor will be identified by the replacement field key. A link to a anchor not defined on the help page will show the top of the help page. | help | |
Field display | Show form fields | On | hideParameters | |
Show group header on form | Off | hideColumnHeadings | ||
Show more fields by default | Off | Normally more fields are hidden until the more icon is pressed. | showMore | |
Focused field | Name of an input field to receive focus when the page is initially displayed to allow typing or selection immediately. Themes or other page content may override this setting. It may also be browser dependent. | focus | ||
Buttons | Show run button | Off | hideRun | |
Run button text | Run or translation | titleRun | ||
Show a reset button | Off | The Reset button allows the user to reset all the field values. The values are reset based on the occurrence of the RUN action.
| showReset | |
Reset button text | Reset or translation | titleReset | ||
Show a clear button | Off | The Clear button allows the user to clear the input provided for the form fields. If you click the Clear button:
| showClear | |
Clear button text | Clear or translation | titleClear | ||
Show export button | On | hideExport | ||
Export button text | Export or translation | The exportFile parameter is required before the export button will show. | titleExport | |
Text before Run and Export buttons | Blank | Text that appears just prior to the run or export buttons. Line breaks with leading space ( <br>) and required spaces ( ) are supported. | prompt | |
Button padding | 4 | In pixels. | buttonPadding | |
Advanced | Allow HTML rendering | Off | Since 4.4. Allows HTML in parameter descriptions. Use may be restricted by the administrator. This is controlled by Macro Security for Confluence. | disableAntiXss |
Show field key in form | Off | Can be useful for testing. | showKey | |
Velocity include reference | For advanced customization of the display of the parameter input table. This requires velocity programming and Confluence system administrator privileges to add and update the customized velocity file. This is a velocity include reference relative to the Confluence web app and replaces the table portion of the velocity file embedded in the add-on. | parameterInput | ||
Run settings | ||||
Parameters | Unique form id | automatically generated numeric id | Used for url request parameters. | id |
Request parameter default | @default | Default is run_id_ where id is the value of the id parameter. The prefix is appended with the parameter name to form the request parameter key on the url. Use @blank to have a blank prefix. | requestPrefix | |
Keep request parameters | Off | Turn this toggle On to keep existing request parameters on the url after button is pressed. Normally used for recursive use or when there are multiple run commands on the same page so that the results of one run macro are retained when the second is run. All requests parameters will be retained if keepRequestIds is not specified. Otherwise, non-run macro request parameters and those references by the keepRequestIds parameter will be retained. | keepRequestParameters | |
Keep specific request parameters by id | Comma separated list of run macro ids whose request parameters should be retained on the url after button is pressed. Use of this parameter or keepRequestParameters parameter is required for recursive use of this macro. | keepRequestIds | ||
Request parameter key for the action | Default is run_id where id is the value of the id parameter. This represents the request parameter key for the action to perform (run or export). | requestAction | ||
Suppress quoting of multi-select values | Off | Multi-select field types replace as a comma separated list of single quoted strings. Turn this toggle On to remove the quotes. | suppressQuote | |
Processing | Run on page load | Off | Turn this toggle On to automatically render the macro body with the default field values. | autoRun |
Set focus to this page anchor | Name of a page anchor on the current page used to position after button press. Normally, the anchor would be placed before the run macro or at the top of the run macro body so that the results are shown at the top of the page. If there are parameter validation conditions, errors from user input may not be visible if the anchor is after the form. | anchor | ||
Date format for $current_time | system default | See Date Format for how to specify this value. | dateFormat | |
Export | Export on page load | Off | Turn this toggle On to automatically render the macro body with the default field values and export to the exportFile if specified. | autoExport |
Name of export file | Location of the partial html file that will be created on export representing the rendered macro body. For export to an attachment, the user must be authorized to add attachments to the page specified. Replacement variables are allowed.
| exportFile | ||
Text in front of the export file field | Name: or translation | This will only be shown if the exportFile parameter value starts with a question mark (?). | titleExportFile | |
Encoding for export file | system default | encoding | ||
Export file versioning | new | Defines the the version mechanism for exported reports.
| exportVersion | |
Attachment comment | The comment will be used for an exported attachment. If it begins with a question mark (?), then an entry field with this value will appear next to the export button. Replacement variables are allowed. | attachmentComment | ||
Attachment comment prefix | Comment: or translation | This will only be shown if the attachmentComment parameter value starts with a question mark (?). | titleAttachmentComment | |