Check App Integrations with CMJ

Who can use this information?

  1. Jira admins who want to move app data and configuration between Jira instances.

  2. App vendors who want to allow their customers to move app configuration and data from one Jira instance to another.

  3. Jira customers who develop apps for internal usage and want to move the app configuration and data between Jira instances.

  4. Developers who want to integrate apps with Configuration Manager for Jira (CMJ) for app data and configuration migration purposes.


On this page:

Related pages:

List of Integrated Apps

What are CMJ’s app integrations?

The various apps which enrich Jira’s features can integrate with Configuration Manager for Jira (CMJ). CMJ can export configurations and data of the integrated apps from a Jira Server/DC instance. Then, the app configuration and data can be imported into another Jira Server/DC instance with CMJ automatically.

Apps may provide custom conditions, validators, or post functions. These objects can reference other Jira objects like custom fields, users, groups, statuses, etc. Jira stores these references as properties, usually containing the ID of the referenced object.

CMJ exports references to such objects in an instance-independent manner. This approach ensures the workflow will behave the same when migrated to another Jira instance (even if the object does not exist at all).

How can Jira apps integrate with CMJ?

We’ve built an extension to CMJ called Service Provider Interface (SPI). It empowers vendors and developers to integrate their apps with CMJ. The SPI provides integration points, which the app vendors can use to integrate their apps with CMJ. This way, they extend CMJ to handle the entire configuration and data of the specific app.

You can find out more about vendor-supplied integrations in our Vendor Integration Corner.

Already integrated apps

You can see the list of apps that have integration with CMJ in our List of Integrated Apps document.

If you want to move the configuration and data of an app not yet integrated with CMJ, contact the app vendor with a request for integration.

Check app integrations on your Jira

This feature is available since Configuration Manager version 6.5.0

The App Integrations page in CMJ lists the apps on your Jira that have integration with CMJ and tracks their integration status. To check which apps on your system are integrated with CMJ, go to Settings > Configuration Manager > App Integrations (on the left).

For vendors

If you’re in the process of integrating an app with CMJ, you can use this page to validate the integration. For this purpose, during the process, you can monitor the state of your integration and its integration points.

Integration points

The App Integrations page also shows the SPI integration points that each app has implemented. The endpoints available are Custom field, Project, Workflow, Dashboard, Global Configuration, App Data, and Issue Data.
Once an app is integrated with CMJ, you’ll see these endpoints in the Integration Type column.

If there are multiple integration points between a specific app and CMJ, they all will be listed in this column. Some integration points are grouped into a single integration point shown in the column. For example, if conditions and post-functions are integration points for an app, its integration type will be Workflow.

These integration points allow CMJ to migrate any custom configuration and data, provided by the app. Let’s briefly review these integration points and their purpose.

  • Custom field
    Specific custom field configurations provided by the app can be migrated between Jira Server/DC instances with CMJ.

  • Project
    Specific app configuration attached to a project can be migrated between Jira Server/DC instances with CMJ.

  • Workflow
    Custom conditions, validators, and post-functions, provided by the app can be migrated between Jira Server/DC instances with CMJ.

  • Dashboard
    Custom dashboard gadgets provided by the app can be migrated between Jira Server/DC instances with CMJ.

  • Global Configuration
    CMJ will migrate the global app configuration if you included the app in the snapshot. Learn more

  • App Data
    Custom app data can be migrated between Jira Server/DC instances with CMJ. Learn more

  • Issue Data
    The issue data stored in the app can be migrated between Jira Server/DC instances with CMJ.

Integration states

The state of integration can be either Active or Inactive. The integration will be in an Inactive state in the following cases:

  • The app requires a newer version of CMJ so that the integration can be activated.

  • The app is disabled.

  • One or more of the app integration modules are disabled.

For each of the inactive integration use cases above, you will see an informative status message. The message marks the cause of the inactivity and provides instructions on how to activate the integration.

How are app configuration and data migrated?

When you integrate an app with CMJ with the Custom field, Workflow, and Dashboard endpoints, the relevant configuration will be included in the CMJ snapshot automatically. This means, the app’s configuration like custom fields, workflows, conditions, validators, dashboards, etc., are included by default. You don’t need to choose them explicitly during the snapshot creation.

If an app has integration with CMJ using the Global Configuration or App Data integration points, its global configuration, and app data are not automatically included in the CMJ snapshot. In this case, CMJ allows you to:

  • choose whether to include the app’s global configuration in the snapshot and

  • select the app data you want to include.

Then, you can deploy the snapshot to the target Jira Server/DC instance. Learn more on how to migrate the global configuration and data of apps integrated with CMJ.

Built-in integrations for older app versions

Built-in integrations are integrations shipped with CMJ available only for some of the most widely used Jira apps. This integration option was implemented by our team for much older versions of these apps.

Built-in integrations are no longer supported. Most of the apps that had built-in integrations already switched to vendor-supplied integrations.

App Integrations FAQ

For more information and answers to frequently asked questions, you can visit the App Integrations FAQ page.