Support types
EventClass
Purpose: Provide a high-level categorisation of events.
Details:
- Message events relate to the structure and delivery of aseXML A standard for energy transactions in XML. A set of schemas and usage guidelines that define how data should be exchanged under FRC in the gas and electricity industries in Australia. messages.
- Application events are generated by the applications communicating via aseXML.
- Processing events reflect environmental issues associated with running applications.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventClass |
xsd:string enumerated list (see EventClass list) |
simple |
Events_r41 |
|
Application |
Message |
Processing |
|---|
EventCode
Purpose: Provide a numeric identification of the event that has occurred.
Detail: The Guidelines for the Development of aseXML define a set of common codes, as well as ranges for application whitespace errors. Where the receiving system does not know the textual definition of the code, the description attribute is provided with the code, as per the Guidelines for the Development of aseXML.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventCode |
see relevant B2B Procedure |
complex |
Events_r41 |
|
EventCodeBase |
nonnegative xsd:integer |
Events_r41 |
|
|
description |
xsd:string use=”optional” |
attribute |
Events_r41 |
EventCodeBase
Purpose: Helper Type in defining EventCode.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventCodeBase |
non-negative xsd:integer |
simple |
Events_r41 |
EventContext
Purpose: Identify the specific data or condition causing the event.
Detail: Provide the portion of the input where the event applies.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventContext |
xsd:string maxLength value=”80”xsd:string ≤ 80 chars |
simple |
Events_r41 |
EventKeyInfo
Purpose: Provide information to allow identification of the data triggering the event.
Detail: Where the combination of class and code are insufficient to completely describe an event, you can use KeyInfo to provide further detail about the source of the event within the original transaction.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventKeyInfo |
xsd:string |
simple |
Events_r41 |
EventSeverity
Purpose: Provide an indication of the action required after receiving an event.
Detail: The severity dictates the further processing possible after receiving the event.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
EventSeverity |
xsd:string enumerated list (see Table 51 EventSeverity) |
simple |
Events_r41 |
Figure 126 Table 51 EventSeverity
|
Error |
Fatal |
Information |
Warning |
|---|
EventSupportedVersions
Purpose: Provide the set of versions supported for a particular transaction.
Detail: Where an unsupported version of a supported transaction is received, the initiator indicates the supported version to allow the receiver to choose a compatible version.
|
Field |
Restrictions |
aseXML |
Schema |
|---|---|---|---|
|
version |
maxOccurs=”unbounded” |
Events_r41 |