Versions Compared

Key

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

In this page, it's explained how to export a property when it has more than a single value such as:

Table of Contents

Iterating Issue History

maxLevel3
minLevel2

The Document Generator also provides data filtering and sorting directly on the iteration definition. Read the following topics:

Table of Contents
maxLevel1

Issue History

Changes to issues are registered in the Issue History, but it is not known in advance how many changes are going to be made. You can iterate a section over all the history entries of an issue. This allows you to create a table that dynamically grows according to the number of changes dene. The notation is:History Entrydone. 


Exportable Data

FieldDescription
HistoryEntriesCountReturns the number of changes made.
AuthorReturns the user who made the change.
CreatedDate of the change
ChangedItemsCoutReturns the number of fields changed in the current change.
ChangedItem
FieldDescription
FieldReturns the name of the field which the value was changed.
FromReturns the old value.
ToReturns the new value.


The notation is:

Code Block
titleExpand to see the sample code
collapsetrue
#{for historyEntries}
   ${fullname:HistoryEntries[n].Author} made changes ${dateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntries[n].Created}
  #{for ch=HistoryEntries[n].ChangedItemsCount}
	Field Name: ${HistoryEntries[n].ChangedItems[ch].Field}
	Old Value:  ${HistoryEntries[n].ChangedItems[ch].From}
	New Value:  ${HistoryEntries[n].ChangedItems[ch].To}
  #{end} 
#{end}
 
or
 
#{for h=HistoryEntriesCount}
   ${fullname:HistoryEntries[h].Author} made changes    ${dateformat("dd-MM-yyyy HH:mm:ss"):HistoryEntries[h].Created}
   #{for ch=HistoryEntries[h].ChangedItemsCount}
	Field Name: ${HistoryEntries[h].ChangedItems[ch].Field}
	Old Value:  ${HistoryEntries[h].ChangedItems[ch].From}
	New Value:  ${HistoryEntries[h].ChangedItems[ch].To}
   #{end} 
#{end}

...

...

Because Changes to issues are registered in the Issue Activity, but it is not known in advance how many changes are going to be made. You linked issues exist for an issue, you can iterate a section over all the activities linked issues of an issue. This allows you to create a table that dynamically grows according to the number of existing activities. The notation is:linked issues. 

Exportable Data

Activity FieldsWhen an activity regards an Issue Status change, this field displays the new Issue Status
FieldDescription
TitleAppType

The title of the issue

SummaryThe summary of the activity
ContentWhen an activity involves a change in the Issue contents, this field displays the new contents
AuthorThe author of the activity
AuthorEmailThe email of the author of the activity
PublishedThe time the issue was published
UpdatedThe time the issue was updated
Categories

Returns the Application Type. The values can be:

Application ValueDescription

JIRA

Link from the same Jira Instance
External Jira Link from the another Jira Instance
Confluence Link from a Confluence page
External External link
LinkType Returns the Link Type.

Note:  When the link you are iterating is of AppTypes External Jira or Confluence, the name is obtained using the Summary property.

The notation is:

Code Block
titleExpand to see the sample code
collapsetrue
#{for activityEntrieslinks}
   ${ActivityEntriesLinks[n].TitleAppType}
   ${ActivityEntriesLinks[n].SummaryLinkType}
   ${ActivityEntriesLinks[n].ContentKey}
   ${ActivityEntriesLinks[n].AuthorSummary}
   ${ActivityEntriesLinks[n].AuthorEmail}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntries[n].Published}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntries[n].Updated}
   ${ActivityEntries[n].Categories}
#{end}
 
or
 
#{for <VariableName>=ActivityEntriesCount}
   Content and Issue Mappings. Example: ${ActivityEntries[VariableName].Field}
#{end}
Info

We suggest that you use the html function to render the data because almost all content is HTML, e.g., ${html:ActivityEntries[n].Title}

Below is an example of using the Activity iteration in a Word template:

Image Removed

or

Image Removed

Below is an example of using the Activity iteration in an Excel template:

Image Removed

or

Image Removed

Iterating Issue Links

Because it is not known in advance how many linked issues exist for an issue, you can iterate a section over all the linked issues of an issue. This allows you to create a table that dynamically grows according to the number of existing linked issues. The notation is:

...

The application type of the link

...

The URL of the link

URL}
#{end}
 
or
 
#{for <VariableName>=LinksCount}
   Content and Linked Issue Mappings. Example: ${Links[VariableName].Field}
#{end}


The image below demonstrates an example of a Word template that iterates over linked issues.

Image Added

or

Image Added


The image below demonstrates an example of an Excel template that iterates over linked issues.

Image Added

or

Image Added

Issue Comments

Because it is not known in advance how many comments exist for an issue, you can iterate a section over all the comments on an issue. This allows you to create a table that dynamically grows according to the number of existing comments. The notation is:

Comments FieldsDescription
Author

The author of the comment

AuthorFullNameThe full name of the author of the comment
BodyThe comment
CreatedThe date the comment was posted
GroupLevelThe group level of the comment
Code Block
titleExpand to see the sample code
collapsetrue
#{for linkscomments}
   ${LinksComments[n].AppTypeAuthor} 
   ${LinksComments[n].LinkTypeAuthorFullName} 
   ${LinksComments[n].KeyBody} 
   ${Linksdateformat("dd-MM-yyyy HH:mm:ss"):Comments[n].SummaryCreated}
   ${LinksComments[n].URLGroupLevel}
#{end}
 
or
 
#{for <VariableName>=LinksCountCommentsCount}
   Content and Linked Issue Mappings. Example: ${LinksComments[VariableName].Field}
#{end}

All fields listed here are available on Links[n] because they represent an issue. In addition, there are two new fields at the Links[n] level: 


The image below demonstrates an example of a Word template that iterates over issue comments.

Image Added

or

Image Added

The image below demonstrates an example of an Excel template that iterates over issue comments.

Image Added

or

Image Added

Issue Worklogs

Because it is not known in advance how many worklogs exist for an issue, you can iterate a section over all the worklogs of an issue. This allow you to create a table that dynamically grows according to the number of existing worklogs. The notation is:

Worklogs Fields

Description

Author

The author of the worklog

AuthorFullName

The full name of the author of the worklog

Comment

The comment of the worklog

Created

The date the worklog was created

Date Started

The date the worklog was started

Time Spent

The time spent in seconds

TimeSpentFormatted

The time spent as displayed on Jira

BilledHours

The billed hours in seconds (Belongs to Tempo Timesheets plugin)

BilledHoursFormatted

The billed hours as displayed on Jira (Belongs to Tempo Timesheets plugin)

Code Block
titleExpand to see the sample code
collapsetrue
#{for worklogs}
   ${Worklogs[n].Author} 
   ${Worklogs[n].AuthorFullName} 
   ${Worklogs[n].Comment}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Created}
   ${dateformat("

...

Returns the Application Type. The values can be:

Application ValueDescription

JIRA

Link from the same Jira Instance
External JiraLink from the another Jira Instance
ConfluenceLink from a Confluence page
ExternalExternal link

...

Note:  When the link you are iterating is of AppTypes External Jira or Confluence, the name is obtained using the Summary property.

The image below demonstrates an example of a Word template that iterates over linked issues.

Image Removed

or

Image Removed

For a working example of this functionality, check the SampleIterations.docx template in the Template Store.

The image below demonstrates an example of an Excel template that iterates over linked issues.

Image Removed

or

Image Removed

Iterating Issue Comments

Because it is not known in advance how many comments exist for an issue, you can iterate a section over all the comments on an issue. This allows you to create a table that dynamically grows according to the number of existing comments. The notation is:

...

The author of the comment

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for comments}
   ${Comments[n].Author} 
   ${Comments[n].AuthorFullName} 
   ${Comments[n].Body} 
   ${dateformat("dd-MM-yyyy HH:mm:ss"):CommentsWorklogs[n].Date Started} 
   ${Worklogs[n].CreatedTime Spent}
   ${CommentsWorklogs[n].GroupLevelTimeSpentFormatted} 
#{end}
  
or
  
#{for <VariableName>=CommentsCountWorklogsCount}
   Content and IssueWorklog Mappings. Example: ${CommentsWorklogs[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over issue comments.

Image Removed

or

Image Removed

For a working example of this functionality, check the SampleIterations.docx template in the Template Store.

The image below demonstrates an example of an Excel template that iterates over issue comments.

Image Removed

or

Image Removed

Info
titleJira Service Desk

If you are using Jira Service Desk you can see more information about comments here.

Iterating Issue Worklogs


Issue Sub-Tasks

Because it is not known in advance how many subtasks exist for an issue, you can iterate a section over all the subtasks of an issue. This allows you to create a table that dynamically grows according to the number of existing subtasks. The notation is:

Subtasks FieldsDescription
KeyThe key of the subtasks
SummaryThe summary of the subtasks
AssigneeUserDisplayNameThe assignee user of the subtasks
Code Block
titleExpand to see the sample code
collapsetrue
#{for subtasks}
   ${Subtasks[n].Key}
   ${Subtasks[n].Summary}
   ${Subtasks[n].AssigneeUserDisplayName}
#{end}
 
or
 
#{for <VariableName>=SubtasksCount}
   Content and Issue Mappings. Example: ${Subtasks[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over issue subtasks.

Image Added

or

Image Added

The image below demonstrates an example of an Excel template that iterates over issue subtasks.

Image Added

or

Image Added

For an example of how to iterate the details of a subtask Parent issue, please check the Iterating JQL Queries area below.

Issue Components

Because it is not known in advance how many components exist for an issue, you can iterate a section over all the components of an issue. This allows you to create a table that dynamically grows according to the number of existing components. The notation is:

Components FieldsDescription
NameThe name of the component
DescriptionThe description of the component
LeadThe name of the component lead
IdThe ID of the component
ProjectIdThe project ID of the component
AssigneeTypeThe assignee type of the component

Because it is not known in advance how many worklogs exist for an issue, you can iterate a section over all the worklogs of an issue. This allow you to create a table that dynamically grows according to the number of existing worklogs. The notation is:

The billed hours as displayed on Jira (Belongs to Tempo Timesheets plugin)

Worklogs Fields

Description

Author

The author of the worklog

AuthorFullName

The full name of the author of the worklog

Comment

The comment of the worklog

Created

The date the worklog was created

Date Started

The date the worklog was started

Time Spent

The time spent in seconds

TimeSpentFormatted

The time spent as displayed on Jira

BilledHours

The billed hours in seconds (Belongs to Tempo Timesheets plugin)

BilledHoursFormatted

Code Block
titleExpand to see the sample code
collapsetrue
#{for worklogscomponents}
   ${WorklogsComponents[n].AuthorName}
   ${Components[n].Description}
   ${Worklogsfullname:Components[n].AuthorFullNameLead} 
   ${WorklogsComponents[n].CommentId}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[Components[n].CreatedProjectId}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):WorklogsComponents[n].Date StartedAssigneeType} 
   ${Worklogs[n].Time Spent}
   ${Worklogs[n].TimeSpentFormatted} 
   ${Worklogs[n].BilledHours} 
   ${Worklogs[n].BilledHoursFormatted} 
#{end}
 
or
 
#{for <VariableName>=WorklogsCount}
   Content and Worklog Mappings. Example: ${Worklogs[VariableName].Field}
#{end}#{end}

 The image below demonstrates an example of a Word template that iterates over issue components.

Image Added

 The image The image below demonstrates an example of a Word an Excel template that iterates over issue worklogscomponents.

Image Removed

or

Image Removed

For a working example of this functionality, check the SampleIterations.docx template in the Template Store.

The image below demonstrates an example of a template in Excel that iterates over issue work logs.

Image Removed

...

or

Image Added

 

Issue Status Transitions

...

Because it is not known in advance how many subtasks Status Transitions exist for an issue, you can iterate a section over all the subtasks Status Transitions of an issue. This allows you to create a table that dynamically grows according to the number of existing subtasksstatus transitions. The notation is:

Subtasks Status Transitions FieldsDescription
KeyAuthorThe key author of the subtasksstatus transition
SummaryCreatedThe summary of the subtasksdate the status transition was performed
OldStatusThe old status of the status transition
NewStatusThe new status of the status transitionAssigneeUserDisplayNameThe assignee user of the subtasks
Code Block
titleExpand to see the sample code
collapsetrue
#{for subtasks statusTransitions}
   ${StatusTransitions[n].Author}
   ${Subtasksdateformat("dd-MM-yyyy HH:mm:ss"):StatusTransitions[n].KeyCreated}
   ${SubtasksStatusTransitions[n].SummaryOldStatus}
   ${SubtasksStatusTransitions[n].AssigneeUserDisplayNameNewStatus}
#{end}
 
or
  
#{for <VariableName>=SubtasksCountStatusTransitionsCount}
   Content and IssueStatusTransitions Mappings. Example: ${SubtasksStatusTransitions[VariableName].Field}
#{end}

The image The image below demonstrates an example of a Word template that iterates over issue subtasksstatus transitions.

Image RemovedImage Added

or

Image Removed

For a working example of this functionality, check the SampleIterations.docx template in the Template Store.

...

Image Added

The image

...

below demonstrates an example of an Excel template that iterates over

...

status transitions.

...

Image Added

or

Image Removed

For an example of how to iterate the details of a subtask Parent issue, please check the Iterating JQL Queries area below.

...

Image Added

Issue Attached Images

Because it is not known in advance how many components Images can exist for an issue (as an attachment), you can iterate a section over all the components attached images of an issue to get some metadata about them. This allows you to create a table that dynamically grows according to the number of existing componentsimages. The notation is:

The assignee type of the component
Components Attachments Images FieldsDescription
IDThe ID of the attached image
ImageThe image of the attached image
NameThe name of the componentattached image
DescriptionSizeThe description size of the componentattached image
LeadHumanReadableSizeThe name size of the component leadattached image
IdAuthorThe ID author of the component
ProjectIdThe project ID of the component
attached image
CreatedThe date the attached image was created
MimeTypeThe type of the attached image
ThumbnailURLThe URL to the thumbnail of the imageAssigneeType
Code Block
titleExpand to see the sample code
collapsetrue
#{for componentsimages}
   ${ComponentsImages[n].Name}
   ${ComponentsImage|maxwidth=150|maxheight=150}
   ${Images[n].Name}
   ${Images[n].DescriptionID}
   ${fullname:ComponentsImages[n].LeadSize}
   ${ComponentsImages[n].IdHumanReadableSize}
   ${ComponentsImages[n].ProjectIdAuthor}
   ${Componentsdateformat("dd-MM-yyyy HH:mm:ss"):Images[n].AssigneeTypeCreated}
#{end}

 The image below demonstrates an example of a Word template that iterates over issue components.

Image Removed

   ${Images[n].MimeType}
   ${Images[n].ThumbnailURL}
 #{end}
 
or
 
#{for <VariableName>=ImagesCount}
   Content and Images Mappings. Example: ${Images[VariableName].Field}
#{end}

The image  The image below demonstrates an example of an Excel a Word template that iterates over issue componentsattached images. 

Image Added Image Removed

Iterating Issue Status Transitions

Because it is not known in advance how many Status Transitions exist for an issue, you can iterate a section over all the Status Transitions of an issue. This allows you to create a table that dynamically grows according to the number of existing status transitions. The notation is:

...

or

Image Added


Info

Doc. Generator will automatically read the EXIF orientation property of an image and rotate it to its correct orientation. You can turn this off by adding this property to your template.

Code Block
titleExpand to see the sample code
Code Block
titleExpand to see the sample code
collapsetrue
#{for statusTransitionsimages}
   ${StatusTransitionsImages[n].AuthorImage|width=150|height=150}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):StatusTransitions[n].Created}
   ${StatusTransitions[n].OldStatus}
   ${StatusTransitions[n].NewStatus}
#{end}
 
or
 
#{for <VariableName>=StatusTransitionsCount}
   Content and StatusTransitions Mappings. Example: ${StatusTransitions[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over status transitions.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over status transitions.

Image Removed

or

Image Removed

Iterating Issue Attached Images

Because it is not known in advance how many Images can exist for an issue (as an attachment), you can iterate a section over all the attached images of an issue to get some metadata about them. This allows you to create a table that dynamically grows according to the number of existing images. The notation is:

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for images}
   ${Images[n].Image|maxwidth=150|maxheight=150}
   ${Images[n].Name}
   ${Images[n].ID}
   ${Images[n].Size}
   ${Images[n].HumanReadableSize}
   ${Images[n].Author}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Images[n].Created}
   ${Images[n].MimeType}
   ${Images[n].ThumbnailURL}
 #{end}
 
or
 
#{for <VariableName>=ImagesCount}
   Content and Images Mappings. Example: ${Images[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over attached images. 

Image Removed 

or

Image Removed

Info

Xporter will automatically read the EXIF orientation property of an image and rotate it to its correct orientation. You can turn this off by adding this property to your template.

Since Xporter 5.5.0, you can use the mappings width and height to define the exact width and height of the printed image.

Code Block
titleExpand to see the sample code
collapsetrue
#{for images}
   ${Images[n].Image|width=150|height=150}
 #{end}

These values are in pixels and if you only define one of them the image will be rescaled.

Info

Note that, if you use both maxWidth and width mappings, only the max value will be read. The same behavior happens with height and maxHeight.

The image below demonstrates an example of an Excel template that iterates over attached images. 

Image Removed 

or

Image Removed

Info

You can iterate over ${Images[n].Image} in Excel on Xporter version 5.4.0 and above.

Iterating Issue Attachments

Because it is not known in advance how many attachments exist in an issue, you can iterate a section over all the attachments of an issue. This allows you to create a table that dynamically grows according to the number of existing attachments. The notation is:

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for attachments}
   ${Attachments[n].ID}
   ${Attachments[n].Name}
   ${Attachments[n].Author}
   ${Attachments[n].AuthorFullName}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Attachments[n].Created}
   ${Attachments[n].Size}
   ${Attachments[n].HumanReadableSize}
   ${Attachments[n].MimeType}
#{end}
 
or
 
#{for <VariableName>=AttachmentsCount}
   Content and Issue Mappings. Example: ${Attachments[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over attachments.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over attachments.

Image Removed

or

Image Removed

Iterating Issue Labels

Because it is not known in advance how many labels exist in an issue, you can iterate a section over all the labels of an issue. The notation is:

...

Code Block
#{for labels}
   ${Labels[n].Name}
#{end}
 
or
 
#{for <VariableName>=LabelsCount}
  ${Labels[VariableName].Name}
#{end}

The image below demonstrates an example of a Word template that iterates over labels.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over labels.

Image Removed

or

Image Removed

Iterating Project Versions from an Issue

You can iterate over all project versions to which the issue belong to. The notation is:

...

Start date

...

Release date

...

Code Block
#{for projectVersions}
   ${ProjectVersions[n].Name}
   ${ProjectVersions[n].Description}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[n].Start date}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[n].Release date}
#{end}
 
or
 
#{for <VariableName>=ProjectVersionsCount}
   ${ProjectVersions[VariableName].Name}
   ${ProjectVersions[VariableName].Description}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[VariableName].Start date}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[VariableName].Release date}
#{end}

The image below demonstrates an example of a Word template that iterates over project version.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over project version.

Image Removed

or

Image Removed

Iterating JQL Queries

You can iterate issues that are the result of a JQL Query. The syntax is similar to the other iterations, but there is a clause parameter that will receive the JQL Query. A few examples are provided below.

Code Block
titleExpand to see the sample code
collapsetrue
a simple example iterating the details of issues from a specified Project:
 
#{for i=JQLIssuesCount|clause=project = DEMO}
   ${JQLIssues[i].Key}
   ${JQLIssues[i].Summary} 
#{end}

or a more advanced example iterating the details of issues linked with the current Issue:
 
#{for m=JQLIssuesCount|clause=issuekey in linkedIssues (${Links[j].Key})}
   Linked Issue ${JQLIssues[m].Summary} has ${JQLIssues[m].LinksCount} links
#{end} 
 
or an also advanced example iterating the details of the Parent issue from the current Subtask:
 
#{for i=JQLIssuesCount|clause=issuekey = ${ParentIssueKey}}
	${JQLIssues[i].Key}
	${JQLIssues[i].Id}
	${JQLIssues[i].Description}
#{end}

The image below demonstrates an example of a Word template that iterates over issue subtasks.

Image Removed

For a working example of this functionality, check the template Sample Iterations in the Template Store.

The image below demonstrates an example of an Excel template that iterates over issue subtasks.

Image Removed
 

Info

You can also use a Filter Name or a Filter Id as a clause. For more info, check [http://confluence.xpand-addons.com/display/public/XPORTER/JQL]

Iterating Issue Commits

Because it is not known in advance how many commits exist for an issue, you can iterate a section over all the commits of an issue. This allows you to create a table that dynamically grows according to the number of existing commits. The notation is:

...

The URL of the link

...

Message

...

Author

...

 #{end}

These values are in pixels and if you only define one of them the image will be rescaled.


Info

Note that, if you use both maxWidth and width mappings, only the max value will be read. The same behavior happens with height and maxHeight.


The image below demonstrates an example of an Excel template that iterates over attached images. 

Image Added 

or

Image Added

Issue Attachments

Because

 Image Removed

Code Block
titleExpand to see the sample code
collapsetrue
#{for commits}
	${Commits[n].Author} 
	${Commits[n].URL} 
	${Commits[n].Message}
	${Commits[n].CreatedDateTime}
	
	Here we have the FilesCount where we can get all the files associated with a commit.
	#{for m=Commits[n].FilesCount}
		${Commit[n].FilesCount[m].Path}
		${Commit[n].FilesCount[m].URL}
		${Commit[n].FilesCount[m].ChangeType}
	#{end}
#{end}
 
or
 
#{for <VariableName>=CommitsCount}
   Content and Issue Mappings. Example: ${Commits[VariableName].Field}
#{end}

 

Iterating Issue Branches

Because it is not known in advance how many branches exist for an issue, you can iterate a section over all the branches of an issue. This allows you to create a table that dynamically grows according to the number of existing branches. The notation is:

Branches FieldsDescription
URL

The URL of the Branch

NameThe name of the Branch
RepositoryName
The name of the repository
RepositoryURL
The URL of the repository

Image Removed

Code Block
titleExpand to see the sample code
collapsetrue
#{for branches}
  ${Branches[n].URL}
  ${Branches[n].Name}
  ${Branches[n].RepositoryName}
  ${Branches[n].RepositoryURL}
#{end}
 
or
 
#{for <VariableName>=BranchesCount}
   Content and Issue Mappings. Example: ${Branches[VariableName].Field}
#{end}

 

Iterating Issue Pull Requests

As it is not known in advance how many pull requests attachments exist for in an issue, you can iterate a section over all the pull requests of attachments of an issue. This allows you to create a table that dynamically grows according to the number of existing pull requestsattachments. The notation is:

Pull Requests Attachments FieldsDescription
URL

The URL of the Branch

NameThe name of the Branch
RepositoryName
The name of the repository
RepositoryURL

The URL of the repository

CommentsCountCounts the number of comments in the pull request
StatusThe status of the pull request
LastUpdatedThe last time the pull request was updated
PullRequestReviewers.NameThe name of the pull request reviewer
PullRequestReviewers.ApprovedIndicates the approval of the pull request reviewer

You can get information about reviewers from each  pull request:

...

IDThe ID of the attachment
NameThe name of the attachment
AuthorThe author of the attachment
AuthorFullNameThe full name of the author of the attachment
CreatedThe date the attachment was created
SizeThe size of the attachment
HumanReadableSizeThe formatted size of the attachment
MimeTypeThe type of the attachment

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for pullRequests}
  	${PullRequestsattachments}
   ${Attachments[n].ID}
   ${Attachments[n].Name}
   ${Attachments[n].Author}
   ${Attachments[n].AuthorFullName}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Attachments[n].URLCreated}
   	${PullRequestsAttachments[n].NameSize}
  	 ${PullRequestsAttachments[n].RepositoryNameHumanReadableSize}
  	 ${PullRequestsAttachments[n].RepositoryURLMimeType}
	${PullRequests[n].CommentsCount} (This represents the number of comments in a pull request)
	${PullRequests[n].Status}
	${PullRequests[n].LastUpdated}
 
	Here we have the PullRequestReviews where we can get all the reviewers for this pull request.
	#{for m=PullRequests[n].PullRequestReviewers}
  		${PullRequests[n].PullRequestReviewers[m].Name}
  		${PullRequests[n].PullRequestReviewers[m].Approved}
	#{end}
#{end}
 
or
 #{end}
 
or
 
#{for <VariableName>=AttachmentsCount}
   Content and Issue Mappings. Example: ${Attachments[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over attachments.

Image Added

or

Image Added

The image below demonstrates an example of an Excel template that iterates over attachments.

Image Added

or

Image Added

Issue Labels

Because it is not known in advance how many labels exist in an issue, you can iterate a section over all the labels of an issue. The notation is:

Attachments FieldsDescription
NameThe name of the label
Code Block
#{for labels}
   ${Labels[n].Name}
#{end}
 
or
 
#{for <VariableName>=PullRequestsCountLabelsCount}
   Content and Issue Mappings. Example: ${PullRequestsLabels[VariableName].FieldName}
#{end}

 

Iterating Issue Builds

 Because it is not known in advance how many builds exist for an issue, you can iterate a section over all the builds of an issue. This allows you to create a table that dynamically grows according to the number of existing builds. The notation is:

...

Plans.Key

...

Plans.BuildNumber

...

The image below demonstrates an example of a Word template that iterates over labels.

Image Added

or

Image Added

The image below demonstrates an example of an Excel template that iterates over labels.

Image Added

or

Image Added

Project Versions

You can iterate over all project versions to which the issue belong to. The notation is:

Attachments FieldsDescription
NameThe name of the project version
DescriptionThe description of the project version
          Start date
        
The Start Date of the project version
          Release date
        
The Release Date of the project version
Code Block
#{for projectVersions}
   ${ProjectVersions[n

Image Removed

Code Block
titleExpand to see the sample code
collapsetrue
#{for builds}
  	${Builds[n].ProjectName}
  	${Builds[n].ProjectKey}
	
	Here we have the each Build Plans where we can get all the individual plans for this project and the correspondent build in existence for this plan.
	#{for m=Builds[n].Plans}
  		${Builds[n].Plans[m].Key}
  		${Builds[n].Plans[m].Name}
  		 ${BuildsProjectVersions[n].Plans[m].BuildNumberDescription}
  		 ${Buildsdateformat("dd-MM-yyyy"):ProjectVersions[n].Plans[m].BuildKeyStart date}
  		${Builds[n].Plans[m].BuildDuration}
  		${Buildsdateformat("dd-MM-yyyy"):ProjectVersions[n].Plans[m].BuildFinishedDateRelease date}
	#{end}
#{end}
 
 
or
  
#{for <VariableName>=BuildsCountProjectVersionsCount}
   ${ProjectVersions[VariableName].Name}
   Content and Issue Mappings. Example: ${Builds${ProjectVersions[VariableName].Description}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[VariableName].Start date}
   ${dateformat("dd-MM-yyyy"):ProjectVersions[VariableName].FieldRelease date}
#{end}

 

Iterating Issue Reviews

Because it is not known in advance how many reviews exists for an issue, you can iterate a section over all the pull requests of an issue. This allows you to create a table that dynamically grows according to the number of existing reviews. The notation is: 

...

The review ID, e.g., 1

...

The URL of the review

...

The review status

...

The image below demonstrates an example of a Word template that iterates over project version.

Image Added

or

Image Added

The image below demonstrates an example of an Excel template that iterates over project version.

Image Added

or

Image Added

Iterating JQL Queries

You can iterate issues that are the result of a JQL Query. The syntax is similar to the other iterations, but there is a clause parameter that will receive the JQL Query. A few examples are provided below.

Code Block
titleExpand to see the sample code
collapsetrue
a simple example iterating the details of issues from a specified Project:
 
#{for i=JQLIssuesCount|clause=project = DEMO}
   ${JQLIssues[i].Key}
   ${JQLIssues[i].Summary} 
#{end}

or a more advanced example iterating the details of issues linked with the current Issue:
 
#{for m=JQLIssuesCount|clause=issuekey in linkedIssues (${Links[j].Key})}
   Linked Issue ${JQLIssues[m].Summary} has ${JQLIssues[m].LinksCount} links
#{end} 
 
or an also advanced example iterating the details of the Parent issue from the current Subtask:
 
#{for i=JQLIssuesCount|clause=issuekey = ${ParentIssueKey}}
	${JQLIssues[i].Key}
	${JQLIssues[i].Id}
	${JQLIssues[i].Description}
#{end}

The image below demonstrates an example of a Word template that iterates over issue subtasks.

Image Added


The image below demonstrates an example of an Excel template that iterates over issue subtasks.

Image Added 
 

Info

You can also use a Filter Name or a Filter Id as a clause. For more info, read this.

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for reviews} ${Reviews[n].Id} ${Reviews[n].URL} ${Reviews[n].Status} ${Reviews[n].Title} ${Reviews[n].Author} ${Reviews[n].Moderator} Here we have the Reviewers for each review where we can get all the individual reviewers for this review. #{for m=Reviews[n].Reviewers} ${Reviews[n].Reviewers[m].Username} ${Reviews[n].Reviewers[m].Completed} #{end} #{end}   or   #{for <VariableName>=ReviewsCount} Content and Issue Mappings. Example: ${Reviews[VariableName].Field} #{end}


Applying filters to Iterations

If you want to take the previous iterations over comments, subtasks and issue links to another level of control, you can use a JavaScript filter to define over which issues the iteration will be made. This can be useful in the following scenarios:

  • Iterating over linked issues that are only of a specific issue type
  • Iterating over subtasks of a specific issue type
  • Iterating over linked issues with a specific priority
  • Iterating over comments created by a specific user

The notation for applying filters to the iterations is:

Code Block
titleExpand to see the sample code
collapsetrue
#{for <VariableName>=<LinksCount|SubtasksCount|CommentsCount|WorklogsCount>|filter=%{<Javascript>}}
   Content here
#{end}
  • VariableName is the name of the variable to use as the iteration index.
  • LinksCount|SubtasksCount|CommentsCount  indicates over which type of entities you want to iterate.

  • Filter indicates the filter to be applied in the iteration.

Notice that as the filter is evaluated as a JavaScript expression, which provides flexibility in the definition of the conditions. You can use and (&&), or (||) and other logical operators supported by the JavaScript language.

It is also possible to format fields inside iteration filters. For more information on formatters, see Native Iterations.

The image below demonstrates an example of a template that iterates over issue links and comments with filters being applied.

Links Bugs with High Priority:

Image RemovedImage Added

Nested Iterations:

Image Removed

For a working example of this functionality, check the template Sample Iterations in the Template Store.Image Added

Iterating in the same line of the document

You can also possible to iterate values in the same line of the document. This can be useful if you want to display a list of Subtasks on Linked Issues in the same line, separated by commas or spaces. 


Code Block
titleExpand to see the sample code
collapsetrue
Users that added comments to this issue: #{for comments}${Comments[n].Author} #{end}

Subtasks of this issue: #{for j=SubtasksCount}${Subtasks[j].Key};#{end}

Linked issues this issue duplicates: #{for j=LinksCount|filter=%{'${Links[j].LinkType}'.equals('duplicates')}}${Links[j].Key} #{end}


Iterating in the same cell in an Excel document

You can also iterate values in the same cell in an Excel document. You can achieve this by simply making your Iteration inside the same cell.

You can use all the Iterations that you are used to and construct them in the exact same way, the difference being that you only use one cell to do them.

Code Block
titleExpand to see the sample code
collapsetrue
Issue iteration as a demonstration.
Copy this iteration below and paste it into a cell.
 
&{for issues} ${Key} &{end}

Iterating with the BREAK or CONTINUE statement

You can iterate anything, set up a Conditional expression and then utilize the BREAK and CONTINUE statements.

The way to do this is by doing a normal Conditional expression and using the mapping #{break} or #{continue} inside it. 

Code Block
titleExpand to see the sample code
collapsetrue
Imagine that you have a Jira Issue that contains these comments:
- Hello
- World
- Greetings
- Hi
 
For the Break functionality, lets say that you want to stop the iteration if the current comment is "World". Here is the template for that:
#{for comments}
Current Comment: ${Comments[n].Body}
#{if (%{'${Comments[n].Body}'.equals('World')})}
#{break}
#{end}
Current Comment Author: ${Comments[n].Author}
#{end}
In this case, Xporterit for Jira will print the comment "Hello" and it´s author. Next it will print the comment Body "World" but since the Conditional expression is true, it will stop the iteration all together and not print anything else.
Note: Anything after the #{break} mapping will not be printed in the exported document.
 
For the Continue functionality, lets say that you want to skip to the next iteration if the current comment is "World", bypassing the Author mapping for this iteration. Here is the template for that:
#{for comments}
Current Comment: ${Comments[n].Body}
#{if (%{'${Comments[n].Body}'.equals('World')})}
#{continue}
#{end}
Current Comment Author: ${Comments[n].Author}
#{end}
In this case, Xporter for Jirait will print the comment "Hello" and it´s author. Next, it will print the comment Body "World" but since the Conditional expression is true, it will continue to the next iteration, not printing the Author of the "World" comment.

Iterating Parent Issues

You can iterate a section over all the parent issues of an issue. This allows you to create a table that dynamically grows according to the information you want to see from parent issues.

Imagine that you have a Jira Issue that contains a Key, Summary, Description and further information. From now on, you are able to get all the information from a parent issue. In order to get those fields, you just need to have the following definition:

${Parent.<Field>}


Example:

Code Block
titleExpand to see the sample code
collapsetrue
&{for issues|filter=%{'${IssueTypeName}'.equals('Sub-task')}}
   ${Parent.Key}
   ${Parent.Summary}
   ${Parent.Description}
   ${wiki:Parent.Description}
   ${html:Parent.Description}
   ${dateformat(“dd-MM-yyyy HH:mm:ss”):Parent.date}
   ${emailaddress:Parent.userpicker}
&{end}

This example only has a few fields, but this new feature allows you to get all information from a parent issue.


Sorting iterations

Imagine that you have an iteration and want to sort it by any field that it can export normally. This will be the header for such an iteration:

#{for comments|sortby=<Iteration mapping>}

NOTE: The mapping after the "sortby" must be equal to the supported mappings for each Iteration.

Example:

Code Block
titleExpand to see the sample code
collapsetrue
This iteration will be sorted by the Body of all the comments in the issue.

#{for comments|sortby=Body}
${Comments[n].Author}
${Comments[n].Body}
#{end}

Sort By

...

on multi issue  export

The sortby can also be used to sort a &{for issues} iteration on a Bulk Export.

Code Block
titleExpand to see the sample code
collapsetrue
&{for issues|sortby=IssueTypeName}
${Key} - ${IssueTypeName}
&{end}
Info
titleSorting Criteria

asc and desc can be defined in order to define how do you want to sort your data. The default value is asc.