Status Abort and Timeout Messages
This page describes how Status Messages, Abort Messages and Exception Messages can be configured/generated.
MES Qualifier in Status and Abort Messages
Status Messages as well as Abort Messages can includes MES qualifieres, these are required by the MES to identify the EBR which the individual message belongs to. As each Status or Abort Messages is generated by an Message Configuration, the Qualifieres are defined by the taglist, and only the entries marked as 'To MES' and 'MES Qualifier' are considered here.
Additionally the Abort and Status Message use the same 'Mapping Type' to read the values of the MES Qualifier and therefore the generations differs depending on the mapping type.
Direct Mapping
Status Message
The MSI interface is capable of the generation of status messages. Status messages do not include any parameters, but they may include qualifiers, which are used to assigne this message to the correct basic function. Therefore the status message is best used in the context of a bidirectional communication. In this scenario a bidirectional OrderParameter Message is configured. An incomming message will then include the required qualifier values, which are stored in inmation or even on a connected OPC-UA Server or PLC, depending on the configuration of the item at the configured Path.
In additiona to the Qualifiers, the the Status Message includes only a status text. This text can either be predefined or be read from an path within the system. If no path is given or the path is not readable, the predefined status will be used. The status message is sent whenever the Trigger Item is set to true or a triggering script returns true. If the message was triggered by a Trigger Item, this item will be reset to false when the message has been generated. The Message Name is for documentation purposes only.
Abort Message
The MSI interface is also capable of generatng abort messages. Abort Messages do not include any parameters, but they may include qualifiers, which are used to assigne this message to the correct basic function. The Abort Message is intended as an alterntive to the OrderParameterMessage as error response to a bidirectional communication. Therefore the abort message shallbe used in the context of a bidirectional communication. In this scenario a bidirectional OrderParameter Message is configured. An incomming message will then include the required qualifier values, which are stored in inmation or even on a connected OPC-UA Server or PLC, depending on the configuration of the item at the configured Path.
In addition to the qualifiers, the abort message only includes an ErrorCode an the ErrorTest. Both can either be predefined or read from a path within the system. The predefined ErrorCode and ErrorText are used if no associated path is given or if this path is not readable. The abort message is sent whenever the Trigger Item is set to true or the triggering script returns true. If the message was triggered by a Trigger Item, this item will be reset to false when the message has been generated. The Message Name is for documentation purpose only.
The configuration Device Path and Device Name do not have any meaning for direct mapping and are ignored.
Using Central Mapping
If the Mapping type of the 'Message Configuration' is direct mapping, then the qualifier values will be determinated following the rules of the direct mapping. In this case all ObjectNames in the Taglist which are marked as qualifiers, there must be an entry for EquipmentId= <EquipmentId> and Tag= <ObjectName> in the central mapping table. The Path from this entry will then be used to read the individual qualifier value.
Group Mapping
Status Message
The MSI interface is capable of the generation of status messages. Status messages do not include any parameters, but they may include qualifiers, which are used to assigne this message to the correct basic function. Therefore the status message is best used in the context of a bidirectional communication. In this scenario a bidirectional OrderParameter Message is configured. An incomming message will then include the required qualifier values, which are stored in inmation or even on a connected OPC-UA Server or PLC, depending on the configuration of the item at the configured Path.
In order to allow different Status Texts per device and to allow different trigger items on a "per Device" basis, each device will need its own set of Status Message Configurations.
In order to identify, for which device the individual configuration shall be valid, the property Device Name shall be configured with the individual Device Name. The Device Path is still available, but deprecated and will be removed in the future.
Based on the Device Name the path of the qualifiers is resolved.
In additiona to the Qualifiers, the the Status Message includes only a status text. This text can either be predefined or be read from an path within the system. If no path is given or the path is not readable, the predefined status will be used.
The status message is sent whenever the Trigger Item is set to true or a triggering script returns true. If the message was triggered by a Trigger Item, this item will be reset to false when the message has been generated. The Message Name is for documentation purposes only.
Abort Message
The MSI interface is also capable of generatng abort messages. Abort Messages do not include any parameters, but they may include qualifiers, which are used to assigne this message to the correct basic function. The Abort Message is intended as an alterntive to the OrderParameterMessage as error response to a bidirectional communication. Therefore the abort message shallbe used in the context of a bidirectional communication. In this scenario a bidirectional OrderParameter Message is configured. An incomming message will then include the required qualifier values, which are stored in inmation or even on a connected OPC-UA Server or PLC, depending on the configuration of the item at the configured Path.
In order to allow different "Error Codes" and "Error Texts" per device and to allow different trigger items on a "per Device" basis, each device will need its own set of Abort Message Configurations. In order to identify, for which device the individual configuration shall be valid, the property Device Name shall be configured with the individual Device Name. The Device Path is still available, but deprecated and will be removed in the future.
Based on the Device Name the path of the qualifiers is resolved.
In additiona to the Qualifiers, the the Abort Message includes only a Error Code and Error. Both can either be predefined or read from a path within the system. The predefined ErrorCode and ErrorText are used if no associated path is given or if this path is not readable.
The abort message is sent whenever the Trigger Item is set to true or a triggering script returns true. If the message was triggered by a Trigger Item, this item will be reset to false when the message has been generated. The Message Name is for documentation purposes only.
Using Central Mapping
In order to use the Group Mapping in combination with the Central Mapping the Group Mapping must have one entry, which identifies the DeviceSelector. This is required in order to identify which ObjectName of the taglist shall be used as DeviceSelector.
Then the 'Device Name' must be configured for the status message. This device name is combined with the ObjectName in the Taglist (which are marked as qualifiers). And with these two information the path of the qualifier is looked up un the 'Central Mapping Table'.
For this combination there must be an entry for EquipmentId= <Device Name> and Tag= <ObjectName> in the central mapping table. The 'Device Path' configuration is ignored.
Flexible Mapping and Historian Mapping
For Flexible Mapping and Historian Mapping, the Status Message and Abort Message configurations must not be used. The required Qualifiers will not be available and thus the communication will not reach the correct place in the EBR.
Custom Script and Function Mapping
In the case of an Function Mapping or Custom Script Mapping Status Messages are currently not supported.
Abort Messages can be send instead of a OrderParameter Message as response. In order to send an Abort Message there is an aditional return value available for the Output Function (Function Mapping) or the Output Script (Custom Script Mapping). This additional parameter must include the ErrorCode, ErrorText and the required Qualifiers. The detailes structure of the response is described here: Function and CustomScript Mapping.
Usage of Central Mapping
The Central Mapping can also be used for the generation of Abort Messages within Function Mapping and CustomScript Mapping. This is possible as follows: The 'Central Mapping Table' is available as additional input parameter to the Output Function (Function Mapping) and the Output Script (Custom Script Mapping). Therefore the mapping can be used in these functions for the generation of the Abort Message.
Timeout Messages
Timeout Message are Abort messages, which are automatically generate whenever an bidirectional communication runs into a timeout. In order for a timeout to work correctly, the requires MES Quallifier must be included in the incomming message (the must be marked as 'Bidirectional'). This allows to use the qualifier from the incomming message to automatically generate a timeout message whithout any outgoing data.
The only configuration left for a timeout message is the 'Error Code' and 'Error Text' to be used in the Abort Message for Timeouts.
Timeout Messages are generated automatically for each Bidirectional Communication, which runs into a timeout, independent of the Mapping Type.