Integrations - Best practices for refreshes
search cancel

Integrations - Best practices for refreshes


Article ID: 217777


Updated On:


Clarity PPM On Premise Clarity PPM SaaS


This article covers the best practices for avoiding any issues post refresh if using an integration such as the Rally (Agile Central) / Clarity Integration. As referenced at: Refresh an Environment with DB Backup in Clarity SaaS, if you have any integrations, it will be your responsibility to ensure the integration mapping is disabled in non production post refresh, if applicable. This may be important to ensure data is not incorrectly synced from non production to the production integration.


Pre Refresh Checklist

  • Production/Source environment

    • It's recommended to deactivate the Integration in production (Or the source environment) during the refresh window - this will ensure the Production Mapping is not synced incorrectly in non production post refresh until you are able to deactivate the mapping there.

    • Steps to do this:

      1. In Classic Clarity go to Administration->General Settings->Integrations

      2. Uncheck Active for all applicable Integrations on the list

      3. Click Save

    • IMPORTANT: If this is not possible, note that there will be a risk until you are able to deactivate the mapping in non production.
    • Another option is to change the API Keys temporarily in Rally or Clarity then set back post refresh if you know your API Keys
    • Before refreshing, please ensure to pause all your jobs/processes pertaining to any external integrated system to ensure your data from production as well as the refreshed environment don't overwrite
  • Non production / destination environment
    • Copy and paste all destination environment integration details prior to refresh into a word document so that it can be recreated quickly post refresh

Post Refresh Checklist

  • Non Production/Source environments

    • Disable any production (or applicable source environment) mappings in the destination (refreshed) environment if these are enabled

    • Recreate the correct integration mapping for the environment (using the information saved in the pre refresh checklist)

  • Production/Source environments

    • If you disabled the mapping in production prior to the refresh, enable the mapping again in production

To prevent recreating the non-production Integration post refresh 

  • You could create the integration mapping(s) in production (Deactivated), so that when a refresh is done, you would just have to activate the applicable Sandbox mapping (versus recreating the entire integration)

Additional Information

See also: