SYS.DataCheck.Destination
persistent class SYS.DataCheck.Destination extends SYS.DataCheck.System
SQL Table Name: SYS_DataCheck.Destination
The destination system directs the datacheck protocol. This class provides control methods for starting and stopping the system. See System for overview.To create a new DataCheck system:
Important: Once created, the destination object is modified by the DataCheck daemons on a running system only, and should be treated as read-only for all other purposes. Users should call %Save on this object only once as part of creating the DataCheck destination system.
To modify an existing DataCheck system, modify the Configuration, RunParameters, or Workflow objects as needed, adhering to the following guidelines:
To delete a Datacheck system, call %DeleteId(name). All related objects and DataCheck results are deleted automatically.
Property Inventory
Method Inventory
Properties
property Configuration as Configuration;
Configuration object for this system
Property methods: ConfigurationGet(), ConfigurationGetObject(), ConfigurationGetObjectId(), ConfigurationGetStored(), ConfigurationGetSwizzled(), ConfigurationIsValid(), ConfigurationNewObject(), ConfigurationSet(), ConfigurationSetObject(), ConfigurationSetObjectId(), ConfigurationUnSwizzle()
property GUID as %String;
Used on the Source to compute a unique name for this connection
Property methods: GUIDDisplayToLogical(), GUIDGet(), GUIDGetStored(), GUIDIsValid(), GUIDLogicalToDisplay(), GUIDLogicalToOdbc(), GUIDNormalize(), GUIDSet()
property Phase as Phase (CLASSNAME = 1);
Current phase of workflow. This property is modified by the DataCheck daemons
on a running system only, and should be treated as read-only for all other purposes.
Property methods: PhaseGet(), PhaseGetObject(), PhaseGetObjectId(), PhaseGetStored(), PhaseGetSwizzled(), PhaseIsEmpty(), PhaseIsValid(), PhaseNewObject(), PhaseSet(), PhaseSetObject(), PhaseSetObjectId(), PhaseUnSwizzle()
property PhaseNumber as %Integer;
Current phase number. This property is modified by the DataCheck daemons
on a running system only, and should be treated as read-only for all other purposes.
Property methods: PhaseNumberDisplayToLogical(), PhaseNumberGet(), PhaseNumberGetStored(), PhaseNumberIsValid(), PhaseNumberLogicalToDisplay(), PhaseNumberNormalize(), PhaseNumberSet()
property RunParameters as RunParameters;
Running Parameters object for this system
Property methods: RunParametersGet(), RunParametersGetObject(), RunParametersGetObjectId(), RunParametersGetStored(), RunParametersGetSwizzled(), RunParametersIsValid(), RunParametersNewObject(), RunParametersSet(), RunParametersSetObject(), RunParametersSetObjectId(), RunParametersUnSwizzle()
property Workflow as Workflow;
Workflow object for this system
Property methods: WorkflowGet(), WorkflowGetObject(), WorkflowGetObjectId(), WorkflowGetStored(), WorkflowGetSwizzled(), WorkflowIsValid(), WorkflowNewObject(), WorkflowSet(), WorkflowSetObject(), WorkflowSetObjectId(), WorkflowUnSwizzle()
Methods
Constructor for creating a new DataCheck destination system. Specify a unique
name for this DataCheck system as the first parameter. If this DataCheck
system is to be based on a mirror configuration, pass the mirror name as the
second parameter.
Starts the system if not already started. Returns %Status. If the 'restartworkflow'
parameter is set to true, the workflow will be set to restart at phase #1 rather
than resume where it left off.
Any changes to the destination object or related objects must be saved before calling this method.
Note: A return of $$$OK return here does not indicate the system started successfully See the GetState() method to check the running state
method Stop() as %Status
Requests the system to stop if running. Upon restart, the system will resume
processing the queries that it was last running.
Note: The system is not necessarily stopped upon returning from this method See the GetState() method to check the running state
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- GetState()
- GetStateBySystem()
Storage
Gray indicates storage defined by superclasses.
Storage Model: Storage (SYS.DataCheck.System)
^SYS.DataCheck.SystemD(ID) |
= | %%CLASSNAME
Debug
PeerProtocolVersion
StorageVersion
MirrorName
Type
|
Storage Model: Storage (SYS.DataCheck.Destination)
^SYS.DataCheck.SystemD(ID,"Destination") |
= | Configuration
GUID
RunParameters
Stats
Workflow
Phase
PhaseNumber
LastConnectedAddress
|