Login
Home CMS Documentation Home CMS 10 Administration Schema Designer Schema Actions Schema Synchronization Syncing Embedded Components

Syncing Embedded Components

Prerequisites:

You can sync embedded components or local instances of components with the associated schema. See Components for details about embedded components.

Warning
To prevent lost work, ensure users log out of the CMS before running a sync. Syncing schemas sends the CMS into maintenance mode, which prevents content changes.
To synchronize an component schema with an embedded component:
  1. Navigate to Administration > Schema Designer.
  2. Choose one of the following steps.
    • Select the Synchronization view. Select the schema in the Schema drop-down list.
    • Select the schema from the Component Types tab in the Management view. Click Sync in the Actions menu. The Synchronization view displays.
    • Select the schema from the Component Types tab in the Management view. Click Edit in the Actions menu. The Create/Edit view displays.
      • Click Sync in the Schema Actions menu. The Synchronization view displays.
  3. Click Find out-of-sync embedded components. The results display components not synced with the selected schema.

    Synchronizing schemas in the CMS

  4. Optional: Click Analyze Change Efforts to view total required changes.
  5. Select embedded components to sync. Choose one of the following steps.
    • Click Sync selected to update only the selected component(s).
      Note
      Use Ctrl+Click to multi-select components.
    • Click Sync all to update all content components.
    The Synchronize Pages to Match Schema dialog displays.

    Sync Selected Pages to Match Schema Dialog

  6. Select or clear the following options.
    OptionDescription
    Allow synced pages to be checked in without review

    If selected, the content item doesn't require a user to check in the content item to validate the sync. The Edit tab, DSS Preview, and the content item's XML displays the changes.

    If cleared, the system requires a user to check in the page to manually validate the sync. When the user checks in the page, the system creates a new content item version that includes the sync changes in the History tab.

    Sync pages without checking out

    If selected, the system doesn't check out the content item, and the content item syncs with the schema changes. The changes display in the Edit tab, DSS Preview, and the content item's XML. The latest existing version contains the sync changes in the History tab.

    If cleared, the system checks out the content item to the current user, and the current checked-out content item version syncs with the schema changes in the Edit tab, DSS Preview, and the content item's XML. The latest existing version doesn't contain the sync changes in the History tab.
    Note
    User assignments don't change.
    Overwrite value of Attribute fields

    If selected, the synced schema overwrites the content item's original attribute values. The Edit tab, DSS Preview, and the content item's XML displays the new values.

    For example, if a user with Schema Designer permissions enters a new attribute value in the content item's associated schema and executes a sync with this option selected, the new value overwrites the content item's existing value for that attribute.

    See Adding Attributes to Top-level Schemas for details about editing default attribute values.

  7. Click Proceed. The checkmark (✓) indicates sync completion in the Change Effort column. The number in the Schema Version column reflects the Current Version in the Schema Synchronization area.