You are here:
Upgrade a Context Definition
Extended context definitions are auto-upgraded to their latest version. When an extended definition is out of sync with the standard definition, use the Sync Now option to instantly upgrade the standard components to their latest version. Easily track the progress of the sync by checking the sync status.
Required Editions
| Available in: Lightning Experience |
| Available in: Developer, Enterprise, Professional, and Unlimited editions for Industries clouds where Context Service is enabled |
| User Permissions Needed | |
|---|---|
| To upgrade context definitions: | Context Service Admin |
After you upgrade your orgs to the latest Salesforce version, your extended context definitions are automatically synced receive the latest updates. The new artifacts from the standard definition to the extended definition are automatically copied when:
- You go to Setup > Context Definitions, and click on an extended definition.
- An application hydrates the extended definition.
Note The extended definition is not automatically synced when the hydration is triggered by an APEX code or Flow.
The auto-sync process can fail when:
- There is a conflict between artifact records in the custom definition. To solve this, click Sync to manually resolve the conflicts.
- The user does not have permissions to copy the records. To solve this, ensure that the user has the Context Service Admin permissions.
- The number of attributes or nodes in the context definition cross the Context Service limits. To solve this, delete unused custom nodes or attributes from your context definition. If it still doesn't work, contact Salesforce Customer Support.
- Invalid mapping records corrupt a context definition. To solve this, contact Salesforce Customer Support
Important
- Sync is not available for cloned context definitions.
- If the auto-sync fails, the Sync button is enabled only for the extended definitions that require an upgrade.
- To maintain data integrity, avoid performing a Sync in production orgs. First, perform the Sync in a sandbox org. Then, export the updated context definition as a package and deploy it to the production org.
- From Setup, in the Quick Find box, enter Context Service, and then select Context Definitions.
-
On the Custom Definitions tab, from the action menu, select the extended definition
that you want to upgrade, and then click Sync Now.
If the extended definition fails to upgrade, you can do one of the following:
Preview Lists the conflicting artifacts that prevent the extended definition from upgrading. Override Removes the conflicting artifacts from the extended context definition and replaces them with the corresponding artifacts from the standard context definition. Important The conflicting artifacts are permanently removed. Overriding the extended context definition is irreversible. To ensure that a previous version of your custom data can be safely restored if required, export the extended definition as a package before performing an Override.
Did this article solve your issue?
Let us know so we can improve!