Versions Compared

Key

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

Table of Contents

Iterating Issue

...

Comments

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 comments exist for an issue, you can iterate a section over all the activities of comments on an issue. This allows you to create a table that dynamically grows according to the number of existing activitiescomments. The notation is:

Title title issue
Activity Comments FieldsDescription
Author

The

author of the

comment

SummaryAuthorFullNameAuthorThe summary of the activity
ContentWhen an activity involves a change in the Issue contents, this field displays the new contents
The full name of the author of the activitycomment
AuthorEmailBodyThe email of the author of the activitycomment
CreatedPublishedThe time date the issue comment was publishedposted
UpdatedGroupLevelThe time the issue was updated
CategoriesWhen an activity regards an Issue Status change, this field displays the new Issue Status
group level of the comment
Code Block
titleExpand to see the sample code
collapsetrue
#{for activityEntriescomments}
   ${ActivityEntriesComments[n].TitleAuthor}
   ${ActivityEntries[n].Summary}
   ${ActivityEntriesComments[n].ContentAuthorFullName} 
   ${ActivityEntriesComments[n].AuthorBody}
   ${ActivityEntries[n].AuthorEmail}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntriesComments[n].PublishedCreated}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):ActivityEntriesComments[n].UpdatedGroupLevel}
   ${ActivityEntries[n].Categories}
#{end}
 
#{end}
 
or
 
#{for <VariableName>=ActivityEntriesCountCommentsCount}
   Content and Issue Mappings. Example: ${ActivityEntriesComments[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 Comments

The documents below demonstrate examples both in Word and Excel template that iterates over all the issue comments.

Image Added Iterations_Comments.docx

Image Added Iterations_Comments.xlsx

...

Iterating Issue Worklogs

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

Comments comment commentBody comment posted

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

GroupLevel

Date Started

The

group level of the comment

date the worklog was started

Time Spent

The time spent in seconds

TimeSpentFormatted

The time spent as displayed on Jira
Code Block
titleExpand to see the sample code
Code Block
titleExpand to see the sample code
collapsetrue
#{for commentsworklogs}
   ${CommentsWorklogs[n].Author} 
   ${CommentsWorklogs[n].AuthorFullName}  
   ${CommentsWorklogs[n].Body} Comment}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Created}
   ${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 documents below demonstrate examples both in Word and Excel template that iterates over all the issue

...

worklogs.

Image Removed

or

Image Removed

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

Image Removed

or

Image Removed

Image Added Iterations_Worklogs.docx

Image Added Iterations_Worklogs.xlsx

...

Iterating Issue Components

...

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

Worklogs Components FieldsDescription
AuthorNameThe author name of the worklogcomponent
AuthorFullNameDescriptionThe full name description of the author component
LeadThe name of the worklogcomponent lead
CommentIdThe comment ID of the worklogcomponent
CreatedProjectIdThe 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
BillableSecondsThe billable seconds (Belongs to Tempo Timesheets plugin)
project ID of the component
AssigneeTypeThe assignee type of the component
Code Block
titleExpand to see the sample code
collapsetrue
#{for worklogscomponents}
   ${WorklogsComponents[n].AuthorName} 
   ${WorklogsComponents[n].AuthorFullNameDescription} 
   ${Worklogsfullname:Components[n].CommentLead}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):WorklogsComponents[n].CreatedId}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Date Started} Components[n].ProjectId}
   ${WorklogsComponents[n].Time Spent}
   ${Worklogs[n].TimeSpentFormatted} AssigneeType}
#{end}
 
or
 
#{for <VariableName>=WorklogsCount}
   Content and Worklog Mappings. Example: ${Worklogs[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel The image below demonstrates an example of a Word template that iterates over all the issue worklogscomponents.

Image Removed

or

Image Removed

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

Image Removed

or

...

Image AddedIterating_Issue_Components.docx

Image Added Iterating_Issue_Components.xlsx

...

Iterating Issue Status Transitions

...

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

Components Status Transitions FieldsDescription
NameAuthorThe name author of the componentstatus transition
DescriptionCreatedThe 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
date the status transition was performed
OldStatusThe old status of the status transition
NewStatusThe new status of the status transition
Code Block
titleExpand to see the sample code
collapsetrue
#{for componentsstatusTransitions}
   ${ComponentsStatusTransitions[n].NameAuthor}
   ${Componentsdateformat("dd-MM-yyyy HH:mm:ss"):StatusTransitions[n].DescriptionCreated}
   ${fullname:ComponentsStatusTransitions[n].LeadOldStatus}
   ${ComponentsStatusTransitions[n].Id}NewStatus}
#{end}
 
or
   ${Components[n].ProjectId}
   ${Components[n].AssigneeType
#{for <VariableName>=StatusTransitionsCount}
   Content and StatusTransitions Mappings. Example: ${StatusTransitions[VariableName].Field}
#{end}

 The  image below demonstrates an example of a Word documents below demonstrate examples both in Word and Excel template that iterates over all the issue componentsstatus transitions.

Image Removed

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

 Image Removed

...

Image Added Iterations_StatusTransitions.docx

Image Added Iterations_StatusTransitions.xlsx

...

Iterating Issue Attached Images

Because it is not known in advance how many Status Transitions Images can exist for an issue (as an attachment), you can iterate a section over all the Status Transitions 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 status transitionsimages. The notation is:

Author author status transitionThe new status of the status transition
Status Transitions Attachments Images FieldsDescription
IDThe ID of the attached image
CreatedImageThe date the status transition was performed
OldStatusThe old status of the status transition
image of the attached image
NameThe name of the attached image
SizeThe size of the attached image
HumanReadableSizeThe size of the attached image
AuthorThe author of the attached image
CreatedThe date the attached image was created
MimeTypeThe type of the attached image
ThumbnailURLThe image thumbnail URL.NewStatus
Code Block
titleExpand to see the sample code
collapsetrue
#{for statusTransitionsimages}
   ${StatusTransitionsImages[n].AuthorImage|maxwidth=150|maxheight=150}
   ${dateformat("dd-MMImages[n].Name}
   ${Images[n].ID}
   ${Images[n].Size}
   ${Images[n].HumanReadableSize}
   ${Images[n].Author}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):StatusTransitionsImages[n].Created}
   ${StatusTransitionsImages[n].OldStatusMimeType}
   ${StatusTransitionsImages[n].NewStatusThumbnailURL}
# #{end}
 
or
 
#{for <VariableName>=StatusTransitionsCountImagesCount}
   Content and StatusTransitionsImages Mappings. Example: ${StatusTransitionsImages[VariableName].Field}
#{end}

The image below demonstrates an example of a Word The documents below demonstrate examples both in Word and Excel template that iterates over status transitionsall the issue attached images.

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:

...

Image Added Iterations_AttachedImages.docx

Image Added Iterations_AttachedImages.xlsx

Info

Document 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 ${prop(xporter.images.process.exif,true/false)} to your template.

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
Code Block
titleExpand to see the sample code
collapsetrue
#{for images}
   ${Images[n].Image|maxwidthwidth=150|maxheightheight=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.

...

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:

Attachments FieldsDescription
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 attachment
Code Block
titleExpand to see the sample code
collapsetrue
#{for attachments   ${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}
   ${ImagesAttachments[n].MimeTypeID}
   ${ImagesAttachments[n].ThumbnailURLName}
 #{end}
 
or
 
   ${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>=ImagesCountAttachmentsCount}
   Content and ImagesIssue Mappings. Example: ${ImagesAttachments[VariableName].Field}
#{end}

The image below demonstrates an example of a Word The documents below demonstrate examples both in Word and Excel template that iterates over attached images. 

Image Removed 

or

Image Removed

Info

Document 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 ${prop(xporter.images.process.exif,true/false)} to your template.

You can use the mappings "width" and "height" to define the exact width and height of the printed image.

all the issue attachments.

Image Added Iterations_Attachments.docx

Image Added Iterations_Attachments.xlsx

...

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:

Attachments FieldsDescription
NameThe name of the label
Code Block
#{for labels
Code Block
titleExpand to see the sample code
collapsetrue
#{for images}
   ${ImagesLabels[n].Image|width=150|height=150Name}
 #{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

Iterating Issue Attachments

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

The documents below demonstrate examples both in Word and Excel template that iterates over all the issue comments.

Image Added Iterations_Labels.docx

Image Added Iterations_Labels.xlsx

...

Iterating Fix Versions of an Issue

You can iterate over all fix versions to which the issue belong toBecause 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:

The ID of the attachmentThe type of attachment
Attachments Versions FieldsDescriptionID
NameThe version name of the attachment
AuthorDescriptionThe 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
version description
Start dateStarting date of the version
Release dateRelease date of the version
ArchivedBoolean that indicates if the version is archived or not
ReleasedBoolean that indicates if the version is released or notMimeType
Code Block
titleExpand to see the sample smaple code
collapsetrue
#{for attachmentsFixVersions}
   	${AttachmentsFixVersions[n].IDName}
   	${AttachmentsFixVersions[n].NameDescription}
   	${Attachmentsdateformat(“dd-MM-yyyy”):FixVersions[n].Author}
   ${Attachments[n].AuthorFullName}
   Start date}
	${dateformat("dd“dd-MM-yyyy HH:mm:ss"):Attachmentsyyyy”):FixVersions[n].Created}
   ${Attachments[n].Size}
   ${AttachmentsRelease date}
	${FixVersions[n].HumanReadableSizeArchived}
   	${AttachmentsFixVersions[n].MimeTypeReleased}
#{end}
 
or
 
#{for <VariableName>=AttachmentsCountFixVersionsCount}
   Content and Versions Issue Mappings. Example: ${AttachmentsFixVersions[VariableName].Field}
#{end}

The image below demonstrates an example of a Word The documents below demonstrate examples both in Word and Excel template that iterates over attachmentsall the issue fix versions.

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

Image Added Iterating_Issue_FixVersions.docx

Image Added Iterating_Issue_FixVersions.xlsx

...

Iterating Affected Versions of an Issue

You can iterate over all affected versions to which the issue belong toBecause 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:

label
Attachments Versions FieldsDescription
NameThe version name
DescriptionThe version description
Start dateStarting date of the version
Release dateRelease date of the version
ArchivedBoolean that indicates if the version is archived or not
ReleasedBoolean that indicates if the version is released or not
Code Block
titleExpand to see the sample code
collapsetrue
#{for AffectedVersions}
	${AffectedVersions
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 Fix Versions of an Issue

	${AffectedVersions[n].Description}
	${dateformat(“dd-MM-yyyy”):AffectedVersions[n].Start date}
	${dateformat(“dd-MM-yyyy”):AffectedVersions[n].Release date}
	${AffectedVersions[n].Archived}
	${AffectedVersions[n].Released}
#{end}

or

#{for <VariableName>=AffectedVersionsCount}
   Content and Versions Issue Mappings. Example: ${AffectedVersions[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel template that iterates over all the issue affected versions.

Image Added Iterating_Issue_AffectedVersions.docx

Image Added Iterating_Issue_AffectedVersions.xlsx

...

Iterating Project Versions

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


Project Versions FieldsDescription
NameThe version name
DescriptionThe version description
Start dateStarting date of the version
Release dateRelease date of the version
ArchivedBoolean that indicates if the version is archived or not
ReleasedBoolean that indicates if the version is released or not
Code Block
titleExpand to see the smaple code
collapsetrue
#{for FixVersions}
	${FixVersions[n].Name}
	${FixVersions[n].Description}
	${dateformat(“dd-MM-yyyy”):FixVersions[n].Start date}
	${dateformat(“dd-MM-yyyy”):FixVersions[n].Release date}
	${FixVersions[n].Archived}
	${FixVersions[n].Released}
#{end}

or

#{for <VariableName>=FixVersions}
   Content and Versions Issue Mappings. Example: ${FixVersions[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over fix versions that an issue belongs to.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over an fix versions that an issue belongs to.

Image Removed

or

Image Removed

Iterating Affected Versions of an Issue

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

...

Code Block
titleExpand to see the sample code
collapsetrue
#{for AffectedVersions}
	${AffectedVersions[n].Name}
	${AffectedVersions[n].Description}
	${dateformat(“dd-MM-yyyy”):AffectedVersions[n].Start date}
	${dateformat(“dd-MM-yyyy”):AffectedVersions[n].Release date}
	${AffectedVersions[n].Archived}
	${AffectedVersions[n].Released}
#{end}

or

#{for <VariableName>=AffectedVersions}
   Content and Versions Issue Mappings. Example: ${AffectedVersions[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over affected versions that an issue belongs to.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over an affected versions that an issue belongs to.

Image Removed

or

Image Removed

Iterating Project Versions

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

...

Boolean that indicates if the version is released or not
Code Block
titleExpand to see the smaple code
collapsetrue
#{for projectVersions}
	${ProjectVersions[n].Name}
	${ProjectVersions[n].Description}
	${dateformat(“dd-MM-yyyy”):ProjectVersions[n].Start date}
	${dateformat(“dd-MM-yyyy”):ProjectVersions[n].Release date}
	${ProjectVersions[n].Archived}
	${ProjectVersions[n].Released}
#{end}

or

#{for <VariableName>=ProjectVersionsCount}
   Content and Project Versions Mappings. Example: ${ProjectVersions[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel template that iterates over all the issue project versions.

Image Added Iterations_ProjectVersions.docx

Image Added Iterations_ProjectVersions.xlsx

...

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:

Links FieldsDescription
LinkTypeThe type of the link
KeyThe key of the linked issue
SummaryThe summary of the linked issue
URL

The URL of the link

Code Block
titleExpand to see the sample code
collapsetrue
#{for links}
   ${Links[n].LinkType}
   ${Links[n].Key}
   ${Links[n].Summary}
   ${Links[n].URL
Code Block
titleExpand to see the smaple code
collapsetrue
#{for projectVersions}
	${ProjectVersions[n].Name}
	${ProjectVersions[n].Description}
	${dateformat(“dd-MM-yyyy”):ProjectVersions[n].Start date}
	${dateformat(“dd-MM-yyyy”):ProjectVersions[n].Release date}
	${ProjectVersions[n].Archived}
	${ProjectVersions[n].Released}
#{end}

or

#{for <VariableName>=ProjectVersions}
   Content and Project Versions Mappings. Example: ${ProjectVersions[VariableName].Field}
#{end}

The image below demonstrates an example of a Word template that iterates over project versions that an issue belongs to.

Image Removed

or

Image Removed

The image below demonstrates an example of an Excel template that iterates over project versions that an issue belongs to.

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

Code Block
titleExpand to see the sample code
collapsetrue
#{for links}
   ${Links[n].AppType}
   ${Links[n].LinkType}
   ${Links[n].Key}
   ${Links[n].Summary}
   ${Links[n].URL}
#{end}
 
or
 
#{for <VariableName>=LinksCount}
   Content and Linked Issue Mappings. Example: ${Links[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: 

...

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

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

Image Removed

Iterating Issue Subtasks

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:

...

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 Removed

or

Image Removed

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

Image Removed

or

Image Removed

Iterating Preconditions

From a Precondition, it's possible to export the following Xray data: Tests.

In addition to the usual Jira mappings, you can export the following fields:

  • PreCondition.Type
  • PreCondition.Definition
  • PreConditionsCount
Code Block
titleSome mappings we can export from a Pre-condition
Key: ${Key}
Summary: ${Summary}
Type: ${PreCondition.Type}
Definition: ${PreCondition.Definition}
Count: ${PreConditionsCount}

Exporting Tests from a Precondition

Below you can find an example on how to iterate over the list of Tests associated with a Pre-condition.

Code Block
titleIterate over tests
Total number of associated tests: ${TestsCount}

// Iterating each test
#{for tests}
	Key: ${Tests[n].Key}
	Test Status: ${Tests[n].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[n].TestStepsCount}
		Action: ${Tests[n].TestSteps[m].Action}
		Data: ${Tests[n].TestSteps[m].Data}
		Expected Result: ${Tests[n].TestSteps[m].ExpectedResult}
	#{end}
#{end}
 
or
 
// Iterating each test
#{for j=TestsCount}
	Key: ${Tests[j].Key}
	Test Status: ${Tests[j].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[j].TestStepsCount}
		Action: ${Tests[j].TestSteps[m].Action}
		Data: ${Tests[j].TestSteps[m].Data}
		Expected Result: ${Tests[j].TestSteps[m].ExpectedResult}
	#{end}
#{end}

For more detailed information on how to export Tests and its information please check the Test section.

Iterating Tests

From a Test, it's possible to export the following Xray data: Preconditions, Test Sets, TestPlans, Test Executions, and Test Runs.

In addition to the usual Jira mappings, you can export the following fields:

  • Cucumber Scenario
  • Generic Test Definition
  • TestType
  • TestStatus
  • TestStepsCount
  • TestsCount
Code Block
titleSome mappings we can export from a Test
Key: ${Key}
Cucumber Scenario: ${Cucumber Scenario}
Generic Test Definition: ${Generic Test Definition}
Test Type: ${TestType}
Test Status: ${TestStatus}
Test Steps Total: ${TestStepsCount}
Tests Count: ${TestsCount}

Exporting Test Steps from a Test

For each Test Step you can export the following fields:

  • Action
  • AttachmentsCount
  • Data
  • ExpectedResult
  • StepNumber

Below you can find an example on how to iterate over the list of TestSteps associated with a Test.

Code Block
titleIterate over test steps
Total number of associated test steps: ${TestStepsCount}

// Iterating each test step
#{for teststeps}
	 Action: ${TestSteps[n].Action}
     Data: ${TestSteps[n].Data}
     Expected Result: ${TestSteps[n].ExpectedResult}
     Step Number: ${TestSteps[n].StepNumber}
     // Iterating over attachments for each test step
     #{for l=TestSteps[n].AttachmentsCount}
     	Id: ${TestSteps[n].Attachments[l].Id}
        Name: ${TestSteps[n].Attachments[l].Name}
        Image: ${TestSteps[n].Attachments[l].Image}
        FileURL: ${TestSteps[n].Attachments[l].FileURL}
     #{end}
#{end}
 
or
 
// Iterating each test step
#{for j=TestStepsCount}
	 Action: ${TestSteps[j].Action}
     Data: ${TestSteps[j].Data}
     Expected Result: ${TestSteps[j].ExpectedResult}
     Step Number: ${TestSteps[j].StepNumber}
     // Iterating over attachments for each test step
     #{for l=TestSteps[j].AttachmentsCount}
     	Id: ${TestSteps[j].Attachments[l].Id}
        Name: ${TestSteps[j].Attachments[l].Name}
		Image: ${TestSteps[n].Attachments[l].Image}
        FileURL: ${TestSteps[n].Attachments[l].FileURL}
     #{end}
#{end}

Exporting Preconditions from a Test

Below you can find an example on how to iterate over the list of Preconditions associated with a Test.

Code Block
titleIterate over preconditions
Total number of associated preconditions: ${PreConditionsCount}

// Iterating each precondition
#{for preconditions}
	Key: ${PreConditions[n].Key}
	Type: ${PreConditions[n].PreCondition.Type}
	Definition: ${PreConditions[n].PreCondition.Definition}
#{end}
 
or
 
// Iterating each precondition
#{for j=PreConditionsCount}
	Summary: ${PreConditions[j].Summary}
	Type: ${PreConditions[j].PreCondition.Type}
	Definition: ${PreConditions[j].PreCondition.Definition}
#{end}

For more detailed information on how to export Pre-conditions and its information please check the Precondition section.

Exporting Test Sets from a Test

Below you can find an example on how to iterate over the list of TestSets associated with a Test.

Code Block
titleIterate over test sets
Total number of associated test sets: ${TestSetsCount}

// Iterating each test set
#{for testSets}
	Description: ${TestSets[n].Description}
#{end}
 
or
 
// Iterating each test set
#{for j=TestSetsCount}
	Summary: ${TestSets[j].Summary}
#{end}

For more detailed information on how to export Test Sets and its information please check the Test Set section.

Exporting Test Plans from a Test

Below you can find an example on how to iterate over the list of TestPlans associated with a Test.

Code Block
titleIterate over test plans
Total number of associated test plans: ${TestPlansCount}

// Iterating each test plan
#{for testPlans}
	Summary: ${TestPlans[n].Summary}
#{end}
 
or
 
// Iterating each test plan
#{for j=TestPlansCount}
	Description: ${TestPlans[j].Description}
#{end}

For more detailed information on how to export Test Plans and its information please check the Test Plan section.

Exporting Test Executions from a Test

Below you can find an example on how to iterate over the list of TestExecutions associated with a Test.

Code Block
titleIterate over test executions
Total number of associated test executions: ${TestExecutionsCount}

// Iterating each test execution
#{for testExecutions}
	Key: ${TestExecutions[n].Key}
	Test Environments: ${TestExecutions[n].TestEnvironments}
#{end}
 
or
 
// Iterating each test execution
#{for j=TestExecutionsCount}
	Summary: ${TestExecutions[j].Summary}
	Test Environments: ${TestExecutions[j].TestEnvironments}
#{end}

For more detailed information on how to export Test Executions and its information please check the Test Execution section.

Exporting Test Runs from a Test

Below you can find an example on how to iterate over the list of TestRuns associated with a Test.

Code Block
titleIterate over test runs
Total number of associated test runs: ${TestRunsCount}

// Iterating each test run
#{for testruns}
    Assignee Id: ${TestRuns[n].AssigneeId}
    Key: ${TestRuns[n].Key}
    Summary: ${TestRuns[n].Summary}
    Comment: ${TestRuns[n].Comment}
    Generic Test Definition: ${TestRuns[n].Generic Test Definition}
    Cucumber Scenario: ${TestRuns[n].Cucumber Scenario}
    Executed by: ${TestRuns[n].Executed By}
    Execution Status: ${TestRuns[n].Execution Status}
    Started on: ${TestRuns[n].Started On}
    Finished on: ${TestRuns[n].Finished On}

    // Iterating over execution evidences for each test run
    Execution Evidences Total: ${TestRuns[n].ExecutionEvidencesCount}
    #{for m=TestRuns[n].ExecutionEvidencesCount}
        Id: ${TestRuns[n].ExecutionEvidences[m].Id}
        Name: ${TestRuns[n].ExecutionEvidences[m].Name}
    #{end}

    // Iterating over execution defects for each test run
    Execution Defects Total: ${TestRuns[n].ExecutionDefectsCount}
    #{for m=TestRuns[n].ExecutionDefectsCount}
        Id: ${TestRuns[n].ExecutionDefects[m].Id}
        Description: ${TestRuns[n].ExecutionDefects[m].Description}
        Key: ${TestRuns[n].ExecutionDefects[m].Key}
        Summary: ${TestRuns[n].ExecutionDefects[m].Summary}
    #{end}

    // Iterating over test steps for each test run
    Test Steps Total: ${TestRuns[n].TestStepsCount}
    #{for m=TestRuns[n].TestStepsCount}
        Action: ${TestRuns[n].TestSteps[m].Action}
        Comment: ${TestRuns[n].TestSteps[m].Comment}
        Data: ${TestRuns[n].TestSteps[m].Data}
        Expected Result: ${TestRuns[n].TestSteps[m].ExpectedResult}
		Actual Result: ${TestRuns[n].TestSteps[m].ActualResult}
        Status: ${TestRuns[n].TestSteps[m].Status}
        Step Number: ${TestRuns[n].TestSteps[m].StepNumber}
        // Iterating over attachments for each test step
        #{for l=TestRuns[n].TestSteps[m].AttachmentsCount}
            Id: ${TestRuns[n].TestSteps[m].Attachments[l].Id}
            Name: ${TestRuns[n].TestSteps[m].Attachments[l].Name}
            Image: ${TestRuns[n].TestSteps[m].Attachments[l].Image}
            FileURL: ${TestRuns[n].TestSteps[m].Attachments[l].FileURL}
        #{end}
        // Iterating over evidences for each test step
        #{for l=TestRuns[n].TestSteps[m].EvidencesCount}
            Id: ${TestRuns[n].TestSteps[m].Evidences[l].Id}
            Name: ${TestRuns[n].TestSteps[m].Evidences[l].Name}
        #{end}
        // Iterating over defects for each test step
        #{for l=TestRuns[n].TestSteps[m].DefectsCount}
            Description: ${TestRuns[n].TestSteps[m].Defects[l].Description}
            Id: ${TestRuns[n].TestSteps[m].Defects[l].Id}
            Key: ${TestRuns[n].TestSteps[m].Defects[l].Key}
            Summary: ${TestRuns[n].TestSteps[m].Defects[l].Summary}
        #{end}
    #{end}
#{end}

Iterating Test Executions

From a Test Execution, it's possible to export the following Xray data: Tests and Test Runs.

In addition to the usual Jira mappings, you can export the following fields:

  • TestEnvironments
Code Block
titleSome mappings we can export from a Test Execution
Key: ${Key}
Description: ${Description}
Test Environments: ${TestEnvironments}

#Overall Execution Status (percentage + total of testes per status)
TO DO: ${Overall Execution Status.TO DO.Percentage}% - ${Overall Execution Status.TO DO.Count}
EXECUTING: ${Overall Execution Status.EXECUTING.Percentage}% - ${Overall Execution Status.EXECUTING.Count}
PASSED: ${Overall Execution Status.PASSED.Percentage}% - ${Overall Execution Status.PASSED.Count}
FAILED: ${Overall Execution Status.FAILED.Percentage}% - ${Overall Execution Status.FAILED.Count}
ABORTED: ${Overall Execution Status.ABORTED.Percentage}% - ${Overall Execution Status.ABORTED.Count}

Exporting Tests from a Test Execution

Below you can find an example on how to iterate over the list of Tests associated with a Test Execution.

Code Block
titleIterate over tests
Total number of associated tests: ${TestsCount}

// Iterating each test
#{for tests}
	Key: ${Tests[n].Key}
	Test Status: ${Tests[n].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[n].TestStepsCount}
		Action: ${Tests[n].TestSteps[m].Action}
		Data: ${Tests[n].TestSteps[m].Data}
		Expected Result: ${Tests[n].TestSteps[m].ExpectedResult}
	#{end}
#{end}
 
or
 
// Iterating each test
#{for j=TestsCount}
	Key: ${Tests[j].Key}
	Test Status: ${Tests[j].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[j].TestStepsCount}
		Action: ${Tests[j].TestSteps[m].Action}
		Data: ${Tests[j].TestSteps[m].Data}
		Expected Result: ${Tests[j].TestSteps[m].ExpectedResult}
	#{end}
#{end}

For more detailed information on how to export Tests and its information please check the Test section.

Exporting Test Plans from a Test Execution

Below you can find an example on how to iterate over the list of TestPlans associated with a Test Execution.

Code Block
titleIterate over test plans
Total number of associated test plans: ${TestPlansCount}

// Iterating each test plan
#{for testPlans}
	Summary: ${TestPlans[n].Summary}
#{end}
 
or
 
// Iterating each test plan
#{for j=TestPlansCount}
	Description: ${TestPlans[j].Description}
#{end}

For more detailed information on how to export Test Plans and its information please check the Test Plan page.

Exporting Test Runs from a Test Execution

Below you can find an example on how to iterate over the list of TestRuns associated with a Test Execution.

Code Block
titleIterate over test runs
Total number of associated test runs: ${TestRunsCount}

// Iterating each test run
#{for testruns}
    Assignee Id: ${TestRuns[n].AssigneeId}
    Key: ${TestRuns[n].Key}
    Summary: ${TestRuns[n].Summary}
    Comment: ${TestRuns[n].Comment}
    Generic Test Definition: ${TestRuns[n].Generic Test Definition}
    Cucumber Scenario: ${TestRuns[n].Cucumber Scenario}
    Executed by: ${fullname:TestRuns[n].Executed By}
    Execution Status: ${TestRuns[n].Execution Status}
    Started on: ${TestRuns[n].Started On}
    Finished on: ${TestRuns[n].Finished On}

    // Iterating over execution evidences for each test run
    Execution Evidences Total: ${TestRuns[n].ExecutionEvidencesCount}
    #{for m=TestRuns[n].ExecutionEvidencesCount}
        Id: ${TestRuns[n].ExecutionEvidences[m].Id}
        Name: ${TestRuns[n].ExecutionEvidences[m].Name}
        Size: ${TestRuns[n].ExecutionEvidences[m].Size}
        HumanReadableSize: ${TestRuns[n].ExecutionEvidences[m].HumanReadableSize}
        Created: ${TestRuns[n].ExecutionEvidences[m].Created}
        MimeType: ${TestRuns[n].ExecutionEvidences[m].MimeType}
        Evidence: ${TestRuns[n].ExecutionEvidences[m].Evidence}
        FileURL: ${TestRuns[n].ExecutionEvidences[m].FileURL}
    #{end}

    // Iterating over execution defects for each test run
    Execution Defects Total: ${TestRuns[n].ExecutionDefectsCount}
    #{for m=TestRuns[n].ExecutionDefectsCount}
        Id: ${TestRuns[n].ExecutionDefects[m].Id}
        Description: ${TestRuns[n].ExecutionDefects[m].Description}
        Key: ${TestRuns[n].ExecutionDefects[m].Key}
        Summary: ${TestRuns[n].ExecutionDefects[m].Summary}
    #{end}

    // Iterating over test steps for each test run
    Test Steps Total: ${TestRuns[n].TestStepsCount}
    #{for m=TestRuns[n].TestStepsCount}
        Action: ${TestRuns[n].TestSteps[m].Action}
        Comment: ${TestRuns[n].TestSteps[m].Comment}
        Data: ${TestRuns[n].TestSteps[m].Data}
        Expected Result: ${TestRuns[n].TestSteps[m].ExpectedResult}
		Actual Result: ${TestRuns[n].TestSteps[m].ActualResult}
        Status: ${TestRuns[n].TestSteps[m].Status}
        Step Number: ${TestRuns[n].TestSteps[m].StepNumber}
        // Iterating over attachments for each test step
        #{for l=TestRuns[n].TestSteps[m].AttachmentsCount}
            Id: ${TestRuns[n].TestSteps[m].Attachments[l].Id}
            Name: ${TestRuns[n].TestSteps[m].Attachments[l].Name}
            Image: ${TestRuns[n].TestSteps[m].Attachments[l].Image}
            FileURL: ${TestRuns[n].TestSteps[m].Attachments[l].FileURL}
        #{end}
        // Iterating over evidences for each test step
        #{for l=TestRuns[n].TestSteps[m].EvidencesCount}
            Id: ${TestRuns[n].TestSteps[m].Evidences[l].Id}
            Name: ${TestRuns[n].TestSteps[m].Evidences[l].Name}
			Size: ${TestRuns[n].TestSteps[m].Evidences[l].Size}
			HumanReadableSize: ${TestRuns[n].TestSteps[m].Evidences[l].HumanReadableSize}
			Created: ${TestRuns[n].TestSteps[m].Evidences[l].Created}
			MimeType: ${TestRuns[n].TestSteps[m].Evidences[l].MimeType}
			Evidence: ${TestRuns[n].TestSteps[m].Evidences[l].Evidence}
			FileURL: ${TestRuns[n].TestSteps[m].Evidences[l].FileURL}
        #{end}
        // Iterating over defects for each test step
        #{for l=TestRuns[n].TestSteps[m].DefectsCount}
            Description: ${TestRuns[n].TestSteps[m].Defects[l].Description}
            Id: ${TestRuns[n].TestSteps[m].Defects[l].Id}
            Key: ${TestRuns[n].TestSteps[m].Defects[l].Key}
            Summary: ${TestRuns[n].TestSteps[m].Defects[l].Summary}
        #{end}
    #{end}
#{end}

Iterating Test Plans

From a Test Plan, it's possible to export the following Xray data: Tests and Test Executions.

Given that the Test Plan behaves like a regular JIRA issue, you can also export any other JIRA field.

Code Block
titleSome general mappings we can export from a Test Plan
Key: ${Key}
Description: ${Description}

#Overall Execution Status (percentage + total of testes per status)
TO DO: ${Overall Execution Status.TO DO.Percentage}% - ${Overall Execution Status.TO DO.Count}
EXECUTING: ${Overall Execution Status.EXECUTING.Percentage}% - ${Overall Execution Status.EXECUTING.Count}
PASSED: ${Overall Execution Status.PASSED.Percentage}% - ${Overall Execution Status.PASSED.Count}
FAILED: ${Overall Execution Status.FAILED.Percentage}% - ${Overall Execution Status.FAILED.Count}
ABORTED: ${Overall Execution Status.ABORTED.Percentage}% - ${Overall Execution Status.ABORTED.Count}

Exporting Tests from a Test Plan

Below you can find an example on how to iterate over the list of Tests associated with a Test Plan.

Code Block
titleIterate over tests
Total number of associated tests: ${TestsCount}

// Iterating each test
#{for tests}
	Key: ${Tests[n].Key}
	Test Status: ${Tests[n].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[n].TestStepsCount}
		Action: ${Tests[n].TestSteps[m].Action}
		Data: ${Tests[n].TestSteps[m].Data}
		Expected Result: ${Tests[n].TestSteps[m].ExpectedResult}
	#{end}
#{end}
 
or
 
// Iterating each test
#{for j=TestsCount}
	Key: ${Tests[j].Key}
	Test Status: ${Tests[j].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[j].TestStepsCount}
		Action: ${Tests[j].TestSteps[m].Action}
		Data: ${Tests[j].TestSteps[m].Data}
		Expected Result: ${Tests[j].TestSteps[m].ExpectedResult}
	#{end}
#{end}

For more detailed information on how to export Tests and its information please check the Test section.

Exporting Test Executions from a Test Plan

Below you can find an example on how to iterate over the list of TestExecutions associated with a Test.

Code Block
titleIterate over test executions
Total number of associated test executions: ${TestExecutionsCount}

// Iterating each test execution
#{for testExecutions}
	Key: ${TestExecutions[n].Key}
	Test Environments: ${TestExecutions[n].TestEnvironments}
#{end}
 
or
 
// Iterating each test execution
#{for j<VariableName>=TestExecutionsCountLinksCount}
	Summary: ${TestExecutions[j].Summary}
	Test Environments   Content and Linked Issue Mappings. Example: ${TestExecutionsLinks[jVariableName].TestEnvironmentsField}
#{end}

// Print the Test Execution issue keys
${TestExecutionKeys}

For more detailed information on how to export Test Executions and its information please check the Test Execution section.

Iterating Test Sets

From a Test Set, it's possible to export the following Xray data: Tests.

Given that the Test Set behaves like a regular Jira issue, you can also export any other Jira field.

Code Block
titleSome general mappings we can export from a Test Set
Key: ${Key}
Description: ${Description}

#Overall Execution Status (percentage + total of testes per status)
TO DO: ${Overall Execution Status.TO DO.Percentage}% - ${Overall Execution Status.TO DO.Count}
EXECUTING: ${Overall Execution Status.EXECUTING.Percentage}% - ${Overall Execution Status.EXECUTING.Count}
PASSED: ${Overall Execution Status.PASSED.Percentage}% - ${Overall Execution Status.PASSED.Count}
FAILED: ${Overall Execution Status.FAILED.Percentage}% - ${Overall Execution Status.FAILED.Count}
ABORTED: ${Overall Execution Status.ABORTED.Percentage}% - ${Overall Execution Status.ABORTED.Count}

Exporting Tests from a Test Set

Below you can find an example on how to iterate over the list of Tests associated with a Test Set.

Code Block
titleIterate over Tests
Total number of associated tests: ${TestsCount}

// Iterating each test
#{for tests}
	Key: ${Tests[n].Key}
	Test Status: ${Tests[n].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[n].TestStepsCount}
		Action: ${Tests[n].TestSteps[m].Action}
		Data: ${Tests[n].TestSteps[m].Data}
        Expected Result: ${Tests[n].TestSteps[m].ExpectedResult}
	#{end}
#{end}
 
or
 
// Iterating each test
#{for j=TestsCount}
	Key: ${Tests[j].Key}
	Test Status: ${Tests[j].TestStatus}
	// Iterating over test steps for each test
	#{for m=Tests[j].TestStepsCount}
		Action: ${Tests[j].TestSteps[m].Action}
		Data: ${Tests[j].TestSteps[m].Data}
		Expected Result: ${Tests[j].TestSteps[m].ExpectedResult}
	#{end}
#{end}

The documents below demonstrate examples both in Word and Excel template that iterates over all the issue links.

Image Added Iterations_Links.docx

Image Added Iterations_Links.xlsx

...

Iterating Issue Subtasks

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 documents below demonstrate examples both in Word and Excel template that iterates over all the issue subtasks.

Image Added Iterations_Subtasks.docx

Image Added Iterations_Subtasks.docx

...

Iterating Issues In Epic

All fields listed here are available on IssuesInEpic[n] because they represent an issue.

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

Code Block
titleExpand to see the sample code
collapsetrue
#{for IssuesInEpic}
   ${IssuesInEpic[n].Key}
   ${IssuesInEpic[n].Summary}
   ${IssuesInEpic[n].Description}
   ${IssuesInEpic[n].Epic Link.Key}
#{end}
 
or
 
#{for <VariableName>=IssuesInEpicCount}
   Content and Issue Mappings. Example: ${IssuesInEpic[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel template that iterates over the issues in epic.

Image Added Iterating_Issues_In_Epic.docx

Image Added Iterating_Issues_In_Epic.xlsx

...

Iterating Project Components

You can iterate over all project components. The notation is:

Code Block
titleExpand to see the sample code
collapsetrue
#{for ProjectComponents}
   ${ProjectComponents[n].Name}
   ${ProjectComponents[n].Description}
   ${fullname:ProjectComponents[n].Lead}
   ${ProjectComponents[n].Id}
   ${ProjectComponents[n].ProjectId}
   ${ProjectComponents[n].AssigneeType}
#{end}

#{for <VariableName>=ProjectComponentsCount}
   Content and Components Mappings. Example: ${ProjectComponents[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel template that iterates over the project components.

Image Added Iterating_Issue_ProjectComponents.docx

Image Added Iterating_Issue_ProjectComponents.xlsxFor more detailed information on how to export Tests and its information please check the Test page.

...

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:

...

It is also possible to format fields inside iteration filters.

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

Links Bugs with High Priority:Image Removed

Image Added Links_with_Filter.docx

Image Added Links_with_Filter.xlsx

Nested Iterations:Image Removed

Image Added Links_with_nested_Iterations.docx

Image Added Links_with_nested_Iterations.xlsx

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

...

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.

...

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.

...

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, Xporter 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 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 continue to the next iteration, not printing the Author of the "World" comment.

...

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:

...

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 Bulk export

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

...