Plan and Prepare for Deployment
A successful deployment starts with a solid plan. To avoid conflicts or missing dependent metadata and configuration data during deployments, review these prerequisites, best practices, and limitations.
Required Editions
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, Performance, Unlimited, and Developer Editions |
Prerequisites
- Authorize the source and target orgs to send and receive changes.
- Include all required metadata components and their dependencies to prevent deployment failure. Use the Metadata Dependencies window to understand the metadata dependencies in your org. See About Metadata and Data Dependencies.
- Review the list of metadata supported for deployment. You can deploy only the metadata types tracked using source tracking. See Metadata Coverage Report.
- Review your data structure, including all objects, fields, records, and relationships, to identify which configuration data to migrate.
- Map the relationships between your selected objects. For example, Accounts are parents to Contacts. To maintain data integrity, plan the migration order based on these dependencies.
- Understand how the deployment affects different metadata types and data objects. Some metadata components can’t be overwritten. See Special Behavior During Deployments.
- Verify that you have the object and field-level permissions in the target org to create and edit records for the specific objects intended for configuration data migration.
Best Practices
- Set external IDs before you start. While optional, we recommend using external IDs for configuration data migration. The deployment process uses the External ID field to match records between the source and target orgs. If an external ID is present, the process upserts records, which prevents duplicates in your target org.
- Back up your target org’s metadata and data before starting the deployment so that you can restore the previous state, if needed.
- Deploy in small batches to minimize risks and identify issues more quickly.
- Monitor your org limits to better coordinate deployments.
- Review the additional deployment best practices. See Deployment Best Practices.
Limitations
- In the Metadata Dependencies window, selecting a parent row or using the Select All option doesn’t automatically select child rows. This is a limitation of the lightning-tree-grid component, where the row checkbox selects only the individual row.
- Each deployment operation can migrate up to 2,000 records per object, with a total limit of 10,000 records.
Did this article solve your issue?
Let us know so we can improve!
