| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Description
Renders the body contents after substitution of parameters. Parameters can be provided by Pre-defined variables or request parameters. This is a simplified version of the Run macro with no user interaction specifically setting autoRun=true, hideParameters=true, hideRun=true, and hideExport=true. Any text in the macro body that begins with $ immediately followed by a key found in the replace parameter list of comma separated key:value:description triplets are replaced by the value. The default value is specified in the key:value:description triplet.
This macro may have restricted use for security reasons. See Macro Security for Confluence and consult with your administrator for details.
Parameters
This macro implements parameters like those available on the Run macro. All the parameters are logically grouped into the following tabs:
| 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 |
| Run settings | ||||
| Parameters | Unique form id | Optional. Can be specified as the default parameter. A way to specify a unique id to identify this instance of the run macro. By default, a numeric id is automatically assigned based on the order of the macro on the page. When using legacy wiki markup, you must assign a unique id if there are more than one run macros on the same page. | ||
| Request parameter prefix | @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. | 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 | 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. This works only for default request prefix values. | keepRequestIds | ||
| Request parameter id for button actions | This represents the request parameter key for the action to perform (run or export). | requestAction | ||
| Processing | Date format for $current_time | Date format to use for replacement of $current_time. Default is server date format. See Date Format for how to specify this value. | dateFormat | |
...