Troubleshooting CMJ deployment errors caused by automation rules and integrity checks

Troubleshooting CMJ deployment errors caused by automation rules and integrity checks

When deploying a project snapshot using Configuration Manager for Jira (CMJ), the process may fail even if the automation rules in the target environment are disabled and not included in the snapshot. This happens because CMJ performs an integrity check that validates automation rules, workflows, screens, filters, and custom fields in both the source and the destination environments. If invalid JQL, missing fields, or malformed data are detected, the deployment can be blocked to prevent inconsistencies.

In some cases, the error can also be linked to third-party app dependencies, such as automation rules using components from third-party apps. Additionally, custom fields with malformed JSON can stop the deployment until corrected.

 Instructions

  1. Verify Jira and CMJ versions

    1. Make sure the source and target environments are running the same CMJ version. The target environment should be on the same or a higher Jira version than the source.

  2. Check automation rules in the target environment

    1. Review disabled and enabled rules.

    2. Inspect all triggers, conditions, and actions for invalid JQL or references to missing fields.

    3. Fix or remove problematic rules before retrying the deployment.

  3. Run the Integrity Check

    1. Perform the Integrity Check on both the source and target instances.

    2. Resolve errors flagged in the report, even if they seem unrelated to the project being migrated. CMJ enforces instance-wide consistency to avoid hidden conflicts.

  4. Investigate custom fields

    1. Look for malformed JSON in custom fields.

    2. If using any third-party apps, confirm that the field configuration is valid and the app is available in the target instance.

  5. Use Power Admin for Jira

    1. Locate custom fields, workflows, or automations involved in the errors.

    2. Identify and correct broken references before attempting deployment again.

  6. Test with automation temporarily removed

    1. If the issue persists, remove the problematic automation rule, complete the deployment, and then re-import or recreate the automation afterward.

  7. Review the Analyze phase before deployment

    1. During the Analyze phase, CMJ will show which objects are being added, updated, or overwritten. Carefully review this step to avoid unexpected overwrites of workflows, screens, or other shared configurations.

  8. Do not disable Integrity Check

    1. Disabling the Integrity Check is not recommended because it can cause inconsistencies or data corruption during deployment. Always resolve the reported errors instead.

Best practices for smooth deployments

  1. Keep Jira and CMJ versions aligned across environments.

  2. Regularly run the Integrity Check on both source and target instances, not just before deployments.

  3. Clean up unused or disabled automation rules, workflows, and custom fields.

  4. Standardize naming conventions for workflows, screens, and schemes to avoid accidental overwrites.

  5. Use a lower environment (such as staging or test) to dry-run deployments before applying them in production.

  6. Review the Analyze phase results thoroughly and plan adjustments before confirming deployment.

  7. Document which apps and custom field types are in use, especially if they are tied to automations or workflows, to ensure they exist in both environments.

 Related articles