Upgrading

General upgrade procedure is simple:

  1. Create backup of Structure data. Use Administration | Structure | Backup Structure. See Backing Up Structure for details.
  2. Install the new version of the plugin.

  3. Check Structure extensions. If you are using Structure.Testy, Structure.Pages, or other extensions, they will most likely become disabled. You need to either upgrade them too (it might be a compatibility requirement), or enabled them manually in the Add-on Manager. If they fail to enabled, reinstall them (uninstall and install again).
  4. Check plugins that integrate with Structure, such as Colors or Gantt Chart. Like with extensions, see if they are enabled and maybe upgrade or reinstall them.
  5. Monitor catalina.out or jira-application.log for warnings or errors.

For more specific instructions, please check the Release Notes for the version to which you wish to upgrade. 

Downgrading

Reverting the plugin to an older version is not always possible because newer versions can modify the database so it becomes incompatible with older versions.

Simplified Downgrade

Simple downgrade is possible if the database schema hasn't changed. Check the Release Notes for the version you are downgrading from and look for downgrade advisory. Proceed only if you have indications that it is safe to downgrade to the specific version you have in mind.

  1. Uninstall Structure plugin. This step is required because Add-on Manager will not install an earlier version over a later version.
  2. Install the version that you need.
  3. Check Structure extensions and integrating add-ons. See the steps in the Upgrading section above.
  4. Monitor catalina.out or jira-application.log for warnings or errors. This is especially important with this kind of downgrade, because some errors may be subtle and not visible to the users!

Reliable Downgrade

Reliable downgrade requires Structure backup file and manual access to the database.

  1. Create Structure backup using Administration | Structure | Backup Structure
    1. Backup files are backward / forward compatible along Structure 3.x series. You cannot use Structure 3.x backup to downgrade to Structure 2. 
    2. You can use a previously created backup file. Note that all data will be rolled back to the state when the backup file was created.
  2. Uninstall Structure add-on.
  3. Double-check you have the backup! You are about to delete all Structure data.
  4. Manually access your database using database tools. Drop all tables that start with AO_8BAD1B_. If after that you have other objects starting with that prefix, drop them too.
  5. Install previous version of Structure add-on.
  6. Use Administration | Structure | Restore Structure to populate the data from the backup file.
  7. Check Structure extensions and integrating add-ons. See the steps in the Upgrading section above.
  8. Monitor catalina.out or jira-application.log for warnings or errors.

 

Creating a backup and restoring from backup may require considerable time. If you want to speed up the process and you don't need the history of structure changes, turn off the option "Include History" when creating a backup.