In this page

Overview
Configuring PDF templates via configuration variables
Creating new PDF templates
General-purpose issue exports
Issue with basic information
Issue with all information
Issue with its attachments embedded
Issue with its detailed sub-tasks
Issue with QR code
Automatic localization
International characters
Issue lists
Simple issue table
Task list with rich formatting
Issue table with QR code
Timesheets & invoices
Timesheet
Time-based invoice
Tempo invoice
Learn more about the Tempo Timesheets integration
Jira Service Desk (support desk) exports
Ticket export
SLA list
Learn more about the Jira Service Desk integration
Portfolio for Jira exports
Issue with Portfolio fields
Issue list with Portfolio fields
Learn more about the Portfolio for Jira integration
Release notes documents
Release notes for a software product
Gantt charts
Weekly Gantt chart report
Daily Gantt chart report
Time by X reports
Time in status report
Time by assignee report
Profields exports
Issue with Profields custom fields
Issue list with Profields custom fields
Project list with Profields custom fields
Learn more about the Profields integration
Project status reports
Project on schedule
Project off schedule
Requirement specifications
Software Requirement Specifications (SRS)
Traceability reports
Traceability report
Traceability matrix reports
Traceability matrix
Agile story card prints
Story cards
Story cards with QR codes
Color Custom Fields exports
Issue with Color Custom Fields
Issue list with Color Custom Fields
Learn more about the Color Custom Fields integration
Custom reports
Custom sales report
Custom agile sprint report
Google Maps as Jira custom field

Overview

This gallery displays sample exports created using the "factory-default" templates shipped with the Better PDF Exporter for Jira. Our aim is to give you a quick understanding of what is possible out of the box. This is obviously just the beginning of the story, because the customization and export creation possibilities are literally endless.

You can use the "factory-default" templates in the following ways:

  1. As they are (we polished them further and further over the years so that they give a ready-made solution for most situations)
  2. Configure their look and behaviour by editing their configuration variables (see next section)
  3. Customize their look and behaviour by actually editing the template or the corresponding scripts
  4. Make a copy of them for the starting point of a new template
  5. Use their implementation as "cheatsheet" when developing custom templates

Configuring PDF templates via configuration variables

Many of the templates shipped with the Better PDF Exporter for Jira offer configurability via variables. These variables appear in the top part of the PDF templates or in the top part of the Groovy scripts, and are documented right in the code. Some variables are required to work correctly (like setting up the Tempo authentication for Tempo exports), while some actually modify the export's look or behaviour.

For instance, the Gantt chart template (gantt-chart-fo.vm) offers the following configuration variables:

#set($showCurrentTime = true)					## whether to highlight the current week or day
#set($startDateCustomFieldId = 10400)			## should be a date picker type custom field
#set($endDateCustomFieldId = 10401)				## should be a date picker type custom field
#set($progressPercentageCustomFieldId = 10800)	## should be a number type custom field or 0 to hide progress percentage
#set($viewPeriod = "week") 						## use one of "week" or "day"
#set($groupSubTasksByParent = true)				## whether subtasks should be rendered right after their parent (set it to false to strictly follow the original order, i.e. allow parents and subtasks appear "detached")

You can edit the configuration variables intuitively:

  1. Login to Jira as administrator.
  2. Go to AdministrationAdd-onsPDF Templates.
  3. Click the template file you wanted to edit, for example gantt-chart-fo.vm. It opens in the built-in template editor.
  4. Edit the variables.
  5. Save your changes.
  6. Make a new export, which will reflect the changes in the configuration variables.

Creating new PDF templates

You can easily create custom templates by reading the template development documentation and by using the recipes that we collected for frequent use cases.

For those who'd rather focus on their core business and use our expertise to create custom PDF templates for their needs, Midori offers template development services.

General-purpose issue exports sharing customer-facing document archiving

The issue-fo.vm template exports one or more issues to straight-forward PDF documents. It offers you several configuration variables to choose what to include in the PDFs. The visual design is intentionally kept on the bare minimum, so that the emphasis is on your content, not on the "chrome" around it, although you can customize it with extreme flexibility.

Issue with basic information

The most basic export captures standard- and custom field values, attachments, issue links, remote link, subtasks, worklogs and comments.

jira-single-issue-export.pdf

Issue with all information

In addition to the basic information, it also displays image attachment thumbnails and the detailed change history.

jira-single-issue-export-with-history.pdf

Issue with its attachments embedded

This PDF document embeds 3 files originally attached to the issue, to provide a complete self-containing snapshot of the issue. Open this with Adobe Reader or some other full profile PDF viewer, as browser plugins may not support PDF attachments!

jira-single-issue-export-with-attachments.pdf

Issue with its detailed sub-tasks

This sample contains a (parent) issue and all its sub-tasks. Note that sub-tasks are exported not only as a simple list, but with the same details (fields, comments, etc.) as parent issues.

jira-single-issue-export-with-subtasks.pdf

Issue with QR code

This PDF export includes a QR code link to the exported issue. It can be easily read with special barcode scanner devices or free barcode reader smartphone apps. In addition to QR code, you can encode information in any standard 1D and 2D barcode format!

jira-single-issue-export-with-qr-code.pdf

Automatic localization

This example shows that the template automatically uses the preferred language of the user who created the export, turning the caption Priority to Priorität or Attachments to Anhänge, for example.

jira-single-issue-export-german.pdf

International characters

All our templates fully support Unicode, i.e. all character sets from Eastern European to Asian. This particular example was created with Japanese locale (Japanese characters and Japanese date format).

jira-single-issue-export-japanese.pdf

Issue lists sharing customer-facing document archiving

The issue-navigator-fo.vm template exports any list of issues from Issue Navigator to a landscape-oriented table using the currently configured columns and ordering. It allows you to create custom PDF documents from ad-hoc JQL searches and saved filters with a single click. As for visuals, this one and all our templates apply the "invisible design" paradigm, allowing readers to focus on the data.

Simple issue table

Notice the subtle details in this otherwise self-explanatory document: no icons used, hyper links where they create value, minimal text decoration (ex: outlined issue links).

jira-issue-list-table-export.pdf

Task list with rich formatting

Just because this is a table, it does not mean you can't freely use text formatting or embedded images within the cells.

jira-issue-table-export.pdf

Issue table with QR code

Read the QR code in the footer with your smartphone to re-run the JQL search or saved filter which generated the original PDF document!

jira-issue-list-table-export-with-qr-code.pdf

Timesheets & invoices reporting invoicing billing

The timesheet-fo.vm template calculates the Spent Time totals and grand totals for any arbitrary issue set. It supports both Jira's internal time tracking and Tempo Timesheets, the most popular time tracking app for Jira.

Timesheet

This is a simplistic timesheet, aggregating the worklogs of an issue list, in a professional document that you can share with your clients.

jira-timesheet.pdf

Time-based invoice

After specifying the hourly rate, it will include money information as well (amout due, net, gross). You may event want to add tax information, payment information (SWIFT code and IBAN). If you run time and material based projects, you can easily turn Jira into a powerful billing system with this template.

jira-invoice.pdf

Tempo invoice

Invoices can also be created from Tempo worklogs, making use of the additional domain data like Account or Team.

jira-tempo-invoice-example.pdf

Learn more about the Tempo Timesheets integration

See the Tempo Timesheets integration details for a tutorial video and configuration guide.

Jira Service Desk (support desk) exports ticketing sla reporting

Integration is a key design goal for Better PDF Exporter. It supports the most popular Jira apps, enabling you to get more value out of your previous investment and your existing data. These samples demonstrate exporting the Jira Service Desk managed custom fields to various templates (in fact, you can integrate those to any template).

Ticket export

Please note the two SLA values (Time to assignment and Time to resolution) and the Customer Request Type value natively appearing among the built-in custom fields. The template is using the same intuitive red-green color coding as the web interface.

jira-service-desk-fields-single-issue.pdf

SLA list

Service Desk custom fields (see the 3 rightmost columns) are also supported when bulk-exporting tickets to a table.

jira-service-desk-fields-issue-navigator.pdf

Learn more about the Jira Service Desk integration

See the Jira Service Desk integration details for a tutorial video and configuration guide.

Portfolio for Jira exports reporting project portfolio management roadmap

Portfolio for Jira is Atlassian's Project Portfolio Management (PPM) solution, an agile roadmapping and project planning app for Jira Software. It helps project managers see the big picture by combining multiple projects and resources on a single timeline. Better PDF Exporter exports the Portfolio custom field values, including Target Start Date, Target End Date, Team, Parent Link and Original Story Points, to PDF. Using the power of JQL, you can create custom documents from the complete portfolio, from multiple programs, from multiple plans, from multiple plan levels, or all these combined!

Issue with Portfolio fields

This is the export of an Epic-type work item from a Portfolio plan. It contains all the Portfolio for Jira custom fields in addition to the standard fields.

jira-portfolio-fields-single-issue.pdf

Issue list with Portfolio fields

This sample is the export of a plan built with Portfolio, including Initiative, Story and Task type work items (issues). It is exported from Issue Navigator using a custom column configuration, which includes all Portfolio-managed custom fields plus Epic Link.

jira-portfolio-fields-issue-navigator.pdf

Learn more about the Portfolio for Jira integration

See the Portfolio for Jira integration details for a tutorial video and configuration guide.

Release notes documents software engineering release management

The smart release-notes-fo.vm template has several advantages over the basic Release Notes generated by Jira: it enables company branding (logos, colors), you can precisely specify what fields to include, you have full access to any piece of information inside and outside Jira, and you can include additional content like installation instructions, pricing information (not only the fixed issues). This is an easy and powerful way to get software version documentation out of Jira.

Release notes for a software product

Company branded release notes for a software product, with Download and Installation Instructions sections. This looks awesome printed to paper, as well.

jira-release-notes.pdf

Gantt charts scheduling reporting project management

The gantt-chart-fo.vm template visualizes project schedules by displaying issues as horizontal bars, along with their start and end-dates. Gantt charts are popular data representation tools in practical project management. These sample PDFs are Gantt charts created from Jira tasks with a single click.

Weekly Gantt chart report

Tasks and subtasks, with their bars colored by the corresponding priority color. It is generated in "week" resolution. Current week is also marked.

jira-gantt-chart-report.pdf

Daily Gantt chart report

Similar to previous, but in "day" resolution for shorter projects. Weekend days are also marked.

jira-gannt-chart-report-daily.pdf

Time by X reports reporting process management

The time-by-x-report-fo.vm template exports various Key Performance Metrics and charts calculated from the changes of the given field. Out of the box, it can be used with the "status" field (resulting in a "Time in Status" report), the "assignee" field (a "Time by Assignee" report) and every sort of custom fields. It can also be customized by adding, removing or modifying sections, or can be used as starting point for custom graphical reports.

Time in status report

This report helps to understand the issue's status changes by visualizing that in a timeline. In addition, it helps to indentity bottlenecks in your process by calculating how much time spent in each status and how many times the issue entered each status.

jira-time-in-status-report.pdf

Time by assignee report

Similarly to the previous, it visualizes how much time an issue has spent per assignee. It reveals the ownership of issues when being passed between multiple persons.

jira-time-by-assignee-report.pdf

Profields exports project custom fields reporting project management

Profields is the project administration app for Jira that enables adding custom fields to projects, such as due dates, budgets and supervisors. It centralizes information that is project-dependent, not issue-dependent, which Better PDF Exporter can export both in the context of issues and in the context of projects. Ultimately, PDF exports with the Profields data makes it easier for the project-, program- and portfolio managers to manage, watch and share Jira projects.

Issue with Profields custom fields

This sample is a single task exported to PDF, transparently merging issue-specific fields (like Status) with project-specific fields managed by Profields (like Project customer). Better PDF Exporter can export Profields data, mapped project custom fields to issue custom fields, without any configuration.

jira-profields-export.pdf

Issue list with Profields custom fields

This document contains issues from multiple projects. Note that each row contains Profields-managed data obtained from the issue's encompassing project, in the columns from "Project" to "Final project deadline".

jira-profields-issue-navigator.pdf

Project list with Profields custom fields

Not only issues, but also projects can be exported to PDF (using this technique). If you have a large number of projects, it offers an easy way to search, share project information between stakeholders and executives.

jira-profields-project-export.pdf

Learn more about the Profields integration

See the Profields integration details for a tutorial video and configuration guide.

Project status reports reporting project management

The project-report-fo.vm helps to create an executive level status report with visual Key Performance Indicators (KPI) like Schedule, Costs and Risk in the cover page and with precise issue lists in the other pages. You can freely customize this template to your own KPI's.

Project on schedule

In this sample, there is one unsolved issue in the Highest priority, meaning risk and therefore turning the overall report to "Yellow exclamation mark" status. Other constraints are met.

jira-project-status-report.pdf

Project off schedule

Several KPI's turned to yellow and red: no tasks are completed in the last week, project is behind schedule (due to the 3 overdue issues) and there are risks (4 unsolved highest-priority issue). The red-yellow-green coding helps to identify the problems intuitively.

jira-project-status-report-off-schedule.pdf

Requirement specifications srs software engineering requirements management

The requirements-specification-fo.vm enables you to replace your hyper-expensive Requirements Management system with a practical and light-weight Jira based mechanism, producing accurate technical documentation with lower efforts. The template is based on the recommendations of the IEEE/EIA 12207.1-1997 standard (Recommended Practice for Software Requirements Specifications), but it can be applied to any kind of engineering discipline, from hardware design to mechanicals.

Software Requirement Specifications (SRS)

Please note the hierarchical PDF bookmarks and Table of Contents (both automatically built based on a "numbering" custom field), and the bookmarks linking one requirement to another within the document in this sample.

jira-software-requirement-specification.pdf

Traceability reports test management testing requirements management

The traceability-report-fo.vm template exports the input issues (the "source") and the issues reachable from the input issues along issue links and parent-sub-task relationships recursively up to a maximum distance. While the leftmost column describes the link type and its distance from the source, it also adds the currently selected columns in the right, making this an easily configurable way to visualize dependencies between requirements, tasks, tests, bugs and any types of issues.

Traceability report

This sample shows the dependencies between various types of issues in a software project: user stories implemented by tasks, verified by tests, some blocking each other. It traces the issue links to the max distance of 4 (configurable).

jira-traceability-report.pdf

Traceability matrix reports test management testing requirements management

The traceability-matrix-fo.vm template renders a matrix with bi-directional relations between two list of issues, based on the issue links created between the items. It helps you to discover the dependencies between requirements (or use cases vs. implementation tasks) or the completeness of your test suite (coverage between features and test cases), for example.

Traceability matrix

Although not super-spectacular, this table summarizes the dependencies between the requirements of a mobile device design. Arrows point to the direction of the corresponding issue links ("depends on" vs. "is a dependant for").

jira-traceability-matrix-report.pdf

Agile story card prints kanban scrum agile

The story-card-fo.vm template helps to print paper cards for physical story boards, for teams working with Scrum, Kanban or some other methodology that represents work items with signal cards on boards. The template allows customizing paper size, card size and card content to the smallest details. Get a paper cutter, cut along the marks and enjoy!

Story cards

In this sample, each card in the 4x3 grid captures the project avatar, the issue summary, the priority (plus avatar), the assignee (with avatar), the story points and the leading part of the formatted description.

jira-agile-storycard.pdf

Story cards with QR codes

You can't (and you shouldn't) fit all issue details to story cards. But you can easily include a QR code for your agile team members to scan so that they can see the originating issue.

jira-agile-storycard-with-qr-code.pdf

Color Custom Fields exports visualization risk management project management

Using color-type custom fields to manage issue attributes, that can be intuitively color-coded, will make your information intuitive, visual and easy-to-understand. A good example of this is modeling Impact and Likelihood with a red/yellow/green scale for a special "Risk" issue type in a Risk Management use case. Although color-type custom fields are not available in core Jira, the free Color Custom Fields app can add those as extension and Better PDF Exporter can export those to PDF documents.

Issue with Color Custom Fields

In this example, the risk's details are collected into their own section. Note the color-coded fields giving a quick reading and understanding on this particular risk. (For the color-blind, the integration can be configured to display the color name next to the colored rectangle.)

jira-color-custom-fields-export.pdf

Issue list with Color Custom Fields

This PDF is an issue list exported from a JQL search result, with all the risks in a given Jira project. Note that the export reminds to a heat-map kind of visualization, which makes communicating the risk factors with the project stakeholders quick and easy.

jira-color-custom-fields-issue-navigator.pdf

Learn more about the Color Custom Fields integration

See the Color Custom Fields integration details for a tutorial video and configuration guide.

Custom reports reporting archiving

You can model any sort of business process and manage any sort of data with Jira. Thanks to the low-level approach based on document templates and Groovy scripts, Better PDF Exporter gives you incomparable flexibility and power to extract complex documents from those. In this section we collected some custom-built report examples for inspiration.

Custom sales report

A comprehensive sales performance report, enhanced with custom charts. A fine example of using Jira for business, but non-technical purposes.

jira-sales-report.pdf

Custom agile sprint report

This custom sprint report calculates Burn Down Rate and Velocity based on issue count vs. time. It also compares the ideal performance to the actual one.

jira-burn-down-chart.pdf

Google Maps as Jira custom field

This custom document demonstrates the extreme flexibility of Better PDF Exporter. One of our power-users implemented Google Maps (with various markers and polylines) as a custom field, then uses his custom template to generate maps for comprehensive technical documents. Wow, just wow!