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 QR code
Automatic localization
International characters
Issue lists
Simple issue table
Task list with rich formatting
Issue table with QR code
Jira dashboards, gadgets & reports
Basic dashboard export
Monthly service desk report
Aggregated Scrum sprint report
Kanban performance report
Built-in Jira report (as gadget)
Automatic localization for dashboards & reports
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
Release notes documents
Release notes for a software product
Gantt charts
Weekly Gantt chart report
Daily Gantt chart report
Zephyr test exports
Zephyr test steps
Zephyr test executions
Zephyr test step results
Learn more about the Zephyr integration
Insight exports
Issue with objects
Issue list with objects
Learn more about the Insight integration
Gliffy diagram exports
Process diagram
Technical drawing
Learn more about the Gliffy integration
nFeed exports
Issue with nFeed fields
Issue list with nFeed data
Learn more about the nFeed integration
JEditor exports
Issue with JEditor formatted fields
Learn more about the JEditor integration
Table Grid Editor exports
Issue with table grid
Issue list with table grids
Learn more about the Table Grid Editor integration
Project status reports
Project on schedule
Project off schedule
Requirement specifications
Software Requirement Specifications (SRS)
Traceability matrix reports
Traceability matrix
Agile story card prints
Story cards
Story cards with QR codes
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 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

Jira dashboards, gadgets & reports reporting project management

Jira dashboards are great tools to summarize issue, project and progress information online, but they were not designed for exporting and for sharing with external people. The dashboard-fo.vm template exports complete Jira dashboards or individual Jira gadgets to customizable PDF reports. Automate the process and the periodical reports will come to your mailboxes automatically!

Basic dashboard export

One-column, portrait oriented export of a progress tracking dashboard, featuring the Created vs. Resolved, the Two Dimensional Filter Statistics, the Issue Statistics, the Pie Chart and the Filter Results gadgets. You should expect this look using the default settings in the template.

jira-dashboard-export.pdf

Monthly service desk report

This company-branded document is combining hand-written content with the visually simplified look of the Average Age Chart, the Recently Created Chart, the Resolution Time and the Time Since Chart gadgets (plus others). It is, essentially, a customer-facing export of Jira sourced-key performance indicators (KPIs).

jira-dashboard-service-desk-report.pdf

Aggregated Scrum sprint report

This example aggregates the status reports of 3 teams' on-going sprints into a single PDF document, one page per team. In addition to Jira Core gadgets, it also contains the following Jira Software gadgets: Sprint Health, Sprint Burndown and Agile Wallboard. This is a great data source for cross-team status reviews and daily stand-ups.

jira-dashboard-agile-sprint-report.pdf

Kanban performance report

This A3 landscape example demonstrates using custom layouts: a Kanban board is stretching to the full page width in the top, followed by four charts and their data tables in the bottom. Not only it gives a fast-to-grasp summary via the charts, the precise data points are also shown.

jira-dashboard-kanban-report.pdf

Built-in Jira report (as gadget)

When you need a built-in Jira report exported to PDF (not possible with Jira!), just export its gadget equivalent along with the data table. This particular sample captures a Burndown Chart report, containing the chart and the detailed event table.

jira-burndown-report-with-data-table.pdf

Automatic localization for dashboards & reports

Similar to all other types of exports, dashboard exports also use the language selected in the user's profile settings. Note that all content (including gadget titles, charts and data tables) is exported in German without any further interaction.

jira-dashboard-export-german.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, 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 section in the Integrations page for a tutorial video and technical details.

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 section in the Integrations page for a tutorial video and technical details.

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

Zephyr test exports test management testing reporting

Better PDF Exporter integrates with Zephyr, the most popular test management app for Jira. Test type issues keep their layout and data structure when exported to PDF. You also have control over the level of test details to be exported: you can choose to export executions with detailed step result, just the execution results or the test steps only.

Zephyr test steps

This example shows the export of the Zephyr test steps (with the corresponding test data and expected result), augmented with regular issue information, from field values through attachments to links.

jira-zephyr-atm-test-steps.pdf

Zephyr test executions

This is very similar to the previous, extending that with the executions of the test.

jira-zephyr-atm-test-executions.pdf

Zephyr test step results

This is the most detailed example, exporting all executions and their step results, also including related defects, executor and execution time.

jira-zephyr-atm-test-step-results.pdf

Learn more about the Zephyr integration

See the Zephyr section in the Integrations page for a tutorial video and technical details.

Insight exports reporting asset management

Insight is the leading asset management app for Jira, that allows implementing CMDB, CRM, HR, ITSM or ITIL functionality on the Jira platform. Better PDF Exporter 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.

Issue with objects

This straightforward PDF document (created using the default issue-fo.vm template) contains a single issue with two Insight custom fields. In addition to object names and keys, attributes are exported as comma-separated name-value pairs in brackets (the format is completely customizable).

jira-insight-fields-single-issue.pdf

Issue list with objects

Insight custom fields (see the 2 rightmost columns) are also supported when bulk-exporting issues to a table. In this example, attributes are turned off for a more compact content.

jira-insight-fields-issue-navigator.pdf

Learn more about the Insight integration

See the Insight section in the Integrations page for a tutorial video and technical details.

Gliffy diagram exports illustration drawing diagram

Diagrams can save a thousand words when communicating issues, by illustrating complex concepts with easy to grasp drawings. Gliffy is the most popular diagram drawing app for Jira. Better PDF Exporter allows exporting Gliffy diagrams to PDF, so that you can communicate issues with external parties outside Jira just as efficiently as inside Jira.

Process diagram

This export explains the visitor interaction process using a Gliffy diagram, as part of a marketing task.

jira-gliffy-export-marketing.pdf

Technical drawing

When working on software or other types of technical projects, deployments, system architectures, workflows are just a few of the concepts to visualize. This example enhances an engineering initiative with an architecture design.

jira-gliffy-export-software-architecture.pdf

Learn more about the Gliffy integration

See the Gliffy section in the Integrations page for a tutorial video and technical details.

nFeed exports rest sql ldap data integration

The nFeed app integrates external data sources (SQL databases, LDAP, Active Directory, REST APIs, Salesforce, CSV files, etc.) to Jira. Better PDF Exporter is tightly integrated with nFeed, allowing you to export all nFeed custom fields to PDF. Having full access to nFeed custom field values, you can easily implement custom reporting and Business Intelligence on nFeed data.

Issue with nFeed fields

This sample PDF (generated from the issue-fo.vm template) contains a single issue with several nFeed custom fields: one of them is a Google Drive document selector, while customers, invoice address and contacts are dependent fields loaded from an external CRM database.

jira-nfeed-fields-single-issue.pdf

Issue list with nFeed data

nFeed custom fields are also supported when bulk-exporting issues to a table. Note: nFeed fields are so transparent in the PDF document that the "(nFeed)" ending was added to the field names to mark those.

jira-nfeed-fields-issue-navigator.pdf

Learn more about the nFeed integration

See the nFeed section in the Integrations page for a tutorial video and technical details.

JEditor exports wysiwyg rich text

JEditor is a popular Jira app which makes it easier to edit text type issue fields (environment, description, text type custom fields, etc.) and comments by replacing Jira's built-in markup editor with a visual rich text editor. Better PDF Exporter correctly exports all JEditor formatted texts to PDF, allowing users stay productive with the WYSIWYG editor plus create rich documents with low efforts.

Issue with JEditor formatted fields

In this sample document, a multi-line text custom field, the Description field and the comments were formatted with JEditor. Thanks to the seamless integration, JEditor formatted fields cannot be distinguished from the markup-formatted ones.

jira-jeditor-fields.pdf

Learn more about the JEditor integration

See the JEditor section in the Integrations page for a tutorial video and technical details.

Table Grid Editor exports table spreadsheet

The Table Grid Editor app adds tabular (spreadsheet-like) custom fields to Jira issues. This format enables managing structured information, like quote line items, employee history or checklists, in powerful custom fields. Better PDF Exporter exports Table Grid Editor managed custom fields to PDF, fully preserving their structure also in the PDF documents.

Issue with table grid

This sample is a typical quote document with the line items stored in a table grid. The table grid has columns of various data types.

jira-table-grid-editor-fields-single-issue.pdf

Issue list with table grids

When exporting an issue table, the table grid fields are fit into single cells, essentially becoming tables-in-a-table. Even in this case, the export is perfectly readable and summarizes large amount of data in an intuitive layout.

jira-table-grid-editor-fields-issue-navigator.pdf

Learn more about the Table Grid Editor integration

See the Table Grid Editor section in the Integrations page for a tutorial video and technical details.

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 top and precise issue lists in bottom. You can freely customize this template to your own KPI's, and then make the report generation automatic for a simple progress tracking solution.

Project on schedule

In this sample, there is one unsolved issue in Critical 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

2 of the 3 KPI's turned red: project is behind schedule (2 overdue issues) and there are risks (1 unsolved critical 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 matrix reports test management testing requirements management

The traceability-matrix-fo.vm 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

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!