Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Chapter 8 Private Messages : Initiator Messages

Initiator Messages
Initiator Outbound Request
The Initiator private process uses this message to handle outbound requests.
If the TpName and receiver qualifier ID are sent from the private process, TpName takes precedence over the receiver qualifier ID of the per message field. The TpName is selected first; if it is not present, the receiver qualifier ID is selected.
Figure 15 Initiator Outbound Request
Rendezvous Subject Name
prefix.installation.standardID.INITIATOR.REQUEST
Example: AX.BC.BC-ACME.X12.INITIATOR.REQUEST
JMS Queue Name
prefix.installation.INITIATOR.REQUEST
Example: AX.BC.BC-ACME.INITIATOR.REQUEST
Message Name
InitiatorRequest
ID of operation to be performed. Format: interchange_version/group_version/transactionoperation
Overrides the default parameters of the host and trading partner configuration on a per-message basis. For overriding parameters for the interchange header, the ID and qualifier are validated against the list of domain identities for the host and the trading partner. See EnvelopeInfo.
X12   The parameters for X12 are:
InterchangeHeaderInfo present in the class EDIInterchangeInfo has several overridable fields that are part of the participant Interchange Header tab. The following fields are overridable:
InterchangeHeaderInfo present in the class EDIInterchangeInfo has several overridable fields that are part of the participant Interchange Header tab.
EDIFACT   The parameters for EDIFACT are:
InterchangeHeaderInfo present in the class EDIInterchangeInfo has several overridable fields that are part of the participant Interchange Header tab. The following fields are overridable:
UNBS001Identifier: Syntax identifier
UNBS001ServiceCodeList: Service code list directory version number
UNBS001CharacterEncoding: Character encoding, coded
UNBS002InternalID: Interchange sender internal identification. Identification (such as a division, branch, or computer system/process) specified by the sender of the interchange; to be included, if agreed, by the recipient in the response interchange to facilitate internal routing.
UNBS002SubInternalID:Interchange sender internal sub-identification. Sub-level of the server internal identification when further sub-level identification is required.
UNBS003InternalID: Interchange recipient internal identification/Routing Address
UNBS003SubInternalID: Interchange recipient internal sub-identification
Note: The values entered in the InterchangeHeaderInfo Node of the perMessage field in TIBCO BusinessConnect Palette are not validated when XML to EDI conversion happens for the X12 and EDIFACT protocol. Users should send appropriate valid values from the private process.
InterchangeHeaderInfo present in the class EDIInterchangeInfo has several overridable fields that are part of the participant Interchange Header tab. The following fields are overridable:
UNBS001Identifier: Syntax identifier
UNBS001ServiceCodeList: Service code list directory version number
UNBS001CharacterEncoding: Character encoding, coded
UNBS002InternalID: Interchange sender internal identification. Identification (such as a division, branch, or computer system/process) specified by the sender of the interchange; to be included, if agreed, by the recipient in the response interchange to facilitate internal routing.
UNBS002SubInternalID:Interchange sender internal sub-identification. Sub-level of the server internal identification when further sub-level identification is required.
UNBS003InternalID: Interchange recipient internal identification/Routing Address
UNBS003SubInternalID: Interchange recipient internal sub-identification
Note: The values entered in the InterchangeHeaderInfo Node of the perMessage field in BusinessConnect Palette are not validated when XML to EDI conversion happens for X12 and EDIFACT protocols. Users should send appropriate valid values from the private process.
The final destination file name is comprised of destinationFileName and a file extension. The file extension default value is .dat and is derived from the property edi.outbound.contentDisposition.fileExtension, which is located under System Settings > Activated Protocol Plug-ins and Properties > tibEDI.
Note : It is supported by X12, EDIFACT, TEXT, and TRADCOMS protocols.
Note : It is supported by X12, EDIFACT, TEXT, and TRADCOMS protocols.
Note: Attachments are ignored if both the content and fileName elements are empty, if both elements are configured, the content element takes precedence.
Setting the Transport Subject Dynamically
Based on the subject specified in the configuration of the transports EMAIL, AS1, or AS2-HTTP/S, the subject field is overridable by the private process mimeSubject. Users set macros that are case-insensitive either at the configuration or at private process mimeSubject and the macro field is substituted by the TIBCO BusinessConnect EDI Protocol powered by Instream runtime engine. The values pertain to the interchange level for X12 and EDIFACT protocols and non-interchange field values for Gateway protocol.
The TEXT protocol does not have InterchangeCtrlNum or InterchangeVerNum and, therefore, the transport subject field with macros
#(InterchangeCtrlNum)
and
#(InterchangeVerNum)
is not applicable for this protocol.
The interchange level fields supported as macros are:
ReceiverID, ReceiverQual, SenderID, SenderQual, InterchangeCtrlNum, and InterchangeVerNum.
Other non interchange fields that are supported are:
toName, DocID, hostname, guid, and TxName.
All date/time fields supported for FILE.FTP macros are also supported. See Chapter 6, File Masks.
TpName, HostName, Date/Time macro fields, GUID and docID.
Values specific to the EDI Interchange document level values, such as InterchangeID/Qualifier (SenderID/ReceiverID, SenderQual/ ReceiverQual), InterchangeVerNum and InterchangeCtrlNum will not get populated in this scenario.
The subject in transport configuration can be overridden with the mimesubject from the private process:
Non-batching only (non-Gateway trading partner or Gateway trading partner)
When the private process mimeSubject field is set with a value that contains some macro fields to TIBCO BusinessConnect, this value should override the value set in the Transport subject and should be dynamically updated if there are macros passed, such as in #(DocID)- #(tpName)- #(SenderID).
If there are no macros, then the value should be used.
When mimeSubject is not set, the Transport subject value should be dynamically updated if there are macros passed, such as in #(DocID)- #(tpName)- #(SenderID).
If there are no macros, then the value should be used.
Batching (Gateway or protocol trading partner)
Overriding of the mimeSubject field is not supported for the batching.
The Transport subject value is used and the macro values of the first interchange in the document are set, if present.
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 16 Initiator Inbound Response
Rendezvous Subject Name
prefix.installation.standardID.INITIATOR.RESPONSE
Example: AX.BC.BC-ACME.X12.INITIATOR.RESPONSE
JMS Queue Name
prefix.installation.INITIATOR.RESPONSE
Example: AX.BC.BC-ACME.INITIATOR.RESPONSE
Message Name
InitiatorResponse
The transmissionID property is provided in the InitiatorResponse message to indicate to the private process when it is scheduled for batching.
ID of operation to be performed. Format: interchange_version/group_version/transactionoperation
200 success. Otherwise, one of the error codes. See Appendix B, Status and Error Codes.
OK, or the string representing the cause of the error. In this case, the response might be an error document. See Appendix B, Status and Error Codes.
This field will have a value of batch in case of Batching. In case of messages sent from TEXT or Gateway, this field will not be populated with any values.
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.
TIBCO BusinessConnect is required to return this closure contents back in the InitiatorResponse to ensure that the private process can match it with the original InitiatorRequest.
Initiator Acknowledgment From Partner
The Initiator TIBCO BusinessConnect uses this message to create a notify message that it sends back to its private process to indicate that a previously sent transaction has been successfully reconciled upon receiving an acknowledgment from the trading partner. If the Responder TIBCO BusinessConnect failed to successfully post the acknowledgment to the Initiator, the statusMsg field indicates the cause of the error.
When configuring the smart routing rule, you should set operation "EDI/Inbound/Interchange" under BusinessConnect > System Settings > Private Process Smart Routing for initiator.ack to get the message.
Rendezvous Subject Name
prefix.installation.standardID.INITIATOR.ACK
Example: AX.BC.BC-ACME.X12.INITIATOR.ACK
JMS Queue Name
prefix.installation.INITIATOR.ACK
Example: AX.BC.BC-ACME.INITIATOR.ACK
Message Name
TransactionAckFromTradingPartner
ID of operation to be performed. Format: interchange_version/group_version/operation

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved