You will find the AutoPage configuration in the administration section under Add-ons/AutoPage Settings.
The rule defines which template is used for which Jira issue(s) and under which parent page the generated pages are created.
Create rules
Click "Create new rule" in the upper right to create a new rule.
You can always see on the label in the upper right side of a rule if you are creating or editing a rule.
Parameter descriptions
| Parameter | Description |
|---|---|
| Rule Name | Name of the rule. |
| Rule Status | If active, this rule is evaluated. If inactive, no evaluation is performed and the rule is not applied. |
| Trigger | Defines when the rule should be executed. You can choose between Issue events, Jira Post Function or Sprint events. If you choose "Issue Events" or "Sprint Events" you have the ability to select Event-Types to filter when your rule should be executed. |
| Issue Event Types | Decide on which issue events the rule should be executed. If you just want AutoPage to listen to all Events, choose "All Events". This Parameter only shows up if you choose the Trigger "Issue Events". |
| Sprint Event Types | Decide on which sprint events the rule should be executed. This Parameter only shows up if you choose the Trigger "Sprint Events". |
| Board | Select a Jira Board for which the Sprint Rule should apply. This Parameter only shows up if you choose the Trigger "Sprint Events". |
| Use explicit executing user | If you want the page to be created/updated by a specific user then check this box. The user needs to have all rights to create/update pages in the selected Confluence space. If you are not using the explicit executing user, the page is getting created by/updated by the user who updates the ticket. In this case they also need to have all the rights to create/update pages in Confluence. We recommend creating a user explicitly used for AutoPage (e.g. AutoPage User) who has the required rights in Jira and Confluence. |
| Executing user | Select a Jira User on whose behalf the rules should be executed. This should be an administrator account on both Jira and Confluence with the rights to create pages in the spaces you want your rule to be executed. This Parameter only shows up if you check "Use explicit executing user" or if you choose the Trigger "Sprint Events". |
| JQL Filter | The JQL that is used to determines the issues for which a template is to be used for. Every time an issue is updated, the system checks whether it applies to the JQL. If so, generated Confluence pages are created or updated. This Parameter only shows up if you choose the Trigger "Issue Events". |
| Confluence Space Key | The space where the generated pages will be created. |
| Confluence Template Page | The Confluence Page that will be used as the template for this rule. See AutoPage Configuration - Confluence Templates for information about template configuration and placeholders. |
| Confluence Page Title | Title of the generated pages. You can use issue fields or sprint properties as placeholders in the titles. You can find more about using these placeholders here. Each Confluence page requires a unique name, or it cannot be created in a Confluence instance. We recommend that you use the Issue Key $#{Key} or the Sprint ID $#{sprint_id} in the title, so that each page's title is unique. |
| Confluence Page Labels | You can specify labels to be applied to the generated pages. You also have the ability to use placeholders like in the "Confluence Page Title" field to let AutoPage create dynamic labels for you. Using these makes it easy to find and use the generated pages in Confluence. Specifying labels is optional. |
| Parent Page | Decide how the Parent Page should be determined. You have the option to set a Confluence Page as Parent Page, you can use the generated page of another rule as Parent Page or you can set the Parent Page via a Custom Field (see Using the 'Parent Page from Custom Field' feature at the end of this page). |
| Confluence Page | Choose the Confluence Page under which the generated page will be created. This option will only show up if you selected the Parent Page strategy "Confluence Page". |
| Rule | Choose the rule whose generated page serves as Parent Page. In this case, generated pages are created under a page created using this referenced rule. The specified rule must also generate a page for the same Jira issue (or for the parent issue, see the next parameter) or Sprint. |
| Use parent page from parent Issue | If active the generated page created for the parent issue is used as the parent page. Here you can find a demonstration config to create a Epic-Story-SubTask hierarchy: AutoPage configuration demo for Epic-Story-SubTask hierarchy |
| Create a Remote Issue Link | When active, a Remote Issue Link for the generated Confluence page will be created and can be seen in the "Issue Links" panel on your Jira issue. |
Issue Link Name | With this parameter, you can specify a name for the link type that will be displayed in the "Issue Links" panel on your Jira issue: For example, "Quest Description".
|
Example of a rule in edit mode
Delete a rule
In the rule overview, you can delete the rule by clicking on the Delete icon in the upper right.
Recreate Confluence Pages - VERSION 2.1.0
In the rule overview, you can trigger to recreate all confluence pages of this rule.
The recreation affects all Confluence Pages that were already created by the rule. The recreation process will not generate new pages. It will only update existing pages with the content of the current Template Page.
This means that all manual changes to the created pages are overwritten with the content of the Template!
This feature is useful if you are making changes to your Template. It offers you an easy way to recreate your example pages and see your changes on the Template directly.
Or you can recreate all generated Pages if you want to roll out a new version of your Template.
The Page History remains intact if a page is recreated.
Using the Post Function Trigger - VERSION 2.2.0
If you want to have your rules executed in a plain JIRA Post Function (e.g. on the "Reopen Issue" Transition) you can easily do that by setting the Trigger parameter to "Post Function".
After you've done that, you just have to add a Post Function of type "AutoPage Post Function" to your Workflow.
And select the rule you want to execute when the Post Function is triggered.
You can edit, delete or change the order of the Post Function in the plain JIRA Post Function overview.
Using the Sprint Event Trigger - VERSION 2.3.0
Since AutoPage version 2.3.0 you have the ability to run your rules when a Sprint Event occurs. We also shipped new Placeholders for this scenario. The template configuration can be found here.
When using the Sprint Trigger you have to choose a Board that is used to determine for which Sprints a page will be created. Currently you can set one board per rule.
You will also have to choose a user on whose behalf the rules should be executed. This should be an administrator account on both Jira and Confluence with the rights to create pages in the spaces you want your rule to be executed.
The remaining options are the same as for all other Trigger types.
Using the 'Parent Page from Custom Field' feature - VERSION 2.6.0
Since AutoPage version 2.6.0 you have the ability to dynamically set the parent page through a Custom Field. This also enables you to move your page in Confluence via the parent page custom field.
We therefore shipped a new Custom Field Type (Confluence Page Search) that lets you search Confluence for a parent page directly on your Issue create or edit screens.
To use this new feature you have to create a new Custom Field of type "Confluence Page Search (AutoPage)" and configure your screens accordingly so that this field shows up on issue creation and edit.
It is also possible to use a Single Line Text Field or a with a Confluence page ID in it.
Now you just have to choose the parent page strategy "Parent Page from Custom Field" and the newly created Custom Field in your rule config.
When creating an issue first choose the Confluence space and then your parent page.
After creation the parent page will also show up on your issue detail view.
If you edit the parent page after the issue was created you are now able to move the page in Confluence. Just choose another parent page and your page will be moved automatically.
Using the 'Use explicit executing user' feature - VERSION 2.7.6
Since AutoPage version 2.7.6 you have the ability to set an executing user for your rules.
If you want the page to be created/updated by a specific user then check the box "Use explicit executing user". The user needs to have all rights to create/update pages in the selected Confluence space.
If you are not using the explicit executing user, the page is getting created by/updated by the user who updates the ticket. In this case they also need to have all the rights to create/update pages in Confluence.
We recommend creating a user explicitly used for AutoPage (e.g. AutoPage User) who has the required rights in Jira and Confluence.
Using the 'Dynamic Page Permission' feature - VERSION 2.16.0
Since AutoPage version 2.16.0 you have the ability to trigger page restrictions changes for pages created by AutoPage via a Post function.
You can find this Post function under the name Dynamic Page Permission Post Function (AutoPage).
On the Post function configuration screen you can choose between two Restriction types:
- Editing restricted - This restricts all users except the users and users in the groups configured in this Post function from making any changes to a page
- Viewing and editing restricted - This will not let any user view a page, except explicitly configured in this Post function
Please be aware that you have to set an executing user in whose name AutoPage performs the page restriction updates. For the restriction updates to work as expected this executing user will also be automatically given an exception from the permissions you are applying to a page. This is done because Confluence wants to make sure that nobody evicts itself from a page.