Introduction
With Xporter 5.1.0 and higher and Structure 4.0, it's possible to export your structures directly from their screens, with the full capabilities of the Xporter App reporting engine!
Prerequisites:
- Structure 4.0
- Xporter 5.1.0
Configurations
There are two configurations needed to ensure you can export your structures.
- Enable Xporter for Jira in Structure in Xporter Integrations (Xporter administration).
- Have Xporter Templates configured with the STRUCTURE scope (this scope is only available when Structure is present.)
Template Syntax
There are some structure-related syntax changes in Xporter for Jira templates in order to export all of your Structure.
Note
These syntax changes won't affect your templates or the way Xporter processes previous exports.
&{for entries}
On multiple issue exports, use &{for issues}. Outside this iteration block are static parts of the document. Within the &{for entries} block, a dynamic section will iterate all top-level rows from your structure (i.e., all rows without indentation).
ChildrenCount
In order to access all rows from your structure, you can iterate through each row's direct children (i.e., all subsequent rows with exactly one more indentation than the current row.) It's possible to export ${ChildrenCount} on any row, resulting in the number of direct children. This should be treated as any Xporter for Jira iteration.
&{for entries} ${Key} #{for children} ${Children[n].Key} #{for p=Children[n].ChildrenCount} ${Children[n].Children[p].Key} #{end} #{end} &{end}
Row placeholders
There are some placeholders that will always be available for any row, regardless of type (issue, user, component, etc.).
StructureName | Refers to the Structure name. |
Key | Refers to the value present on the Key column in the Structure screen. |
Name | Refers to the value present on the Name column in the Structure screen. |
Summary | Refers to the value present on the Summary column in the Structure screen. |
Description | Refers to the value present on the Description column in the Structure screen. |
URL | The URL of the item represented on the row. |
DataType | Refers to the item type represented on the row. Some example are "Issue", "Component", "Project", "Version", "Folder", "User", "Status", ... |
Issue placeholders
For any row representing an Issue, it's possible to extract its data (native fields, custom fields, iterations, etc.) like any other Xporter for Jira export.
Export from Issue screen
You can also export the Structure information present on the Issue screen by using the Xporter for Jira web panel. Just use the iteration ChildrenCount to iterate through each row.
Compatibility Matrix
Xporter for Jira Version | Structure Version |
---|---|
5.1.0 - 6.4.1 | < 6.0.0 |
>= 6.4.2 | >= 6.0.0 |