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 |