Document toolboxDocument toolbox

This article is for Data Center. Visit Cloud

Structure Backup, Restore and Migration

Owned by Jaramy Conners
Last updated: May 16, 2024
2 min read

Structure data can be backed up and restored separately from other Jira data. Structure data includes structures, hierarchies (forests), generators, synchronizers, folders - everything added to Jira by the Structure add-on. Structure backup does not include issue or other items data (except for some attributes that are added to enable migration.)

You need Jira System Administrators global permission to back up, restore or migrate Structure data.

Starting with Structure 3, when you fully back up Jira, Structure data is also backed up – it is stored in the same database as the Jira data. However, you can use the separate backup to:

  • Restore only Structure data, without changing Jira data
  • Migrate structures to other servers (following a Project Import in Jira, for example)
  • Export Structure data to some other tool by parsing the backup XML

Using Structure Backup

Structure can use a backup file in two ways:

  • Full structure restore. This operation replaces all existing structure data (if any) with the data stored in the backup file. This operation refers to issues and other items by their numeric IDs (not issue keys!), so the issues must be present in Jira before this operation is run, and issue IDs must be the same as they were at the time the Structure backup file was created.

    Issue IDs are preserved if the Jira instance is fully restored from a backup with the Restore System command. Issue IDs are not preserved if the issues are moved to another Jira instance with Jira's Project Import feature – in this case, you should use the migration option below.

  • Migration / partial import. This operation lets you restore one or more structures backed up from a different Jira instance (assuming the issues have been moved over with the Jira's Project Import command). It also allows you to merge the backup structure data with the structure data already existing on your Jira.

    A structure in a backup file cannot be restored if it refers to issues in a project that is not present in the Jira instance.