In this page

Version History

Version Date Notes
1.9.0 06/06/2020 New PDF export options. Release Notes & Upgrade Guide
1.8.0 25/05/2020 Support for the Tempo Timesheets Cloud REST API. Release Notes & Upgrade Guide
1.7.0 15/05/2020 Support for Jira Software Cloud next-gen boards (also known as agility boards). Release Notes & Upgrade Guide
1.6.1 15/01/2020 Support for the Jira Cloud Android app. Release Notes & Upgrade Guide
1.6.0 05/12/2019 Support for Insight for Jira Cloud. Support for the "Story point estimate value" custom field type. Release Notes & Upgrade Guide
1.5.0 27/11/2019 Support for ScriptRunner for Jira Cloud. Release Notes & Upgrade Guide
1.4.0 25/11/2019 Support for Portfolio for Jira Cloud. Faster exports for Zephyr test step results. Release Notes & Upgrade Guide
1.3.0 20/11/2019 Support for Zephyr for Jira Cloud. Release Notes & Upgrade Guide
1.2.1 14/11/2019 Icons updated for the new Jira design language. Custom field export bugfixes. Release Notes & Upgrade Guide
1.1.0 07/11/2019 Support for Tempo Timesheets for Jira Cloud. Release Notes & Upgrade Guide
1.0.0 03/06/2019 Stable version with commercial support. Release Notes & Upgrade Guide
0.13.0 14/05/2019 Minor update for the Open Beta program. Release Notes & Upgrade Guide
0.1.0 15/04/2019 Support for Jira Software Cloud. Support for Jira Service Desk Cloud. Release Notes & Upgrade Guide

Release Notes

1.9.0

This release introduces a bunch of new PDF export options, which are fine-grained, parametrized variants of some old ones.

New PDF export options

The problem we're addressing is three-fold:

  1. Our PDF templates are super-configurable and super-flexible, but the user is required to edit the configuration parameters in the template code.
  2. Or, if he wanted to use the same template in multiple configurations (e.g. a report both in weekly and monthly resolution), he would essentially make copies of the original template and use different configuration parameters in the copies.
  3. Finally, if he doesn't look into the template code or doesn't check the Template Gallery, a lot of possibilities may remain hidden for him.

Therefore, we split some of the old PDF export options (PDF views) to multiple, more granular ones. Templates are now picking up configuration parameters from the view name. For instance, if the view name contains "My Worklogs", then the timesheet-invoce-fo.vm template will set the $filterByUser variable to true, which will activate filtering to the current user.

List of changes:

  • The old "Release Notes" PDF export option was converted to these new ones:
    1. "Release Notes" (same as the old one: generates it for the first fix version of the first issue)
    2. "Release Notes (For Last Version)" (generates it for the released version with the most recent release date)
    3. "Release Notes (For Next Version)" (generates it for the unreleased version with the closest release date)
  • The old "Timesheet" PDF export option was converted to these new ones:
    1. "Timesheet" (same as the old one)
    2. "Timesheet (My Worklogs Only)" (exports only the worklogs created by the current user)
  • The old "Invoice" PDF export option was converted to these new ones:
    1. "Invoice" (same as the old one)
    2. "Invoice (Detailed Worklogs)" (exports precise hour-minute details for worklogs, plus the Tempo work attributes)
  • The old "Traceability Report" PDF export option was converted to these new ones:
    1. "Traceability Report (Direct Only)" (exports only the issues directly linked to the original issue set)
    2. "Traceability Report (Recursive)" (exports all issues linked to the original issue set up to a maximum distance)
  • The old "Project Report" PDF export option was converted to these new ones, each exporting the report for the given period:
    1. "Project Report (Last 7 Days)"
    2. "Project Report (Last 30 Days)"
    3. "Project Report (This Week)"
    4. "Project Report (This Month)"
  • There are new PDF export options introduced for the Zephyr app. These will work if the Zephyr REST API access is configured, each exporting the given details:
    1. "Zephyr Test Steps"
    2. "Zephyr Test Executions"
    3. "Zephyr Test Steps + Executions"
    4. "Zephyr Test Executions + Results"
    5. "Zephyr Test Steps + Executions + Results"
Improvements
Upgrading from 1.8.0

There are several templates and scripts updated, and there are several new views created to support the new PDF options. Please execute the following upgrade steps precisely.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.9.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. project-report-fo.vm
    2. project-report.groovy
    3. release-notes-fo.vm
    4. timesheet-invoice-fo.vm
    5. traceability-report-fo.vm
  6. Then, create the new script file release-notes.groovy:
    1. From the unzipped files, open the release-notes.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter release-notes.groovy as file name, copy the file's content to the editor, and save it.
    3. Check if the new file has appeared in the template list.
  7. There are several new PDF views introduced. Instead of creating those one by one, follow these steps to complete the upgrade faster:
    1. Go to Jira settingsAppsPDF Views (under Better PDF Exporter).
    2. Open the same page again in another browser tab. The idea is that in the first tab you will be able to see your old PDF views during the upgrade, which include your custom PDF views if you created any in the past. (Obviously, do not reload the first tab until the upgrade is completed!)
    3. In the second browser tab, click Reset all views under the list. It will delete all existing PDF views (including your custom PDF views), and re-create the default ones. Consequently, it will give you the working "factory defaults".
    4. Finally, you need to re-create your custom PDF views that were deleted in the previous step. Still in the second browser tab, re-create the custom PDF views that are still visible in the first tab. If you had no custom PDF views, you can skip this step.

1.8.0

This release introduces support for the new Tempo Timesheets REST API.

Support for Tempo Timesheets Cloud REST API

In April 2020, the Tempo Timesheets Servlet API has been replaced with the new REST API. In this version, the integration between Better PDF Exporter and Tempo has been rewritten to use their new REST API.

In addition to the rewrite, a couple of smaller, but important improvements were introduded, as well. See their list below.

Improvements
  • Tempo work attributes are exported with their names (instead of their IDs) for better readability.
  • Tempo "Account" type work attribute values are exported with the account name (instead of the account key) for better readability.
  • Customer is searched for using an extended twofold logic in the timesheet-invoice-fo.vm template: it first checks the "Account" custom field, then it checks the "Account" work attribute.
Upgrading from 1.7.0

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.8.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. tempo-tool.groovy
    2. timesheet-invoice-fo.vm
  6. As the REST API authenticates differently than the old Servlet API, you must configure the Tempo REST API access in the issue-fo.vm and the timesheet-invoice-fo.vm templates. Please follow the configuration guide (takes 2 minutes).
  7. Enjoy!

1.7.0

This version introduces support for exporting issues directly from the next-gen boards in Jira Software Cloud.

Support for Jira Software Cloud next-gen boards (also known as agility boards)

Next-gen boards (available in next-gen projects) are the new primary user interface for teams using Jira Software Cloud. From this version, Better PDF Exporter for Jira Cloud can export issues directly from both the backlog view and the board view of a next-gen board.

It works for board types using any combination of the board features (thus for any type of agile methodology):

  1. Scrum (backlog on, sprints on)
  2. Kanplan (backlog on, sprints off)
  3. Kanban (backlog off, sprints off)

Note: classic Kanban boards, classic Scrum boards and backlogs have been supported for a long time, and are still supported without any change.

Improvements
  • You can export issues from future sprints defined in the backlog of classic Scrum boards (via the sprint's "..." menu).
  • The Description field of views and templates accepts a limited set of HTML elements for security reasons (to avoid XSS).
Bugfixes
  • Fixed: Zephyr test execution and test step result "Executed On" date is exported in the wrong timezone.
Upgrading from 1.6.1

You need to update a single file. It takes just a moment, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.7.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Enjoy!

1.6.1

This version is compatible with the "glance" user interface component promoted by the official Jira Cloud Android app. Finally, you can export custom PDF documents from your Jira issues also on Android! (iOS coming soon!)

Support for the Jira Cloud Android app

Just recently, Atlassian has started to roll out glances for Jira Cloud apps on mobile. Working together with the Atlassian team, we implemented glances for the Better PDF Exporter app, and made the interface responsive so that it gives optimal layout also on narrow screens.

As result, you can create PDF documents from your issues with just a couple of taps. The files will be automatically downloaded to your Android device, and then be opened with the system default PDF viewer app.

Upgrading from 1.6.0

Just update your app version using UPM (Universal Plugin Manager, the app manager built in to Jira).

1.6.0

This version introduces the Insight integration, which allows to export the Insight objects linked to Jira issues via the Assets custom fields.

Support for Insight for Jira Cloud

Insight is the leading asset management app for Jira, that allows implementing CMDB, CRM, HR, ITSM or ITIL functionality on the Jira platform. Starting from this version, Better PDF Exporter can export the Insight-managed objects from the Assets type custom fields to PDF documents.

See some sample exports from Insight and learn more about this integration.

Improvements
  • Support for the new "Story point estimate value" custom field type.
Upgrading from 1.5.0

You need to update a couple of files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.6.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. issue-navigator-fo.vm
    2. reference-manual-fo.vm
    3. traceability-report-fo.vm
    4. zephyr-tool.groovy
  6. Then, create the new script file insight-tool.groovy:
    1. From the unzipped files, open the insight-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter insight-tool.groovy as file name, copy the file's content to the editor, and save it.
    3. Check if the new file has appeared in the template list.
  7. If you are using Insight, complete the Insight configuration guide so that the templates can access Insight-managed information.
  8. Enjoy!

1.5.0

This version introduces a new integration, enhancing ScriptRunner for Jira with PDF exporting features.

Support for ScriptRunner for Jira Cloud

ScriptRunner for Jira is the most powerful app to extend and customize Jira with every kind of custom logic, expressed as Groovy scripts. Starting from this version, Better PDF Exporter can export ScriptRunner-managed custom fields to PDF documents.

See some sample exports from ScriptRunner and learn more about this integration.

Upgrading from 1.4.0

Just update your app version using UPM (Universal Plugin Manager, the app manager built in to Jira).

1.4.0

This version introduces our next integration, this time with Portfolio for Jira Cloud. It also comes with a major performance improvement for the export of Zephyr test step results.

Support for Portfolio for Jira Cloud

Portfolio for Jira Cloud is Atlassian's Project Portfolio Management (PPM) solution, an agile roadmapping and project planning app for Jira Software. From this version, Better PDF Exporter is integrated with Portfolio, allowing you to export all Portfolio custom fields to PDF.

See some sample exports from Portfolio for Jira and learn more about this integration.

Faster exports for Zephyr test step results

Only couple days after the first release of the Zephyr integration, we found a way to accelerate the export of test step results by reducing the number of ZAPI (Zephyr API) calls that collect the Zephyr data. The new approach is identical with the old approach in terms of features, but it performs 35% faster in average. (Depending on the number of test step results, it is somewhere between 20% and 74%.)

This release comes with the new approach. Just update your templates and scripts as the upgrade guide below instructs, and enjoy the performance improvement.

Upgrading from 1.3.0

You need to update a few files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.4.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. issue-navigator-fo.vm
    2. reference-manual-fo.vm
    3. time-by-x-report.groovy
    4. traceability-report-fo.vm
    5. zephyr-tool.groovy
  6. Enjoy!

1.3.0

This version introduces integration with Zephyr, the most popular test management app for Jira Cloud. It is already the second release that extends a widely-used Jira Cloud app with powerful PDF exporting capabilities (after 1.1.0, which introduced PDF exports to Tempo Timesheets). Even more integrations coming soon!

Support for Zephyr for Jira Cloud

Zephyr is the most popular test management solution for the Jira Cloud platform. From this Better PDF Exporter version, you can export Zephyr tests, test steps, test executions and test step results to PDF.

See some sample exports from Zephyr and learn more about this integration.

Upgrading from 1.2.1

You need to update two files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.3.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Then, create the new script file zephyr-tool.groovy:
    1. From the unzipped files, open the zephyr-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter zephyr-tool.groovy as file name, copy the file's content to the editor, and save it.
    3. Check if the new file has appeared in the template list.
  6. If you are using Zephyr, complete the Zephyr configuration guide so that the templates can access Zephyr-managed information.
  7. Enjoy!

1.2.1

This version is primarily a maintenance release. It updates the look of the "PDF Templates" screen to the new design Atlassian (and Jira) design language, and fixes two export bugs around custom field values.

Improvements
  • PDF template, Groovy script, and other file format icons use the latest Atlassian design language.
Bugfixes
  • Fixed: "People" type custom field values are exported as JSON strings.
  • Fixed: "Request Language" type custom field values (used by Jira Service Desk) are exported as JSON strings.
Upgrading from 1.1.0

You need to update a couple of files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.2.1-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. issue-navigator-fo.vm
    2. reference-manual-fo.vm
    3. time-by-x-report.groovy
    4. traceability-report-fo.vm
  6. Enjoy!

1.1.0

This version introduces integration with Tempo Timesheets, a widely-used 3rd party Jira Cloud app. For the long run, we aim to enhance all popular Jira Cloud apps with customizable PDF exports, and this version is the first step to that direction. Additionally, this version comes with a couple of smaller, but important improvements and bugfixes.

Support for Tempo Timesheets for Jira Cloud

Tempo Timesheets is the most widely used time tracking solution for Jira Cloud. Starting from this Better PDF Exporter version, you can export the Tempo-managed custom field types (e.g. Account, Team or Iteration) and the Tempo-managed worklogs with intelligent filtering and formatting, to custom PDF documents. This version also introduces a customizable timesheet/invoice template to generate custom timesheets and time-based invoices from Tempo worklogs.

See some sample exports from Tempo Timesheets and learn more about this integration.

Improvements
  • The new configuration option $embeddedAttachmentMaxFileSize in issue-fo.vm allows limiting the file size of the attachments to be embedded in the exported PDF documents (default: 50M).
Bugfixes
  • Fixed: creating a new PDF view results in NullPointerException if there is another view existing without description.
  • Fixed: built-in worklogs are not always chronologically ordered.
Upgrading from 1.0.0

You need to update a couple of files. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-1.1.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the issue-fo.vm template file:
    1. Open the issue-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original issue-fo.vm file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original issue-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current issue-fo.vm file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Repeat the previous step also for the following files:
    1. issue-navigator-fo.vm
    2. reference-manual-fo.vm
    3. timesheet-invoice-fo.vm
    4. traceability-report-fo.vm
  6. Then, create the new script file tempo-tool.groovy:
    1. From the unzipped files, open the tempo-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter tempo-tool.groovy as file name, copy the file's content to the editor, and save it.
    3. Check if the new file has appeared in the template list.
  7. If you are using Tempo, complete the Tempo configuration guide so that the templates can access Tempo-managed information.
  8. Enjoy!

1.0.0

Better PDF Exporter for Jira Cloud is production-ready!

After so many months in beta status, we are happy to announce that Better PDF Exporter for Jira Cloud is now ready for production use! Starting from this version, Midori offers its commercial-grade support service also for this app.

Upgrading from 0.13.0

Just update your app version using UPM (Universal Plugin Manager, the app manager built in to Jira).

0.13.0

This is a minor update after the Open Beta program has started.

Better PDF Exporter for Jira Cloud is available at Atlassian Marketplace!

After a month of working together with the most eager users and incorporating their insights and feedback to the product, we made the app available for everyone via the Atlassian Marketplace! Please note that it can still be used free.

Learn more about the Open Beta period.

Upgrading from 0.1.0

You need to update one script file. It takes just a minute, follow the guide below.

Steps:

  1. Upgrade the app as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: better-pdf-exporter-for-jira-cloud-0.13.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to Jira settingsAppsPDF Templates (under Better PDF Exporter).
  4. Upgrade the time-by-x-report.groovy template file:
    1. Open the time-by-x-report.groovy template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original time-by-x-report.groovy file, then just copy-paste the content of the new template (the one you just downloaded) to the editor, save it and you are done.
    3. If you made changes to the original time-by-x-report.groovy, you will need to migrate those to the new template. This should be done by comparing the content your current time-by-x-report.groovy file with the new one, and merging all changes you made in the former to the latter. Use a visual merge tool (like WinMerge or Eclipse's compare and merge editor), and it should be trivial.
  5. Enjoy!

0.1.0

This is an important release that implements integration with cloud-hosted Jira Service Desk and Jira Software instances.

Integration with Jira Service Desk Cloud

The new feature allows exporting Service Desk managed custom fields like Approvals (including decision details), Customer Request Type, Organizations or even SLA to PDF.

Learn more about the Jira Service Desk integration.

Integration with Jira Software Cloud

You can now export Jira Software managed custom fields like Sprint, Epic, or Story Points to PDF.

Learn more about the Jira Software integration.

How to get the app free?

Note that the app is available completely free of charge during the beta program!

Don't forget to join the beta program and get free access!