Skip to content
Kevin Jump edited this page Sep 6, 2015 · 3 revisions

uSync 3

uSync3 is a re-engineering of the popular uSync package for umbraco. uSync lets you take the elements stored inside the umbraco DB and write them to disk, it also takes config information from disk and writes them to the database.

uSync has been developed to keep bits of umbraco in sync since umbraco v4.7 and a lot has changed between that version and v7.3 of umbraco.

For quite a while uSync has being doing things with both the latest Umbraco.Core API and legacy API calls from older versions. For Umbraco 7.3 A lot of effort has gone into the the Back Office API for Umbraco, and we have decided to use this opportunity to clean up uSync and move everything onto the new API. For uSync3 this means everything calls the new APIs and everything works. it has allowed us to clean up a lot of things.

Elements of uSync

uSync.BackOffice

if you have used uSync before, backoffice does all the things you expect uSync to do, it reads and saves elements to and from disk, it handles save events and it generally controls you're disk version of files.

uSyncBack office consists of:

The back office dashboard page is also part of the package, although not needed to run uSync

  • bin/Jumoo.uSync.BackOffice.UI.dll
  • app_plugin/uSync/Backoffice/uSyncBackOfficeDashboard.ascx

uSync.Core

for uSync 3 we have separated out the serialize/deserialization and the writing things to and from disk - uSync.Core does all the serialization and deserialization. On its own uSync.Core does nothing, it needs something else to tell it to do something.

the core consists of two files

uSync.Migrations

Migrations is a variation on how backoffice work, instead of importing and export and listening for saves. migrations lets you create a migration snapshot when you want to.

this lets you capture the changes when you want and build up a change set that contains only the changes you made since the last time you created a migration.

Clone this wiki locally