Skip to content

1.0.0-beta.2

Pre-release
Pre-release

Choose a tag to compare

@andresvillenas andresvillenas released this 08 Oct 05:24
56a0a3f

Second beta of the Content Sync Toolkit for Xperience by Kentico. It redesigns the item statuses so each one says what to do, and makes filtering by status easier.

What's new

  • One status per item, in four colors. The color says what to do, and the label says what's different:

    Status Color What to do
    Incompatible Red Ask a developer: the target is missing a content type, language, channel or workspace the item uses. Hover the tag for what to deploy.
    Unpublished Orange Sync it: it's unpublished here but still live on the target.
    New Orange Sync it to create it on the target.
    Changed Orange Sync it to update it (or publish it, if the target has it unpublished).
    Moved Orange Sync all pages on its old and new level.
    Reordered Orange Use Sync with all subpages on the level's parent.
    Not published Grey Publish it: it has no published version here (unpublished, then edited again, or never published while the target has it), so Content Sync can't sync it yet.
    Only on target Grey Nothing to sync: Content Sync can't delete. Delete it on the target if it shouldn't be there.
    In sync Green Nothing.

    Before, an edit, an unpublish and a move all showed as Out of date on target, and you had to hover the tag to tell them apart.

  • Incompatible first. Incompatible items sort to the top, and their tooltip says what the target needs and what the sync will do once it's fixed.

  • Multi-select Status filter. Choose several statuses at once, for example Unpublished and New.

  • Hide items in sync. One checkbox in the filter shows only what differs, Incompatible and Only on target included.

  • No more warning banner for missing objects. The banner listing what the target is missing grew with every issue and showed even on a tab with no affected items. The Incompatible status replaces it.

  • Clearer tooltips. Each tag's tooltip says what a sync would do for that item, and the Status column header explains every status.

  • Unpublished changes are explained. An item edited and saved without publishing (including a version in a workflow step or scheduled to publish) keeps its status, and its tooltip says only the published version is synced.

  • Fix: an item unpublished and then edited again no longer shows as Only on target with a hint to delete it there; it shows as Not published.

  • Column widths rebalanced so every label and date fits in a 1440px-wide window.

Breaking changes

These only affect code that uses the toolkit's services directly, or saved links to the status page with a filter applied:

  • ContentSyncStatus has new members: New, Changed, Unpublished, Moved, Reordered, NotPublished, OnlyOnTarget and InSync. MissingOnTarget, OutOfDateOnTarget and ExtraOnTarget were removed.
  • ContentSyncStatusItem.Reason and the ContentSyncStatusReason enum were removed: the status now carries that information. Use ContentSyncStatusItem.HasCompatibilityIssues to tell whether the target is missing objects the item needs, and ContentSyncStatusExtensions.NeedsSync() for "would a sync change this item".
  • The Status filter is now a multi-select of statuses only; its needs-action option was removed. Use Hide items in sync, or select the statuses you want.

No configuration changes. The target's inventory endpoint adds two publish states, for items without a published version; a beta.1 target still works with a beta.2 source. Update both anyway, as the Usage Guide recommends.

Installation

Install on both the source and the target:

dotnet add package XperienceCommunity.ContentSyncToolkit --prerelease

See the Usage Guide for registration, configuration and giving editors access.

Compatibility

Xperience by Kentico 30.8.0 or newer. See the verification record.

This is a beta: APIs and behavior may change before 1.0.0.