The template is a simple Confluence page and you can use the full power of the Confluence page editor. The magic comes with the placeholder Macros for AutoPage. The template can be understood as a blueprint and you define where AutoPage should insert content of a Jira issue.
So let's start - Create a page
You can use whatever space and name you want for your template. It's a good idea to think about where to create your templates and how to name them. It's easier to find templates while configuring AutoPage rules and to make clear what's the usage of a page for users, if you have a naming and storage convention.
If a template should only be used in the context of a specific space, then create the template in this exact space. Should the template be used in different spaces, you better choose a more general space.
We recommend to use a name prefix as "AutoPage Template" followed by the type of documentation (e.g. EPIC Documenation or Project Summary).
Style your Page - Add macros to place Jira issue content
You can edit your template page as every other Confluence page. The only difference is that you can define how and what Jira issue content should be inserted with our great AutoPage-Macros.
The macros display Jira issue content on a Confluence page, independent of individual Confluence user permissions for the Jira issue. As the rule creator, carefully consider in advance which issues and custom fields should be published to Confluence. To control visibility within, you can apply page-level permissions to limit access to specific user groups.
To insert a macro just type / followed by Autopage or use the +-Icon in the editor menu:
If you want your page to look different from the template, then you can customize the page as you need after you create it. You can add macros even after your page is created by AutoPage for more flexibility.
AutoPage Macros
There are three types of Macros to insert content, while creating a page from a template.
Supported Jira Field Types
Currently Supported Jira custom field types by the AutoPage Macros:
Field type | Macro type | Advanced Formatting |
---|---|---|
Paragraph (rich text, multi-line, issue description) | Rich Text (Block Macro) |
|
Date / DateTime | Inline Macro |
|
Text field / Short Text (single-line) | Inline Macro |
|
Number field | Inline Macro |
|
User / User Picker (single user, multiple users) | Inline Macro |
|
Project / Project Picker | Inline Macro |
|
Issue status | Inline Macro |
|
Issue priority | Inline Macro |
|
Issue type | Inline Macro |
|
Votes | Inline Macro |
|
Labels | Inline Macro |
|
Version / Version Picker | Inline Macro |
|
Components | Inline Macro |
|
Select List | Inline Macro | |
Radio Buttons | Inline Macro | |
Sprint | Inline Macro |
More Field types will be coming soon:
- Issuelinks & Parent
- Time tracking fields
- Service Desk fields
Macro Detail Setting
Once you have inserted a macro you got to configure the details. You can do so by clicking on the Macro Placeholder in the page edit mode and enter the configuration by click on the "pen icon":
The configuration menu appears on the right side where you can choose the Jira custom field you want to display
Macro Sync Mode
You can choose between to sync modes
- "Live Update" (Default setting)
- The content of the configured Jira custom field is retrieved realtime when you load the confluence page. The user will see the latest Jira changes but with slower performance and no data displayed, when the communication with the Jira API does not deliver an answer.
- "On Page Update"
- This mode saves the Jira issue content into the confluence page when the Autopage rule is triggered. The user will see a snapshot of the Jira issue at a defined point in time. Loading performance is faster and content will be shown even if Jira is down.
Advanced Formatting Options
For Inline Macros with Text information you can define the display mode (see supported Jira Field Types).