PDF View Plugin for JIRA User Manual

Exporting JIRA issues to PDF

From users' point of view, the PDF View Plugin for JIRA is very simple to use.

All you have to do is clicking certain items in the Export drop-down menu to get your PDF documents. Those can either be generated from a single issue, or from the set of issues visible in the Issue Navigator, a JIRA Agile board, a JIRA Service Desk queue or a Tempo timesheet. Exporting from the Issue Navigator is the flexible way to generate PDF reports from saved filters, JQL queries, searches, versions, sprints and all other JIRA features that are based on the JQL query language.

After the PDF document is downloaded to your computer, open the file in any compatible viewer. Our primary recommendation is Adobe Reader.

Exporting a single issue to PDF

Click one of the items in the Export drop-down menu in the Issue Details screen to get your PDF document.

Please note that there are multiple Export menu items available, because the plugin allows using any number of templates to generate PDF documents. You can, for instance, use one template to generate a timesheet based invoice from your issues, and use another to generate custom release notes.

Exporting the issues from Issue Navigator to PDF

Similarly to the previous, click one of the items in the Export drop-down menu in the Issue Navigator screen. (There can be multiple PDF export options available there, as written in the previous section.)

Managing PDF views (export types)

The plugin enables using any number of so-called views (export types), each relying on a different PDF template and different template logic. You can use one view to generate task lists, another to generate timesheets, and a third one to generate release notes documents, for example.

Each view:

  • has its name, which appears in the Export menu.
  • has a short description, to explain the purpose of this export type.
  • can be available for single issues (in the Issue Details screen), for multiple issues (in the Issue Navigator screen), for both, for dashboards, or can be disabled (hidden).
  • renders one particular PDF template file. (Template files can be reused by multiple export types. For example, a Product Foo Release Notes and a Product Bar Release Notes can render the same PDF template, with some differences in the template logic.") )
  • can be optionally restricted to certain groups, users or issues (specified by JQL).
Views are ordered. Their order can be defined right in the PDF Views list. The same order will also be reflected in the Export drop-down menus, allowing the administrators to define a logical order for the items.

As written above, views render their output from PDF templates. All templates can be edited directly in a web based editor, by clicking on the name of a template in PDF Templates list.

Each PDF template:

  • has its name (filename).
  • has a short description.
  • is stored in the JIRA database. (Administrators can edit these files any time.)

Managing PDF views

Go to JIRA AdministrationAdd-onsPDF Views.

You can easily create, update, delete or reorder export types (views) in this screen. Please note that you can use the "update" function also to rename or hide views.

Managing PDF templates

The final PDF documents are rendered from template files, optionally running Groovy scripts. These files, used by the rendering process, are together called "resources".

Go to JIRA AdministrationAdd-onsPDF Templates to manage resources.

You can easily create or edit PDF templates and Groovy scripts in this screen, using the web based code editor. To edit a resource, just click on its name, make the necessary modifications and save your work.

Next step

Next step: customizing your JIRA PDF templates.


Ask us any time.