TwoWay Sync Plugin

The TwoWay Sync plugin is responsible to perform two-way synchronization of PIM items. More...

Collaboration diagram for TwoWay Sync Plugin:

The TwoWay Sync plugin is responsible to perform two-way synchronization of PIM items.

Two-way synchronization can be done only between two instances of OpenAB::Storage (identified as local and remote). Two-way synchronization uses metadata information to store information about association between items in OpenAB::Storage instances.

During synchronization process different cases can occur:

• Case 1: There is no metadata information - in that case do full synchronization and produce initial metadata. During this case common items on both OpenAB::Storage will be found and items not contained in one of OpenAB::Storage instances will be sent to other. During that case no items will be removed from local or remote OpenAB::Storage.
• Case 2: There is already metadata information - in that case ask OpenAB::Sources for lists of current item revisions and compare them with information from metadata. For each item there are 9 possible states in which it may be:
  • Item was removed in both local and remote OpenAB::Storage - in that case remove information about item from metadata.
  • Item was removed in local/remote but was not modified in remote/local - in that case remove item from remote/local and remove information about item from metadata.
  • Item was removed in local/remote but was modified in remote/local - in that case restore item on local/remote
  • Item was not changed in local/remote but was changed in remote/local - in that case propagate modifications to local/remote.
  • Item was changed in local/remote and was changed in remote/local - in that case create duplicate item on remote/local so user can decide how to merget two items.
  • Item was not modified either in local or remote - in that case no action is needed. After synchronization updated metadata is sent using callback method OpenAB_Sync::Sync::SyncCallback::metadataUpdated

Parameters

Parameters:

Type	Name	Description	Mandatory
String	"remote_plugin"	name of OpenAB_Source::Source plugin to use	Yes
Struct	remoteSourcePluginParams	parameters of OpenAB_Source::Source plugin to use	Yes
Struct	remoteStoragePluginParams	parameters of OpenAB_Storage::Storage plugin to use	Yes
String	"local_plugin"	name of OpenAB_Storage::Storage plugin to use	Yes
Struct	localStoragePluginParams	parameters of OpenAB_Storage::Storage plugin	Yes
Struct	localSorcePluginParams	parameters of OpenAB_Source::Source plugin	Yes
Pointer	"callback"	pointer to OpenAB_Sync::Sync::SyncCallback	No
Float	"sync_progress_frequency"	interval of OpenAB_Sync::Sync::SyncCallback::syncProgress() emission in seconds	No
Integer	"batch_size"	size of batches to be used on Storage operations	No
Stringr	"metadata"	last synchronization meta data information in JSON format	No

Todo:

Add support for pausing/resumig/canceling operation

Add possibility to sleep after processing each item to lower CPU consumption during sync