The JoiningSystemAssetMethodSetType provides a set of methods for various assets in a joining system and is formally defined in Table 58.
Table 58 – JoiningSystemAssetMethodSetType Definition
|
Attribute |
Value |
||||
|
BrowseName |
JoiningSystemAssetMethodSetType |
||||
|
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 |
SetCalibration |
|
|
O |
|
0:HasComponent |
Method |
EnableAsset |
|
|
O |
|
0:HasComponent |
Method |
DisconnectAsset |
|
|
O |
|
0:HasComponent |
Method |
RebootAsset |
|
|
O |
|
0:HasComponent |
Method |
SendFeedback |
|
|
O |
|
0:HasComponent |
Method |
GetFeedbackFileList |
|
|
O |
|
0:HasComponent |
Method |
SetTime |
|
|
O |
|
0:HasComponent |
Method |
SetOfflineTimer |
|
|
O |
|
0:HasComponent |
Method |
SetIOSignals |
|
|
O |
|
0:HasComponent |
Method |
GetIOSignals |
|
|
O |
|
0:HasComponent |
Method |
SendIdentifiers |
|
|
O |
|
0:HasComponent |
Method |
SendTextIdentifiers |
|
|
O |
|
0:HasComponent |
Method |
GetIdentifiers |
|
|
O |
|
0:HasComponent |
Method |
ResetIdentifiers |
|
|
O |
|
0:HasComponent |
Method |
GetErrorInformation |
|
|
O |
|
0:HasComponent |
Method |
ExecuteOperation |
|
|
O |
|
Conformance Units |
|||||
|
IJT Method Input Argument |
|||||
|
IJT Disconnect Asset |
|||||
|
IJT Enable Tool |
|||||
|
IJT Send Identifiers |
|||||
|
IJT Get Identifiers |
|||||
|
IJT Reset Identifiers |
|||||
The component Variables of the JoiningSystemAssetMethodSetType have additional Attributes defined in Table 59.
Table 59 – JoiningSystemAssetMethodSetType Attribute values for child nodes
|
BrowsePath |
Value Attribute |
Description Attribute |
|
0:DefaultInstanceBrowseName |
2:MethodSet |
The default BrowseName for instances of the type. |
The Method SetCalibration is used to set the calibration information of a given asset.
It is intended to set the basic calibration information and does not cover the certification process.
Note:
- In a Joining System, calibration data is applicable primarily to a Sensor (if available), else it can be set for the Tool when the Sensor asset is not available.
- The Server shall update the respective Calibration information of the asset after execution of this method.
The signature of this Method is specified below. Table 60 and Table 61 specify the Arguments and AddressSpace representation, respectively.
Signature
SetCalibration (
[in]0:String productInstanceUri,
[in]CalibrationDataTypecalibrationData,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 60 – SetCalibration 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. |
|
calibrationData |
It is the input calibration data which needs to be configured for the asset. |
|
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 61 – SetCalibration Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetCalibration |
||||
|
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 EnableAsset is used to Enable or Disable a given asset. It is mostly applicable for Tool.
The joining system can report a respective event when an asset is enabled or disabled.
The signature of this Method is specified below. Table 62 and
Table 63 specify the Arguments and AddressSpace representation, respectively.
Signature
EnableAsset (
[in]0:String productInstanceUri,
[in]0:Boolean enable,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 62 – EnableAsset 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. |
|
enable |
If true, it will enable the asset, else it will disable the asset. The default value is false. Note: If the asset is performing the joining operation when the method is executed, then it shall disable the asset after the current 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 63 – EnableAsset Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
EnableAsset |
||||
|
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 DisconnectAsset is used to disconnect or connect the asset.
Note: It is intended to be used for physical assets connected with physical cables where an asset can be disconnected using the method before removing the cable connection.
Examples: Cable Tool connected to a Controller or a gateway, Robot docking.
The joining system can report a respective event when an asset is ready to be disconnected.
The signature of this Method is specified below. Table 64 and Table 65 specify the Arguments and AddressSpace representation, respectively.
Signature
DisconnectAsset (
[in]0:String productInstanceUri,
[in]0:Boolean disconnect,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 64 – DisconnectAsset 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. |
|
disconnect |
If true, it will prepare the asset for disconnect. 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 65 – DisconnectAsset Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
DisconnectAsset |
||||
|
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 RebootAsset is used to reboot an asset.
The signature of this Method is specified below. Table 66 and Table 67 specify the Arguments and AddressSpace representation, respectively.
Signature
RebootAsset (
[in]0:String productInstanceUri,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 66 – RebootAsset 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 67 – RebootAsset Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
RebootAsset |
||||
|
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 SendFeedback is used to send any type of feedback to a given asset. The feedback can be a text input or other types of feedback supported by the asset.
Note: The types of feedback files supported is application specific. Refer to the application documentation or configuration for the details of the feedback files.
The signature of this Method is specified below. Table 68 and
Table 69 specify the Arguments and AddressSpace representation, respectively.
Signature
SendFeedback (
[in]0:String productInstanceUri,
[in]0:Int16 feedbackType,
[in]0:String feedbackText,
[in]0:String feedbackFile,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 68 – SendFeedback 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. |
|
feedbackType |
It is the type of feedback and has the following pre-defined values: 0 – UNDEFINED 1 – OTHER 2 – TEXT 3 – VISUAL 4 – AUDIO 5 – VIBRATE |
|
feedbackText |
It is the text feedback if the feedbackType is TEXT. It is empty for any other feedback type. |
|
feedbackFile |
It is the file available in the asset which needs to be run for different types of feedback such as AUDIO, VIBRATE, etc. This can be retrieved using the GetFeedbackFileList method. It is optional and not applicable for text feedback. |
|
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 69 – SendFeedback Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SendFeedback |
||||
|
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 GetFeedbackFileList is used to get the list of feedback files from the asset.
Note: The types of feedback files supported is application specific. Refer to the application documentation or configuration for the details of the feedback files.
The signature of this Method is specified below. Table 70 and Table 71 specify the Arguments and AddressSpace representation, respectively.
Signature
GetFeedbackFileList (
[in]0:String productInstanceUri,
[out]0:String[] feedbackFileList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 70 – GetFeedbackFileList 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. |
|
feedbackFileList |
It is the list of feedback files available in the system. It contains the feedback filenames or the file paths which can be used as an input in SendFeedback method. |
|
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 71 – GetFeedbackFileList Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetFeedbackFileList |
||||
|
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 SetTime is used to set the time of the asset manually. It is recommended to be used only when an asset does not have automated time synchronization.
The joining system can report a respective event when the time is configured manually using this method.
The signature of this Method is specified below. Table 72 and Table 73 specify the Arguments and AddressSpace representation, respectively.
Signature
SetTime (
[in]0:String productInstanceUri,
[in]0:UtcTime inputTime,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 72 – SetTime 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. |
|
inputTime |
It is the input time to be configured in the asset. |
|
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 73 – SetTime Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetTime |
||||
|
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 SetOfflineTimer is used to set the offline timer for the asset to determine how long the asset can perform the joining operations in an offline mode.
Note: If an asset performs the joining operation in offline mode after setting the offline timer, the corresponding results generated shall have the IsGeneratedOffline flag set to TRUE.
The signature of this Method is specified below. Table 74 and Table 75 specify the Arguments and AddressSpace representation, respectively.
Signature
SetOfflineTimer (
[in]0:String productInstanceUri,
[in]0:Duration offlineTimer,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 74 – SetOfflineTimer 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. |
|
offlineTimer |
It is the offlineTimer to be set. The behaviour of the asset when the timer is elapsed is application specific. |
|
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 75 – SetOfflineTimer Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetOfflineTimer |
||||
|
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 SetIOSignals is used to set a list of IO signals of the asset. The type of operations mapped to each signal is application specific.
The signature of this Method is specified below. Table 76 and Table 77 specify the Arguments and AddressSpace representation, respectively.
Signature
SetIOSignals (
[in]0:String productInstanceUri,
[in]SignalDataType[] signalList,
[out]0:Int32[] signalStatusList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 76 – SetIOSignals 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. |
|
signalList |
It is the list of signals which needs to be set in the asset. |
|
signalStatusList |
It is the list of status for each signal. 0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors. |
|
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 77 – SetIOSignals Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SetIOSignals |
||||
|
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 GetIOSignals is used to get the list of available signals from the asset.
Note: Client can also subscribe to IOSignals variable in the address space to get the list of signals.
The signature of this Method is specified below. Table 78 and Table 79 specify the Arguments and AddressSpace representation, respectively.
Signature
GetIOSignals (
[in]0:String productInstanceUri,
[in]0:TrimmedString[] signalIdList,
[out]SignalDataType[] signalList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 78 – GetIOSignals 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. |
|
signalIdList |
It is the list of signal identifiers requested. If it is empty, then all the available signals are returned from the asset. |
|
signalList |
It is the list of signals which are available in the asset based on the input signalIdList. If the signalIdList is empty, then all the available signals are sent from the asset. |
|
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 79 – GetIOSignals Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetIOSignals |
||||
|
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 SendIdentifiers is used to send one or more identifiers to the joining system.
These identifiers can be used for selection of a joining process, etc.
These identifiers can often be part of the generated result.
The input argument to this method is an array of EntityDataType structure where every entity in the joining system can be associated to a specific type for filtering.
SendTextIdentifiers method can be used if identifiers cannot be sent as an array of EntityDataType.
Note: The decision on which set of identifiers are used for the selection of a joining process and which set of identifiers should be part of the generated result is application specific.
The signature of this Method is specified below. Table 80 and Table 81 specify the Arguments and AddressSpace representation, respectively.
Signature
SendIdentifiers (
[in]0:String productInstanceUri,
[in]EntityDataType[] entityList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 80 – SendIdentifiers 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. |
|
entityList |
It is the list of identifiers sent to the joining 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 81 – SendIdentifiers Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SendIdentifiers |
||||
|
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 SendTextIdentifiers is used to send one or more identifiers to a joining system.
These identifiers can be used for selection of a joining process, etc.
These identifiers can often be part of the generated result.
Note: The decision on which set of identifiers are used for the selection of a joining process and which set of identifiers should be part of the generated result is application specific.
This method can be used only to send the values of the identifiers but it is recommended that SendIdentifiers is used instead of this method.
The signature of this Method is specified below. Table 82 and Table 83 specify the Arguments and AddressSpace representation, respectively.
Signature
SendTextIdentifiers (
[in]0:String productInstanceUri,
[in]0:TrimmedString[] identifierList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 82 – SendTextIdentifiers 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. |
|
identifierList |
It is the list of identifiers sent to the joining 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 83 – SendTextIdentifiers Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
SendTextIdentifiers |
||||
|
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 GetIdentifiers is used to get the list of identifiers available in the system which were managed by external systems.
The signature of this Method is specified below. Table 84 and Table 85 specify the Arguments and AddressSpace representation, respectively.
Signature
GetIdentifiers (
[in]0:String productInstanceUri,
[in]0:TrimmedString[] identifierNames,
[out]EntityDataType[] entityList,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 84 – GetIdentifiers 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. |
|
identifierNames |
The list of names of the identifiers which are requested. If it is empty, then all available identifiers are returned. |
|
entityList |
It is the list of identifiers available in the joining system based on the input criteria. |
|
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 85 – GetIdentifiers Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetIdentifiers |
||||
|
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 ResetIdentifiers is used to reset the specified identifiers.
The signature of this Method is specified below. Table 86 and Table 87 specify the Arguments and AddressSpace representation, respectively.
Signature
ResetIdentifiers (
[in]0:String productInstanceUri,
[in]0:TrimmedString[] identifierList,
[in]0:Boolean resetAll,
[in]0:Boolean resetLatest,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 86 – ResetIdentifiers 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. |
|
identifierList |
It is the list of names of the identifiers which are requested to be reset. If it is NOT empty, then resetAll and resetLatest flags are ignored. If it is empty, then the resetAll or resetLatest flag is used. |
|
resetAll |
If True, it will reset all the identifiers available in the joining system and resetLatest flag is ignored. If False and identifierList is empty then the resetLatest flag is used. |
|
resetLatest |
If True, it will reset the latest identifier available in the system. Note: This is provided for supporting legacy systems. The criteria to determine which identifier is latest is application specific. |
|
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 87 – ResetIdentifiers Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
ResetIdentifiers |
||||
|
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 GetErrorInformation is used to get the error information based on the input identifier. The details returned from the joining system is application specific.
Examples: Log file, Detailed Error Information or Event Logs, or an actual file or reference to some other entity in the system.
The signature of this Method is specified below. Table 88 and Table 89 specify the Arguments and AddressSpace representation, respectively.
Signature
GetErrorInformation (
[in]0:String productInstanceUri,
[in]0:TrimmedString errorId,
[out]0:BaseDataType errorContent,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 88 – GetErrorInformation 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. |
|
errorId |
It is the identifier of the error. It could be available as part of the JoiningResult. It is a mandatory input argument. |
|
errorContent |
It is the detailed error information. Examples: Log file, Detailed Error Information or Event Logs, etc. |
|
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 89 – GetErrorInformation Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
GetErrorInformation |
||||
|
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 ExecuteOperation is an application specific interface to execute any generic operations supported by a joining system.
The signature of this Method is specified below. Table 90 and Table 91 specify the Arguments and AddressSpace representation, respectively.
Signature
ExecuteOperation (
[in]0:String productInstanceUri,
[in]0:Int32 operationType,
[in]0:String operationText,
[in]0:String vendorName,
[out]0:Int64 status,
[out]0:LocalizedText statusMessage)
Table 90 – ExecuteOperation 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. |
|
operationType |
It is the type of operation. The list of integer values corresponding to a specific operation is provided by the documentation or the joining system via some interface. |
|
operationText |
It is the optional text to provide information on the type of operation. |
|
vendorName |
It is the optional vendor’s name provided to identify the type of operations supported. |
|
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 91 – ExecuteOperation Method AddressSpace Definition
|
Attribute |
Value |
||||
|
BrowseName |
ExecuteOperation |
||||
|
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 |