Initiator Inbound Response
This message indicates if a InitiatorRequest has been successfully sent to your trading partner. If the requesting operation is a synchronous operation, this message contains the synchronous response EDI message received from the trading partner.
Figure 22: Initiator Inbound Response
| JMS Queue
Name |
prefix.installation.INITIATOR.RESPONSE |
| Example: AX.BC.BC-ACME.INITIATOR.RESPONSE | |
| Message Name | InitiatorResponse |
| Field | Type | Required | Description |
|---|---|---|---|
| standardID | String | Yes | X12 and Gateway. |
| transmissionID | String | No | The transmissionID property is provided in the InitiatorResponse message to indicate to the private process when it is scheduled for batching. |
| operationID | String | Yes | ID of operation to be performed. Format: interchange_version/group_version/transactionoperation Example: 00403/005010/850 |
| transactionID | String | Yes | The transaction ID of the response. |
| txName | String | Yes | Name of the transaction |
| statusCode | Integer | Yes | 200 success. Otherwise, one of the error codes. See Status and Error Codes. |
| statusMsg | String | Yes | OK, or the string representing the cause of the error. In this case, the response might be an error document. See Status and Error Codes. |
| envelopeInfo | Object | No | The interchange and group envelope information of this transaction. The interchange envelope identifies the sender and receiver interchange qualifier and ID. The envelope identifies the sender and receiver application ID. See EnvelopeInfo. |
| controlNumInfo | Object | No | The control number information of this transaction that identifies itself in group envelope and interchange envelope of the incoming document. It contains the control numbers for the interchange envelope, the group envelope and the transaction itself. See ControlNumberInfo. This field will have a value of batch in case of Batching. In case of messages sent from Gateway, this field will not be populated with any values. |
| transactionInfo | Object | No | The raw EDI segments of this transaction and the header and trailer segment of its interchange envelope and group envelope. By default, transaction information is not included in the Initiator response. To include transaction information in the validation alert, select the Include Raw EDI Segments in Validation Error Advisory check box. If the Log Raw EDI segments To File check box for inbound transactions is enabled for the trading partner, the full path of the stored location is included in this message class. See TransactionInfo. |
| duplicate | Boolean | No | Set to true if the private process sent a duplicate document. |
| closure | Any | Yes | The private process generates the closure message and sends it to TIBCO BusinessConnect Container Edition. TIBCO BusinessConnect Container Edition is required to return this closure contents back in the InitiatorResponse to ensure that the private process can match it with the original InitiatorRequest. |
| response | Any | Yes | XML string representing the message body or JMS representation of an XML file. For a notify operation, the XML response indicates if the outbound request was successfully sent to the trading partner. For a synchronous request-response operation, this XML string is the converted EDI information for either the rejection acknowledgment or the response that was received from the trading partner. |
| archivedFileRef | String | No | This field is populated with the location of the file where the raw EDI document is stored. It is populated only when the option Log raw EDI is enabled under Trading Host > Protocol with a valid location. |
| auditReportFileRef | String | No | This field is populated with the location of the XML file created during XML to EDI validation, when the option Enable Audit Report Logging is enabled for a participant available in the General tab for Outbound. This file is created only by the internal conversion engine and gives full reporting information of the transactions that are validated. A valid location must be entered for the trading host for the corresponding protocol. |
| PayloadType | String | No | This field describes the type of document (request, response, confirmation, or acknowledgement) and the type of transaction. For Initiator Response messages, the payload type is received from the trading partner as part of an actual request. |
| ProcessingMode | String | No | This field describes the type of transaction - real-time or batch. |
| PayloadID | String | No | This field is the ID for the payload of the message received from a trading partner. |
| TimeStamp | String | No | This field indicates the time at which the response message is sent. |
| SenderID | String | No | This field is the ID of the sender of the message. |
| ReceiverID | String | No | This field is the ID of the receiver of the message. |
| ErrorCode | String | No | This field is the error code that is displayed. |
| ErrorMessages | String | No | This string field is the error message that is displayed against the corresponding error code. |