| Warning |
|---|
Pdf PDF generation is not working on your server/data center version of Jira? ARN needs Google chrome installed on the Jira server, for pdf PDF generation. Follow instructions on this page to install chrome - Support docs If you have chrome installed but ARN is not detecting it, follow the troubleshooting guide. |
To customise content of the pdf PDF template, read this - Customising release notes content
To add the PDF action in a rule, read this article - Actions
Create a
pdfPDF template
Navigate to the templates page on the ARN screen & click on the ‘Create’ button.
You will be brought to the template creation page where Email will be selected by default. Change the dropdown selection to ‘PDF’.
Default template will be populated. Make any required changes & save them to create a new template. You can also use some sample templates available in the template gallery on the left side, refer above image.
Edit a
pdfPDF template
An existing pdf PDF template can be edited by clicking on the template name link from the list.
This will bring you to the template edit screen, which is same as that of create - except, data is pre-populated for the current template. Make any required changes, click on save and the template is updated.
Local level templates can always be edited right away. But However, whether a global template can be edited in the given project depends on where it was created. If it was created within the current project, then it can be edited otherwise it cannot be.
To know more about template levels, read this -https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/204013600/Templates#What-are-template-levels---local-%26-global%3F
Template that can be edited
Template that you can edit will have ‘Save’ button at the left bottom of the screen.
Template that cannot be edited
If the template was not originally created within the current project, then it cannot be edited here. ‘Save’ button will not be available in this case. And an additional message is displayed indicating the parent project for the template.
Delete a
pdfPDF template
An existing pdf PDF template can be deleted by clicking on the delete icon from the list.
Local level templates can always be deleted right away. But whether a global template can be deleted in the given project depends on where it was created. If it was created within the current project, then it can be deleted otherwise it cannot be.
To know more about template levels, read this - https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/204013600/Templates#What-are-template-levels---local-%26-global%3F
Template that can be deleted
Template that you can delete will have a delete button in the right most rightmost column of the template list view.
Template that cannot be deleted
If the template was not originally created within the current project, then it cannot be deleted here. ‘Delete’ button will not be available in this case.
Preview a
pdf templatePDF template
| Note |
|---|
We are storing the locale of user in cache which is valid for 30 mins. If any user changes their Jira language, it might take 30 mins to reflect in the app. |
When creating or editing a pdf PDF template, it can be previewed immediately. Just click on the ‘Preview’ button once desired changes have been done.
This will open a version selector pop-up. Choose one or more versions and then click on preview.
Versions can be filtered based on their statuses in Jira - Unreleased, Released, Archived. By default, only ‘Unreleased' versions are displayed
Based on the JQLs used in the PDF template, you will need to input values. e.g. in the above screenshot, user is asked to choose 1 version since the template’s JQLs have 1 version variable in them.
| Info |
|---|
Read on to know more about Generating release notes from multiple versions in a project |
This will generate the pdf PDF template preview file in your browser. Depending on your browser setting, it will be automatically downloaded or a confirmation will be asked from you.
| View file | ||
|---|---|---|
|
If what you see is the desired result, save the template.
PdfPDF template fields
Template type
Here, PDF option is selected since we are creating a PDF type template
Template name
This is for internal reference & doesn’t show up in the actual release pdf PDF file.
Level
Local or Global - Determines whether the pdf PDF template is available to be used in other projects across Jira.
Cross-project - For cross-project templates (which can be managed only from the cross-project ARN screen), this field is disabled from editing & is set to cross-project by default.
ARN branding - To define whether you wish to show ARN branding in release notes.
For Free ARN app it is default and cannot be unchecked
Advanced settings and Header, Footer - Read below section called - https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/162267218/PDF#Further-customisation-with-advanced-settings
File name -
This determines the name of pdf the PDF file that will be generated. You can use variables in this field similar to email Email subject. Max length is ~100 characters, extra characters will be trimmed at the time of file generation.
Pdf PDF content -
The actual release pdf PDF content is generated within the pdf PDF body. Follow below link to know more.
Further customization with advanced settings
Advanced settings in the PDF template are for further customisationcustomization. Clicking on the advanced settings link brings you options to customise customize title page, header & footer along with a few other options for your PDF.
Advanced
settingsettings
Layout - Whether you want the pdf PDF in portrait or landscape orientation
Paper Size - You get to select the A0-A5 or legal, letter, and tabloid size of the paper here
Margin - Set up a correct margin to display the content(text/images) properly. If you are adding header/footer, you will have to use custom margins of appropriate dimensions.
Header & footer
As shown in the above image, header and footer have an extensive set of options to edit the content. You can format text, add images, tables, links. Align the content in desired manner. Using these options you can add images/logos, website links, etc.
When you add an image, you can adjust the height & width. Also define whether it can adjusted in template editor or not.
When you want to add information related to Jira projects, you can use variables option.
You can also use PDF variables to add date or page numbers.
For example -
In tempate builder -
In PDF -
By using above options, add required information in header & footer, format the content & save.
Enabale title page - With this, you can customize the title page.
This setting allows users to add the contents of the title page within this WYSIWYG editor using all the inline editing options.
You can also insert other elements like a Link, Image, Table, ARN variables, and PDF variables.
If you do not wish to insert a dedicated title page, you can skip this setting
Background image
In addition to the above-mentioned controls, you can also insert a background image to the title page.
Click on the Background image button on the editor, in the pop-up upload image.
Impact on the PDF output when title page is added
When the output of a PDF template with title page configuration is generated, the contents of the title page should always be placed on the title page of the PDF.
Like other pages of the template, all the variables within the title page are also replaced with their relevant values.
In case the background image is inserted in the title page configuration, it appears as the background image only for the title page and not other pages of the PDF.
The contents of the main template by default start from the second page onwards with a mandatory page break after the title page.
If Header & footers are configured, the they will be shows from the second page onward and not on the title page.
In case the title page setting is disabled, then header footers appear from the first page of the PDF.
Header & footer
You can format text, add images, tables, links, and align the content in the desired manner separately for header & footer.
Both, header & footer sections allow using variables. In fact, there are the traditional variables that you use within the PDF body & then there are some specifically available for PDF header/footer.
Using the ‘PDF variables’ you can insert current/total page numbers along with dates in header or footer (or in both places).
| Warning |
|---|
Only thing to keep in mind - use custom margins when you have header & footer configured. Depending on the size of your header/footer you have to manually adjust the margins otherwise header/footer won’t show up as expected. |
On this page | |||
|---|---|---|---|
|
|
| Iframe | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
