Skip to main content

Best practice for deploying config data with data deployment

Using data deployments to keep config data in sync across your orgs

Written by Nick Apostolides

Config data is the term most commonly used for Salesforce records that are required to make business logic work. Often it is developed in lower environments and promoted up to production. If you are following this practice, config data needs to be kept in sync across your Salesforce sandboxes. This ensures behaviour is kept consistent with production.

Gearset data deployment can be used to keep config data in sync across multiple orgs, including sandboxes and production. Best practice starts with understanding the schema of your config data. It is important to know which records will be created and updated. Also you need to know, what groups of related objects need to be deployed together.

Next you need to have a unique field to match records between orgs. Each config data object should have an external id field which has a unique value for each record. This ensures the records can be matched across all the orgs. Performance will also be helped, if this field is indexed.

Best results for CPQ and RCA config data will be achieved using Gearset compare and deploy .

Selecting objects to deploy

On the configure data deployment page you should select any config data you want to deploy to the target. The config data objects can be selected from the left panel. When deploying config data, you may want to filter by Name, Id or external id to ensure only the data you want to promote is deployed.

Children should also be selected here. If you are applying a filter to the parent, you should ensure the "only deploy records that are children" checkbox is ticked.

Once all config data and child records are selected click "Next".

Select related objects and deployment methods

On the next page you can select the deployment method for the selected objects and any parent objects. It is recommended to use the Upsert method, matching on the external id field. If you do not want to update certain fields, these can be excluded using the alternative option when clicking the Next button.

For deployment of config data to a production org, you will need to enable data deployments to production orgs in settings. This can be found in the data deployments section.

Did this answer your question?