Page tree
Skip to end of metadata
Go to start of metadata





The templates used by AutoPage are normal Confluence pages that you can create in any Confluence space. Based on this template, AutoPage will generate a Confluence page from within Jira.
Templates may contain placeholders You can also create templates without using any placeholders.
The title of the generated pages is defined in the AutoPage configuration, and doesn't use the template's title.
A template is always based on a Jira issue or sprint. Fields from the issue can be used as placeholders.
The placeholders are entered as normal text when you create the Confluence page (the template). You can also format placeholders.
Placeholders can also be used within macros. You can also use placeholders as parameters for macros, see AutoPage placeholder in macros.


You can change and add content to the Confluence pages that were generated by AutoPage. AutoPage remains updating the placeholders of the generated page.

The template is only used when generating a page for the first time. When you make changes to the template after pages have been generated, this will not update any existing generated pages.

If you want to apply these template changes to the already generated pages, you can click on the "Recreate Pages" Button in the rule config. AutoPage will then generate a new Confluence page based on the edited template. If you are using the Postfunction Trigger you must delete the generated pages and remove the links to these generated pages from the Jira issue.


Placeholder - Issue Rules

Default fields


The format for Jira default field placeholders is $#{Fieldname}.

Be careful when using field names - they are case-sensitive.

Supported issue fields (please note the spelling and case): 

Issue Placeholder

$#{Assignee}

$#{Description}

$#{Summary}

$#{AffectedVersions}

$#{ComponentObjects}

$#{Created}

$#{Creator}

$#{DueDate}

$#{FixVersions}

$#{Environment}

$#{Id}

$#{IssueTypeObject}

$#{Key}

$#{Labels}

$#{ParentObject}

$#{PriorityObject}

$#{ProjectObject}

$#{Reporter}

$#{ResolutionObject}

$#{SecurityLevelId}

$#{Status}

$#{StatusObject}

$#{Updated}

$#{Votes}

$#{SubTaskObjects}

The following fields are not supported: the fields for time tracking $#{Estimate}, $#{OriginalEstimate}, $#{TimeSpent}.

Wiki-markup is used to format the Description.

Custom Fields


The format for custom field placeholders is $#{CF_CustomFieldName} and you can reference the custom fields using their custom field names.

Alternatively, you can use the custom field ID in a placeholder $#{customfield_CustomFieldId}.

Eample: $#{CF_Location} or $#{customfield_10100}

Supported custom field types:

Field type

Checkboxes

Date Time Picker

Date Picker

Group Picker (single group)

Labels

Number Field

Radio Buttons

Select List (multiple choices)

Select List (single choice)

Text Field (multi-line)

Text Field (single line)

User Picker (single user)

Version Picker (single version) 

Query Issues Custom Fields (third party app)

The Project Picker custom field type is not supported.

Text fields containing wiki-markup will be formatted appropriately.


Placeholder - Sprint Rules

Default properties


The format for sprint placeholders is the same as for rules with an issue trigger: $#{placeholder}.

Be careful when using these placeholders - they are case-sensitive.

Supported sprint properties (please note the spelling and case): 

Sprint PlaceholderShort Description

$#{sprint_id}

This is the the identifier of this sprint. It is counted upwards for each created sprint in your board and can be used to filter issues by JQL.
$#{sprint_name}This is the name you gave your sprint.
$#{sprint_goal}This represents the goal you've added to your sprint.
$#{start_date}The start date represents the date when the sprint was started. This property is empty as long as you've not started your sprint.
$#{end_date}The end date represents the date when the sprint should be completed. This property is empty as long as you've not started your sprint.
$#{complete_date}The complete date represents the date when the sprint really was completed. This property is empty as long as you've not closed your sprint.
$#{sprint_state}The sprint state can have three values: FUTURE (created but not started yet), ACTIVE (sprint was started) and CLOSED (sprint was completed)
$#{board_id}This is the identifier of the board the sprint lives in. It can be used to filter issues by JQL.




Example

Jira issue


Confluence template


Generated page





The Custom Field Picture is a text field (multi-line) with active wiki-markup. Autopage does not currently support direct embedding of attachments.






  • No labels