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/beginning of the document.

On the fourth exercise, you'll be going to be learn how to export information from multiple issues on a Section of a single template.

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 populated for each issue, and which sections will be static.

The notation we'll use 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 we'll use in that instance 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.

Info

Using a XLSX template however, please take note that to define an iteration for multiple columns, you need to merge a row of columns and define the "for" inside of those merged cells. The same thing should be made to define

...

the end

...

 of the same iteration. All content between

...

the for

...

 definition and

...

the end

...

 will be duplicated for each iteration.

For further information please check our documentation here.

 

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

This Template has:

  • A static section iteration
  • Headings
  • Text styling

Below there is a sample of how the generated file will be populated:

...

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

 

This Template has:

  • A static section iteration
  • Headings
  • Text styling

Below there is a sample of how the generated file will be populated:

...