Some, but not all, metadata can be synced in Organization Sync. To ensure that data syncs correctly between the two organizations, you must customize and maintain the metadata in your secondary organization.
Available in: Salesforce Classic
Organization Sync is available in: Enterprise, Performance, Unlimited, and Developer Editions
What is metadata, anyway?
Every time your Salesforce organization is customized, its metadata is modified. For example, editing page layouts, creating a custom field, and creating a record type are all metadata updates. Data is information contained in a field, such as a phone number or name. The metadata in your secondary organization must match the metadata in your primary organization. If they don’t match, you may not be able to effectively implement Organization Sync.
How do I keep metadata synced between the primary and secondary organizations?
Before creating the Organization Sync connection:
Perform basic data clean-up in the primary organization so your data syncs correctly. Check the primary organization for the following issues, and resolve any that you find:
Blank required fields (these can occur if a field was changed from Optional to Required)
Customize the secondary organization’s metadata to match the primary organization’s. You can opt to sync some metadata automatically by selecting the Sync Metadata checkbox when you send the connection invitation; for a list of supported metadata, see Which Types of Metadata are Synced?. However, if the primary organization has customizations that include unsupported metadata types, you must perform the same customizations or deployments in the secondary organization.
After the organizations are connected, develop a business process to ensure that all metadata updates made in one organization are repeated in the other. Remember that if the Sync Metadata checkbox is selected, some updates are already synced for you.
When is metadata synced?
If you select the option to sync metadata, Salesforce begins copying supported metadata to the secondary organization as soon as you accept the Organization Sync connection invitation. The Connection Status field on your connection’s detail page reads Metadata Sync in Progress during this process.
After this initial copying of metadata, updates to supported metadata are synced daily. If you need to trigger an immediate sync of all supported metadata, follow these steps:
Navigate to your Organization Sync connection’s detail page in the primary organization.
In the Connection Detail section, click Edit.
Deselect the Sync Metadata checkbox. Click Save.
In the Connection Detail section, click Edit again.
Select the Sync Metadata checkbox. Click Save.
What are best practices for keeping metadata synced?
If you opt to sync metadata, follow these best practices:
If you need to delete metadata in one organization, delete it in the other organization as well. This is because metadata deletion isn’t synced between the organizations.
If you need to create or update unsupported metadata, perform the action in both organizations.
If you need to create or update supported metadata, perform the action in the primary organization only. Because supported metadata is synced daily from the primary to the secondary organization, changes to supported metadata types performed in the secondary organization are overwritten in the daily sync.
To keep your metadata current and avoid possible syncing failures, leave the Sync Metadata checkbox selected except when triggering an immediate sync as described above. Deselecting the checkbox after a connection invitation is accepted pauses the automatic syncing of metadata updates. The checkbox is editable only from the primary organization.
If you leave the Sync Metadata checkbox deselected, ensure that all metadata changes—creating, deleting, and updating metadata—are repeated in both organizations.
How do integrations and APIs work in Organization Sync?
If you decide that an integration is time-critical to your business operations—for example, an external web form—you must redirect the integration to the secondary organization each time users are redirected there. The same is true for API calls. Any time-critical API calls into Salesforce must be modified to include the secondary organization credentials, or they'll stop processing during the switch to the secondary organization.