Acknowledgements

Purpose: The payload used to carry acknowledgments.

Detail: The 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. acknowledgement model calls for acknowledgement of each message and transaction, subject to certain rules.

For more information, see Guidelines for the Development of aseXML.

Field	Restrictions	aseXML	Schema
Acknowledgements	sequence	complex	Acknowledgements_r15
MessageAcknowledgement	see MessageAcknowledgement	MessageAcknowledgement	Acknowledgements_r15
TransactionAcknowledgement	see TransactionAcknowledgement	TransactionAcknowledgement	Acknowledgements_r15
ReceiptIdentifier	see ReceiptIdentifier	ReceiptIdentifier	Acknowledgements_r15

MessageAcknowledgement

Purpose: Acknowledge a received message.

Detail: For every message, a message acknowledgment is generated (with the exception of messages containing message acknowledgements).

A BusinessReceipt has two possible implementations:

• MessageAcknowledgement.

• Event, errors are reported via Event elements.

If a message is rejected, no receipt identifier is required with the acknowledgement.

Field	Restrictions	aseXML	Schema
Event	minOccurs=”0” maxOccurs=”unbounded”	Event (element)	Events_r41
initiatingMessageID	Mandatory	MessageIdentifier	Header_r37
receiptID	Optional	ReceiptIdentifier	Acknowledgements_r15
receiptDate	Mandatory	xsd:dateTime (ccyy-mm-ddThh:mm:ss.sss+hh:mm)	Acknowledgements_r15
Status	Mandatory	MessageStatus	Acknowledgements_r15
Duplicate	Optional, default=”No”	YesNo	Acknowledgements_r15

TransactionAcknowledgement

Purpose: Acknowledge a received transaction.

Detail: For every transaction, a transaction acknowledgment is generated. Any errors are reported via Event elements.

If a transaction is rejected, no receipt identifier is required with the acknowledgement.

Field	Restrictions	aseXML	Schema
Event	minOccurs=”0” maxOccurs=”unbounded”	Event (element)	Events_r41
initiatingTransactionID	Mandatory	TransactionIdentifier	Transactions_r38
receiptID	Optional	ReceiptIdentifier	Acknowledgements_r15
receiptDate	Mandatory	xsd:dateTime	Acknowledgements_r15
Status	Mandatory	TransactionStatus	Acknowledgements_r15
Duplicate	Optional, default=”No”	YesNo	Acknowledgements_r15
acceptedCount	Optional, non-negative xsd:integer	element	Acknowledgements_r15

Support types

ReceiptIdentifier

Purpose: Provide a unique identifier to acknowledge a message or transaction.

Detail: The receiver of an aseXML message or transaction generates a receipt identifier. Its purpose is to provide the sender with an identifier to quote if inquiring about the progress of processing for a message or transaction. It is the sender’s guarantee that the receiver will process the message or transaction.

Receipt identifiers are not necessarily globally unique, only unique to a particular receiver. You can use UUIDs as receipt identifiers to guarantee global uniqueness.

Field	Restrictions	aseXML	Schema
ReceiptIdentifier	See UniqueIdentifier	UniqueIdentifier	Transactions_r38

MessageStatus

Purpose: Indicate the acceptance or rejection of the message.

Field	Restrictions	aseXML	Schema
MessageStatus	xsd:string enumerated list: Accept Reject	simple	Acknowledgements_r15

 

TransactionStatus

Purpose: Indicate the acceptance, partial acceptance or rejection of the transaction.

Field	Restrictions	aseXML	Schema
TransactionStatus	xsd:string enumerated list: Accept Partial Reject	simple	Acknowledgements_r15