Updating Configuration in General
Whenever you change a Flow, entity type, bundle, or field settings, you need to export the site's configuration to the Content Sync service. You can automate this process by running drush cse
as part of your deployment scripts.
Updating Entity Types
Removing Entity Types
After removing an entity type, please update all Flows that were previously using it by editing and saving them.
Removing Bundles
After removing a bundle, please update all Flows that were previously using it by editing and saving them.
Adding Entity Types
If you want to add support for an entity type after Content Sync has already been configured, you need to add it manually to the Flows where you want this entity type to be pushed or pulled.
Adding Bundles
When adding bundles, some may be recognized and included automatically. This depends on whether you have grouped all bundles of a type in the Flow settings:
Grouped Bundles: New bundles will be added automatically.
Managed Separately: New bundles must be added manually. To do this, edit the Flows where you want to push or pull the new bundle and enable it manually.
Updating Fields
Removing Fields
Fields are managed automatically by Content Sync. When a field is removed, you only need to export the configuration to the Content Sync service.
Important Note: If you remove a field from a content entry site and it is required by a target site, the content cannot be synchronized and will result in a validation error.
Adding Fields
Fields are managed automatically by Content Sync. When a field is added, you only need to export the configuration to the Content Sync service. When a new required field is added to content, all translations must be pushed, even if the field itself is not translatable. This ensures consistency across all language versions and prevents potential issues with missing data.
Key Considerations:
Validation Rules: Content Sync strictly validates content to match the provided type settings. If you add a new required field, all content passing through Content Sync from or to that site must have a valid value for the field.
Existing Content: When adding a new required field, existing content may no longer be synchronizable unless a value is provided for the required field. If you do not add values automatically, you must update existing content and provide values for the required field before synchronization.
Translations: You need to push the value for all translations. While Content Sync allows independent translation pushes, this will fail if a required field is missing in any existing translation. Validation rules will block synchronization until all translations include the required field.
Example:
If a required field is added, and an editor pushes a translation that includes the required value, but other translations do not, synchronization will be aborted. To resolve this, ensure all translations include the required field before attempting to sync.