Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This feature is availabe only in ARN Cloud.

Tip

If you are using this approach for the first time, please take a look at Checklist to Publish release notes (in new Confluence editor) using ARN Helper app

Create template/page within Confluence

You can create Global and Local template or a normal Confluence page. Despite whether Whether you create a Global/local template or page, the steps are going to be the same. Here, for example, we are creating a global template, let us see how to use ARN Confluence Helper App macro in the template.

Read https://support.atlassian.com/confluence-cloud/docs/create-a-template/ for more details if you are using the template.

Confluence helper app macros

JQL macro

Either use the shortcut command (/JQL or /ARN) to find the macro or use + icon in the Confluence editor to search the macro with options JQL/ARN. Once the Macro appears, click on it.

Image Removed

Now this will open the Insert JQL Section pop-up. Here you can add JQL section the same way you do it via ARN Confluence (For old Confluence editor using template within ARN) templates or any other type of Templates. You can also to all the all the options like Feilds and Layout here same as you use in JQL section within ARN.

You will notice below differences of JQL sections in ARN templates vs JQL section in the Confluence template added via JQL macro -

JQL section in ARN templates

JQL section via JQL macro in Confluence template

Section tab has the wyswyg editor

No wyswyg editor

JQLs are automatically validated

Manual JQL validation needed

Supports Stats function

Stats & bar chart function not available yet. We are working on this enhancement.

Supports Varialble function

Separate macro available for Variables, you can copy variables from macro /directly type variables in JQL sections

Image Removed

Please note, if you have not added a token within Helper app configurations, the JQL will not auto-populate and you will have to manually update the JQL. Since it could be error-prone we strongly recommend completing the setup as mentioned in Checklist .

Varialble macro

For variables, you can use variable macro. simply type /variables or use the + icon and search for a macro called Variables - Automated Release notes for Jira (ARN) in the template.

Image Removed

Search for the relevant variable. Copy to use anywhere in JQL, template title, etc.

Image Removed

Limitations

This feature is currently in Beta and we will be adding more capabilities in the next few releases. Current limitations are as below -

  • Images/videos directly added to the confluence side templates are not supported on the published page yet

  • You cannot preview the template output before executing the Rule Action

  • Following fields only support 'Display as text' -

    • Issue type

    • Status

    • Priority

    • SLA fields

  • Some of the visual elements within the wiki renderer field such as lozenge/status, code block, etc are not fully supported.

Date macro

As shown in the below image, one can search for a Date macro. Click on Date macro displayed with ARN app name.

date macro.pngImage Removed

Once the macro is launched, you can either specify an exact date or use variables related to dates like releaseDate, startDate, sprintStartDate, etc. If you use the variables, those will be replaced by actual dates from within Jira when release notes are published.

Please feel free to share any queries or feedback on our Support portal.Read ARN Specific macros (Confluence helper app macros) for more details

On this page

Table of Contents
minLevel2
maxLevel6
outlinefalse
typelist
printablefalse

Iframe
scrollingauto
srchttps://form.typeform.com/to/loItQqk5#url=xxx
width350
frameborderhide
alignmiddle
height250

Request support👨‍💻

Leave us a review(green star)