Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

On this page:

Table of Contents
maxLevel2


Introduction

The Onetrail Acknowledgement is used to confirm the receipt or non-receipt of a document, like an order request.

...

If a message is submitted by Onetrail to the recipient, either Onetrail or the recipient will create and send an Onetrail Acknowledgement. In practice, the Onetrail Acknowledgement is generated on the receipt or non-receipt of orders. With the usage of web services, the response always contains an Onetrail Acknowledgement to indicate the receipt of the message at Onetrail TPN™. A second Acknowledgement will still be created as described in the first lines above.   

Choreography

_OrdReq_choreography.jpgImage Removed

Process management

Orders submitted by Onetrail TPN™ have to be confirmed with an Onetrail Acknowledgement within 1 hour, otherwise an alert will be generated and sent to the Onetrail TPN™ Support department who will take action.

...

Use code and description OR combi tag without description. Onetrail will use the default description to the recipient as stated in the above exception codes list.

Example 1:

<GlobalMessageExceptionCode>000E</GlobalMessageExceptionCode>

</errorClassification> <errorDescription> <FreeFormText


             </errorClassification>
             <errorDescription>
                           <FreeFormText xml:lang="EN">Ok</FreeFormText>


Remark: Where “000E” = exception code and Freeform text = “OK”. Freeform text will ALWAYS overrule the default description as stated in the above exception codes list.

Example 2:

<GlobalMessageExceptionCode>504E%21120</GlobalMessageExceptionCode>


Remark: Where “504E” = exception code and “21120” = Ship to address(code) “%” needs to precede the variable!

<Exceptions> <ExceptionDescription> <errorClassification> <GlobalMessageExceptionCode>000E</GlobalMessageExceptionCode> </errorClassification> <errorDescription> <FreeFormText

<Exceptions>
     <ExceptionDescription>
              <errorClassification>
                     <GlobalMessageExceptionCode>000E</GlobalMessageExceptionCode>
             </errorClassification>
             <errorDescription>
                    <FreeFormText lang="EN">Ok</FreeFormText>


             </errorDescription>


     </ExceptionDescription>

<GlobalExceptionTypeCode>Receipt Acknowledgement


     <GlobalExceptionTypeCode>Receipt Acknowledgement Exception</GlobalExceptionTypeCode>


</Exceptions>

Format & Syntax

The format of the standard Onetrail XML messages is XML version 1.0.
The encoding must be UTF-8. Please refer to our OT(N)ACK XSD Documentation for default values, multiplicity of elements, attributes, business rules and an overview for mapping design purposes.

Info
For more information we refer to: Format & Syntax Acknowledgement

Communication

Info
Please refer to the communication page: Onetrail TPN™ Communication

Examples

Info
For more information we refer to: Onetrail TPN™ XML Ack Examples