This schema file is part of the aseXML schema set, and is subject to the terms and conditions that are detailed in the aseXML_r*.xsd schema file with which this file is used
Purpose - Define the common format to be used to report events.Detail - aseXML encourages the use of events in transactions to report status information. They are also used in message and transaction acknowledgements.
Purpose - Top level element used when reporting transport level errors, e.g. decompression failuresDetail - There may be a number of error conditions detected by a transport receiving an aseXML message, that prevent it detecting a valid message. In order that these can be reported as XML in a consistent fashion, this top level element may be used. It should be noted that this element is not to be used via the ref="Event" mechanism of XML Schema.Rather, this should always be achieved via a type="Event" attribute. For an example, refer tothe acknowledgements schema.
<xsd:element name="Event" type="Event"><xsd:annotation><xsd:documentation>Purpose - Top level element used when reporting transport level errors, e.g. decompression failures Detail - There may be a number of error conditions detected by a transport receiving an aseXML message, that prevent it detecting a valid message. In order that these can be reported as XML in a consistent fashion, this top level element may be used. It should be noted that this element is not to be used via the ref="Event" mechanism of XML Schema. Rather, this should always be achieved via a type="Event" attribute. For an example, refer to the acknowledgements schema.</xsd:documentation></xsd:annotation></xsd:element>
<xsd:simpleType name="ReleaseIdentifier"><xsd:annotation><xsd:documentation>Purpose - Identify a release of aseXML Details - Release identifiers are used extensively in aseXML to enable versioning of transactions.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:pattern value="r[0-9]*|r[0-9]*_[a-z][0-9]*"/></xsd:restriction></xsd:simpleType>
Purpose - Common format used to report eventsDetail - aseXML encourages the use of events in transactions to report status information. They are also used in message and transaction acknowledgements. Where possible, an element name of "Event" should be used.
<xsd:complexType name="Event"><xsd:annotation><xsd:documentation>Purpose - Common format used to report events Detail - aseXML encourages the use of events in transactions to report status information. They are also used in message and transaction acknowledgements. Where possible, an element name of "Event" should be used.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="Code" type="EventCode"/><xsd:element name="KeyInfo" type="EventKeyInfo" minOccurs="0"/><xsd:element name="Context" type="EventContext" minOccurs="0"/><xsd:element name="Explanation" type="xsd:string" minOccurs="0"/><xsd:element name="SupportedVersions" type="EventSupportedVersions" minOccurs="0"/></xsd:sequence><xsd:attribute name="class" type="EventClass" use="optional" default="Application"/><xsd:attribute name="severity" type="EventSeverity" use="optional" default="Fatal"/></xsd:complexType>
Purpose - Provide a numeric indentification of the event that has occurredDetail - The aseXML guidelines define a set of common codes, as well as ranges for application specfiic errors. Where the receiving system does not know the textual definition of the code, the description attribute should be provided with the code, as per the aseXML guidelines.
<xsd:complexType name="EventCode"><xsd:annotation><xsd:documentation>Purpose - Provide a numeric indentification of the event that has occurred Detail - The aseXML guidelines define a set of common codes, as well as ranges for application specfiic errors. Where the receiving system does not know the textual definition of the code, the description attribute should be provided with the code, as per the aseXML guidelines.</xsd:documentation></xsd:annotation><xsd:simpleContent><xsd:extension base="EventCodeBase"><xsd:attribute name="description" type="xsd:string" use="optional"/></xsd:extension></xsd:simpleContent></xsd:complexType>
<xsd:simpleType name="EventCodeBase"><xsd:annotation><xsd:documentation>Purpose - Helper type in defining EventCode</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:nonNegativeInteger"/></xsd:simpleType>
Purpose - Provide information to allow identification of the data that triggered the eventDetail - Where the combination of class and code are insufficient to completely describe an event, KeyInfo may be used to provide further detail as to the information needed to locate the source of the event within the original transaction.
<xsd:simpleType name="EventKeyInfo"><xsd:annotation><xsd:documentation>Purpose - Provide information to allow identification of the data that triggered the event Detail - Where the combination of class and code are insufficient to completely describe an event, KeyInfo may be used to provide further detail as to the information needed to locate the source of the event within the original transaction.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:maxLength value="80"/></xsd:restriction></xsd:simpleType>
<xsd:simpleType name="EventContext"><xsd:annotation><xsd:documentation>Purpose - Identify the specific data/condition that caused the event Detail - The portion of the input to which the event applies should be provided.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:maxLength value="80"/></xsd:restriction></xsd:simpleType>
Purpose - Provide the set of versions supported for a particular transactionDetail - Where an unsupported version of a supported transaction is received, the receiver should indicate those versions that are supported, allowing the receiver to choose a compatible transaction version.
<xsd:complexType name="EventSupportedVersions"><xsd:annotation><xsd:documentation>Purpose - Provide the set of versions supported for a particular transaction Detail - Where an unsupported version of a supported transaction is received, the receiver should indicate those versions that are supported, allowing the receiver to choose a compatible transaction version.</xsd:documentation></xsd:annotation><xsd:sequence><xsd:element name="Version" type="ReleaseIdentifier" maxOccurs="unbounded"/></xsd:sequence></xsd:complexType>
Purpose - Provide a high level categorisation of eventsDetail - Message events pertain to the structure and delivery of aseXML messages.Application events are generated by the applications communicating via aseXML.Processing events reflect environmental issues associated with running applications.
<xsd:simpleType name="EventClass"><xsd:annotation><xsd:documentation>Purpose - Provide a high level categorisation of events Detail - Message events pertain to the structure and delivery of aseXML messages. Application events are generated by the applications communicating via aseXML. Processing events reflect environmental issues associated with running applications.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="Message"/><xsd:enumeration value="Application"/><xsd:enumeration value="Processing"/></xsd:restriction></xsd:simpleType>
Purpose - Provide an indication as to the action required as a result of receiving an eventDetail - The severity dictates the further processing possible after receiving the event.
<xsd:simpleType name="EventSeverity"><xsd:annotation><xsd:documentation>Purpose - Provide an indication as to the action required as a result of receiving an event Detail - The severity dictates the further processing possible after receiving the event.</xsd:documentation></xsd:annotation><xsd:restriction base="xsd:string"><xsd:enumeration value="Information"/><xsd:enumeration value="Warning"/><xsd:enumeration value="Error"/><xsd:enumeration value="Fatal"/></xsd:restriction></xsd:simpleType>