Initiator Messages

Initiator Outbound Request — Private Process to TIBCO BusinessConnect

The Initiator private process uses this message to handle outbound requests. Data that is sent is in a string or in binary form.

If both plainRequest and inputFile are passed, the plainRequest node is used.

If both binaryRequest and inputFile are passed, the binaryRequest node is used.

Subject Name

prefix.installation.EZComm.INITIATOR.REQUEST

External example: AX.BC.BC-ACME.EZComm.INITIATOR.REQUEST

Table 16 Private Message: InitiatorRequest
Field Type Required Description
fromTp String No Name of the trading partner initiating the transaction.
toTp String Yes Name of the trading partner receiving the transaction.
transactionID String Yes An ID unique within Initiator private processes environment for this transaction. The private process creates this ID.
closure String No The private process generates the closure message and sends it to TIBCO BusinessConnect, which is required to return this closure contents back in the InitiatorResponse to ensure that the private process can match it with the original Initiator.Request.
binaryRequest base64 Binary No Private processes use the binaryRequest field to send binary data to BusinessConnect Container Edition.
as2-subject String No

A short string identifying the topic of the AS2 message.

The value in the as2-subject element overrides the value in the MIME Subject field.

content-type String No Content type of the passed data.
content-disposition String No Maps to MIME's content-disposition. This value, if provided, is set in the MIME Internet headers.
inputFile String No If a file reference is being passed to BusinessConnect Container Edition, this field is used.
httpAttributes
name String No

Name of the httpAttribute.

Note: It works only with Request_Response operations.
value String No

Value assigned to the httpAttribute.

Note: It works only with Request_Response operations.
Attachment
name String No

Name of the attachment file.

For more information, see Multiple Attachments

content Base64 Binary No Content for the attachment.
fileName String No

A file reference can be sent as an attachment.

For more information, see Multiple Attachments

deleteFile Boolean No If set to true, the file reference specified in the filename field is deleted after the completion (successful or otherwise) of the transaction processing.
content-id String No

Represents the content Id for the attachment. It must be specified and enforcement is performed at the BusinessWorks palette level.

If this field is not specified, it is populated as transactionID-sequence number.

content-type String No

Represents the content type of the message content.

For more information, see Multiple Attachments

Initiator Inbound Response — BusinessConnect to Private Process

The Initiator private process uses this message to handle inbound responses.

Subject Name

prefix.installation.EZComm.INITIATOR.RESPONSE

External example: AX.BC.ACME.EZComm.INITIATOR.RESPONSE

Table 17 Private Message: Initiator Response
Field Type Required Description
resend Boolean No A boolean value indicating whether a message is resent.
standardID String Yes Protocol name.
fromTp String No Name of the trading partner initiating the transaction.
toTp String Yes Name of the trading partner receiving the transaction.
operationID String No

A three-part ID of the form:

category/version_number/operation_Name.

transactionID String No An ID unique within Initiator private processes environment for this transaction. The private process creates this ID.
statusCode String No Code indicating the status of the message. 200 for success. Otherwise, a code that represents the type of error.
statusMsg String No OK or a description of the cause of the error.
closure String No The private process generates the closure message and sends it to BusinessConnect Container Edition. 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.
duplicate Boolean No Specifies whether the incoming response is a duplicate.
binaryResponse String No Response is sent to this field if it contains binary data.
responseFile String No File name containing the response.
originalFileName String No
This field contains the filename of the original response file in an Asynchronous request response operation:
  • If a response is received over the FILE or FTP transport, this is the actual filename that is in the directory or on the FTP server.

  • For HTTP/s transports, this is the filename that is sent as a file reference from the private process when the Allow override of filename via HTTP parameter check box for the partner is selected.

    See Allow override of filename via HTTP parameter (applies only to HTTP/S transports).

as2-subject String No A short string identifying the topic of the AS2 message.
as2-to String No

A short string aiding the receiving system in identifying

the sending system.

The as2-to and as2-from headers are used.

as2-from String No

A short string aiding the receiving system in identifying the sending system.

The as2-to and as2-from headers are used.

email-subject String No A string receiving an email subject by the EMAIL or AS1-EMAIL transport.
Attachment
name String No

Name of the attachment file.

For more information, see Multiple Attachments

content any No Content for the attachment.
fileName String No

A file reference can be sent as an attachment.

For more information, see Multiple Attachments

deleteFile Boolean No If set to true, then the private process can decide to delete the inbound attachment file.
content-id String No Represents the content Id for the attachment. It must be specified and enforcement is performed at the BusinessWorks palette level. If this field is not specified, it is populated as transactionID-sequence number.
content-type String No

Represents the content type of the message content.

For more information, see Multiple Attachments

Body
stringData (plainResponse) String No Response is sent to this field if it contains string data.