7.3 Structure of the Acknowledgement

The structure of the Acknowledgement is described in below. The Acknowledgement can be used to signal that a file created in accordance with other parts of the ECM standard has been received. It provides no further validation than explicitly communicated in the Acknowledgement. The Acknowledgement contains seven sub-elements as depicted in Figure 6:

The Acknowledgement contains six sub-elements as depicted in Figure 6:

  • A mandatory @AvsVersionId that communicates the version of the allowed value sets used in the message;

  • A mandatory MessageHeader that communicates general message metadata as depicted in Figure 7;

  • A mandatory tag to identify the acknowledged message;

  • A mandatory FileStatus that enables the sender of the Acknowledgement to signal whether the acknowledged message has been received without error or not. The FileStatus does not signal anything beyond this basic status;

  • An optional ErrorText that enables the sender of the Acknowledgement to provide additional details should be set to anything other than FileOk; and

  • An optional ProposedActionType that enables the sender of the Acknowledgement to propose to the sender of the acknowledged message to, for example, re-send the message.

Picture 1.png

Figure 6 – Structure of the Acknowledgement

Picture 2.png

Figure 7 – Structure of the MeassageHeader composite of the Acknowledgement