Joining Systems Base - 7.5.16 AbortJoiningProcess

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