Each of your JIRA issue fields is assigned to a specific style name used during the export operation.
If you do not see a field that you would like to export, contact our Support Team via our Service Desk.
When you open an exported Jira issue document, using a document editor such as MS Word or Open Office Writer, you will notice that new styles are available, and you can modify them.
A style is a set of formatting characteristics, such as font name, size, color, paragraph alignment, and spacing. Some styles include borders and shading.
Using styles to format your document, you can quickly and easily apply a set of formatting choices consistently throughout your document.
For example, instead of taking three separate steps to format your heading as 16-point, bold, Cambria, you can achieve the same result in one step by applying the built-in Heading 1 style. You do not need to remember the characteristics of the Heading 1 style. For each heading in your document, just click on the heading. For more information about styles, read this article!
Remember that you can upload your own files as templates. This means that you can download one of the supplied ones, customize it using styles and upload again to have your own template!
The list of styles can be presented in a separate pane. The Styles task pane can be opened with the keyboard shortcut Alt+Ctrl+Shift+S.
The styles listed in the pane start with the prefix "BT.task." The first word always starts with lowercase and the following ones depending on how they were named in Jira. There are no spaces between words.
You can add a space after the name of a style to add a description to help you identify the desired style:
- BT.task.summary header
- BT.task.summary footer
In version 2.0, the prefix was changed from SP (like SoftwarePlant) to BT (like BigTemplate).
Supported field types
Jira standard fields
The style name should include the Jira field, as explained above. For standard JIRA fields, it's relatively simple:
|JIRA field||Style name|
You can find a list of styles with examples on the following page: Click!
Assignee and reporter e-mail support are supported. To make them appear in a document, use the identifiers:
Image identifier BT.task.key#qr generates a QR code with a link to the issue.
Date and format
It is possible to add an identifier to the template, which will be converted into the date and time when the export is generated. Examples:
- for the current date: #BT.task.currentD (-> 31-12-2021)
- for the current date and time: #BT.task.currentDT (-> 31-12-2021 1:47 PM)
The dates exported from the Jira task are saved in the format set in the Jira system (except for the Cloud version).
Dates can be formatted using the following modifiers:
- BT.task.createdDate$yyyy-MM-dd (-> 2021-12-31)
- BT.task.createdDate$dd-MM-yyyy (-> 31-12-2021)
- BT.task.createdDate$MMM/dd/yyyy (-> Dec/31/2021)
Custom field types
- Select List (multiple choice)
- Select List (single choice)
- User Picker (single line)
- User Picker (multiple choice)
- Date Picker
- Text Field (multi-line)
- Text Field (single line)
For custom fields, you need to find out how a given field is named in your JIRA instance - the field ID is used for this. To do so, go to JIRA Administration->Issues→Custom Fields:
To obtain the ID, you need to right-click a custom field on your JIRA issue screen and hit Inspect Element - the Id will be clearly shown as a numerical value (10400 as an example below for field 123):
The pattern is BT.task.custom.<ID-here>. e.g. BT.task.custom.customfield_10001
It can be looked up in leave.docx default template -> date from and date to is a custom field.
Fonts need to be embedded if a template uses custom ones. This can be done in MS Word in the Options section shown below:
Note: this feature is not available on the Mac version of Office 365.