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:
Comments Fields | Description |
---|---|
Author | The author of the comment |
AuthorFullName | The full name of the author of the comment |
Body | The comment |
Created | The date the comment was posted |
GroupLevel | The group level of the comment |
The image below demonstrates an example of a Word template that iterates over issue comments.
or
The image below demonstrates an example of an Excel template that iterates over issue comments.
or
Iterating Issue Worklogs
Because it is not known in advance how many work logs 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:
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 |
BillableSeconds | The billable seconds (Belongs to Tempo Timesheets plugin) |
The image below demonstrates an example of a Word template that iterates over issue worklogs.
or
The image below demonstrates an example of a template in Excel that iterates over issue work logs.
or
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:
Components Fields | Description |
---|---|
Name | The name of the component |
Description | The description of the component |
Lead | The name of the component lead |
Id | The ID of the component |
ProjectId | The project ID of the component |
AssigneeType | The assignee type of the component |
The image below demonstrates an example of a Word template that iterates over issue components.
The image below demonstrates an example of an Excel template that iterates over issue components.
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:
Status Transitions Fields | Description |
---|---|
Author | The author of the status transition |
Created | The date the status transition was performed |
OldStatus | The old status of the status transition |
NewStatus | The new status of the status transition |
The image below demonstrates an example of a Word template that iterates over status transitions.
or
The image below demonstrates an example of an Excel template that iterates over status transitions.
or
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:
Attachments Images Fields | Description |
---|---|
ID | The ID of the attached image |
Image | The image of the attached image |
Name | The name of the attached image |
Size | The size of the attached image |
HumanReadableSize | The size of the attached image |
Author | The author of the attached image |
Created | The date the attached image was created |
MimeType | The type of the attached image |
ThumbnailURL | The image thumbnail URL. |
The image below demonstrates an example of a Word template that iterates over attached images.
or
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.
These values are in pixels and if you only define one of them the image will be rescaled.
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.
or
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 Fields | Description |
---|---|
ID | The ID of the attachment |
Name | The name of the attachment |
Author | The author of the attachment |
AuthorFullName | The full name of the author of the attachment |
Created | The date the attachment was created |
Size | The size of the attachment |
HumanReadableSize | The formatted size of the attachment |
MimeType | The type of attachment |
The image below demonstrates an example of a Word template that iterates over attachments.
or
The image below demonstrates an example of an Excel template that iterates over attachments.
or
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 Fields | Description |
---|---|
Name | The name of the label |
#{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.
or
The image below demonstrates an example of an Excel template that iterates over labels.
or
Iterating Fix Versions of an Issue
You can iterate over all fix versions to which the issue belong to. The notation is:
Versions Fields | Description |
---|---|
Name | The version name |
Description | The version description |
Start date | Starting date of the version |
Release date | Release date of the version |
Archived | Boolean that indicates if the version is archived or not |
Released | Boolean that indicates if the version is released or not |
The image below demonstrates an example of a Word template that iterates over fix versions that an issue belongs to.
or
The image below demonstrates an example of an Excel template that iterates over an fix versions that an issue belongs to.
or
Iterating Affected Versions of an Issue
You can iterate over all affected versions to which the issue belong to. The notation is:
Versions Fields | Description |
---|---|
Name | The version name |
Description | The version description |
Start date | Starting date of the version |
Release date | Release date of the version |
Archived | Boolean that indicates if the version is archived or not |
Released | Boolean that indicates if the version is released or not |
The image below demonstrates an example of a Word template that iterates over affected versions that an issue belongs to.
or
The image below demonstrates an example of an Excel template that iterates over an affected versions that an issue belongs to.
or
Iterating Project Versions
You can iterate over all project versions to which the issue belong to. The notation is:
Project Versions Fields | Description |
---|---|
Name | The version name |
Description | The version description |
Start date | Starting date of the version |
Release date | Release date of the version |
Archived | Boolean that indicates if the version is archived or not |
Released | Boolean that indicates if the version is released or not |
The image below demonstrates an example of a Word template that iterates over project versions that an issue belongs to.
or
The image below demonstrates an example of an Excel template that iterates over project versions that an issue belongs to.
or
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 Fields | Description |
---|---|
AppType | The application type of the link |
LinkType | The type of the link |
Key | The key of the linked issue |
Summary | The summary of the linked issue |
URL | The URL of the link |
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:
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AppType | Returns the Application Type. The values can be:
| ||||||||||
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 image below demonstrates an example of a Word template that iterates over linked issues.
or
The image below demonstrates an example of an Excel template that iterates over linked issues.
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 Fields | Description |
---|---|
Key | The key of the subtasks |
Summary | The summary of the subtasks |
AssigneeUserDisplayName | The assignee user of the subtasks |
The image below demonstrates an example of a Word template that iterates over issue subtasks.
or
The image below demonstrates an example of an Excel template that iterates over issue subtasks.
or
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
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.
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
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.
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].Attachment} 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].Attachment} 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.
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.
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.
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.
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.
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} Evidence: ${TestRuns[n].ExecutionEvidences[m].Evidence} #{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} Evidence: ${TestRuns[n].TestSteps[m].Evidences[l].Evidence} #{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
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.
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.
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.
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.
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.
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.
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} // 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.
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.
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 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:
- 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:
- 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.
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:
Nested Iterations:
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.
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.
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.
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:
Sort By Bulk export
The sortby can also be used to sort a &{for issues} iteration on a Bulk Export.
Sorting Criteria
asc and desc can be defined in order to define how do you want to sort your data. The default value is asc.