The JoiningProcessManagementType provides access to various joining processes in a joining system and is formally defined in Table 92.
Table 92 – JoiningProcessManagementType Definition
|
Attribute |
Value |
||||
|
BrowseName |
JoiningProcessManagementType |
||||
|
IsAbstract |
False |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseObjectType defined in OPC 10000-5, i.e., inheriting the InstanceDeclarations of that Node. |
|||||
|
0:HasProperty |
Variable |
0:DefaultInstanceBrowseName |
0:QualifiedName |
0:PropertyType |
|
|
0:HasComponent |
Method |
SendJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
GetJoiningProcessList |
|
|
O |
|
0:HasComponent |
Method |
GetJoiningProcessRevisionList |
|
|
O |
|
0:HasComponent |
Method |
GetJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
SetJoiningProcessMapping |
|
|
O |
|
0:HasComponent |
Method |
SelectJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
DeselectJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
IncrementJoiningProcessCounter |
|
|
O |
|
0:HasComponent |
Method |
DecrementJoiningProcessCounter |
|
|
O |
|
0:HasComponent |
Method |
SetJoiningProcessCounter |
|
|
O |
|
0:HasComponent |
Method |
SetJoiningProcessSize |
|
|
O |
|
0:HasComponent |
Method |
ResetJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
AbortJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
StartJoiningProcess |
|
|
O |
|
0:HasComponent |
Method |
StartSelectedJoining |
|
|
O |
|
0:HasComponent |
Method |
DeleteJoiningProcess |
|
|
O |
|
Conformance Units |
|||||
|
IJT Method Input Argument |
|||||
|
IJT Joining Process Management |
|||||
|
IJT Get Joining Process List |
|||||
|
IJT Abort Joining Process |
|||||
|
IJT Start Selected Joining |
|||||
|
IJT Select Joining Process |
|||||
|
IJT Deselect Joining Process |
|||||
|
IJT Reset Joining Process |
|||||
|
IJT Increment Joining Process Counter |
|||||
|
IJT Decrement Joining Process Counter |
|||||
|
IJT Set Joining Process Size |
|||||
|
IJT Start Joining Process |
|||||
|
IJT Delete Joining Process |
|||||
The component Variables of the JoiningProcessManagementType have additional Attributes defined in Table 93.
Table 93 – JoiningProcessManagementType Attribute values for child nodes
|
BrowsePath |
Value Attribute |
Description Attribute |
|
0:DefaultInstanceBrowseName |
JoiningProcessManagement |
The default BrowseName for instances of the type. |
The Method SendJoiningProcess is used to send a joining process to the joining system. It can be used to insert a joining program or joining batch or joining job or any other process applicable to a joining system. It shall overwrite the joining process if it already exists in the joining system.
The signature of this Method is specified below. Table 94 and Table 95 specify the Arguments and AddressSpace representation, respectively.
Signature
SendJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessDataTypejoiningProcess,
[in]0:TrimmedString selectionName,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 94 – SendJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcess |
With this argument the Client can provide the content of the joining process. |
|
selectionName |
With this argument the Client can provide the required selection name for the given joining process. It is optional and can be empty. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 95 – SendJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SendJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method GetJoiningProcessList is used to get the list of joining process meta data available in the system.
The signature of this Method is specified below. Table 96 and Table 97 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJoiningProcessList (
[in]0:String productInstanceUri,
[out]JoiningProcessMetaDataType[]joiningProcessList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 96 – GetJoiningProcessList Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessList |
It is the list of joining process meta data available in the system. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 97 – GetJoiningProcessList Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetJoiningProcessList |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method GetJoiningProcessRevisionList is used to get the list available revisions of a specific joining process based on the joiningProcessOriginId.
The signature of this Method is specified below. Table 98 and Table 99 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJoiningProcessRevisionList (
[in]0:String productInstanceUri,
[in]0:TrimmedString joiningProcessOriginId,
[out]JoiningProcessMetaDataType[]joiningProcessList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 98 – GetJoiningProcessRevisionList Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessOriginId |
It is the origin identifier of the joining process which is used to manage the revisions of a given joining process. |
|
joiningProcessList |
It is the list of joining process meta data available in the system. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 99 – GetJoiningProcessRevisionList Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetJoiningProcessRevisionList |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method GetJoiningProcess is used to get the joining process based on the input identifier.
The signature of this Method is specified below. Table 100 and Table 101 specify the Arguments and AddressSpace representation, respectively.
Signature
GetJoiningProcess (
[in]0:String productInstanceUri,
[in]0:TrimmedString joiningProcessId,
[out]JoiningProcessDataType joiningProcess,
[out]0:TrimmedString selectionName,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 100 – GetJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessId |
It is the identifier of the joining process. |
|
joiningProcess |
It is the joining process available in the system. |
|
selectionName |
It is the selection name of the joining process configured in the system. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 101 – GetJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method SetJoiningProcessMapping is used to set the mapping of the joining process in a joining system. It can be used to map a joining process to a selection name.
The signature of this Method is specified below. Table 102 and Table 103 specify the Arguments and AddressSpace representation, respectively.
Signature
SetJoiningProcessMapping (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 102 – SetJoiningProcessMapping Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to map the respective joiningProcessId with selectionName and joiningProcessOriginId.
It shall at least contain the joiningProcessId and selectionName. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 103 – SetJoiningProcessMapping Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetJoiningProcessMapping |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method SelectJoiningProcess is used to select the joining process based on the input arguments.
The signature of this Method is specified below. Table 104 and Table 105 specify the Arguments and AddressSpace representation, respectively.
Signature
SelectJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 104 – SelectJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 105 – SelectJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SelectJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method DeselectJoiningProcess is used to deselect any selected joining process.
The signature of this Method is specified below. Table 106 and Table 107 specify the Arguments and AddressSpace representation, respectively.
Signature
DeselectJoiningProcess (
[in]0:String productInstanceUri,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 106 – DeselectJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 107 – DeselectJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
DeselectJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method StartJoiningProcess is used to start the input joining process.
Note: It is not intended to be used in a hard real-time use case.
The signature of this Method is specified below. Table 108 and Table 109 specify the Arguments and AddressSpace representation, respectively.
Signature
StartJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in] EntityDataType[] associatedEntities,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 108 – StartJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
associatedEntities |
It is the list of identifiers used for performing the joining operation. It is optional and can be empty. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 109 – StartJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
StartJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method StartSelectedJoining is used to start the selected joining. The joining operation can be selected using SelectJoiningProcess or SelectJoint.
Note: It is not intended to be used in a hard real-time use case.
The signature of this Method is specified below. Table 110 and Table 111 specify the Arguments and AddressSpace representation, respectively.
Signature
StartSelectedJoining (
[in]0:String productInstanceUri,
[in]0:Boolean deselectAfterJoining,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 110 – StartSelectedJoining Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
deselectAfterJoining |
If True, it will deselect the existing joining process after the joining operation is completed. The default value is False. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 111 – StartSelectedJoining Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
StartSelectedJoining |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method SetJoiningProcessSize is used to set the size of the batch joining process.
The signature of this Method is specified below. Table 112 and Table 113 specify the Arguments and AddressSpace representation, respectively.
Signature
SetJoiningProcessSize (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in]0:UInt32 maxCounterSize,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 112 – SetJoiningProcessSize Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
maxCounterSize |
It is the maximum counter size for the joining process. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 113 – SetJoiningProcessSize Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetJoiningProcessSize |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method IncrementJoiningProcessCounter is used to increment the counter of the sequential joining processes such as Job, etc.
The signature of this Method is specified below. Table 114 and Table 115 specify the Arguments and AddressSpace representation, respectively.
Signature
IncrementJoiningProcessCounter (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in]0:UInt32 incrementCount,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 114 – IncrementJoiningProcessCounter Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
incrementCount |
It is the number of increments to be done for the joining process counter. The default value is 1 if it is not provided. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 115 – IncrementJoiningProcessCounter Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
IncrementJoiningProcessCounter |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method DecrementJoiningProcessCounter used to decrement the counter of the sequential joining processes such as Job, etc .
The signature of this Method is specified below. Table 116 and Table 117 specify the Arguments and AddressSpace representation, respectively.
Signature
DecrementJoiningProcessCounter (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in]0:UInt32 decrementCount,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 116 – DecrementJoiningProcessCounter Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
decrementCount |
It is the number of decrements to be done for the joining process counter. The default value is 1 if it is not provided. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 117 – DecrementJoiningProcessCounter Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
DecrementJoiningProcessCounter |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method SetJoiningProcessCounter is used to set the counter of a sequential joining processes (such as Job, etc.) to the given input value.
The signature of this Method is specified below. Table 118 and Table 119 specify the Arguments and AddressSpace representation, respectively.
Signature
SetJoiningProcessCounter (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in]0:UInt32 counterValue,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 118 – SetJoiningProcessCounter Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
counterValue |
It is the new counter value for the joining process. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 119 – SetJoiningProcessCounter Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetJoiningProcessCounter |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method ResetJoiningProcess is used to reset/restart the sequential joining processes such as Job, etc.
The signature of this Method is specified below. Table 120 and Table 121 specify the Arguments and AddressSpace representation, respectively.
Signature
ResetJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 120 – ResetJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 121 – ResetJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
ResetJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method AbortJoiningProcess is used to abort the input joining process if it is under execution.
The signature of this Method is specified below. Table 122 and Table 123 specify the Arguments and AddressSpace representation, respectively.
Signature
AbortJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[in]0:LocalizedText abortMessage,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 122 – AbortJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
abortMessage |
It is an optional message sent from the Client to the joining system to indicate the reason for aborting the joining operation. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 123 – AbortJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
AbortJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
The Method DeleteJoiningProcess is used to delete the input joining process.
The signature of this Method is specified below. Table 122 and Table 123 specify the Arguments and AddressSpace representation, respectively.
Signature
DeleteJoiningProcess (
[in]0:String productInstanceUri,
[in]JoiningProcessIdentificationDataType
joiningProcessIdentification,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 124 – DeleteJoiningProcess Method Arguments
|
Argument |
Description |
|
productInstanceUri |
With this argument the Client can provide the identifier of the asset on which this method is applicable. It can be empty if the method is modelled directly under the required asset. If it is empty, the system can consider the identifier of the asset where the Server is running. |
|
joiningProcessIdentification |
It is the identification information of the joining process which can be used to select the joiningProcess.
If it includes joiningProcessId then it is used for the selection and other arguments are ignored.
If it does not include joiningProcessId, then the system checks for joiningProcessOriginId which will be used for the selection.
If joiningProcessId and joiningProcessOriginId are not available, then the system uses the selectionName for the selection of the joining process. |
|
status |
It provides the status of the Method execution. Refer 7.2.3 for details. |
|
statusMessage |
It provides the high-level status information in a user-friendly text. |
Table 125 – DeleteJoiningProcess Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
DeleteJoiningProcess |
||||
|
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
|
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
|
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |