Skip to main content


class %SYNC.SyncSet extends %Library.RegisteredObject

Caché Objects provides a toolkit for synchronizing objects of selected types between namespaces containing compatible type classes. The core of the synchronization toolkit is the SyncSet. A SyncSet contains all of the objects of selected types that have been filed in the local database from a defined starting time up to an ending time. "Time" in the context of synchronization means a sequencing value and is not an "hours-minutes-seconds" value. Object Synchronization consists of three primary tasks. The first task is to build the SyncSet. That task involves determining which objects are to included in the SyncSet. Caché uses a transaction journal for that purpose. The transaction journal is implemented as %Library.ObjectJournalTransaction. Any persistent or serial class that declares the class parameter OBJJOURNAL as true will record all filing events in %Library.ObjectJournalTransaction. The second task is to add changed objects to the SyncSet. The most common mechanism for performing this task is to retrieve the object state from the system journal using information recorded in %Library.ObjectJournalTransaction. This mechanism allows historical object data to be included in the SyncSet. If the system journal is not available, there is a provision to include the current object state. The third task is to import the SyncSet into the namespace being synchronized. This involves loading the SyncSet global into the target namespace and then importing each object contained in the SyncSet. If an object being imported already exists in the target namespace then the timestamp for the imported object is compared to the timestamp of the existing object. If a conflict is detected then user implemented code is called to resolve the conflict. This is essentially an optimistic concurrency mechanism. If the conflict is not resolved successfully then a concurrency error is reported and the object is not synchronized.

Property Inventory

Method Inventory


property FilterObject as %RegisteredObject;
Property methods: FilterObjectGet(), FilterObjectGetSwizzled(), FilterObjectIsValid(), FilterObjectNewObject(), FilterObjectSet()
property ResolveConflictEnv as %RegisteredObject;
Property methods: ResolveConflictEnvGet(), ResolveConflictEnvGetSwizzled(), ResolveConflictEnvIsValid(), ResolveConflictEnvNewObject(), ResolveConflictEnvSet()
property SyncSystem as %String;
This is the sysID of the system that produced the SyncSet
Property methods: SyncSystemDisplayToLogical(), SyncSystemGet(), SyncSystemIsValid(), SyncSystemLogicalToDisplay(), SyncSystemLogicalToOdbc(), SyncSystemNormalize(), SyncSystemSet()
property Unresolved as %Integer;
Unresolved is set to point to the first unresolved object in the sync set once Import() has completed. If there are no unresolved objects then this value will be empty (not > 0).
Property methods: UnresolvedDisplayToLogical(), UnresolvedGet(), UnresolvedIsValid(), UnresolvedLogicalToDisplay(), UnresolvedNormalize(), UnresolvedSet()
property sId as %String;
Sync Set ID

This is a string value used to identify the Sync Set object. This value is used as the suffix to the global name root of ^OBJ.SYNC.. For example, if the sId is set to the integer 1 then the global name will be ^OBJ.SYNC.1.

Property methods: sIdDisplayToLogical(), sIdGet(), sIdIsValid(), sIdLogicalToDisplay(), sIdLogicalToOdbc(), sIdNormalize(), sIdSet()


method AddJournaledObject(iTranPtr As %Integer = 0, iObjPtr As %Integer = 0, srcSystem As %String, srcNS As %String) as %Integer
method AddJournaledTransaction(iTranPtr As %Integer = 0, lExclude As %List = "") as %Integer
method AddObject(class As %String = "", id As %String = "", fileop As %Integer = 0, guid As %String = "") as %Integer
Add an object to the current SyncSet. This method can be used to force an object to be included in the SyncSet when it isn't recorded in the ObjectJournal. It should not be used for normal situations since the ObjectJournal is expected to be complete. Normally, an object that is added to the SyncSet is a versioned object meaning that the object state is recovered from history (normally, from the system journal). AddObject causes the object as it currently exists in the extent to be added to the SyncSet, breaking the natural chronology of the SyncSet. Parameters: class - the object's type class; id - the object's ID value; fileop - the filing operation that caused this object to be added to the sync set 0 - update 1 - insert 2 - delete guid - the object's GUID
method AddTransactions(iTranLast As %Integer = 0, iTranEnd As %Integer = 0, lExclude As %List = "", TNumber As %Integer = 0) as %Integer
Add %Library.ObjectJournalTransactions to the current SyncSet. Each transaction in the %ObjectJournalTransaction extent is identified by an integer that is incremented for each new transaction. This ID assignment mechanism places transactions in chronological order, that is, the order in which the transactions are created. Transactions are expected to be in that order when later imported and sync'ed into another namespace. This method adds a range of transactions, beginning with iTranLast and ending with iTranEnd. The TNumber argument, if specified and is not zero, limits the number of transactions added. When that number of transactions has been added the method will return to the caller, even if the iTranEnd value has not yet been reached. The LastTransaction property is set to the ID of the last transaction added to the SyncSet.
method Clear() as %Status
This method should be used for data removal when the syncset is no longer needed. It deletes all the persistent data and makes impossible further usage of the object.
classmethod CollectionValuesClose(ByRef qHandle As %Binary) as %Status
classmethod CollectionValuesExecute(ByRef qHandle As %Binary, sid As %String = "0", iObjPtr As %Integer = 0, CollName="") as %Status
classmethod CollectionValuesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
method ErrCount() as %Integer
classmethod ErrorsClose(ByRef qHandle As %Binary) as %Status
classmethod ErrorsExecute(ByRef qHandle As %Binary, sid As %String = "0") as %Status
classmethod ErrorsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
method ExportFile(file As %String = "", qspec As %String = "", bUpdate As %Boolean = 1) as %Status
method FindLastGUID(guid As %String) as %Integer
Find the last synchronization record for a particular GUID
method GetFirstTransaction() as %Integer
classmethod GetLastInfo(guid As %String, ByRef lastver As %Integer, ByRef sid As %String, ByRef nmsid As %String) as %Status
classmethod GetLastTRN(ByRef num As %String) as %CacheString
method GetLastTransaction() as %Integer
method GetLastTransactionTime() as %Integer
method GetLatestUnresolved() as %ArrayOfObjects
Return the pointer to the last unresolved object in the sync set. This is only valid if Import() has been run to completion before calling this method.
classmethod GetNextTRN(ByRef num As %String) as %CacheString
method GlobalName() as %String
This method returns the name of the global used for the sync set.
method Import(file As %String = "", lastSync As %Integer = 0, maxTS As %Integer, qspec As %String = "", ByRef errorlog As %String, diag As %Integer = 0, trace As %Integer = 0) as %Status

This method synchronizes each object contained in the sync set with the current database. Each object is first checked for concurrency. Concurrency conflicts occur when the object is modified on the local system after the object was last synchronized with the remote system where the sync set originated. If a concurrency conflict is detected, the object is passed to the %ResolveConcurrencyConflict method in %Library.SwizzleObject. If the conflict cannot be resolved, the object is requeued for later processing and the concurrency error is reported in the %%SERR error log. Otherwise, the object is synchronized by passing it to the %SyncObjectIn method in %Library.SwizzleObject.. If the synchronization fails, then the object is requeued for later processing.

There are two types of common synchronization errors. The first is an unresolved dependency. This type of error occurs when an object references another object and the referencing property is part of a REQUIRED constraint. That means the object cannot be saved until the reference can be resolved. This problem is often caused by a reference to an object that is in the sync set but has not yet been processed. The second type of problem is an unresolved reference. This type of problem occurs in the same was as an unresolved dependency but the reference is not required in order for the object to be saved. An object with an unresolved reference is partially synchronized and only the reference is requeued for later processing.

Once all of the objects in the sync set have been processed, the Import method attempts to synchronize all objects that were requeued. During this phase, all of the unresolved dependencies and references are expected to be resolved. Any objects that fail to synchronize during this phase are left in an unresolved state. Unresolved objects and errors reported during synchronization can be accessed by using the Unresolved query or the Errors query.

When all of the objects contained in the Sync Set have been processed the time stamps in the %SYNC.SyncTime class are updated using the maxTS value.

Formal parameters:

file The name of a file containing a sync set. If a file name is specified, then that file will be loaded into the global. If no file is specified, then the global is expected to already exist in the current namespace.


An integer value indicating the SyncTime value when this System.Namespace was last synchronized with the System.Namespace that generated the sync set being imported. If this value is not specified, then it will be retrieved from %SYNC.SyncTime


The highest transaction ID contained in the sync set. It is used to set the rTrn property in the %SYNC.SyncTime class. This value is not used for any purpose during import and is maintained for informational purposes only. This value is specified by the user and is expected to be the ID of the last %Library.ObjectJournal object included in the sync set. See the %SYNC.SyncTime for more information on the rTrn and lTrn properties.


Option flags. This formal argument is maintained for backward compatibility only.


Array of errors encountered during import. These are not errors encountered during synchronization but are errors reported doing tasks like opening the file.


If true, then Import will display status information on the current device.


If true, then Import will record all import activity in the sync set global under the "Trace" subscript.

method IsEmpty() as %Boolean
method OpenFile(file As %String = "", qspec As %String = "", ByRef errorlog) as %Status
Open a file containing a sync set global and load it into the current sync set global. Files containing sync set globals are typically in GOF format and are produced by exporting a sync set on another system.
classmethod PropertyValuesClose(ByRef qHandle As %Binary) as %Status
classmethod PropertyValuesExecute(ByRef qHandle As %Binary, sid As %String = "0", iObjPtr As %Integer = 0) as %Status
classmethod PropertyValuesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
method QueueError(pTranPtr As %Integer, pStatus As %Status = "") as %Status
Queue an error to the current sync set
method Requeue(iPtr As %Integer) as %Status
method UnresolvedFirst() as %SYNC.SyncSetObject
Return the pointer to the first unresolved object in the sync set. This is only valid if Import() has been run to completion before calling this method.
method UnresolvedNext() as %SYNC.SyncSetObject
Return the pointer to the next unresolved object. This is only valid if Import() has been run to completion before calling this method and ..UnresolvedFirst() has been called to initialize the unresolved object iterator.
method nextPointer(ByRef iTranPtr, ByRef iTranLast)


query CollectionValues(sid As %String, iObjPtr As %Integer, CollName As %String)
Selects Key As %String, Value As %String
query Errors()
Selects Ptr As %String, Status As %String
query PropertyValues(sid As %String, iObjPtr As %Integer)
Selects Property As %String, Value As %String

Inherited Members

Inherited Methods

FeedbackOpens in a new tab