...
| Section | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Parameters
- 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.
- replace - A comma separated list of key:value:description triplets. Any entry containing a comma (,) or colon (\:) must be enclosed in single quotes (') - example: x:1:'It''s an example: 1, 2, or 3'. Keys, values, and descriptions are case sensitive. More advanced capabilities are available and documented in the next section.
- key is the parameter name. It must not be blank or contain blanks. Avoid special characters.
- value is the initial replacement value. If not provided, blank will be used.
- description is descriptive text used to provide prompt text for the parameter. If not provided, the key will be used. Line breaks with leading space ( <br>) and required spaces ( ) are supported.
- width - Width of the parameter entry table in percent(%) or pixels. Default is blank (default table format).
- inputSize - Size of the value text entry fields. Default is 95% of table width.
- autoRun - Default is false. Set to true to automatically render the macro body with the default parameter values.
- help - Help page link. 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 parameter key. A link to a anchor not defined on the help page will show the top of the help page. A page can be referenced by title or spacekey:title. Special values of @self, @parent, and @home are valid.
- anchor - Anchor title for positioning after button press. This is the title used on an anchor macro somewhere on the current page. 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.
- focus - Input parameter name to receive focus when 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. Since 3.1.0.
- heading - Heading that appears before the buttons. Default is blank. Line breaks with leading space ( <br>) and required spaces ( ) are supported.
- prompt - Prompt text that appears above the parameters. Default is blank. Line breaks with leading space ( <br>) and required spaces ( ) are supported.
- titleRun - Title for the run button. Default is Run or equivalent translation.
- titleExport - Title for the export button. Default is Export or equivalent translation. Exportfile parameter is required before the export button will show.
- titleExportFile - Title for the export file input field. Default is Name: or equivalent translation. This will only be shown if exportfile parameter value starts with a question mark (?).
- titleAttachmentComment - Title for the attachment comment input field. Default is Comment: or equivalent translation. This will only be shown if attachmentComment parameter value starts with a question mark (?).
- hideParameters - Hide the parameters. Default is false.
- hideColumnHeadings - Hide column headings in the parameter table. Default is <b>false</b>.
- hideRun - Hide the Run button. Default is false.
- hideExport - Hide the Export button. Default is true unless exportFile is non-blank.
- showMore - Show fields with the more attribute on initial display. Default is false. The _more request parameter will override this setting.
- exportFile - Location of the export partial html file representing the rendered macro body. For export to an attachment, the user must be authorized to add attachments to the page specified.
- ^attachment - The rendered html is exported as an attachment to the current page.
- page^attachment - The rendered html is exported as an attachment to the page name provided.
- space:page^attachment - The rendered html exported as an attachment to the page name provided in the space indicated.
- filename - The rendered html is exported as a file located in confluence home directory/script/filename. Subdirectories can be specified.
Replacement keys are allowed in this field and will be replaced with values.
- exportVersion - Defines the the version mechanism for exported reports.
- new - (default) Creates new version of the attachment. For file based exports 'new' has the same effect as 'keep'.
- replace - Replace (overwrites) existing rendered html and, for attachments, removes all previous versions! To replace an existing attachment, the user must be authorized to remove attachments for the page specified.
- keep - Only creates an new export if an existing export of the same name does not exist. An existing attachment will not be changed and an existing file will not be updated.
- attachmentComment - Comment 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 keys are allowed in this field and will be replaced with values.
- autoExport - Default is false. Set to true to have the rendered macro body automatically exported.
- showKey - Show the key. The key is shown after the value entry field. Default is false.
- suppressQuote - Suppress quoting of multi-select values. Default is false. Normally, a multi-select value is represented as a comma separated list of single quoted values. Set suppressQuote=true to have a multi-select value represented as a comma separated list of values. The user must ensure that no values contain commas to prevent unpredictable results.
- dateFormat - Date format to use for replacement of $current_time. Default is server date format. See Date Format for how to specify this value.
- requestPrefix - 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.
- requestAction - 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).
- keepRequestParameters - Default is false. Set to true 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.
- keepRequestIds - 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.
- parameterInput - 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 plugin.
...