Breadcrumbs

Page History

Versions Compared

Key

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

Table of Contents

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:

...

Code Block

title	Expand to see the sample code
collapse	true

#{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 image below demonstrates an example of a Word The documents below demonstrate examples both in Word and Excel template that iterates over all the issue comments.

Image Removed

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

Image Removed

...

Image Added Iterations_Comments.docx

Image Added Iterations_Comments.xlsx

...

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)

Code Block

title	Expand to see the sample code
collapse	true

#{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 image below demonstrates an example of a Word documents below demonstrate examples both in Word and Excel template that iterates over all the issue worklogscomments.

Image Removed

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

Image Removed

Image Added Iterations_Worklogs.docx

Image Added Iterations_Worklogs.xlsx Image Removed

...

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:

...

Code Block

title	Expand to see the sample code
collapse	true

#{for components}
   ${Components[n].Name}
   ${Components[n].Description}
   ${fullname:Components[n].Lead}
   ${Components[n].Id}
   ${Components[n].ProjectId}
   ${Components[n].AssigneeType}
#{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 componentscomments.

Image Removed

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

Image AddedIterating_Issue_Components.docx

Image RemovedImage Added 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:

...

Code Block

title	Expand to see the sample code
collapse	true

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

Image Removed

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

Image Removed

Image Added Iterations_StatusTransitions.docx

Image Added Iterations_StatusTransitions.xlsxImage Removed

...

Iterating Issue Attached Images

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

...

Code Block

title	Expand to see the sample code
collapse	true

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

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

Image Removed

all the issue comments.

Image Added Iterations_AttachedImages.docx

Image Added Iterations_StatusTransitions.xlsxImage 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.

...

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

Iterating Issue Attachments

...

Iterating Issue Attachments

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

...

Code Block

title	Expand to see the sample code
collapse	true

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

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

Image Removed

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

Image Removed

Image Added Iterations_Attachments.docx

Image RemovedImage 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:

...

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

Image Removed

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

Image Removed

Image Added Iterations_Labels.docx

Image RemovedImage Added Iterations_Labels.xlsx

...

Iterating Fix Versions of an Issue

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

...

Code Block

title	Expand to see the smaple code
collapse	true

#{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>=FixVersionsFixVersionsCount}
   Content and Versions Issue Mappings. Example: ${FixVersions[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 fix versions that an issue belongs to.

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

...

all the issue comments.

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 to. The notation is:

...

Code Block

title	Expand to see the sample code
collapse	true

#{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>=AffectedVersionsAffectedVersionsCount}
   Content and Versions Issue Mappings. Example: ${AffectedVersions[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 affected versions that an issue belongs to.

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

Iterating Project Versions

all the issue comments.

Image Added Iterating_Issue_AffectedVersions.docx

Image Added Iterating_Issue_AffectedVersions.xlsx

...

Iterating Project Versions

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

...

Code Block

title	Expand to see the smaple code
collapse	true

#{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>=ProjectVersionsProjectVersionsCount}
   Content and Project Versions Mappings. Example: ${ProjectVersions[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 project versions that an issue belongs to.

Image Removed

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

Image Removed

all the issue comments.

Image Added Iterations_ProjectVersions.docx

Image RemovedImage 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:

...

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

Image Removed

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

Image Added Iterations_Links.docx

Image Added Iterations_Links.xlsxImage 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

title	Expand to see the sample code
collapse	true

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

Image Removed

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

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

title	Some 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

title	Iterate 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

title	Some 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

title	Iterate 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].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.

Code Block

title	Iterate 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

title	Iterate 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

title	Iterate 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

title	Iterate 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

title	Iterate 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}
		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

Code Block

title	Some 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

title	Iterate 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

title	Iterate 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

title	Iterate 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

title	Some 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

title	Iterate 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

title	Iterate 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}

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

title	Some 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

title	Iterate 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}

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

title	Expand to see the sample code
collapse	true

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

title	Expand to see the sample code
collapse	true

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

title	Expand to see the sample code
collapse	true

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

title	Expand to see the sample code
collapse	true

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

title	Expand to see the sample code
collapse	true

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

title	Expand to see the sample code
collapse	true

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.

...

Content

Space Tools

Breadcrumbs

Page History

Versions Compared

Old Version 3

New Version 4

Key

Iterating Issue Comments

Iterating Issue Worklogs

Iterating Issue Components

Iterating Issue Status Transitions

Iterating Issue Attached Images

Iterating Issue Attachments

Iterating Issue Attachments

Iterating Issue Labels

Iterating Fix Versions of an Issue

Iterating Affected Versions of an Issue

Iterating Project Versions

Iterating Project Versions

Iterating Issue Links

Iterating Issue Subtasks

Iterating Preconditions

Exporting Tests from a Precondition

Iterating Tests

Exporting Test Steps from a Test

Exporting Preconditions from a Test

Exporting Test Sets from a Test

Exporting Test Plans from a Test

Exporting Test Executions from a Test

Exporting Test Runs from a Test

Iterating Test Executions

Exporting Tests from a Test Execution

Exporting Test Plans from a Test Execution

Exporting Test Runs from a Test Execution

Iterating Test Plans

Exporting Tests from a Test Plan

Exporting Test Executions from a Test Plan

Iterating Test Sets

Exporting Tests from a Test Set

Iterating Issues In Epic

Iterating Project Components

Applying filters to Iterations

Iterating in the same line of the document

Iterating in the same cell in an Excel document

Iterating with the BREAK or CONTINUE statement

Sorting iterations

Sort By Bulk export