Page History
| Table of Contents | ||
|---|---|---|
|
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.
...
| Info |
|---|
When creating an Excel template document, you should use: ${wiki:Description} |
Inserting Hyperlinks
Xporter also allows generating hyperlinks on the flyTo create hyperlinks inside of the document you just need to use the following definition.
Definition:
@{title=<Link Title>|href=<Link Address>} |
...
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.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
${html:Description}
${html:Custom Free Text} |
| Info |
|---|
When creating an Excel template document, you should use: ${html:Description} |
| Warning |
|---|
If the document's output format is HTML, you should use: ${wiki:Description} instead. |
JavaScript with Wiki or HTML
JavaScript with Wiki or HTML
Xporter allows applying Wiki or HTML functions in the text rendered based on JavaScript. For example, 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 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.
...
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>)} |
...
| Code Block |
|---|
${prop(my.first.property.key,qwerty12345)}
${prop(service.api.key,84f7970c-5f70-47d9-a4f2-c75151820ba0)}
${prop(service.api.username,userAdmin)} |
See here the possible props you can define in your document.
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.
...
| Info |
|---|
To use the code below, check how to iterate here. |
After exporting the document, the generated file is going to see this:
| Info |
|---|
This functionality is available for Excel templates on Xporter V5.3.0 and higher. |
QRCode
QRCode
This function allows you to create a QRCode image on the template. It accepts as content other Xporter mappings.
...
The user must choose a width large enough for the amount of content in the QR Code. Usually, 100px - 200px is enough.
Inserting the number of issues returned by a JQL Query
Xporter for Jira allows you to insert in the document the number of issues returned by the execution of a JQL query.
Definition:
${jqlcount:<JQL Query>} |
| Code Block | ||||
|---|---|---|---|---|
| ||||
${jqlcount:Project = DEMO} |
The example above will put the number of issues of the project DEMO in the document.
FilterJQL & FilterName
| Info |
|---|
This only works when the export is made via the Export menu on the Issue Navigator screen. |
Xporter for Jira also allows you to render the FilterJQL and the FilterName used to search Issues on the Issue Navigator screen.
Definition:
|
Filter
You can now work with the filters you have defined on your Jira instance.
If you want to get the JQL statement, simply map:
|
Furthermore, if you want to export the jqlCount, you don't need to put the entire JQL Query, you just need use the filter name or the filter ID to see all the entries you have on this filter:
|
Last but not least, you can iterate issues with the JQL associated to a filter within the clause parameter by passing only the filter name or filter ID:
| Code Block | ||||
|---|---|---|---|---|
| ||||
A simple example iterating the details of issues from a filter already defined on your Jira
#{for i=JQLIssuesCount|clause=${filter:<Filter Name> or <FilterId>}}
${JQLIssues[i].Key}
${JQLIssues[i].Summary}
#{end}
|
JQL limit of issues
Once the user defines a maximum number of issues on Global Settings, JQL issues processing will replace the iteration that exceeds that limit with a warning message.
This improvement will avoid the JIRA performance decreasing in cases which the number of issues to be export is a large number. This validation will be done in all kinds of exports provided by Xporter.
The maximum number of issues is 10:
The first filter returns fewer issues than the defined limit and the second returns more than 10 issues:
