In this page

Version History
Release Notes
6.3.0
$componentManager removed from the rendering context
Upgrading from 6.2.1
6.2.1
Bugfixes
Upgrading from 6.2.0
6.2.0
Support for Tempo period- and user filters
Faster export of Tempo worklogs via pre-loading
Improved support for saved filters in automations (via PDF Automation Plugin 3.1.0)
Bugfixes
Upgrading from 6.1.1
6.1.1
Bugfixes
Upgrading from 6.1.0
6.1.0
Upgrading from 6.0.1
6.0.1
Support for the Issue Statistics gadget
Support for Jira Software gadgets (Sprint Burndown, Sprint Health and Agile Wallboard)
Multi-column dashboard exports
New export types to export dashboards to 2 or 3 column layouts
Improvements
Bugfixes
Upgrading from 5.10.0
5.10.0
Support for nFeed
New "Performance Tuning" page
Updated "Getting Started" page
Upgrading from 5.9.0
5.9.0
Support for Insight
Support for 4 new Jira Service Desk custom field types
Improvements
Bugfixes
Upgrading from 5.8.0
5.8.0
Upgrading from 5.7.1
5.7.1
Bugfixes
Upgrading from 5.7.0
5.7.0
Bugfixes
Upgrading from 5.6.0
5.6.0
Support for view contexts
Compatibility release for the upcoming Better Excel Plugin 2.2.0
Bugfixes
Upgrading from 5.5.0
5.5.0
Support for Zephyr
Default template with improved structure
Improvements and bugfixes
Upgrading from 5.4.0
5.4.0
Upgrading from 5.3.0
5.3.0
Support for Gliffy
View names in the "Export" drop-down in any language
Upgrading from 5.2.0
5.2.0
SVG graphics
Support for project / user avatars and issue type / priority icons
Template updates
Upgrading from 5.1.0
5.1.0
Scalability
Error tolerance
Expressions Reference Manual
Upgrading from 5.0.0
5.0.0
Support for Jira Data Center
Licensing via Atlassian Marketplace
Upgrading from 4.1.0
4.1.0
Upgrading from 4.0.0
4.0.0
View visibility
User interface integration with Jira Agile, Jira Service Desk and Tempo
Template improvements
Upgrading from 3.6.0
3.6.0
Upgrading from 3.5.0
3.5.0
Support for dashboards, gadgets and reports
Upgrading from 3.4.0
3.4.0
Support for Tempo Timesheets
Support for Jira Service Desk
Support for Table Grid Editor
Export for remote links
Upgrading from 3.3.0
3.3.0
Support for JEditor
Support for Jira Agile fields
Performance improvements for large exports
Revised default template
New tools in the Velocity context
New "Getting Started" page
Upgrading from 3.2.0
3.2.0
Upgrading from 3.1.0
3.1.0
Upgrading from 3.0.0
3.0.0
Upgrading from 2.1.0
2.1.0
Upgrading from 2.0.1
2.0.1
Upgrading from 2.0.0
2.0.0
Upgrading from 1.8.0
Older releases

Version History

VersionDateNotes
6.3.016/07/2018Compatibility release for Jira 7.11.Release Notes & Upgrade GuideDownload
6.2.122/06/2018Maintenance release.Release Notes & Upgrade GuideDownload
6.2.008/03/2018Support for Tempo period- and user filters. Tempo pre-loading. Improved support for saved filters in automations.Release Notes & Upgrade GuideDownload
6.1.107/02/2018Maintenance release.Release Notes & Upgrade GuideDownload
6.1.015/01/2018Compatibility release for Jira 7.7.0.Release Notes & Upgrade GuideDownload
6.0.122/12/2017Support for the Issue Statistics and Jira Software gadgets (Sprint Burndown, Sprint Health and Agile Wallboard). Multi-column dashboard exports.Release Notes & Upgrade GuideDownload
5.10.023/08/2017Support for nFeed. "Performance Tuning" page.Release Notes & Upgrade GuideDownload
5.9.017/08/2017Support for Insight. Support for 4 new Jira Service Desk custom field types.Release Notes & Upgrade GuideDownload
5.8.004/07/2017Compatibility release for Jira 7.4.0.Release Notes & Upgrade GuideDownload
5.7.123/02/2017Maintenance release.Release Notes & Upgrade GuideDownload
5.7.005/01/2017Compatibility release for the Jira 7.3 line.Release Notes & Upgrade GuideDownload
5.6.008/12/2016Support for view contexts.Release Notes & Upgrade GuideDownload
5.5.020/09/2016Support for Zephyr. Default template with improved structure.Release Notes & Upgrade GuideDownload
5.4.031/08/2016Compatibility release for Jira 7.2.Release Notes & Upgrade GuideDownload
5.3.012/08/2016Support for Gliffy. View names in any language.Release Notes & Upgrade GuideDownload
5.2.028/07/2016SVG, support for project / user / issue type / priority icons. Template updates.Release Notes & Upgrade GuideDownload
5.1.011/05/2016Scalability (via streaming), error tolerance, Expressions Reference Manual.Release Notes & Upgrade GuideDownload
5.0.025/01/2016Support for Jira Data Center, licensing via Atlassian Marketplace.Release Notes & Upgrade GuideDownload
4.1.009/11/2015Compatibility release for Jira 7.Release Notes & Upgrade GuideDownload
4.0.002/11/2015PDF view visibility. UI integration with Jira Agile, Jira Service Desk and Tempo. REST API. More robust templates.Release Notes & Upgrade GuideDownload
3.6.020/03/2015Compatibility release for Jira 6.4.Release Notes & Upgrade GuideDownload
3.5.009/03/2015Support for dashboards, gadgets and reports.Release Notes & Upgrade GuideDownload
3.4.005/01/2015Support for Tempo, Jira Service Desk and Table Grid Editor. Export for remote links.Release Notes & Upgrade GuideDownload
3.3.016/09/2014Support for JEditor and Jira Agile. Better performance, smarter templates.Release Notes & Upgrade GuideDownload
3.2.015/07/2014Compatibility release for Jira 6.3.Release Notes & Upgrade GuideDownload
3.1.028/04/2014API, integration and automation. Generate, export and email PDFs automatically.Release Notes & Upgrade GuideDownload
3.0.017/01/2014Export types are configurable in the web UI. Major review on all templates.Release Notes & Upgrade GuideDownload
2.1.025/06/2013Compatibility release for Jira 6.0.Release Notes & Upgrade GuideDownload
2.0.118/06/2013Maintenance release for Jira 5.2.Release Notes & Upgrade GuideDownload
2.0.019/03/2013Web editor for PDF templates and Groovy scripts. New template for Burn Down charts. Easy installation and maintenance through "plugins 2" compatibility.Release Notes & Upgrade GuideDownload
1.8.007/12/2012Chart rendering. Customizable PDF filenames. Customizable PDF metadata. Easier installation. Updated for Jira 5.2.Release Notes & Upgrade GuideDownload
1.7.009/08/2012Groovy scripting to implement custom logic. New template for Gantt charts and traceability matrixes.Release Notes & Upgrade GuideDownload
1.6.017/02/2012Compatibility release for Jira 5.0.Release Notes & Upgrade GuideDownload
1.5.030/12/2011Support for the embedding the issue attachments in the exported PDF files. New template for requirement specification documents.Release Notes & Upgrade GuideDownload
1.4.021/08/2011Compatibility release for Jira 4.4. New template for timesheets and invoices.Release Notes & Upgrade GuideDownload

Release Notes

6.3.0

This version is a compatibility release for the Jira 7.11 line.

$componentManager removed from the rendering context

The content object $componentManager is now removed from the rendering context. It has been deprecated in Jira core by Atlassian for a long time. It was being replaced by its modern equivalent $componentAccessor. This app version prepares for its complete removal in Jira core scheduled to the release of Jira 8.

Default templates and scripts are not using $componentManager, therefore those require no update.

Custom templates and scripts that use $componentManager should be updated to use $componentAccessor. The update should be straightforward, because from the template's or script's point of view, $componentAccessor provides a very similar interface as $componentManager does. Click to the above links to see the corresponding Javadoc pages.

Upgrading from 6.2.1

Upgrade the app JAR as usual, through the Universal Plugin Manager.

6.2.1

This version is a maintenance release to deliver UI related bugfixes.

Bugfixes
  • Fixed: "Export" menu in Jira Software boards cannot be opened due to a Javascript error in Jira 7.10.0+.
  • Fixed: "Export" menu is not visible on Service Desk queue screen with Jira Service Desk 3.10.0+.
Upgrading from 6.2.0

Upgrade the app JAR as usual, through the Universal Plugin Manager.

6.2.0

This release brings valuable improvements to the popular Tempo to PDF timesheet and invoice export feature. It also improves the support for saved filters in automation actions via PDF Automation Plugin 3.1.0 (released the previous day).

Support for Tempo period- and user filters

The Tempo integration now filters worklogs to the time period you selected above the timesheet! (This was a super-popular feature request.)

We even went one step further. The integration also filters worklogs to the user, if you are looking at a single user's timesheet.

As a result, when exporting from the Timesheet screen you will get exactly those worklogs in the export that you see in the web interface.

Please note that in previous versions the app did not use any of these filtering criteria: if an issue was displayed in the timesheet, we exported all the worklogs on the issue, regardless who and when created that. If you want to return to that behaviour, you can easily turn off both filtering. Learn more about period filtering and user filtering.

Faster export of Tempo worklogs via pre-loading

In addition to "load worklogs for each issue separately", the Tempo integration script now supports a new strategy "pre-load worklogs for all issues". It performs much better for massive worklog exports from the Tempo Timesheet and other Tempo screens.

As it is also a subject for performance tuning, make sure you learn more about pre-loading.

Improved support for saved filters in automations (via PDF Automation Plugin 3.1.0)

We hope you are already using the PDF Automation Plugin, our free app that allows integrating the PDF View Plugin to automatic business processes. If you are, then remember to upgrade your PDF Automation Plugin version to 3.1.0. (We developed these two releases in parallel, make sure you leverage their integration!)

If you are not using that yet, make sure to give this a try! It will save you from lots of boring manual work by creating and distributing PDF documents automatically.

In its latest version PDF Automation Plugin has improved support for saved filters. Learn more in the PDF Automation Plugin 3.1.0 release notes.

Bugfixes
  • Fixed: Dashboard cannot be exported if the Agile Wallboard gadget contains an extra field with the <time> tag.
  • Fixed: URLs generated from ${requestContext.baseUrl} break (and referenced images are missing) when the PDF is rendered in automations (tip: use ${requestContext.canonicalBaseUrl})
Upgrading from 6.1.1

You need to update some of the existing resources and add a new script file. It takes just a few minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-pdfview-plugin-6.2.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views).
  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. project-report-fo.vm
    3. release-notes-fo.vm
    4. requirements-specification-fo.vm
    5. story-card-fo.vm
    6. tempo-tool.groovy
    7. timesheet-fo.vm
  6. Then, create the new script file issue-navigator-tool.groovy:
    1. From the unzipped files, open the issue-navigator-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter issue-navigator-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. Enjoy!

6.1.1

This version is a maintenance release to deliver a single bugfix.

Bugfixes
  • Fixed: a NullPointerException is thrown in rare cases when exporting the Burndown Chart gadget.
Upgrading from 6.1.0

Upgrade the app JAR as usual, through the Universal Plugin Manager.

6.1.0

This version is simply a compatibility release for Jira 7.7.0.

The default templates were modified not to export the "Development" field, as we don't see lots of value in exporting that custom field type. If you disagree, please let us know and we will change our position!

Upgrading from 6.0.1

You need to update some of the existing templates. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-pdfview-plugin-6.1.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views).
  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 issue-navigator-fo.vm.
  6. Enjoy!

6.0.1

This major release focuses on significantly improving dashboard exports.

Most importantly, this version enables exporting four new gadget types, making PDF View Plugin the only viable gadget exporter solution for Jira (see the list of all supported gadgets). For this, we completely re-worked the existing gadget export mechanism. The new mechanism will also allow us to add support for further gadget types in future releases.

Additionally, this version brings various configuration and layout improvements to the PDF template which is used to export dashboards (intuitively named dashboard-fo.vm).

To get started, watch this short video:

If you are interested also in fine-tuning the dashboard exports, don't miss this one either:

Support for the Issue Statistics gadget

Issue Statistics was the most frequently requested gadget to support among the Jira core gadgets. Put it short, this is now supported. (And, we encourage you to let us know about your needs any time via the public Feature request topic.)

See some dashboard export samples generated from Jira core gadgets.

Support for Jira Software gadgets (Sprint Burndown, Sprint Health and Agile Wallboard)

Solving the number two most popular gadget-related feature request, you can finally export the Jira Software (formerly known as Jira Agile) gadgets. Make your executives happy by creating powerful reports from one or all of your Scrum sprints or Kanban flows! You can use these gadgets:

  • Sprint Burndown Gadget
  • Sprint Health Gadget
  • Agile Wallboard Gadget

See some dashboard export samples generated from Jira Software gadgets.

Multi-column dashboard exports

The dashboard export template (dashboard-fo.vm) shipped in previous app versions exported your gadgets to a trivial A3-sized "each gadget stretches to the full page width" layout. Although it was perfectly possible to change that layout to multiple columns and different page geometries (let me repeat: anything is customizable with this app!), we made it easier and more intelligent.

Learn more about configuring the layout for dashboard exports.

New export types to export dashboards to 2 or 3 column layouts

To make it more convenient to get your preferred layout, the app now creates 3 default views for dashboard exporting purposes:

  1. Export Dashboard: one-column layout with A3 portrait page geometry
  2. Export Dashboard to PDF (2 columns): two-column layout with A3 landscape page geometry
  3. Export Dashboard to PDF (3 columns): three-column layout with A4 landscape page geometry

Learn more about customizing column count and paper sizes in dashboard exports.

Improvements
  • The dashboards and gadgets tutorial was rewritten to include the latest changes.
  • Gadget headers are now exported with the color they use in the web interface (can be turned off to save ink when printing).
  • The numbers in the Two Dimensional Filter Statistics Gadget are now exported as clickable links.
  • Various chart gadgets export not only the chart image and the data table, but also a summary line:
    • Average Age Gadget also exports the "Period: last 30 days (grouped Daily)" summary line.
    • Created vs. Resolved Gadget also exports the "Issues: 26 created and 29 resolved Period: last 90 days (grouped Daily)" summary line.
    • Pie Chart Gadget exports also exports the "Status, Total Issues: 51" summary line.
    • Recently Created Gadget also exports the "Total Issues: 51, Period: last 365 days (grouped Monthly)" summary line.
    • Resolution Time Gadget also exports the "Period: last 30 days (grouped Daily)" summary line.
    • Time Since Gadget also exports the "Period: last 62 days (grouped Weekly)" summary line.
Bugfixes
  • Fixed: dashboard exports generated by automation actions have the filename generated from the dashboard ID instead of the dashboard name ("10103.pdf" instead of "My Favourite Dashboard.pdf").
  • Fixed: character encoding in Tempo worklog comments and Zephyr test data (that use international characters) may break when exporting from Jira instances hosted on Windows.
Upgrading from 5.10.0

You need to update some of the existing templates and script files, and also create two views for the new dashboard export layout options. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-pdfview-plugin-6.0.1-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views).
  4. Upgrade the dashboard-details-fo.vm template file:
    1. Open the dashboard-details-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original dashboard-details-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 dashboard-details-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current dashboard-details-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. dashboard-fo.vm
    2. tempo-tool.groovy
    3. zephyr-tool.groovy
  6. Create the new PDF views that export the dashboards in two- and three-column layouts:
    1. To create a new export option in the Export dropdown at dashboards, go to PDF Views (in the left-side bar) and click Add a new view.
    2. Enter "Export Dashboard to PDF (2 columns)" as name, check the Dashboard context option, select the template file dashboard-fo.vm and click submit.
    3. Click Add a new view again.
    4. Enter "Export Dashboard to PDF (3 columns)" as name, check the Dashboard context option, select the template file dashboard-fo.vm and click submit.
  7. Go to a dashboard, and test if the three "Export Dashboard to PDF" options in the Export dropdown are working as expected.
  8. Enjoy!

5.10.0

Support for nFeed

The nFeed app integrates external data sources (SQL databases, LDAP, Active Directory, REST APIs, Salesforce, CSV files, etc.) to Jira. From this version, PDF View Plugin is tightly integrated with nFeed, allowing you to export all nFeed custom fields to PDF. More than data export, you can easily implement custom reporting and Business Intelligence on nFeed data.

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

New "Performance Tuning" page

We compiled a page about what to do and what to avoid when developing custom PDF templates for large scale of data. If you are working with many-many-thousands of issues or many-many-thousands of fields or complicated Groovy scripts, bring a cup of coffee and read the Performance tuning page. We will keep improving it with our future findings, as well.

Updated "Getting Started" page

We updated the "getting started" page in the app to save some reading for first time evaluators. As it may be useful even for more experienced users, it can also be visited via the link at AdministrationAdd-OnsGetting Started (under PDF Views).

Upgrading from 5.9.0

You need to update some of the existing templates and add a new script file. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.10.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views).
  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 issue-navigator-fo.vm.
  6. Then, create the new script file nfeed-tool.groovy:
    1. From the unzipped files, open the nfeed-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter nfeed-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. Enjoy!

5.9.0

Support for Insight

Insight is the leading asset management app for Jira, that allows implementing CMDB, CRM, HR, ITSM or ITIL functionality on the Jira platform. From this release, PDF View Plugin is tightly integrated with Insight, allowing you to export all Insight custom fields with the desired granularity (object keys, names, and attributes) to PDF. Having full access to Insight objects and their attributes, you can easily implement custom reporting and Business Intelligence on Insight data.

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

Support for 4 new Jira Service Desk custom field types

These Jira Service Desk custom field types have been officially supported since PDF View Plugin 3.4.0:

  1. Customer Request Type
  2. Request Participants
  3. SLA

In 5.9.0 we introduced additional support for the following custom field types:

  1. Approvals (including detailed decisions)
  2. Organizations
  3. Satisfaction
  4. Satisfaction Date

Please note that Service Desk is using many other custom fields that are based on standard Jira custom field types. For instance, Approvers is a "User Picker (multiple users)" type custom field, while Operational categorization is "Select List (cascading)". Being standard types, those are supported out of the box.

Overall, this release makes our Service Desk compatibility 100% complete.

Improvements
  • The template issue-fo.vm exports resolution date (together with creation date, update date and due date).
  • Table-heavy templates like "issue-navigator-fo.vm" and "traceability-matrix-fo.vm" have nicer table borders without visual artifacts (also see this hint).
  • Default titles and default filenames are generated according to a slightly revised logic:
    • PDF documents generated from issues: "issue key" (for single issues), "search request name" (for saved filters with a name), "PDF view name (Jira title)" in this order of precedence.
    • PDF documents generated from dashboards: "dashboard name" (for dashboards with a name), "view name (Jira title)" in this order of precedence.
    • You can, of course, override the default title by assigning a value to the $title template variable.
    • You can also override the default filename by assigning a value to the $filename template variable.
Bugfixes
  • Fixed: The "Due Date" standard field and "Date Picker" type custom fields incorrectly use the user's timezone (instead of Jira's default timezone)
  • Fixed: Long issue keys like "VERYLONGPROJECTKEY-123" cannot be exported from agile boards (because of being shortened to "VERYLONG...-123")
Upgrading from 5.8.0

We made major updates on the PDF templates and the Groovy scripts. You can take advantage of all the performance improvements by precisely executing the following steps.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.9.0-templates.zip, and extract it.
  3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views).
  4. Upgrade the burn-down-chart-fo.vm template file:
    1. Open the burn-down-chart-fo.vm template file from the directory where you extracted the ZIP.
    2. If you haven't made any changes in the original burn-down-chart-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 burn-down-chart-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current burn-down-chart-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. dashboard-details-fo.vm
    2. dashboard-fo.vm
    3. gantt-chart-fo.vm
    4. hello-charts-fo.vm
    5. issue-fo.vm
    6. issue-navigator-fo.vm
    7. project-report-fo.vm
    8. reference-manual-fo.vm
    9. release-notes-fo.vm
    10. requirements-specification-fo.vm
    11. sales-report-fo.vm
    12. story-card-fo.vm
    13. timesheet-fo.vm
    14. traceability-matrix-fo.vm
  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. Repeat the previous step also for the service-desk-tool.groovy file.
  8. Enjoy!

5.8.0

This version is simply a compatibility release for Jira 7.4.0.

Upgrading from 5.7.1

Just update your app using UPM (the app manager built in to Jira).

5.7.1

This version is a maintenance release to deliver an important bugfix to PDF View Plugin.

Bugfixes

This version fixes the problem of the #cfValue() and other Velocity macros not rendering randomly: at some exports (including both manual and automated ones), they appear in the PDF document in their original form.

Root cause: there is a potential race condition in Jira's internal macro caching, that we could successfully reproduce with a Python script that simulates rendering PDF documents while generating unusual load also on the Jira web interface.
Fix: although the problem is not in the PDF View Plugin side, we managed to develop a fix for this.

We also reported the problem to Atlassian here: JRA-64200

Upgrading from 5.7.0

Upgrade the app JAR as usual, through the Universal Plugin Manager.

5.7.0

This version is primarily a compatibility release for the Jira 7.3 line.

Bugfixes

  • Fixed: "Cumulative" type Created vs. Resolved gadgets are exported as count (non-cumulative)

Upgrading from 5.6.0

Upgrade the app JAR as usual, through the Universal Plugin Manager.

5.6.0

Support for view contexts

Previous PDF View Plugin versions used the concept of view types. The multiple issues view type, for example, offered the PDF view for any screen that worked with multiple issues, including Issue Navigator, Jira Agile backlog or Jira Service Desk queue among others.

From this version, we allow more fine-grained control over which screen in the UI a view should be available in:

You can set any combination of these so-called view contexts for each PDF view. Combining this with the optional restrictions (limit each view to certain users, to certain user groups, to certain issues), you can flexibly configure all your Export menus.

When you upgrade to this app version, your views will be migrated to the most intuitive contexts (see the table below). You may want to review those settings after the migration.

View type View contexts
Single issue only Single Issue View
Multiple issues only Issue Navigator
Jira Agile Backlog
Jira Agile Board
Jira Service Desk
Tempo Timesheet
Single and Multiple issues Single Issue View
Issue Navigator
Jira Agile Backlog
Jira Agile Board
Jira Service Desk
Tempo Timesheet
Dashboard only Dashboard
Disabled none
Compatibility release for the upcoming Better Excel Plugin 2.2.0

The next release of our Excel exporter Jira app also introduces view contexts. This PDF View Plugin version is also a compatibility release for that.

Bugfixes

  • Fixed: Export menus triggered permission errors for anonymous users (typically in the Dashboard menu)
  • Fixed: An "ORDER BY" clause (which makes no sense anyway) in the visibility restricter JQL breaks visibility checking

Upgrading from 5.5.0

Upgrade the app JAR as usual, through the Universal Plugin Manager.

5.5.0

Support for Zephyr

You can export Zephyr tests (with the "test steps" custom field), test executions and test step results to PDF. These sections can be optionally turned on or off, and integrate perfectly with all the other issue export features to provide the optimal output depending on your use case.
Learn more about the Zephyr integration

Default template with improved structure

Because the PDF View Plugin can now export so many different types of information, from field values, through attachments, diagrams, worklogs, comments, etc. to test executions, the default template started to become a little unstructured.
Therefore we made the following changes in issue-fo.vm in this release:

  • Unobtrusive section titles were added (ex: there is a little explicit "Description" caption above the description field)
  • Related sections were merged for simplicity and consistency: file attachments merged with image and Gliffy attachments, issue links merged with remote links
Improvements and bugfixes
  • Better error reporting at "on-the-fly" template errors (ex: script to execute was not found).
  • Usernames and passwords containing international characters are accepted by the Gliffy integration script
Upgrading from 5.4.0

You need to update some of the existing templates and script files. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade issue-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.5.0-templates.zip
    2. Extract the ZIP and open the issue-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current issue-fo.vm file.
    4. 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.
    5. 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.
  3. Repeat the previous steps also for gliffy-tool.groovy.
  4. Finally, 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.
  5. Turn on the export for Zephyr tests if you are using Zephyr.
  6. Have some chocolate.

Upgrading to this version is recommended if you want to export Zephyr test data, or want to enjoy better structured default exports.

5.4.0

This version is simply a compatibility release for the Jira 7.2 line.

Upgrading from 5.3.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to use the app with Jira 7.2.

5.3.0

Support for Gliffy

You can export the high resolution Gliffy diagrams that illustrate your issues to PDF documents. Gliffy diagrams will be core part of your issue exports, just like image attachments.
Learn more about the Gliffy integration

View names in the "Export" drop-down in any language

View names can now contain alphanumeric characters from any language, from German to Japanese. This was previously limited to the English characters only. Finally, you can offer native language experience for your team.

Upgrading from 5.2.0

You need to update some of the existing templates and script files. It takes just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade issue-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.3.0-templates.zip
    2. Extract the ZIP and open the issue-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current issue-fo.vm file.
    4. 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.
    5. 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.
  3. Repeat the previous steps also for tempo-tool.groovy.
  4. Finally, create the new script file gliffy-tool.groovy:
    1. From the unzipped files, open the gliffy-tool.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter gliffy-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.
  5. Turn on the export for Gliffy diagrams if you are using Gliffy.
  6. Have some chocolate.

Upgrading to this version is recommended if you want to enhance your exports with Gliffy diagrams, or create view names with non-English characters.

5.2.0

SVG graphics

Using embedded SVG is a powerful and simple way to add dynamic vector graphics to your PDF documents. This can be utilized to solve a plethora of problems, from rotating text, drawing lines, to enhancing your documents with geometric shapes.
Learn more about the concrete SVG recipes

Support for project / user avatars and issue type / priority icons

The following short code snippets can be added to any template to display the following graphic elements:

Template updates

The following PDF templates and Groovy scripts were updated:

  • gantt-chart-fo.vm: tolerates NULL priority values
  • issue-fo.vm: exports the project avatar (optional)
  • issue-navigator-fo.vm: keys of resolved linked issues are ruled out
  • project-report-fo.vm: tolerates NULL priority values
  • project-report.groovy: tolerates NULL priority values
  • release-notes-fo.vm: exports the project avatar as logo, long issue keys don't overlap with summaries, smarter logic
  • requirements-specification-fo.vm: exports the project avatar on the cover, use status category colors for the status lozenges
  • sales-report.groovy: minor changes
  • story-card-fo.vm: exports the issue type icon, priority icon and the assignee avatar for each card
  • timesheet-fo.vm: minor visual changes
Upgrading from 5.1.0

You need to update some of the existing templates and script files. It takes just 5 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade gantt-chart-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.2.0-templates.zip
    2. Extract the ZIP and open the gantt-chart-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current gantt-chart-fo.vm file.
    4. If you haven't made any changes in the original gantt-chart-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.
    5. If you made changes to the original gantt-chart-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current gantt-chart-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.
  3. Repeat the previous steps also for issue-fo.vm.
  4. Repeat the previous steps also for issue-navigator-fo.vm.
  5. Repeat the previous steps also for project-report-fo.vm.
  6. Repeat the previous steps also for project-report-fo.groovy.
  7. Repeat the previous steps also for release-notes-fo.vm.
  8. Repeat the previous steps also for requirements-specification-fo.vm.
  9. Repeat the previous steps also for sales-report.groovy.
  10. Repeat the previous steps also for story-card-fo.vm.
  11. Repeat the previous steps also for timesheet-fo.vm.
  12. Have some chocolate.

Upgrading to this version is recommended if you want to use SVG graphics, display avatars and leverage the template enhancements above.

5.1.0

Scalability

We refactored the PDF document renderer from an everything-in-memory to a streaming architecture, resulting in drastic performance improvements. 25-50K issues can be exported to complex, tens-of-thousands-of-pages documents. We also updated the following document templates to scale better to large data sets (faster and using less memory):

  • gantt-chart-fo.vm
  • issue-fo.vm
  • issue-navigator-fo.vm
  • requirement-specification-fo.vm
  • story-card-fo.vm
Error tolerance

The robustness of the exported logic was vastly improved to deal with unexpected HTML and XML. It can handle unknown elements, unknown attributes, unknown CSS styling, and every sort of syntax errors. If you are maintaining or migrating field values in HTML, this will save you lots of headache.

Expressions Reference Manual

Want to export field X of object Y? Use this new template both as cheatsheet and as testing environment.

Upgrading from 5.0.0

You need to update some existing templates and script files. It takes just 5 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade gantt-chart-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-5.1.0-templates.zip
    2. Extract the ZIP and open the gantt-chart-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current gantt-chart-fo.vm file.
    4. If you haven't made any changes in the original gantt-chart-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.
    5. If you made changes to the original gantt-chart-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current gantt-chart-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.
  3. Repeat the previous steps also for issue-fo.vm.
  4. Repeat the previous steps also for issue-navigator-fo.vm.
  5. Repeat the previous steps also for requirements-specification-fo.vm.
  6. Repeat the previous steps also for story-card-fo.vm.
  7. Have some chocolate.

Upgrading to this version is recommended if you want to make large exports or you have lots of inconsistent HTML values in text type fields (Environment, Description, single- and multi line custom fields).

5.0.0

This version supports Jira Data Center (clustered Jira deployments) and licensing via Atlassian Marketplace.

Support for Jira Data Center

In a clustered Jira environment, all configuration including PDF templates, Groovy scripts and other resources are transparently replicated among the nodes by the app. When exporting, you can access any random node in the cluster to get your PDF document. Therefore, the app fully supports Jira enterprise deployments.

Licensing via Atlassian Marketplace

Starting from this release, app licenses can be purchased, renewed and co-termed via Atlassian Marketplace.

Upgrading from 4.1.0

First update your app using UPM (the app manager built in to Jira). Then, assuming that you have an existing license for the app, start the license migration procedure.

Upgrading to this version is necessary if you want to use the app with Jira Data Center or you want to enjoy the advantages of Atlassian Marketplace licensing.

4.1.0

This version is simply a compatibility release for the Jira 7 line, while also maintaining compatibility with Jira 6.4.

Upgrading from 4.0.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to use the app with Jira 7.

4.0.0

This version enables to configure visibility rules for the views, to show or hide them dynamically for user, groups and issues. The PDF View Plugin now also seamlessly integrates with the user interface of the most widely used Jira apps, like Jira Agile, Jira Service Desk and Tempo.

View visibility

You can set restrictions on where and for who the views should be enabled. Now it's easy to show only those export items in the "Export" menus that really make sense in that context. Per-user and per-group settings might also come handy.

Visibility can be restricted to:

  • Certain groups
  • Certain users
  • Issues that match a given JQL expression
User interface integration with Jira Agile, Jira Service Desk and Tempo

You can export PDF tickets with a single mouse click from:

  • Jira Agile: backlog and Scrum/Kanban board view
  • Jira Service Desk: ticket queues
  • Tempo: timesheet, calendar, report and list views
Template improvements

All templates were reviewed to protect against rendering errors, when an empty issue list is passed for the renderer. Albeit it should never happen and is considered a bug in Jira, it did happen in certain circumstances.

Also, the issue-fo template supports a new configuration parameter $excludedCustomFieldTypeKeys. As its name suggests, it allows you to list the type keys of those custom fields you want to exclude from exports. It defaults to the keys of the lexo-rank and legacy-rank custom fields managed by Jira Agile, because those are not generating human-readable output.

Upgrading from 3.6.0

You need to update some existing templates and script files, plus create one new Groovy script. It takes just 5 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade gantt-chart-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-4.0.0-templates.zip
    2. Extract the ZIP and open the gantt-chart-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current gantt-chart-fo.vm file.
    4. If you haven't made any changes in the original gantt-chart-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.
    5. If you made changes to the original gantt-chart-fo.vm, you will need to migrate those to the new template. This should be done by comparing the content your current gantt-chart-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.
  3. Repeat the previous steps also for issue-fo.vm.
  4. Repeat the previous steps also for issue-navigator-fo.vm.
  5. Repeat the previous steps also for project-report.groovy.
  6. Repeat the previous steps also for release-notes-fo.vm.
  7. Repeat the previous steps also for requirements-specification-fo.vm.
  8. Repeat the previous steps also for story-card-fo.vm.
  9. Repeat the previous steps also for tempo-tool.groovy.
  10. Finally, create the new script file requirements-specification.groovy:
    1. From the unzipped files, open the requirements-specification.groovy script file.
    2. In Jira, click the New resource button under the PDF Templates list. Enter requirements-specification.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.
  11. Have some chocolate.

Upgrading to this version is necessary if you want to configure visibility for views, or want to export PDF documents from Jira Agile, Jira Service Desk or Tempo.

3.6.0

This version is simply a compatibility release for the Jira 6.4 line.

Upgrading from 3.5.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to use the app with Jira 6.4.

3.5.0

This version enables to export, print and share Jira dashboards and reports. Combining this with the PDF automation capabilities gives a powerful tool to anyone's hands who's looking for automatic Jira reporting. It's not you opening your browser for reports anymore, but the reports coming to your mailbox automagically.

Support for dashboards, gadgets and reports

You can export the most important reporting gadgets to PDF documents that you can customize to their smallest details.
Learn more about exporting dashboards

Upgrading from 3.4.0

You need to create two new templates, plus the two views that render those templates. It takes for just 2 minutes, follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Create the new template dashboard-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-3.5.0-templates.zip
    2. Extract the ZIP and open the dashboard-fo.vm template file in any plain text editor.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and click Add a new resource.
    4. Enter dashboard-fo.vm as filename, and copy the template's content from the desktop editor to the browser's editor, then save it. Please note that you need to paste to the editor box at the bottom, not to the one right under the filename (which is used for the file description).
  3. Repeat the previous steps also for dashboard-details-fo.vm.
  4. Create the new view Export Dashboard to PDF that will appear in the Tools dropdown menu at dashboards:
    1. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Views (under PDF Views) and click Add a new view.
    2. Enter "Export Dashboard to PDF" as name, select "Dashboard only" as type, select dashboard-fo.vm as template, and save it.
  5. Repeat the previous steps for another view called "Export Dashboard Details (PDF)". For this select "Disabled" as type and select dashboard-details-fo.vm as template.
    Why to disable it? It serves as a helper tool that is only used when developing a custom PDF template for dashboards. You will not need it most of the time, but need to enable it to figure out dashboard IDs or gadget IDs when customizing templates.
  6. Go to one of your dashboards that use gadgets supported by the PDF View Plugin for Jira, open the Tools menu and click Export Dashboard to PDF.
  7. Have some chocolate.

Upgrading to this version is necessary if you want to export Jira reports and dashboards to PDF.

3.4.0

This version focuses on integrating the PDF exporting capabilities better with the most widely used Jira apps.

Support for Tempo Timesheets

You can export Tempo custom fields (Account, Team, Iteration) and Tempo worklogs to PDF. This version has also updated the timesheet-fo.vm template to allow generating professional timesheets and invoices from Tempo data.
Learn more about the Tempo integration

Support for Jira Service Desk

You can export Jira Service Desk custom field (SLA's, Customer Request Type) to PDF.
Learn more about the Jira Service Desk integration

Support for Table Grid Editor

You can export any Table Grid Editor managed custom field (tables, lists) to PDF.
Learn more about the Table Grid Editor integration

Remote links are exported into a new section in the issue-fo.vm template. They will appear in the default "PDF" and "PDF (All fields)" exports.

Upgrading from 3.3.0

Due to the changed templates, upgrading is a little more work than upgrading the app itself only. You will need to update 3 existing templates and create a new Groovy script, just follow the guide below.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrade issue-fo.vm:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-3.4.0-templates.zip
    2. Extract the ZIP and open the issue-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current issue-fo.vm file.
    4. 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.
    5. 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.
  3. Repeat the previous steps also for issue-navigator-fo.vm.
  4. Repeat the previous steps also for timesheet-fo.vm.
  5. Finally, create the new script file tempo-tool.groovy:
    1. You have already unzipped the most current resource files, so open the file tempo-tool.groovy.
    2. In the browser, 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 is correctly appeared in the list.

Upgrading to this version is necessary if you want to take advantage of the new integrations and remote link exporting.

3.3.0

This version comes with many improvements, including the support for JEditor rendered fields, Jira Agile custom fields, performance enhancements and major updates to the 2 most important templates.

Support for JEditor

This was the single most requested item in our public feature request forum.

From this app version, PDF exports will preserve the formatting of all JEditor-rendered fields, including Environment, Description, comments, single- and multi-line text custom fields.

Support for Jira Agile fields

This version also introduces proper export for the Jira Agile-specific custom field types, "Sprint" and "Epic".

It was added to the issue-fo.vm and the issue-navigator-fo.vm templates, so you will need to upgrade the template's code, as well. Please see the "Upgrading" section below for more details.

Performance improvements for large exports

We also worked hard on making the bulk exports faster. Many users reported that their PDF export requests timed out when trying to bulk-export 800, 1000 or more issues (typically resulting in several hunded page long PDF documents).

With this version, you can export large number of issues 30-40 times faster! What took for long minutes previously, will be completed in 5-20 seconds now.

(This improvement is hardly noticeable for single issue exports, as those were already performing efficiently.)

Revised default template

We added several small, but important features to issue-fo.vm:

  • Subtasks, labels, view restrictions for comments are now exported
  • Support for the Security Level field
  • 2 modes to export custom fields:
    1. The new default mode will export only those custom fields that are visible in the current Issue Details screen configuration. It allows showing, hiding, re-ordering custom fields and grouping them to tabs (which appear as separate sub-sections) in the PDF documents.
      At the same time, we do not export the issue's field change history when using this mode (you can, as always, easily change it in the template).
    2. The All mode, as its name suggests, exports all custom fields that has non-blank value. Plus, it also exports the field change history.
      Please note that it has been the default behaviour until this version, but the user feedback convinced us to change it. If you want to continue with the old-style behaviour, you can easily do that by setting the $exportAllCustomFields variable to "true", as written in the "Upgrading" section below.
  • Fixes in international texts: some field names and values were exported in English, even if the user had a different language setting activated. Now fixed!

We also introduced a couple of new configuration variables, in context of the previously listed improvements:

  • $exportAllCustomFields: set to "true" to export all custom fields, or to "false" to export only the visible ones.
  • $excludedCustomFieldIds: comma separated list the ID's of the custom fields to be excluded from the export, e.g.: [10001, 10015].
  • $exportChangeHistory: set to "true" to export the issue field change history.
New tools in the Velocity context

To give more power to template developers, the following new tools are available through the context:

  • $fieldScreenRendererFactory: allows you to obtain field screen renderers, to check which custom fields are added to what screens and tabs.
  • $fieldViewManager: checks whether a custom field is visible for an issue.
  • $workRatio: calculates Jira's special "work ratio" metric.
  • $dateTimeFormatter: is Jira's built-in date formatter.
  • $date: supports standard Java date formatting patterns for flexible date formatting.

Please their detailed description in the template development documentation.

New "Getting Started" page

We added a "getting started" page to save some reading for first time evaluators.

As it may be useful even for more experienced users, it can also be visited via the link at AdministrationAdd-OnsGetting Started (under PDF Views).

Upgrading from 3.2.0

Due to all these changes, upgrading is a little more work than upgrading the app itself only.

Steps:

  1. Upgrade the app JAR as usual, through the Universal Plugin Manager.
  2. Upgrading the templates: you also need to upgrade your templates to leverage the improvements. For that:
    1. Download the ZIP that contains the latest template files: jira-pdfview-plugin-3.3.0-templates.zip
    2. Extract the ZIP and open the issue-fo.vm template file.
    3. Login to Jira as administrator, go to AdministrationAdd-Ons PDF Templates (under PDF Views) and open your current issue-fo.vm file.
    4. 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.
    5. 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.
    6. Repeat these upgrade steps also for the issue-navigator-fo.vm template file.
  3. Upgrading the views: the new app version has two modes for the default exports, one of them exports only the visible custom fields, while the other exports all those. If you want to have these two separate modes after the upgrade, then:
    1. If you already have a view called "PDF", then leave it there.
    2. Add a new view, called "PDF (All fields)" which renders the issue-fo.vm template. Explanation: the latest template checks if the view's name contains the "All" string, and switches to the second mode if it does.

As mentioned previously, the behaviour of the default template has slightly changed. According to the new default, only the visible custom fields will be exported (not everything, as previously). Also, the issue field change history will not be exported. If you want to return to the old behavior, simply set the $exportAllCustomFields and $exportChangeHistory configuration variables in issue-fo.vm to "true".

Upgrading to this version is necessary if you want to take advantage of the new features and performance improvements.

3.2.0

This version is simply a compatibility release for the Jira 6.3 line.

Upgrading from 3.1.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to use the app with Jira 6.3.

3.1.0

This version introduces a public PDF API to generate PDF documents from Jira issues and other Jira data.

You have the following options to leverage the PDF API:

  • Install and configure the free open source post function- and service scripts to your Jira.
  • Automate your processes with the powerful Jira Automation Plugin.
  • Write your custom Groovy scripts, and run them with the ScriptRunner Plugin.
  • Build your own Jira apps in Java, or integrate PDF exporting capabilities to your existing apps.

Follow these links to learn more.

Readily available post functions and services:

Automating PDF exports with the Jira Automation Plugin:

Using the API:

Happy integrations!

Upgrading from 3.0.0

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you want to utilize the new PDF API in any way.

3.0.0

Export types, which appear in the "Export" dropdown menus, can be fully managed in the Jira web UI. You can add, update or delete export types, enable them for single issues or multiple issues (Issue Navigator), and select which export type renders which template.

We also made a major review on all templates, most importantly: Gantt Chart, Burn Down Chart, and Project Status Report.

Upgrading from 2.1.0

If you have not customized the export types (the entries in the "Export" dropdown) in the previous app version, you can simply upgrade using the Universal Plugin Manager, and you are done. (You can stop reading here.)

Otherwise, after upgrading with the Universal Plugin Manager, your custom export types will disappear, new export types will appear, because the selectable options reset to the defaults. (This is because the new app version implements a smarter way to manage and store the export types.)

How to recreate your old configuration?

It's easy. Go to Administration → Add-ons → PDF Views. Create your custom views and configure them for single or multiple issues (trivial).

IMPORTANT: you only have to do this once, and your new setup will be saved to the Jira database. Future app upgrades will preserve it.

While configuring the views, we encourage you to try all templates by enabling the initially disabled views. After you carefully evaluated all, disable the ones that you don't need at the moment.

Upgrading to this version is highly recommended if you use multiple export types, and you implemented that by modifying the app JAR previously.

2.1.0

This version is a compatibility release for Jira 6.0. (Previous app versions are not working with Jira 6.0.)

Upgrading from 2.0.1

Just update your app using UPM (the app manager built in to Jira), that's all.

Upgrading to this version is necessary if you use Jira 6.0.

2.0.1

This is a maintenance release to fix three problems found in app version 2.0.0:

  1. A conflict between the PDF View (this app) and the Create and Link (by Customware) apps. It resulted partly broken license configuration screens on systems where both apps were installed.
  2. An unlikely servlet-filter mapping issue. It was reported by a customer with a complex network topology environment, which effectively rewrote URLs used by the app.
  3. Better (re)use of Velocity contexts and resources during PDF rendering.
Upgrading from 2.0.0

Just update your app using UPM (the app manager built in to Jira), that's all.

2.0.0

This is our biggest release since the first public version.

The most important change is that app is now adapted for Jira's modern plugins 2 framework. Benefits:

  • The app is dead simple to install and upgrade dynamically through the Universal Plugin Manager (UPM). UPM is the standard tool built into Jira for installing, managing, upgrading, and diagnosing apps.
  • The app doesn't use files from the Jira server's filesystem any longer. All those resources (PDF templates, Groovy scripts, configuration files) are managed through a web based editor now. Template development and customization is a bliss.
  • Although it is fully transparent for users, the app now runs in an OSGI container. OSGI provides modularity, isolation and lifecycle management for apps. Its primary goal is enabling apps to be installed, uninstalled, upgraded, started and stopped any time without stopping and restarting Jira itself. Hello Zero Downtime!

This version also introduces a new Agile report template, which exports Burn Down charts, Velocity Trend charts and some other key agile metrics for printing (sample PDF). It can be used with or without GreenHopper!

Upgrading from 1.8.0

As written above, the app packaging is moved to a more modern approach with this release. Migrating to 2.0.0 requires the complete removal of the previously installed app version, and re-installing the new version (in a more convenient way). Don't worry, this remove-and-reinstall is a one-time process. Future app versions will upgrade smoothly using Jira's standard app upgrade mechanism.

The list of the upgrade steps may seem a little overwhelming first, but it is rather trivial, in fact. The only reason why this list is so long is that we give you really detailed instructions here.

  1. Remove the previous app version:
    1. Make a backup of your whole Jira folder. (You will remove files in the next steps, so it's wise to have a rescue belt if something went wrong.)
    2. Stop Jira.
    3. Remove the jira-pdfview-plugin-1.8.0.jar file from the atlassian-jira/WEB-INF/lib directory.
    4. Move the jira-pdfview-plugin.properties file from the atlassian-jira/WEB-INF/classes directory to some other folder, as you will need it soon.
    5. Move the fop-config.xml file from atlassian-jira/WEB-INF/classes to some other folder, as you will need it soon. If you made no modifications in this file, then you can safely remove it.
    6. Move the atlassian-jira/WEB-INF/classes/templates/plugins/pdfview directory (which contains your templates) to some other folder, as you will the files in it soon. If you have no custom templates or made no customizations in the original templates, then you can safely remove the directory.
    7. Restart Jira.
    8. Make sure that the "PDF" links disappeared from the "Views" menu both in the Issue Details screen and in the Issue Navigator. If it is still there then you haven't removed the app JAR, or you forgot to restart Jira.
  2. Download jira-pdfview-plugin-2.0.0.jar. Go to Administration → Manage Add-ons → Upload Plugin and upload the JAR. (You can execute this step also by pasting the download URL directly to the form, if your Jira server has access to the Internet and can download the file by itself.)
  3. Migrate your existing license (you can skip this step if you don't have any license):
    1. Go to Administration → License (under PDF Views).
    2. Open your jira-pdfview-plugin.properties file in any simple text editor, and copy its content to the form. Save it.
    3. Check if the Your license expires at date reflects the correct expiration of your license.
  4. Migrate your existing fop-config.xml (you can skip this step if you made no changes in this file previously):
    1. Go to Administration → PDF Templates and click fop-config.xml in the file list.
    2. Open your custom fop-config.xml file in any simple text editor, and copy its content to the web-based editor. Save it.
  5. Migrate your existing custom templates and scripts (you can skip this step if you made no changes in them and added no new templates or scripts):
    1. Go to Administration → PDF Templates and click the file of which you have a customized version, in the file list. If this a custom template developed from scratch, then click the Add a new resource button under the file list.
    2. Open your custom file in any simple text editor, and copy its content to the web-based editor. If this is a custom template developed from scratch, enter its filename, too.
    3. You need to make the following little changes in all of your custom templates:
      1. Script execution: replace the full filesystem path of the script file with its filename only.
        For example, replace
        $scripting.execute("/templates/plugins/pdfview/gantt-chart.groovy")
        with
        $scripting.execute("gantt-chart.groovy")
        (Why? The scripts are not stored in the filesystem anymore.)
      2. Dispatching and inclusion: replace the #parse macro calls with $include tool calls.
        For example, replace
        #parse("/templates/plugins/pdfview/issue-navigator-fo.vm")
        with
        $include.parse($ctx, "issue-navigator-fo.vm")
        and do not forget to pass the first argument $ctx!
        (Why? The templates to include are not stored in the filesystem anymore.)
    4. Save it, and migrate all other custom templates like this, one by one.
  6. Migrate your custom issue view entries in atlassian-plugin.xml (you can skip this step if you never added or modified issue views in this file, or if you don't know what this whole thing means):
    1. This requires little modifications in the app JAR file. To extract the app with unzip, please follow the appropriate section in the development guide.
    2. Replace the full filesystem path of the template with its filename only.
      For example, replace
      <resource type="velocity" name="fo" location="templates/plugins/pdfview/issue-fo.vm" />
      with
      <resource type="velocity" name="fo" location="issue-fo.vm" />
      (Why? Again, the templates are not in the filesystem anymore.)
    3. Re-build the app JAR with the zip tool, as written in the development guide.
    4. Re-upload the modified JAR through the app manager.
    5. Check if your customized or newly added views work correctly both in the Issue Details screen and in the Issue Navigator.
  7. You're done.

Older releases

Regarding older releases please contact us. We are happy to provide you both with the apps and the corresponding upgrade instructions.