The UA model for the DomainDownload Program is presented in Clause A.2.6.2. Collectively they define the components that constitute this Program. For clarity, the figures present a progression of portions of the model that complement the contents of the tables and illustrate the Program’s composition.

The type definition for the DomainDownload Program precisely represents the behaviour of the Program in terms of UA components. These components can be browsed by a Client to interpret or validate the actions of the Program.

The DomainDownloadType is a subtype derived from the ProgramStateMachineType. It specifies the use or non-use of optional ProgramStateMachineType components, valid extensions such as subordinate State Machines, and constrained attribute values applied to instances of DomainDownload Programs.

Table A.2 specifies the optional and extended components defined by the DomainDownload Type. Note the references to two sub State Machine Types, TransferStateMachine and FinishStateMachine. The DomainDownloadType omits references to the Reset Program Control Method and its associated state transition (HaltedToReady), which it does not support.

Table A.2 – DomainDownloadType

Attribute

Value

Includes all non-optional attributes specified for the ProgramStateMachineType

BrowseName

DomainDownloadType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasComponent

Object

TransferStateMachine

StateMachineType

Mandatory

HasComponent

Object

FinishStateMachine

StateMachineType

Mandatory

HasComponent

Variable

ProgramDiagnostic

ProgramDiagnostic2Type

Mandatory

HasComponent

Object

ReadyToRunning

TransitionType

HasComponent

Object

RunningToHalted

TransitionType

HasComponent

Object

RunningToSuspended

TransitionType

HasComponent

Object

SuspendedToRunning

TransitionType

HasComponent

Object

SuspendedToHalted

TransitionType

HasComponent

Method

Start

Mandatory

HasComponent

Method

Suspend

Mandatory

HasComponent

Method

Halt

Mandatory

HasComponent

Method

Resume

Mandatory

HasComponent

Object

FinalResultData

BaseObjectType

Mandatory

Table A.3 specifies the Transfer State Machine type that is a sub State Machine of the DomainDownload Program Type. This definition identifies the StateTypes that compose the substates for the Program’s Running StateType.

Table A.3 – TransferStateMachineType

Attribute

Value

Includes all attributes specified for the FiniteStateMachineType

BrowseName

TransferStateMachineType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasComponent

Object

Opening

StateType

HasComponent

Object

Sending

StateType

HasComponent

Object

Closing

StateType

HasComponent

Object

ReadyToOpening

TransitionType

HasComponent

Object

OpeningToSending

TransitionType

HasComponent

Object

SendingToClosing

TransitionType

HasComponent

Object

SendingToAborted

TransitionType

HasComponent

Object

SendingToSuspended

TransitionType

HasComponent

Object

SuspendedToSending

TransitionType

HasComponent

Method

Start

Mandatory

HasComponent

Method

Suspend

Mandatory

HasComponent

Method

Halt

Mandatory

HasComponent

Method

Resume

Mandatory

Table A.3 specifies the StateTypes associated with the Transfer State Machine Type. All of these states are substates of the Running state of the base ProgramStateMachineType.

The Opening state is the preparation state for the domain download.

The Sending state is the activity state for the transfer in which the data is moved from the source to destination.

The Closing state is the cleanup phase of the download.

The component Variables of the TransferStateMachineType have additional Attributes defined in Table A.4.

Table A.4 – TransferStateMachineType Attribute values for child Nodes

Source Path

Value Attribute

Description Attribute

Statenumbers

Opening

StateNumber

1

Sending

StateNumber

2

Closing

StateNumber

3

Transitionnumbers

ReadyToOpening

TransitionNumber

1

OpeningToSending

TransitionNumber

2

SendingToClosing

TransitionNumber

3

SendingToAborted

TransitionNumber

4

SendingToSuspended

TransitionNumber

5

SuspendedToSending

TransitionNumber

6

Table A.5 specifies the Finish State Machine Type that is a sub State Machine of the DomainDownload ProgramStateMachineType. This definition identifies the StateTypes that compose the substate for the Program’s Halted StateType.

Table A.5 – Finish State Machine Type

Attribute

Value

Includes all attributes specified for the FiniteStateMachineType

BrowseName

FinishStateMachineType

IsAbstract

False

References

NodeClass

BrowseName

Data

Type

TypeDefinition

Modelling

Rule

HasComponent

Object

Completed

StateType

HasComponent

Object

Aborted

StateType

The Aborted state is the terminal state that indicates an incomplete or failed domain download operation.

The Completed state is the terminal state that indicates a successful domain download.

The component Variables of the FinishStateMachineType have additional Attributes defined in Table A.6.

Table A.6 – FinishStateMachineType Attribute values for child Nodes

Source Path

Value Attribute

Description Attribute

Statenumbers

Aborted

StateNumber

8

Completed

StateNumber

9

Table A.7 specifies the constraining behaviour of a DomainDownload.

Table A.7 – DomainDownloadType Property Attributes variable values

NodeClass

BrowseName

Data

Type

Data Value

Modelling

Rule

Variable

Creatable

Boolean

True

Variable

Deletable

Boolean

True

Mandatory

Variable

AutoDelete

Boolean

False

Mandatory

Variable

RecycleCount

Int32

0

Mandatory

Variable

InstanceCount

UInt32

PropertyType

Variable

MaxInstanceCount

UInt32

500

Variable

MaxRecycleCount

UInt32

0

A DomainDownload Program Invocation can be created and also destroyed by a Client. The Program Invocation will not delete itself when halted, but will persist until explicitly removed by the Client. A DomainDownload Program Invocation cannot be reset to restart. The Server will support up to 500 concurrent DomainDownload Program Invocations.

Figure A.3 presents a partial DomainDownloadType model that illustrates the association between the states and the DomainDownload, Transfer, and Finish State Machines. Note that the current state number for the sub State Machines is only valid when the DomainDownload active base state references the sub State Machine, Running for the Transfer current state and Halted for the Finish current state.

image012.png

Figure A.3 – DomainDownloadType partial state model

Table A.8 specifies the ProgramTransitionTypes that are defined in addition to the ProgramTransitionTypes specified for Programs in Table 7. These types associate the Transfer and Finish sub State Machine states with the states of the base Program.

Table A.8 – TransferStateMachineType Additional References

Source Path

Reference Type

Is Forward

Target Path

ToSending

ToState

True

Sending

FromState

True

Opening

HasCause

True

Start

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

SendingToSending

ToState

True

Sending

FromState

True

Sending

HasEffect

True

ProgramTransitionEventType

SendingToClosing

ToState

True

Closing

FromState

True

Sending

HasEffect

True

ProgramTransitionEventType

SendingToAborted

ToState

True

Aborted

FromState

True

Sending

HasCause

True

Halt

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

ClosingToCompleted

ToState

True

Completed

FromState

True

Closing

HasEffect

True

ProgramTransitionEventType

SendingToSuspended

ToState

True

Suspended

FromState

True

Sending

HasCause

True

Suspend

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

SuspendedToSending

ToState

True

Sending

FromState

True

Suspended

HasCause

True

Resume

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

SuspendedToAborted

ToState

True

Aborted

FromState

True

Suspended

HasCause

True

Halt

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

ReadyToOpening

ToState

True

Opening

FromState

True

Ready

HasCause

True

Start

HasEffect

True

ProgramTransitionEventType

HasEffect

True

AuditProgramTransitionEventType

Figure A.4 through Figure A.10 illustrate portions of the DomainDownloadType model. In each figure, the referenced tates, Methods, transitions, and EventTypes are identified for one or two state transitions.

image013.png

Figure A.4 – Ready To Running model

Figure A.4 illustrates the model for the ReadyToRunning Program transition. The transition is caused by the Start Method. The Start Method requires three input arguments. The Method Call service is used by the Client to invoke the Start Method and pass the arguments. When successful, the Program Invocation enters the Running state and the subordinate Transfer Opening state. The Server issues two Event notifications, ReadyToRunning (2), and ToOpening (19).

Table A.9 – Start Method additions

Attribute

Value

BrowseName

Start

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

ModellingRule

HasProperty

Variable

InputArguments

Argument[]

PropertyType

Table A.9 specifies that the Start Method for the DomainDownloadType requires input arguments. Table A.10 identifies the Start Arguments required.

Table A.10 – StartArguments

Name

Type

Value

Argument 1

structure

 name

String

SourcePath

 dataType

NodeId

StringNodeId

 valueRank

Int32

-1 (-1 = scalar)

 arrayDimensions

UInt32[]

null

 description

LocalizedText

The source specifier for the domain

Argument 2

structure

 Name

String

DestinationPath

 dataType

NodeId

StringNodeId

 valueRank

Int32

-1 (-1 = scalar)

 arrayDimensions

UInt32[]

null

 description

LocalizedText

The destination specifier for the domain

Argument 3

structure

 name

String

DomainName

 dataType

NodeId

StringNodeId

 arrayDimensions

UInt32[]

null

 valueRank

Int32

-1 (-1 = scalar)

 description

LocalizedText

The name of the domain

Figure A.5 illustrates the model for the Opening To Sending and the Sending to Closing Program transitions. As specified in the transition table, these state transitions require no Methods to occur, but rather are driven by the internal actions of the Server. Events are generated for each state transition (10 to 12), when they occur.

image014.png

Figure A.5 – Opening To Sending To Closing model

Notice that a state transition can initiate and terminate at the same state (Sending). In this case the transition serves a purpose. The ProgramTransitionEventType effect referenced by the SendingToSending state transition has an IntermediateResultData Object Reference. The IntermediateResultData Object serves to identify two Variables whose values are obtained each time the state transition occurs. The values are sent to the Client with the Event notification. Table A.11 defines the IntermediateResults ObjectType and Table A.12 defines the Variables of the ObjectType.

Table A.11 – IntermediateResults Object

Attribute

Value

Includes all attributes specified for the ObjectType

BrowseName

IntermediateResults

IsAbstract

False

References

NodeClass

BrowseName

Data

Type

TypeDefinition

Modelling

Rule

HasComponent

Variable

AmountTransferred

Long

VariableType

Mandatory

HasComponent

Variable

PercentageTransferred

Long

VariableType

Mandatory

Table A.12 – Intermediate result data Variables

Intermediate Result Variables

Type

Value

Variable 1

Structure

 Name

String

AmountTransferred

 dataType

NodeId

StringNodeId

 description

LocalizedText

Bytes of domain data transferred.

Variable 2

Structure

 Name

String

PercentageTransferred

 dataType

NodeId

StringNodeId

 description

LocalizedText

Percentage of domain data transferred.

The model for the Running To Suspended state transition is illustrated in Figure A.6. The cause for this transition is the Suspend Method. The Client can pause the download of domain data to the control. The transition from Running to Suspended invokes the Event generation for TransitionEventTypes 5 and 16. Note that there is no longer a valid current state for the Transfer State Machine.

image015.png

Figure A.6 – Running To Suspended model

The model for the SuspendedToRunning state transition is illustrated in Figure A.7. The cause for this transition is the Resume Method. The Client can resume the download of domain data to the control. The transition from Suspended to Running generates the Event for TransitionEventTypes 6 and 17. Now that the Running state is active, the Sending state of the Transfer State Machine is again specified for the CurrentStateNumber.

image016.png

Figure A.7 – Suspended To Running model

The model for the Running To Halted state transition for an abnormal termination of the domain download is illustrated in Figure A.8. The cause for this transition is the Halt Method. The Client can terminate the download of domain data to the control. The transition from Running To Halted generates the Event for TransitionEventTypes 3 and 15. The TransitionEventType 15 indicates the transition from the Sending state as the Running State ends and then to the Aborted state as the Halted state is entered.

image017.png

Figure A.8 – Running To Halted – Aborted model

Figure A.9 illustrates the model for the Suspended To Halted state transition for an abnormal termination of the domain download. The cause for this transition is the Halt Method. The Client can terminate the download of domain data to the control while it is suspended. The transition from SuspendedToHalted invokes the Event notifiers for TransitionEventTypes 7 and 18.

image018.png

Figure A.9 – Suspended To Aborted model

The model for the Running To Completed state transition for a normal termination of the domain download is illustrated in Figure A.10. The cause for this transition is internal. The transition from Closing To Halted generates the Event for TransitionEventTypes 3 and 14. The TransitionEventType 14 indicates the transition from the Closing state as the Running state ends and then to the Completed state as the Halted state is entered.

The DomainDownloadType includes a component reference to a FinalResultData Object. This Object references Variables that persists information about the domain download once it has completed. This data can be read by Clients who are not subscribed to Event notifications. The result data is described in Table A.13.

Table A.13 – FinalResultData

Attribute

Value

Includes all attributes specified for the ObjectType

BrowseName

FinalResultData

IsAbstract

False

References

NodeClass

BrowseName

Data

Type

TypeDefinition

Modelling

Rule

HasComponent

Variable

DownloadPerformance

Double

BaseDataVariableType

Mandatory

HasComponent

Variable

FailureDetails

String

BaseDataVariableType

Mandatory

The Domain Download net transfer data rate and detailed reason for aborted downloads is retained as final result data for each Program Invocation.

DownloadPerformance provides the data rate in seconds for domain data transferred.

FailureDetails provides a descriptive reason for an abort.

image019.png

Figure A.10 – Running To Completed model

Figure A.11 illustrates a normal sequence of service exchanges between a Client and Server that would occur during the life cycle of a DomainDownloadType Program Invocation.

image020.png

Figure A.11 – Sequence of operations

____________