7.7 JoiningProcessManagementType ObjectType Definition

7.7.1 Overview

The JoiningProcessManagementType provides access to various joining processes in a joining system and is formally defined in Table 96.

Table 96 – JoiningProcessManagementType Definition
Attribute Value
BrowseNameJoiningProcessManagementType
IsAbstractFalse
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:HasPropertyVariable0:DefaultInstanceBrowseName0:QualifiedName0:PropertyType
0:HasComponentMethodSendJoiningProcessO
0:HasComponentMethodGetJoiningProcessListO
0:HasComponentMethodGetJoiningProcessRevisionListO
0:HasComponentMethodGetJoiningProcessO
0:HasComponentMethodSetJoiningProcessMappingO
0:HasComponentMethodSelectJoiningProcessO
0:HasComponentMethodDeselectJoiningProcessO
0:HasComponentMethodIncrementJoiningProcessCounterO
0:HasComponentMethodDecrementJoiningProcessCounterO
0:HasComponentMethodSetJoiningProcessCounterO
0:HasComponentMethodSetJoiningProcessSizeO
0:HasComponentMethodResetJoiningProcessO
0:HasComponentMethodAbortJoiningProcessO
0:HasComponentMethodStartJoiningProcessO
0:HasComponentMethodStartSelectedJoiningO
0:HasComponentMethodDeleteJoiningProcessO
0:HasComponentMethodGetSelectedJoiningProgramO
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
IJT Get Selected Joining Program
IJT Send Joining Process
IJT Get Joining Process
IJT Set Joining Process Counter
IJT Set Joining Process Mapping
IJT Get Joining Process Revision List

The component Variables of the JoiningProcessManagementType have additional Attributes defined in Table 97.

Table 97 – JoiningProcessManagementType Attribute values for child nodes
BrowsePath Value Attribute Description Attribute
0:DefaultInstanceBrowseNameJoiningProcessManagementThe default BrowseName for instances of the type.

7.7.2 SendJoiningProcess

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.

Note: The Server includes the business logic to validate the received joining process.

The signature of this Method is specified below. Table 98 and Table 99 specify the Arguments and AddressSpace representation, respectively.

Signature

	SendJoiningProcess (
		[in]	0:String			productInstanceUri,
		[in]	JoiningProcessDataType	joiningProcess,
		[in]	0:TrimmedString			selectionName,
		[out]	0:Int64			status,
		[out]	0:LocalizedText			statusMessage)
Table 98 – 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.

joiningProcessWith this argument the Client can provide the content of the joining process.
selectionNameWith this argument the Client can provide the required selection name for the given joining process. It is optional and can be empty.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 99 – SendJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameSendJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.3 GetJoiningProcessList

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 100 and Table 101 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 100 – 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.

joiningProcessListIt is the list of joining process meta data available in the system.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 101 – GetJoiningProcessList Method AddressSpace Definition
Attribute Value
BrowseNameGetJoiningProcessList
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.4 GetJoiningProcessRevisionList

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 102 and Table 103 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 102 – 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.

joiningProcessOriginIdIt is the origin identifier of the joining process which is used to manage the revisions of a given joining process.
joiningProcessListIt is the list of joining process meta data available in the system.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 103 – GetJoiningProcessRevisionList Method AddressSpace Definition
Attribute Value
BrowseNameGetJoiningProcessRevisionList
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.5 GetJoiningProcess

The Method GetJoiningProcess is used to get the joining process based on the input identifier.

The signature of this Method is specified below. Table 104 and Table 105 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 104 – 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.

joiningProcessIdIt is the identifier of the joining process.
joiningProcessIt is the joining process available in the system.
selectionNameIt is the selection name of the joining process configured in the system.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 105 – GetJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameGetJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.6 SetJoiningProcessMapping

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 106 and Table 107 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 106 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 107 – SetJoiningProcessMapping Method AddressSpace Definition
Attribute Value
BrowseNameSetJoiningProcessMapping
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.7 SelectJoiningProcess

The Method SelectJoiningProcess is used to select the joining process based on the input arguments.

The signature of this Method is specified below. Table 108 and Table 109 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 108 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 109 – SelectJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameSelectJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.8 DeselectJoiningProcess

The Method DeselectJoiningProcess is used to deselect any selected joining process.

The signature of this Method is specified below. Table 110 and Table 111 specify the Arguments and AddressSpace representation, respectively.

Signature

	DeselectJoiningProcess (
		[in]	0:String				productInstanceUri,
		[out]	0:Int64				status,
		[out]	0:LocalizedText				statusMessage)
Table 110 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 111 – DeselectJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameDeselectJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.9 StartJoiningProcess

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 112 and Table 113 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 112 – 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.

associatedEntitiesIt is the list of identifiers used for performing the joining operation. It is optional and can be empty.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 113 – StartJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameStartJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.10 StartSelectedJoining

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 114 and Table 115 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 114 – 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.

Note: If deselection is not possible or fails, but the joining operation starts successfully, the status will be returned as successful. However, the statusMessage can include additional information.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 115 – StartSelectedJoining Method AddressSpace Definition
Attribute Value
BrowseNameStartSelectedJoining
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.11 SetJoiningProcessSize

The Method SetJoiningProcessSize is used to set the size of the batch joining process.

The signature of this Method is specified below. Table 116 and Table 117 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 116 – 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.

maxCounterSizeIt is the maximum counter size for the joining process.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 117 – SetJoiningProcessSize Method AddressSpace Definition
Attribute Value
BrowseNameSetJoiningProcessSize
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.12 IncrementJoiningProcessCounter

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 118 and Table 119 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 118 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 119 – IncrementJoiningProcessCounter Method AddressSpace Definition
Attribute Value
BrowseNameIncrementJoiningProcessCounter
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.13 DecrementJoiningProcessCounter

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 120 and Table 121 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 120 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 121 – DecrementJoiningProcessCounter Method AddressSpace Definition
Attribute Value
BrowseNameDecrementJoiningProcessCounter
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.14 SetJoiningProcessCounter

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 122 and Table 123 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 122 – 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.

counterValueIt is the new counter value for the joining process.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 123 – SetJoiningProcessCounter Method AddressSpace Definition
Attribute Value
BrowseNameSetJoiningProcessCounter
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.15 ResetJoiningProcess

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 124 and Table 125 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 124 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 125 – ResetJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameResetJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.16 AbortJoiningProcess

The Method AbortJoiningProcess is used to abort the input joining process if it is under execution.

Note: It is not intended to be used in a hard real-time use case.

The signature of this Method is specified below. Table 126 and Table 127 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 126 – 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.

abortMessageIt is an optional message sent from the Client to the joining system to indicate the reason for aborting the joining operation.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 127 – AbortJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameAbortJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.17 DeleteJoiningProcess

The Method DeleteJoiningProcess is used to delete the input joining process.

The signature of this Method is specified below. Table 126 and Table 127 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 128 – 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.

statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 129 – DeleteJoiningProcess Method AddressSpace Definition
Attribute Value
BrowseNameDeleteJoiningProcess
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory

7.7.18 GetSelectedJoiningProgram

The Method GetSelectedJoiningProgram is used to get the selected joining program for a given asset.

The signature of this Method is specified below. Table 130 and Table 131 specify the Arguments and AddressSpace representation, respectively.

Signature

	GetSelectedJoiningProgram (
		[in]	0:String				productInstanceUri,
		[out]	JoiningProcessMetaDataType	selectedJoiningProgram,
		[out]	0:Int64				status,
		[out]	0:LocalizedText				statusMessage)
Table 130 – GetSelectedJoiningProgram 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.

selectedJoiningProgramIt is the selected joining program for the input asset.
statusIt provides the status of the Method execution. Refer 7.4 for details.
statusMessageIt provides the high-level status information in a user-friendly text.
Table 131 – GetSelectedJoiningProgram Method AddressSpace Definition
Attribute Value
BrowseNameGetSelectedJoiningProgram
References Node Class BrowseName DataType TypeDefinition ModellingRule
0:HasPropertyVariable0:InputArguments0:Argument[]0:PropertyType0:Mandatory
0:HasPropertyVariable0:OutputArguments0:Argument[]0:PropertyType0:Mandatory