In this page

Export Jira work items to PDF

The Better PDF Exporter for Jira Cloud app enables users to create professional PDF files from work items, filters, dashboards, and other Jira data. The whole process is intuitive and takes just a few clicks.

You can start PDF exports in multiple ways, explained in the next sections.

PDF Export Center

The PDF Export Center is a central screen that allows you to choose the work item, filter, dashboard, sprint, backlog to export. This is useful when you want to quickly start from a central location without navigating to the object.

To start an export from the PDF Export Center:

  1. Go to the Jira left-bar → Apps section → Better PDF Exporter.
  2. Click on the card that specifies what type of data you want to export (work item, filter, dashboard, board, etc.).
  3. Select the object in the dialog. You can see all objects of the selected type or search by name or key.
  4. Select the PDF view that produces your desired output.
  5. Wait for the file to be downloaded to your computer.

Direct PDF exports

Direct exports are seamlessly integrated into the Work Item Details, Filter Results, Dashboard, Board, and other Jira screens. This is useful if you want to review the object before exporting it.

To start a direct PDF export:

  1. Go to the object to export (work item, filter, dashboard, board, etc.).
  2. Click the export link on the screen. (See the next section for the exact location of the link.)
  3. Select the PDF view that produces your desired output.
  4. Wait for the file to be downloaded to your computer.

The following table summarizes the locations of the export links on various screens.

PDF Export Center link location Equivalent direct export link location
"Export a single work item" card on the PDF Export Center screen. "Better PDF Exporter" section on the Work item View screen.
"Export work items from a filter" card on the PDF Export Center screen. "App" menu → "Export PDF" on the top of the Filter screen.
"Export work items from a JQL search" card on the PDF Export Center screen. "App" menu → "Export PDF" on the top of the Search screen.
"Export work items from a queue" card on the PDF Export Center screen. Direct exports are not supported due to Atlassian Forge technical limitation JSDCLOUD-17970.
"Export work items from a board" card on the PDF Export Center screen. "Export" menu → "Export PDF" on the top of the Board screen.
"Export work items from a backlog" card on the PDF Export Center screen. "..." menu → "Export PDF" on the top of the Backlog screen.
"Export work items from a sprint" card on the PDF Export Center screen. "..." menu → "Export PDF" at the sprint on the Backlog screen.
"Export work items from a version (release)" card on the PDF Export Center screen. Direct exports are not supported due to Atlassian Forge technical limitation ECO-1140.
"Export a dashboard" card on the PDF Export Center screen. Direct exports are not supported due to Atlassian Forge technical limitation ECO-1139.

Work with the PDF export file

After the app generated the PDF document, it will automatically download the file to your computer.

You can open it in any PDF viewer. We recommend using Adobe Reader for the best experience.

Configure PDF exports

There are two components to configure PDF exports:

  1. PDF views (also called "export types")
  2. PDF resources

The app supports multiple PDF views. Different PDF views generate PDF exports using different templates and different Groovy scripts. That way you can set up separate views to export work item lists, timesheets, release notes, and other PDF documents.

Manage PDF views (export types)

You can manage the PDF views on the PDF Views screen, where you can add, edit, delete, and reorder them.

To access this screen, go to Apps (on the left-bar) → Better PDF Exporter for Jira → Settings (button on the top left) → PDF Views. It requires Jira administrator permissions for obvious reasons.

Add a new PDF view

You can add a new PDF view by clicking the button beside the list and filling the form with the view's properties.

Each PDF view has the following properties:

  • Name: it appears in the Export pop-up.
  • Description: it explains the purpose of the view. It appears under the name in the Export pop-up.
  • Enabled contexts: the screens where this view will be offered as an export option.
    1. Work item views
    2. Search, filters and work item lists
    3. Export center > Queues
    4. Boards and backlogs
    5. Releases
    6. Export center > Dashboards
    7. Export center > Other data
    (You can completely hide the view by disabling it in all contexts.)
  • PDF template: the template file that will be used to generate the exported PDF document for this view. Template files can be shared between multiple views. For example, a Foo Release Notes and a Bar Release Notes can use the same PDF template, with differences in the template logic.
Edit an existing PDF view

You can edit the view's properties by clicking its name in the list.

Delete an existing PDF view

You can delete a view by clicking the "delete" action in the list.

Reorder PDF views

You can change the display order for the PDF views in the list, which will also be reflected in the Export pop-up. To reorder views, click and drag a view to a new position in the list.

Restore the default PDF views

You may want to restore the default PDF views in the following exceptional cases:

  1. You broke or deleted some views, or created new ones that are no longer needed, and now want to start over from a clean state (factory defaults).
  2. You never customized the views, and you want to upgrade to the latest version without manually performing all the upgrade steps. Restoring guarantees that you will get the views that are 100% consistent with your current app version. For details, see the Version History.

You can restore the default views by opening the "..." menu above the list and clicking Reset default views.

Important: use this feature carefully, as there is no undo.

Manage PDF resources (PDF templates and Groovy scripts)

As written above, PDF views render the export files from PDF templates, optionally running Groovy scripts. Template and script files, used by the rendering process, are together called "resources".

You can manage the PDF resources on the PDF Templates screen, where you can add, edit, and delete them.

To access this screen, go to Apps (on the left-bar) → Better PDF Exporter for Jira → Settings (button on the top left) → PDF Templates. It requires Jira administrator permissions for obvious reasons.

Add a new PDF resource

You can add a new PDF resource by clicking the button beside the list and filling the form with the resource's properties.

Each PDF resource has the following properties:

  • Name: if it is a template, it is used when choosing the template for a PDF view. If it is a script, it is used when executing a script from a template (by name).
  • Description: it explains the purpose of the resource.
  • Content: the actual content of the resource.

All resources, including PDF templates and Groovy scripts, are plain text files. You can conveniently edit them in the online editor. The editor offers syntax highlighting, collapse/expand block, and other useful features.

Edit an existing PDF resource

You can edit the resource properties by clicking its name in the list.

Delete an existing PDF resource

You can delete a resource by clicking the "delete" action in the list.

Restore the default PDF resources

Similarly to restoring the default views, you can also restore the default resources. Again, use it in exceptional situations and use it carefully.

You can restore the default resources by opening the "..." menu above the list and clicking Reset default resources.

Next step

Next step: customizing your Jira PDF templates.

Questions?

Ask us any time.