CMJ - Editing Data Source of Elements Connect Fields in Configuration Manager Snapshots

CMJ - Editing Data Source of Elements Connect Fields in Configuration Manager Snapshots

This article explains how to handle Elements Connect field data sources when using Configuration Manager for Jira (CMJ) to migrate configurations between Jira environments.

Jira Environment

Data Center

Problem

When using CMJ to create a project snapshot, Elements Connect fields may reference environment-specific data sources. During deployment to a different environment, the existing data source references may no longer be valid or optimal.

Diagnosis

Elements Connect fields in Jira rely on specific data source configurations. While CMJ captures these data source settings during snapshot creation, discrepancies can occur between environments due to:

  • Different data source names or credentials

  • Environment-specific databases or endpoints

Configuration Manager for Jira manages all custom field definitions. However, Elements Connect fields have additional configurations, which include:

  • Dependencies on data sources (fully handled by CMJ)

  • Dependencies on other Jira configurable items (not all are covered)

While CMJ captures and manages the Elements Connect field data source dependencies, other related field configurations may still require manual verification post-deployment. Please refer to this documentation for the Elements Connect app : https://doc.elements-apps.com/elements-connect/latest/administration-guide/integrations/configuration-manager-integration#id-.ConfigurationManagerIntegrationv6.6-Datasourcedefinitions

 Solution

CMJ supports capturing Elements Connect field configurations and associated data sources in snapshots. To handle environment-specific data source updates, you have three options:

Option 1: Modify Before Snapshot

  • Update the Elements Connect data source in the source environment to match the desired production configuration.

  • Create the CMJ snapshot after making changes. This ensures the correct data source is included in the snapshot.

Option 2: Modify After Deployment

  • Deploy the snapshot to the target environment (e.g., production).

  • Manually update the Elements Connect data source post-deployment within the Jira UI.

Option 3 (Advanced): Modify the Snapshot File

  • Convert the binary snapshot to XML using CMJ’s built-in feature.

  • Carefully modify the data source reference in the XML file.

  • Re-zip the contents only (not the folder).

  • Deploy the updated snapshot.

⚠️ Warning: This method is not recommended unless you're experienced with CMJ snapshot structures. Incorrect modifications can invalidate the snapshot.

 Related articles