Each week, Marketplace Monday profiles one great add-on available in the Atlassian Marketplace–where you can try and buy more than a thousand add-ons for Atlassian products.

If you’re a JIRA user, you know that JIRA is an excellent tool for project tracking, but there’s always room for improvement. JIRA can always get more efficient or better customized to your workflow. For example, imagine you are used to doing your documentation as Word documents with references to JIRA issues. Imagine creating one template, with a specific layout, format and keywords and in the click of a button generate a final document full of issues. Cool right?

In addition to making you more efficient by automating the task I described above, Xporter for JIRA by XpandIT allows you to customize that final document with a specific structure and elements like images, tables, and more. In a few seconds you can export JIRA issues in a fast and simple way, presenting them in templates fully aligned with your corporate image. This solution is a simple way to increase business agility in the data export process.

In short, Xporter for JIRA allows you to:

  • Export JIRA issues to a PDF or .docx files
  • Configure templates per project, issue type, project roles and users
  • Select templates for multi-issue export
  • Install sample templates
  • Use docx, docm, dotx and dotm files as templates
  • Export subtasks fields
  • Export images attached to issues.

Overview

It’s simple to create your templates in docx files with special placeholders, and watch as they’re transformed for you by the add-on automatically! Allow me to demonstrate how you use Xporter for JIRA to export issues in seconds.

Managing Templates

Xporter for JIRA templates are managed in JIRA Administration. Go to the Manage Plugins > Xporter for JIRA > Manage Xporter for JIRA > Manage templates. Here you can upload and remove templates and set templates permissions, like which templates should be displayed for a project, issue type, user, etc.

Managing Permissions

The options available for permission management are: Select projects with Xporter for JIRA enabled roles or users for JIRA access, Issue Types, Assign Templates to Issue Types.

Using the Add-on

Xporter for JIRA supports:

  • Mappings: To use a mapping, just open Microsoft Word and type use the following notation anywhere in the document: ${<Keyword>}. For more information check the Plugin Documentation.
  • Custom Field Mapping: Xporter for JIRA supports custom fields. To use your own defined custom fields, just use the same notation:  ${<Custom field name>}.
  • Subtask Mapping: You can also render fields from issue subtasks. The notation is: ${Subtasks[n].Field} where n is the index of the Subtask, starting from 0.
  • JavaScript: Finally, the add-on allows rendering text based in Javascript. The notation is: %{<Javascript>}.

All this information is explained in more detail in the Plugin Documentation, but it’s very simple.

Exporting Data

There are two ways to export data:

Single Issue Export

When Xporter for JIRA is enabled for a project, issue type and user, the Xporter for JIRA section will appear on the right side of the screen, as highlighted below. To export the issue based on template, just select the template from the drop-down box and click the export button.

Multiple Issue Export

Exporting multiple issues is achieved using the Bulk Change operation as shown below:

The X Factor: Xporter Plugin

The Xporter for JIRA team has plans to support Microsoft PowerPoint and Excel in upcoming releases. They encourage you to contact them with suggestions for other data formats to export JIRA issues into. Just email them.

You can find great add-ons like Xporter for JIRA in the Atlassian Marketplace.

Since last time…

Check these posts each week to see if there’s something new that will work for your organization, then get an evaluation version from the Marketplace or straight from the Universal Plugin Manager in JIRA, Confluence, or our developer tools. And check out the first edition of the Atlassian Marketplace newsletter!

  • Automatically create subtasks when transitioning issues with the Create on Transition plugin from Bob Swift Software.