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



You will find the AutoPage configuration in the administration section under Add-ons/AutoPage Settings.

You must create a rule for each Confluence page to be generated.

The rule defines which template is used for which Jira issue(s) and in which space the generated pages are created.




Create rules

Click "Create new rule" in the upper right to create a new rule.







Parameter descriptions

ParameterDescription
Rule NameName of the rule.
Rule StatusIf active, this rule is evaluated. If inactive, no evaluation is performed and the rule is not applied.
TriggerDefines 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".

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 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 KeyThe space where the generated pages will be created.
Confluence Template PageA Confluence Page which will used as template for this rule.
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 PageDecide how the Parent Page should be determined. You have the option to set a Confluence Page as Parent Page or you can use the generated page of another rule as Parent Page.
Confluence PageChoose the Confluence Page under which the generated page will be created.
RuleChoose 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.
For general issues, the parent issue is the linked epic, and for subtasks, the parent issue is the issue that the subtasks belong to.

Create an Issue LinkWhen active, a link to the generated Confluence page is added to the Jira issue.

Issue Link Name

With this parameter, you can specify a name for the link type: For example, "Quest Description".


Example




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

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. 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 building up 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

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

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.





  • No labels