Iterating 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. 

The History tab shows the following Issue’s operations/updates:

• Changing the Test Type.
• Changing the Test Definition or Steps.
• Linking the Test with other entities (Preconditions, Test Plans, Test Sets, etc.).
• Moving the Test between folders on the Test Repository.
• Attachment addition.
• Test Execution.

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 done. 

The notation is:

#{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 <VariableName>=HistoryEntriesCount}
   Content and Issue History Mappings. Example:${fullname:HistoryEntries[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue comments.

Iterating_Issue_History.docx

Iterating_Issue_History.xlsx

Iterating Xray Issue History

Changes related to Xray fields in Xray Issues are registered in a separate tab named Xray History, as changes to these fields can not be included with the Issue changes. For this reason, there is another way of iterating Xray history changes. Just like with Issue changes, you can iterate a section over all the Xray history entries of an Issue. This allows you to create a table that dynamically grows according to the number of changes done.

The notation is:

#{for XrayHistoryEntries}
   ${fullname:XrayHistoryEntries[n].User} made changes ${dateformat("dd-MM-yyyy HH:mm:ss"):XrayHistoryEntries[n].Date}
  #{for ch=XrayHistoryEntries[n].XrayChangedItemsCount}
    Field Name: ${XrayHistoryEntries[n].XrayChangedItems[ch].Field}
    Changes:  ${XrayHistoryEntries[n].XrayChangedItems[ch].Changes}
  #{end}
#{end}
  
or
  
#{for <VariableName>=XrayHistoryEntriesCount}
   Content and Xray Issue History Mappings. Example:${fullname:XrayHistoryEntries[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue comments.

Iterating_Xray_Issue_History.docx

Iterating_Xray_Issue_History.xlsx

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:

#{for comments}
   ${Comments[n].Author} 
   ${Comments[n].AuthorFullName} 
   ${Comments[n].Body} 
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Comments[n].Created}
   ${Comments[n].GroupLevel}
#{end}
 
or
 
#{for <VariableName>=CommentsCount}
   Content and Issue Mappings. Example: ${Comments[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue comments.

Iterations_Comments.docx

Iterations_Comments.xlsx

Iterating Issue Worklogs

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

The notation is:

#{for worklogs}
   ${Worklogs[n].Author} 
   ${Worklogs[n].AuthorFullName} 
   ${Worklogs[n].Comment}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Created}
   ${dateformat("dd-MM-yyyy HH:mm:ss"):Worklogs[n].Date Started} 
   ${Worklogs[n].Time Spent}
   ${Worklogs[n].TimeSpentFormatted} 
#{end}
 
or
 
#{for <VariableName>=WorklogsCount}
   Content and Worklog Mappings. Example: ${Worklogs[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue worklogs.

Iterations_Worklogs.docx

Iterations_Worklogs.xlsx

Iterating 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:

#{for components}
   ${Components[n].Name}
   ${Components[n].Description}
   ${fullname:Components[n].Lead}
   ${Components[n].Id}
   ${Components[n].ProjectId}
   ${Components[n].AssigneeType}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue components.

Iterating_Issue_Components.docx

Iterating_Issue_Components.xlsx

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:

#{for statusTransitions}
   ${StatusTransitions[n].Author}
   ${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 documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue status transitions.

Iterations_StatusTransitions.docx

Iterations_StatusTransitions.xlsx

Iterating Issue Attached Images

Because it is not known in advance how many images can exist on 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:

#{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 documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue attached images.

Iterations_AttachedImages.docx 

Iterations_AttachedImages.xlsx

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

#{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.

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:

#{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 documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue attachments.

Iterations_Attachments.docx

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:

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

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue comments.

Iterations_Labels.docx

Iterations_Labels.xlsx

Iterating Fix Versions of an Issue

You can iterate over all fix versions that the Issue belongs to. 

The notation is:

#{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>=FixVersionsCount}
   Content and Versions Issue Mappings. Example: ${FixVersions[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue fix versions.

Iterating_Issue_FixVersions.docx

Iterating_Issue_FixVersions.xlsx

Iterating Affected Versions of an Issue

You can iterate over all affected versions that the Issue belongs to. 

The notation is:

#{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>=AffectedVersionsCount}
   Content and Versions Issue Mappings. Example: ${AffectedVersions[VariableName].Field}
#{end}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue-affected versions.

Iterating_Issue_AffectedVersions.docx

Iterating_Issue_AffectedVersions.xlsx

Iterating Project Versions

You can iterate over all project versions that the Issue belongs to.

The notation is:

#{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 templates that iterate over all the Issue project versions.

Iterations_ProjectVersions.docx

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:

#{for links}
   ${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}

The documents below demonstrate examples both in Word and Excel templates that iterate over all the Issue links.

Iterations_Links.docx

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:

#{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 templates that iterate over all the Issue subtasks.

Iterations_Subtasks.docx

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:

#{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 templates that iterate over the Issues in epic.

Iterating_Issues_In_Epic.docx

Iterating_Issues_In_Epic.xlsx

Iterating Project Components

You can iterate over all project components.

The notation is:

#{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 templates that iterate over the project components.

Iterating_Issue_ProjectComponents.docx

Iterating_Issue_ProjectComponents.xlsx

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:

#{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.

It is also possible to format fields inside iteration filters.

The documents below demonstrate examples of templates that iterate over Issue links and comments with filters being applied.

Links Bugs with High Priority:

Links_with_Filter.docx

Links_with_Filter.xlsx

Nested Iterations:

Links_with_nested_Iterations.docx

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 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. 

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.

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 Statements

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. 

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}

 
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:

Example

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.

&{for issues|sortby=IssueTypeName}
${Key} - ${IssueTypeName}
&{end}