Export Jira issues to Word documents made from your own .docx template. Export one issue from its menu, or many issues found with JQL, a saved filter or the address of a Jira search. Fields, custom fields, descriptions with their headings, tables and pictures, comments, subtasks and links are filled in where your template says, as one document or one document per issue in a ZIP. For status reports, release notes, audits and handovers. The document is built in your browser with your own Jira permissions; issue data is never sent to GRAMSHIFT or to third parties.
Get it on the Atlassian Marketplace (free trial)
…/issues/?jql=… or …/issues/?filter=10042), which is turned into the same JQL. Set Most issues (1 to 5,000, 1,000 at first) and press Find issues.
project = ABC AND status = Done ORDER BY key fixVersion = "2.4" ORDER BY issuetype key in (ABC-12, ABC-15) filter = 10042
You see only the issues, comments and attachments that your own Jira permissions allow. The app only reads Jira; it never changes issues.
Each one comes in English and Japanese; the list shows the ones in the language of your Jira profile. Press Download this template to get the .docx, change it in Word (your logo, fonts, cover page, the fields you need), and upload it again as your own.
| Template | What it makes |
|---|---|
| Issue report | Fields, description, subtasks, links, comments and pictures. One issue per page. |
| Issue list | A landscape table with one row per issue. The header row repeats on every page. |
| Release notes | A short list of changes grouped as one document, with the fix version and type. |
Write names in your Word file where the values belong. Each one is replaced with the value from Jira. Upper and lower case, spaces and the characters _ - . in names do not matter. The app also has a searchable list of every name, under How to write a template, including the custom fields of your Jira site.
| Write | What you get |
|---|---|
${Summary} | One value |
${@Description} | With formatting, tables and pictures. Put it alone in its paragraph. |
${#Comments} … ${/Comments} | Repeat what is between them for each item |
${^Subtasks} … ${/Subtasks} | Only when the list is empty, for example ${^Subtasks}No subtasks${/Subtasks} |
${Comments[0].Body} | One item by number (starts at 0) |
${Key} ${Summary} ${@Description} ${@Environment} ${Status} ${Type} ${Priority} ${Assignee} ${Reporter} ${Creator} ${Created} ${Updated} ${DueDate} ${Resolved} ${Resolution} ${Labels} ${Components} ${FixVersions} ${AffectsVersions} ${Project} ${ProjectKey} ${Parent} ${ParentSummary} ${OriginalEstimate} ${RemainingEstimate} ${TimeSpent} ${URL} (a link to the issue), and the counts ${CommentsCount} ${SubtasksCount} ${LinksCount} ${AttachmentsCount}.
Custom fields are written by their name in Jira, for example ${Story Points} or ${Customer Name}. Jira Service Management fields work too: an SLA shows the remaining time and whether it was met or breached, Request Type shows its name, and the Development field shows a short summary such as the number of pull requests and commits.
| List | Names inside it |
|---|---|
${#Issues} … ${/Issues} | Every issue field. Put the part that repeats for each issue between them when you export many issues into one document (all built-in templates do this). |
${#Comments} … ${/Comments} | ${Author} ${Created} ${Updated} ${Body} (${@Body} keeps formatting and pictures) |
${#Subtasks} … ${/Subtasks} | ${Key} ${Summary} ${Status} ${Type} ${Priority} ${URL} |
${#Links} … ${/Links} | ${Relation} (how it is linked, for example “blocks”), ${Key} ${Summary} ${Status} ${Type} ${Priority} ${URL} |
${#Attachments} … ${/Attachments} | ${Name} ${Size} ${Created} ${Author} ${MimeType}, and ${@Image}, the picture itself when the file is an image |
${#Images} … ${/Images} | Image attachments only: ${Name} ${Size} ${Created} ${Author} ${@Image} |
A repeat inside a table row repeats the row. Put the start and the end of a repeat in the same row, or both in one cell.
${ExportDate} (the date of the export), ${IssueCount} (the number of issues in this document) and ${JQL} (the search that chose the issues) can be written anywhere, including headers and footers.
Names work in the page header and footer as well, for example ${Key} – ${Summary} in the header of a document per issue, or ${ExportDate} in the footer.
Templates written in this form also work without changes. They are read as the repeats above:
| Written as | Read as |
|---|---|
&{for issues} … &{end} | ${#Issues} … ${/Issues} |
#{for comments} … #{end} | ${#Comments} … ${/Comments} |
#{for subtasks} … #{end} | ${#Subtasks} … ${/Subtasks} |
#{for links} … #{end} | ${#Links} … ${/Links} |
#{for attachments} … #{end} | ${#Attachments} … ${/Attachments} |
${Comments[n].Body}, ${Comments[n].Author} | ${Body}, ${Author} inside the repeat |
${wiki:Description} | ${@Description} |
${IssueTypeName}, ${FixVersion}, ${Link} | ${Type}, ${FixVersions}, ${URL} |
Showing a part only when a condition is true (#{if …}) is not supported. The app names each #{if …} and any other command it cannot read, with its place, so you can delete it in Word before you export.
After you upload a template, the app checks it. A missing }, a repeat with no end, or repeats that cross each other are listed as Fix these in the template in Word, with the part (body, header, footer), the paragraph number and the text near it. A name that is not a Jira field is listed under Check these before you export; if you export anyway, it stays in the document as written, and the names are listed again after the export.
${@Description}, ${@Environment} and ${@Body} (in comments) keep headings, bold and italic, links, bullet and numbered lists, tables (with merged cells), code blocks, quotes and panels as Word formatting.A template you upload is saved in your browser only, and other people do not see it. To share one, attach the .docx to any Jira issue and add the label word-template to that issue. Everyone who can see that issue finds the template under Shared in Jira (label word-template). To change it, attach the new version to the same issue. If your browser does not allow saving, an uploaded template is kept until you close the page.
Jira issues ${ExportDate} for one document, and ${Key} ${Summary} for one document per issue (those are saved together in Jira issues YYYY-MM-DD.zip). You can write ${ExportDate} and, for one document per issue, any issue field in the name._, very long names are shortened, and two documents with the same name in a ZIP get (2), (3) and so on.… (part 1 of 3), … (part 2 of 3) and so on. Your browser may ask once to allow multiple downloads.After the export, the screen lists under Not included in the document every issue or picture that could not go in, with the reason:
| Reason on the screen | What to do |
|---|---|
| This issue was not found, or you do not have permission to see it | Check the key and your permission in Jira. When you list keys in JQL (key in (…)), Jira leaves such issues out without a message, so the app names them right after Find issues. |
| No permission to download this file / the file no longer exists in Jira | Open the issue in Jira to check the attachment. |
| A picture in the text has no matching attachment on this issue | The attachment shown in the text was probably deleted. |
| Larger than 50 MB | Download it from the issue in Jira. |
| The pictures of this issue go over the picture limit for one file | Raise Largest total of pictures in one file. |
| Not a picture Word can show | The file name is written instead. |
| Jira kept limiting requests / did not respond / could not be reached | Try again in a few minutes. |
Open Apps → Issues to Word for Jira, find the issues with JQL, a saved filter or the address of a Jira search, choose a template and press Export to Word. You get one Word document with all issues, or one document per issue in a ZIP file, built from the template you chose.
Open the issue, open its ••• menu and choose Export to Word. Pick a template and press Export to Word; the document is saved by your browser.
Yes. Open your .docx in Word, write names such as ${Key}, ${Summary}, ${Status} or a custom field name where the values belong, and upload it with Upload a Word template (.docx). Your logo, fonts, cover page, headers and footers stay as they are.
Write ${#Comments} ${Author} ${Created} ${@Body} ${/Comments} in your template, with ${@Body} alone in its paragraph. Every comment is repeated with its formatting and pictures, also on issues with more than 100 comments.
Yes. Write ${@Description} alone in its paragraph and headings, lists, tables with merged cells, code blocks and pictures arrive as Word formatting. Pictures are made to fit the page width.
Search for the version, for example fixVersion = "2.4" ORDER BY issuetype, choose the built-in Release notes template and press Export to Word. Download that template if you want to change its layout, and upload your version.
Yes. Write the field's name as it appears in Jira, for example ${Story Points}. The list under How to write a template shows every custom field of your Jira site.
Yes. #{for …} … #{end}, &{for issues} … &{end} and names such as ${Comments[n].Body} are read without changes. Conditions written as #{if …} are not supported, and the app shows where each one is so you can delete it.
Attach the .docx to any Jira issue and add the label word-template to that issue. Everyone who can see the issue finds the template under Shared in Jira.
The name is not a Jira field, often because of a spelling difference. The app lists such names when you upload the template and after the export; check the spelling in How to write a template.
The issue does not exist or you do not have permission to see it, and Jira leaves it out of the search without a message. The app names those keys right after Find issues and in the list of what was not included.
The list under Not included in the document gives the reason, for example no permission, a deleted attachment, a file larger than 50 MB, or the picture limit for one file. Every other part of the document is still saved.
No. The app only reads Jira with your own permissions, and the Word document is built in your browser; issue data is never sent to GRAMSHIFT or to third parties.
The app's license on your Jira site has ended or was not started. Ask a Jira admin to renew it or start a trial under Manage apps.
Email contact@gramshift.com. Please include what you exported, what you expected and what happened (a screenshot helps). Please do not send templates or exported documents with confidential content unless we ask for them. We reply by email within 72 hours. Support hours are Monday to Friday, 9:00–18:00 Japan time (JST).
project = ABC AND status = Done ORDER BY key）。Jira の検索画面のアドレスを貼っても使えます。「課題を探す」を押すと、合う課題の数が出ます。キーを並べた JQL で、見つからないか見る権限がない課題は名前を出して知らせます。ひな形には ${Summary} のように名前を書きます。書式・表・画像ごと入れるには ${@Description} をその段落にだけ書きます。コメントなどの繰り返しは ${#Comments} … ${/Comments}、#{for comments} … #{end} の形もそのまま使えます（#{if …} の条件は使えず、場所を出して知らせます）。カスタム項目は Jira の名前のまま（例 ${Story Points}）。チームで共有するには、.docx を Jira のどれかの課題に添付し、その課題にラベル word-template を付けます。1回に書き出せるのは課題 5,000件まで、1ファイルの画像の合計の上限（既定 300 MB・10〜500 MB）を超えると複数のファイルに分けます。50 MB を超える画像は入れずに一覧に出します。文書はブラウザの中で作り、課題のデータを GRAMSHIFT にも第三者にも送りません。お問い合わせ: contact@gramshift.com（72時間以内にメールで返信します。受付は日本時間の平日 9:00〜18:00）
Microsoft Word is a trademark of Microsoft Corporation. Jira is a trademark of Atlassian.