Fields with Wiki Markup
If the fields to be exported are configured to use a Wiki Markup Renderer, you can place the wiki rendering in the result document.
Definition:
${wiki:<Field name>} |
When creating an Excel template document, you should use: ${wiki:Description}
Inserting Hyperlinks
Xporter also allows generating hyperlinks on the fly.
Definition:
@{title=<Link Title>|href=<Link Address>} |
When creating an Excel template document, you should use: ${link:title=${Key},href=${BaseURL}/browse/${Key}}
Fields with HTML
If the fields to be exported are configured to use an HTML renderer, such as the one provided by the JEditor plugin, you can place the HTML rendering in the result document.
Definition:
${html:<Field name>} |
When creating an Excel template document, you should use: ${html:Description}
If the document's output format is HTML, you should use: ${wiki:Description} instead.
JavaScript with Wiki or HTML
Xporter allows applying Wiki or HTML functions in the text rendered based on JavaScript. For example, if the fields to be exported are configured to use the Default Text Renderer provided by Jira, you can use JavaScript to format the field using the notation explained here and then apply the Wiki or HTML functions. You can also use JavaScript to format fields that are configured to use the Wiki Markup Renderer or an HTML renderer, such as the one provided by the JEditor plugin and then apply the Wiki or HTML functions. To achieve that, the JavaScript function should be defined as a field in the template and the function to be applied to that field.
Definition:
|
Formatting Date Fields
If you are exporting a date field such as CreatedDate and LastUpdateDate, you can define how the date is displayed. All the patterns supported by the DateTimeFormatter Java API are supported.
Definition:
${dateformat("<Format>"):<Field name>} |
Formatting Number Field
Available in Xporter for Jira 3.3.0 and later.
If you are exporting a Number Field, you can define how the number is displayed. All the patterns supported by the DecimalFormat(String pattern) Java API are supported.
You can also specify the Locale you want to use. All the Locales in JRE 7 Supported Locales page are supported.
Definition:
|
Formatting User Picker Fields
In Xporter for Jira 4 and later, displayname and displayemail function were replaced by fullname and emailaddress, respectively.
If you are exporting a User Picker or Multiple Users custom field, you can output the Display Name using the fullname function.
Definition:
${fullname:<Field name>} |
If you are exporting a User Picker or Multiple Users custom field, you can output the email using the emailaddress function.
Definition:
${emailaddress:<Field name>} |
Escaping fields
This function allows fields with line breaks or other special characters to be used inside JavaScript.
Definition:
${escape:<Field name>} |
Creating mappings based on JavaScript using formatted fields
There are times when it may be needed to format a field, execute JavaScript actions on the formatted field, and export the result as HTML or WiKi.
In these cases, all the above formatters are available.
Formatting Duration time field
If you are exporting a duration time field, you can define the behavior you want in order to get the correspondent value. Let's suppose you want to export the duration of an issue, you can get this value in milliseconds as well as the formatted version of this value.
Furthermore, this field allows you to execute JavaScript action on the duration time field and export the result.
Definition:
${durationformat:<Field name>} |
Set
This function allows you to create new variables that will be treated as fields (mappings), and then use it to change the values of those variables.
The new value passed to the Set function can be plain text, an existing field (mapping) or a Helper Functions field.
In the case of templates having Static Sections, you can create new variables outside of said Static Sections and use those variables inside the same Static Sections.
Definition:
${set(<variable name>,<new value>)} |
Note
The function Set can be also used to change the value of existing fields (i.e., existing mappings), but it has a limitation: all occurrences of that field in the document will be replaced with the value of the latest Set that is applied.
Note
The values of all the variables (mappings) created with the Set function and used on the header/footer of a template will correspond to the last value passed to the Set function.
Prop
This function allows you to define properties that will be used later by Xporter during the document processing.
Usually, integrations require some extra configuration such as security tokens, API keys and others.
Specification
Function Name | prop |
---|---|
First Parameter | Key |
Second parameter | Value |
Notation
${prop(Key,Value)}
Example
${prop(my.first.property.key,qwerty12345)} ${prop(service.api.key,84f7970c-5f70-47d9-a4f2-c75151820ba0)} ${prop(service.api.username,userAdmin)}
Image Loader
This function basically loads an image from a URL and puts that on the document. You can also specify the width and/or height of the images.
Definition:
|
Below are two examples:
or
To use the code below, check how to iterate here.
After exporting the document, the generated file is going to see this:
This functionality is available for Excel templates on Xporter V5.3.0 and higher.
QRCode
This function allows you to create a QRCode image on the template. It accepts as content other Xporter mappings.
Definition:
${qrcode('<content>',(Optional) <width>, (Optional) <type>)} |
QR Code Content
You can use any mapping on the content of the QR Code function, but you must be careful because Markups won't generate the expected result.
If you try to export ${qrcode(‘${wiki:Description}’)} or ${qrcode(‘${html:Description}’)}, the content of the QR Code won't be correct.
You can apply format mapping such as dateformat, numberformat, fullname or emailaddress.
QR Code Types
You can learn more about QR Code types here. Note that these types may depend on the QR Code reader and the obtained result may be different than expected.
- Text - Plain text. It's the same as not having a type defined.
- URL - The content will be read as a URL link.
- Phone - The content will be read as a phone number.
- Geolocation - The content will be read as GPS coordinates. Content example: "41.714316, -8.811993".
- Email - The content will be read as an email.
- Wifi - The content will be read as a Wifi connection. Content example: T:WPA;S:NetworkName;P:NetworkPassword;
- VCard - The content as a VCard. Please note that not all devices are prepared to understand VCard details. More information here.
QR Code Width
The width of the QR Code must be a value between 0 and 409 (pixels).
If the user introduces a value outside this interval, the width will be set to its default value (177px).
The user must choose a width large enough for the amount of content in the QR Code. Usually, 100px - 200px is enough.