The destination system directs the datacheck protocol. More...

Inheritance diagram for Destination:

[legend]

Collaboration diagram for Destination:

[legend]

Public Member Functions
_.Library.Status	Start (_.Library.Boolean restartworkflow)
	Starts the system if not already started. More...

_.Library.Status	Stop ()
	Requests the system to stop if running. More...

Public Member Functions inherited from System
_.Library.String	GetState (SYS.DataCheck.StateReason reason)
	DataCheck Overview More...

Public Attributes
	Configuration
	Configuration object for this system. More...

	GUID
	Used on the Source to compute a unique name for this connection. More...

	Phase
	Current phase of workflow. More...

	PhaseNumber
	Current phase number. More...

	RunParameters
	Running Parameters object for this system. More...

	Workflow
	Workflow object for this system. More...

Public Attributes inherited from System
	MirrorName
	Name of the mirror that this system is checking or null if not mirrorized. More...

	Name
	Unique name of the system. More...

Private Member Functions
_.Library.Status	OnNew (_.Library.String name, mirrorname)
	Constructor for creating a new DataCheck destination system. More...

Additional Inherited Members
Static Public Member Functions inherited from System
_.Library.String	GetStateBySystem (SYS.DataCheck.SystemName systemname, SYS.DataCheck.StateReason reason)
	Returns current running state of specified system or null on error. More...

Detailed Description

The destination system directs the datacheck protocol.

This class provides control methods for starting and stopping the system. See <CLASS>System</CLASS> for overview.

To create a new DataCheck system: Create a new DataCheck Destination object on the destination system, passing the appropriate parameters to the New constructor (see <METHOD>OnNew</METHOD>). Its related objects will be created automatically. Set up information about the source system in the <CLASS>Configuration</CLASS> object, referenced by the <PROPERTY>Configuration</PROPERTY> property. Modify the <CLASS>RunParameters</CLASS> object, referenced by the <PROPERTY>RunParameters</PROPERTY> property. It defines performance characteristics and what globals should be checked, with conservative but usable defaults. If needed, modify the <CLASS>Workflow</CLASS> object, referenced by the <PROPERTY>Workflow</PROPERTY> property. It defines the strategy for performing the check and has defaults that are often suitable. Call Save on the destination object to save it and, implicitly, its referenced objects. Ensure that the source system has Service_DataCheck enabled Use <METHOD>Start</METHOD> to start the check.

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 <CLASS>Configuration</CLASS>, <CLASS>RunParameters</CLASS>, or <CLASS>Workflow</CLASS> objects as needed, adhering to the following guidelines: All of the referenced objects (as well as the Destination object itself) have, as their ID, the name of the Destination object. Each object can be opened with OpenId(name) directly or referenced through the namesake property of the destination object. Call the Save method of the referenced object that has been modified only. Do not call Save on the destination object. The <CLASS>RunParameters</CLASS> and <CLASS>Workflow</CLASS> objects can be saved while the system is running to change it's behavior dynamically. The system must be stopped to save changes to the Configuration object. The referenced objects should not be deleted or recreated, only modified.

To delete a Datacheck system, call DeleteId(name). All related objects and DataCheck results are deleted automatically.

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew	(	_.Library.String	name,
			mirrorname
	)

private

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.

◆ Start()

_.Library.Status Start ( _.Library.Boolean restartworkflow )

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 <METHOD>GetState()</METHOD> method to check the running state

◆ Stop()

_.Library.Status Stop ( )

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 <METHOD>GetState()</METHOD> method to check the running state

Member Data Documentation

◆ Configuration

Configuration

Configuration object for this system.

◆ GUID

GUID

Used on the Source to compute a unique name for this connection.

◆ Phase

Phase

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.

◆ PhaseNumber

PhaseNumber

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.

◆ RunParameters

RunParameters

Running Parameters object for this system.

◆ Workflow

Workflow

Workflow object for this system.

Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members