In addition to the business document such as a purchase order or invoice in the XML Payload, a set of message attributes are transmitted. Collectively, these attributes are called the XML Gateway envelope.
This section discusses the XML Gateway envelope and its data in the validation process for inbound messages, or its source of data for its creation for outbound messages. Data entered into the Trading Partner Setup form is referred to as data in the trading partner table. Data entered into the Define Transactions form is referred to as data in the transaction table.
Most of the data elements are copied from the Trading Partner tables or the Transaction tables to the XML Gateway envelope.
Transaction direction is determined by the XML Gateway. The direction values used by the XML Gateway are the following:
IN for inbound messages
OUT for outbound messages
The XML Gateway envelope consists of the data presented in the following table:
| Attribute | Contents | Sample Values | Data Source |
|---|---|---|---|
| MESSAGE_TYPE | Payload message format | XML | (Hard-coded) |
| MESSAGE_STANDARD | Message format standard | OAG | Transaction table |
| TRANSACTION_TYPE | External Transaction Type for that business document | INVOICE | Trading Partner table |
| TRANSACTION_SUBTYPE | External Transaction Subtype for that business document | PROCESS | Trading Partner table |
| DOCUMENT_NUMBER | Business document number such as invoice number | (Not Used) | N/A |
| PARTYID | (Not Used) | (Not Used) | Trading Partner table. This is not used by the XML Gateway. |
| SOURCE_TP_LOCATION_CODE | Source Trading Partner Location Code | ACME_CHICAGO | SOURCE TP LOCATION (if not recreated) or TARGET TP LOCATION CODE (if recreated) from Trading Partner table |
| PARTY_TYPE | (Not Used) | (Not Used) | (Not Used) |
| PROTOCOL_TYPE | Transmission Protocol | SMTP, HTTP, HTTP-WM | Trading Partner table |
| PROTOCOL_ADDRESS | Transmission Address | me@co.com, http://www.co.com:5555 | Trading Partner table |
| USERNAME | User Name | User1 | Trading Partner table if Connection is "DIRECT"; Hub Definition if "HUB" |
| PASSWORD | password | ****** | Trading Partner table if Connection is "DIRECT"; Hub Definition if "HUB" |
| ATTRIBUTE1 | (determined by application) | N/A | (determined by application) |
| ATTRIBUTE2 | (determined by application) | N/A | (determined by application) |
| ATTRIBUTE3 | Rerouting Location (used only if the message is rerouted) | TARGET TP LOCATION CODE from Trading Partner table | |
| ATTRIBUTE4 | (determined by application) | N/A | (determined by application) |
| ATTRIBUTE5 | (determined by application) | N/A | (determined by application) |
| PAYLOAD | XML business document | (XML Message) |
Payload message format. This defaults to "XML".
(Defaults to OAG.) Message format standard as displayed in the Define Transactions form and entered in the Define XML Standards form.
External Transaction Type for the business document from the Trading Partner table.
External Transaction Subtype for the business document from the Trading Partner table.
The document identifier used to identify the transaction, such as a purchase order or invoice number. This field is not used by the XML Gateway, but it may be passed on inbound messages.
Source Trading Partner Location Code if no data is found in the Destination Trading Partner Location Code in the Trading Partner table.
Transmission Protocol as defined in the Trading Partner table.
Transmission address as defined in the Trading Partner table.
USERNAME as defined in the Trading Partner table.
The password associated with the USERNAME defined in the Trading Partner table.
For outbound messages, this field has the value from the Destination Trading Partner Location Code in the Trading Partner table.
For inbound messages, the presence of this value generates another XML message that is sent to the trading partner identified in the Destination Trading Partner Location Code in the Trading Partner table. This value must be recognized by the hub to forward the XML message to the final recipient of the XML Message. Refer to XML Gateway Setup for details.
The XML message.
The following parameters may be defined by the base application:
ATTRIBUTE1
ATTRIBUTE2
ATTRIBUTE4
ATTRIBUTE5
The following parameters are not used:
PARTYID
PARTYTYPE