Apps' Data and Global Configuration
- Rosen Marinkov
- Stanley Neychev
On this page:
Migration of global configuration is available since Configuration Manager for Jira (CMJ) version 6.5.0
Migration of app data is available since CMJ version 6.11.0
Introduction
As part of the App Integrations functionality, you can export and import the "global" configuration and apps' data of the apps on your system, integrating with Configuration Manager for Jira.
“Global configuration” means app data that is not related to projects, custom fields, or any other object (configuration element) in Jira.
“Apps' data” refers to any custom functionality of an app that extends standard Jira functions. For example, the “listeners” and “behaviors” in the ScriptRunner app are such functions. You can export and import app data between Jira instances with your snapshots if:
the app integrates with CMJ, and
the app has the SPI app data integration point implemented.
This feature extends the CMJ’s snapshot creation wizard.
How to migrate global configuration and app data?
System Snapshots
When creating system snapshots, you can only choose whether to include the available global configuration and apps' data of all integrated apps on your Jira system or not to include any apps' data at all.
To export global configuration and app data of all integrated apps:
Log in as a user with the Jira System Administrators global permission.
Choose the cog icon at the top right of the screen, then from the menu, choose Configuration Manager.
From the menu on the left, choose the Create Snapshot option.
Select the System Configuration button in the wizard and enter a name for the Snapshot. Optionally enter a description.
Enable the Include Global App Data checkbox.
The snapshot will include apps' global configuration and app data of all installed apps integrating with CMJ.
Project Snapshots
When creating a project snapshot, you can select the apps you want to export. Additionally, you can exclude any integrated app’s global configuration and app data.
To export global configuration and app data of integrated apps:
Log in as a user with the Jira System Administrators global permission.
Choose the cog icon at the top right of the screen, then from the menu, choose Configuration Manager.
From the menu on the left, choose the Create Snapshot option.
Select the Project Configuration button and enter a name for the snapshot.
Select as many projects as you need to include in the snapshot. Optionally enter a description.
Click Next until you reach the Select Apps page in the wizard.
Check the box next to an app, and this will include its global configuration and app data in the snapshot.
To make a more precise selection, you can expand each app and check the boxes individually next to the global configuration and app data you want to include in the snapshot.
Click the Create button.
Importing global configuration and apps' data
To import global configuration and apps' data:
From the menu on the left, choose the Deploy option.
Choose the snapshot that includes global configuration and app data. Read the documentation to learn more about configuration snapshot deployment.
On the Analyze phase, navigate to the Apps tab.
You will see messages informing you about the specific event - whether Configuration Manager for Jira adds, changes, or deletes global configuration and app data.
Click Next and finish the deployment.