ARN Specific macros (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.
Now this will open the Insert JQL Section pop-up. Here you can add JQL section the same way you do it via ARN https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/300351714 templates or any other type of https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/204013600. 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 variable function | Separate macro available for Variables, you can copy variables from macro /directly type variables in JQL sections |
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 .
Adjust column widhth when using Table layout
As shown in below image, navigate to Layout tab in Insert/Edit JQL section pop-up. Click on icon beside Table option, add the column width % for each column (fields selected in Fields tab), and Insert.
Based on configurations, table is created on the Confluence page. This way, user can decide the column width depending on the content being added to the given table.
By default, all the selected fields will have equally distributed column width %
When configuring column width %, if the total goes beyound 100%, the horizontal scroll is added to the table on plublished Conflunce page.
Variable 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.
Search for the relevant variable. Copy to use anywhere in JQL, template title, etc.
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.
Once the macro is launched, you can use variables related to dates like releaseDate, startDate, sprintStartDate, etc. Slected variable will be replaced by actual date from within Jira when release notes are published.
Please feel free to share any queries or feedback on our Support portal.
Status macro
Status macro is add different statuses in the customizable release notes. You can just add the title of the status or select a variable from the dropdown so the status is replaced by the actual value of a selected variable. Then choose color coding and utilise them to show release statuses, sprint statuses, issue statuses, etc.
Stats macro
With this macro, now you can stats similar to the ones you can add to ARN templates.
Once clicked on the macro, below pop-up is displayed -
Add Macro Title, Once the JQL is added it needs to be validated. If it is not validated, needs to correct and get valildated. ( A trick here is that you may want to paste the same JQL in Jira and get it corrected!). Use the correct function to show stats. If needed, numbers can be displayed as links to the underlying issues using Display as link option.
Filters/Jira issues macro
This macro allows to users add Jira issues/filter macro along with ARN variables with the JQL. To search this macro on your Confluence page/template type /Jira issues and notice the pop-up shows Jira issues/filters - Automated release notes for Jira (ARN) macro.
Once you click on it, it loads a pop-up as below -
Below are the feilds -
Title - Add the title of the filter
JQL - Specify the JQL to retrieve issues to be published on the Confluence page. You can also use ARN variables in the JQL.
Project - This dropdown field appears if the project variable is used in JQL. Select the relevant project and validate JQL
Validate JQL - This button appears when you add a JQL
Maximum issues - Mention the maximum number of issues to be displayed on a listing page
Select the fields (columns) - Select the columns to be displayed
Select the output format - Select whether the output format should be Table or Total count of the retrieved issues via configured JQL.
Output for Table format
Output for total count format
In the template page, you can add variables using https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/edit-v2/4026695792#Variable-macro so when the release notes are published, these variables are replaced by their actual values.