Kutools for Jira – User Guide

Turn Jira work items into client-ready delivery reports, and export lists and single work items to Excel, Word and PDF.

Install and permissions

A Jira site admin installs Kutools for Jira from the Atlassian Marketplace. There is nothing to configure after installation.

• Read-only. The app reads work items and user names. It never creates, edits or deletes anything in Jira.
• Runs as the signed-in user. People can only export the work items they are already allowed to see in Jira.
• Its own storage only. The app stores each user's saved export setups (name, filter criteria and selected fields) in Atlassian's Forge storage.

Where to find it

Export a list

The export page has three steps. A live preview below the settings shows how many work items will be exported.

Step 1 – Choose the work items and the format

Choose how to pick the work items:

• Build a filter – choose a project, time range, assignee and status. More filters adds keyword, reporter, resolution, type, priority, components, labels, version, sprint, epic and subtasks. No JQL needed.
• Use a saved filter – pick one of your Jira filters. Its query is used as it is.
• Enter JQL – type any JQL query.

Then choose Export as: List (Excel, Word or PDF) or Delivery report (Word or PDF, see below).

Step 2 – Choose the fields

Click Choose fields to pick the columns. Recommended fields are listed first, followed by custom fields and other system fields. Drag to reorder. The Key is always the first column. Reset to defaults restores the standard set.

Step 3 – Export

Click Export to Excel, Export to Word or Export to PDF. The file is built in your browser and downloaded as one file, however many work items it contains.

• Excel – dates are real Excel dates, the header row has filters, and comments, work logs and change history can be added as extra sheets.
• Word – an editable document with one section per work item, including rich text from the description.
• PDF – ready to archive or send.

Create a delivery report

A delivery report is a document you can hand to a client at the end of a project or a release.

1. Choose the work items in Step 1, for example a project, a version or a saved filter. Keep Done selected if completed work should be included.
2. Under Export as, choose Word delivery report or PDF delivery report.
3. Optionally add Detail fields.
4. Click Create delivery report.

The report contains, in this order:

1. Delivery summary – how many work items are done, in progress and not started, broken down by type.
2. Open items and risks – sorted by risk: overdue first, then by priority, then by due date. Overdue due dates are shown in red.
3. Completed items – with their completion dates.
4. Work item details – one section per work item with type, status, assignee, due date, completion date, attachments, description, comments and change history, plus any detail fields you added.
5. Sign-off – a table for both parties to sign.

After the report is created, Download raw data (Excel) gives you the same work items as an Excel file.

Export a single work item

1. Open the work item and choose ⋯ → Export with Kutools.
2. Choose the Format: Word or PDF.
3. Under Include, choose comments, change history, work logs and the attachment list.
4. Click Download.

The document starts with the project name and lists every field that has a value, followed by the description.

Saved setups and recent exports

• Save this setup stores the current filter, format and fields under a name, for example "Weekly report". Load it later from Saved setups, or export it directly.
• After changing a loaded setup, choose Save changes to update it or Save as new to keep both.
• Recent exports lists what you exported recently. Same as last export repeats your last export in one click.
• Setups are personal. Other users do not see yours.

Word templates and letterheads

These options are available for Word only.

• Letterhead (Word delivery report) – upload a .docx your company already uses. The report keeps its header, footer, margins, fonts and colours, and replaces the body.
• Custom Word template (Word list) – upload a .docx with placeholders such as {key}, {summary} and {status} between {#issues} and {/issues}. The full list of placeholders is shown in the app, together with Download a sample template.

Uploaded files stay in your browser for that session. They are not stored by the app.

Languages, dates and time zones

• The app follows your Jira language. It is available in English, Simplified Chinese, Traditional Chinese, Japanese, German, French, Italian, Spanish, Portuguese, Dutch and Russian. In any other Jira language, the app is shown in English.
• Dates and times are shown in your own time zone.
• PDF files can show text in Latin, Cyrillic, Greek, Chinese and Japanese scripts. If your work items contain text in other scripts, export to Word.

Data security and privacy

• Built on Atlassian Forge with no external hostnames, so the app cannot send data outside Atlassian.
• Files are generated in your browser. The app does not store exported files.
• Saved setups are stored in Atlassian's Forge storage, which supports data residency.
• The app does not log work item content.

See also our privacy policy.

Trial and licensing

• Sites with up to 10 users can use the app for free.
• Larger sites get a 30-day free trial from the Atlassian Marketplace. During the last days of the trial, a note on the export page shows how many days are left.
• If the trial ends or the subscription expires, the export page shows "License not active". Ask your Jira admin to buy or renew the license.

Troubleshooting

Support

Email support@extendoffice.com.
Email support is available 24/7.

Kutools for Jira is made by ExtendOffice, the team behind Kutools for Excel, Word and Outlook.