Home > Class Reference > HSLIB namespace > HS.Message.Sync


persistent class HS.Message.Sync extends HS.Util.EnsRequest

SQL Table Name: HS_Message.Sync

During the SyncRequest we are either requesting transactions or setting the last transaction if SetLastTransaction=1 then we are setting the last transaction and not getting, otherwise we are getting either the latest transactions (GetAllTransaction=0) or all transactions (GetAllTransactions=1)

Property Inventory


parameter XMLIGNORENULL = inputonly;
Inherited description: If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.


property GetAllFinished as %Boolean [ InitialExpression = 1 ];
With a GetAllTransactions, multiple transactions will likely be sent and the productions should be kept quiesced over the entire set
Property methods: GetAllFinishedDisplayToLogical(), GetAllFinishedGet(), GetAllFinishedGetStored(), GetAllFinishedIsValid(), GetAllFinishedLogicalToDisplay(), GetAllFinishedLogicalToXSD(), GetAllFinishedNormalize(), GetAllFinishedSet(), GetAllFinishedXSDToLogical()
property GetAllTransactions as %Boolean [ InitialExpression = 0 ];
GetAllTransactions =1 will return the sync file with All available records
Property methods: GetAllTransactionsDisplayToLogical(), GetAllTransactionsGet(), GetAllTransactionsGetStored(), GetAllTransactionsIsValid(), GetAllTransactionsLogicalToDisplay(), GetAllTransactionsLogicalToXSD(), GetAllTransactionsNormalize(), GetAllTransactionsSet(), GetAllTransactionsXSDToLogical()
property LastTransaction as %Integer;
Set the value = the value from the response for the transactions just processed.
Property methods: LastTransactionDisplayToLogical(), LastTransactionGet(), LastTransactionGetStored(), LastTransactionIsValid(), LastTransactionLogicalToDisplay(), LastTransactionNormalize(), LastTransactionSet(), LastTransactionXSDToLogical()
property NetworkName as %String);
System making request (allows locating the end point on the Hub)
Property methods: NetworkNameDisplayToLogical(), NetworkNameGet(), NetworkNameGetStored(), NetworkNameIsValid(), NetworkNameLogicalToDisplay(), NetworkNameLogicalToOdbc(), NetworkNameNormalize(), NetworkNameSet()
property Retry as %Boolean [ InitialExpression = 0 ];
Used to prevent looping, when a sync fails issue a full transaction set, but don't want to issue it again if that fails
Property methods: RetryDisplayToLogical(), RetryGet(), RetryGetStored(), RetryIsValid(), RetryLogicalToDisplay(), RetryLogicalToXSD(), RetryNormalize(), RetrySet(), RetryXSDToLogical()
property SendStatus as %Status [ InitialExpression = 1 ];
Used to track the status of send operation, error reporting is being suppressed to reduce logging but the service needs to know whether to stop trying to send.
Property methods: SendStatusGet(), SendStatusGetStored(), SendStatusIsValid(), SendStatusLogicalToOdbc(), SendStatusLogicalToXSD(), SendStatusSet(), SendStatusXSDToLogical()
property SetLastTransaction as %Boolean;
SetLastTransaction uses the LastTransaction from the response to indicate what has been received and updated
Property methods: SetLastTransactionDisplayToLogical(), SetLastTransactionGet(), SetLastTransactionGetStored(), SetLastTransactionIsValid(), SetLastTransactionLogicalToDisplay(), SetLastTransactionLogicalToXSD(), SetLastTransactionNormalize(), SetLastTransactionSet(), SetLastTransactionXSDToLogical()
property SyncFile as %Stream.GlobalBinary;
Property methods: SyncFileDelete(), SyncFileGet(), SyncFileGetObject(), SyncFileGetObjectId(), SyncFileGetStored(), SyncFileGetSwizzled(), SyncFileIsValid(), SyncFileNewObject(), SyncFileOid(), SyncFileOpen(), SyncFileSet(), SyncFileSetObject(), SyncFileSetObjectId(), SyncFileUnSwizzle()
property SystemGUID as %String [ InitialExpression = ##class(%SYS.System).InstanceGUID() ];
Property methods: SystemGUIDDisplayToLogical(), SystemGUIDGet(), SystemGUIDGetStored(), SystemGUIDIsValid(), SystemGUIDLogicalToDisplay(), SystemGUIDLogicalToOdbc(), SystemGUIDNormalize(), SystemGUIDSet()
property SystemNamespace as %String [ InitialExpression = $namespace ];
Property methods: SystemNamespaceDisplayToLogical(), SystemNamespaceGet(), SystemNamespaceGetStored(), SystemNamespaceIsValid(), SystemNamespaceLogicalToDisplay(), SystemNamespaceLogicalToOdbc(), SystemNamespaceNormalize(), SystemNamespaceSet()

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)


Storage Model: Storage (HS.Util.EnsRequest)


Storage Model: Storage (HS.Message.Sync)