You are on the Xporter Server documentation. If you are looking for Xporter Cloud documentation, you can find it in this page.

In this exercise, you will use a Word template (DOCX) to export data into charts within the document.

Let's start by creating a cover page as previously learned and inserting a Table of Contents.

This document will iterate multiple issues (Bulk export), exporting some basic information and a chart based on Number Type Custom Fields for each issue.

While iterating all issues, we'll update some template variables (with set function), which will be used to export a final chart at the end of the document.

Insert a title "Issues" with style Heading 1 (to be used with TOC) and below it add the following set functions:

${set(issueTypeBug,0)}

${set(issueTypeStory,0)}

${set(issueTypeSubTestExec,0)}

${set(issueTypeEpic,0)}

${set(statusOpen,0)}

${set(statusResolved,0)}

${set(statusClosed,0)}

${set(statusInProgress,0)}

Those variables will be used to populate the final chart.

Start iterating issues with &{for issues}.

Export some basic information like the issue Key and Summary.

Insert a chart.

 Currently, Microsoft Word Charts aren't supported by Xporter for Jira. To export charts on a Microsoft Word template, it's needed to used OLE (Object Linking and Embedding) Microsoft Excel Chart.

To insert the Microsoft Excel Chart:

  1. Insert
  2. Object
  3. Microsoft Excel Chart

Double-click the newly inserted chart to edit it.

We'll populate the chart with three values: AttachmentsCount, CommentsCount and LinksCount.

Righ click the chart and choose "Select Data". You'll be transferred to the sheet with the data. Select the Range from A1 to D2.

Delete all other data and change the selected range as follows:


ABCD
1
AttachmentsCountCommentsCountLinksCount
2${Key}${AttachmentsCount}${CommentsCount}${LinksCount}

Now, we'll need to update the previously defined variables. We'll increment each issue type and status depending on the issue context being exported.

#{if (%{'${IssueTypeName}' == 'Bug'})}

${set(issueTypeBug,%{${issueTypeBug} + 1})}

#{end}

#{if (%{'${IssueTypeName}' == 'Story'})}

${set(issueTypeStory,%{${issueTypeStory} + 1})}

#{end}

#{if (%{'${IssueTypeName}' == 'Sub Test Execution'})}

${set(issueTypeSubTestExec,%{${issueTypeSubTestExec} + 1})}

#{end}

#{if (%{'${IssueTypeName}' == 'Epic'})}

${set(issueTypeEpic,%{${issueTypeEpic} + 1})}

#{end}

#{if (%{'${Status}' == 'Open'})}

${set(statusOpen,%{${statusOpen} + 1})}

#{end}

#{if (%{'${Status}' == 'In Progress'})}

${set(statusInProgress,%{${statusInProgress} + 1})}

#{end}

#{if (%{'${Status}' == 'Resolved'})}

${set(statusResolved,%{${statusResolved} + 1})}

#{end}

#{if (%{'${Status}' == 'Closed'})}

${set(statusClosed,%{${statusClosed} + 1})}

#{end}

Close the issues iteration with &{end}.

Being almost finished, let's add two final charts with the totals of issue types and issue statuses.

Add a title "Totals" with style Heading 1. Insert two charts as before, with the following data:


ABCDE
1
BugStorySub Test ExecutionEpic
2Issue Types${issueTypeBug}${issueTypeStory}${issueTypeSubTestExec}${issueTypeEpic}

ABCDE
1
OpenIn ProgressResolvedClosed
2Issue Statuses${statusOpen}${statusInProgress}${statusResolved}${statusClosed}

And we're done.

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

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

You can find more examples of charts in MS Word templates in here.

If you like this exercise, please share your opinion on the page by just leaving a comment or a (thumbs up). Your opinion is very important to us.

Thank you in advance.

Enjoy our product. (big grin)

Here's the Exercise 6 related files:

FileDescription
Exercise6Template

Exercise 6 Sample Template file

Exercise6GeneratedExercise 6 Sample generated file
  • No labels