Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Sometimes, you may want to export the contents of multiple issues without repeating some sections of the template. For instance, you may want to create a Cover page or display some information only at the end of the document.
In order to provide this functionality, the Xporter for JIRA plugin supports a special notation. That notation allows defining which sections of the template will be rendered for each issue, and which sections will be static. The notation is demonstrated below:

 

This is the header of the Bulk Export, this section will be rendered a single time.


&{for issues}
This section will be repeated for every issue.
Issue Key: ${Key}
Issue Summary: ${Summary}
&{end}


This is the footer of the Bulk Export, this section will be rendered a single time.

 

You can even push this functionality to another level of control by applying filters to the iterations. This can be useful if you want to place the issues of a specific type (ex: Bug) in a section of the template and the issues of another type (ex: Story) in another section. The notation is demonstrated below:

 

The following section will list the issues of the type Bug.


&{for issues|filter=%{'${IssueTypeName}'.equals('Bug')}}

Issue Key: ${Key}

Issue Summary: ${Summary}

&{end}


The following section will list the issues of the type Story.


&{for issues|filter=%{'${IssueTypeName}'.equals('Story')}}

Issue Key: ${Key}

Issue Summary: ${Summary}

&{end}

 

This is the footer of the Bulk Export, this section will be rendered a single time.

Using a XLSX template however, please take note that to define an iteration you need to merge columns and define the "for" inside of those merged cells. The same thing should be made to define the end of the iteration. All content between the for definition and the end will be duplicated for each iteration

Here you'll be going to be learn how to populate your Issue Description on an Xporter generated file. The mappings in use will be:

Activity FieldsDescription
DescriptionThe issue description

...

titleExpand to see the sample code
collapsetrue

...

 

Below there is a sample of how the mappings will be displayed in a Word template:

...