Responder Messages

Responder Inbound Request — BusinessConnect to Private Process

The Responder private process uses this message to handle inbound requests.

Subject Name

prefix.installation.EZComm.RESPONDER.REQUEST

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

Table 13 Private Message: ResponderRequest
Field Type Required Description
resend Boolean No A boolean value indicating whether a message is resent.
standardID String Yes Protocol name.
fromTp String Yes Name of the trading partner who initiated the transaction.
toTP String Yes Name of the trading partner who received the transaction.
operationID String No

A three-part ID of the form:

category/version_number/operation_Name.

transactionID String Yes

A unique ID generated by BusinessConnect Container Edition when publishing the transaction to the private process's environment.

closure String No

A closure message generated by the private process and sent to BusinessConnect Container Edition.

binaryRequest

base64Binary

No

Used by BusinessConnect Container Edition to send data when binary data is being passed to a partner.

isBinaryFile Boolean No

This field shows whether the file specified in the field inputFile is a binary file.

inputFile String No

Used for a file reference that was passed to BusinessConnect Container Edition.

operationType String No

Represents the type of the operation, such as Notify, Synchronous Request Response, or Asynchronous Request Response.

duplicate Boolean No Specifies whether the incoming request is a duplicate.
originalFileName String No
This field contains the filename of the original response file in an Asynchronous request response operation:
  • For the FILE and FTP transports, 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

Responder Outbound Response — Private Process to BusinessConnect

The Responder private process uses this message to handle outbound responses.

Subject Name

prefix.installation.EZComm.RESPONDER.RESPONSE

External example: AX.BC.BC-ACME.EZComm.RESPONDER.RESPONSE

Table 14 Private Message: Responder.Response
Field Type Required Description
statusCode Integer Yes Code indicating the status of the message (200 for success). Otherwise, a code that represents the type of error.
statusMsg String Yes OK or a description of the cause of the error.
binaryResponse Base64Binary No Response is sent to this field if it contains binary data.
responseFile String No This is the name of the file that contains the response.
deleteResponseFile Boolean Deletes the response file if the value is true.
closure String Yes This is the closure that is received from the Responder Request Based on this value, this response is correlated to the request.
content-type String No Content type of the response. If not specified, BusinessConnect Container Edition interprets this value.
content-disposition String No Maps to MIME's content-disposition. This value, if provided, is set in the MIME Internet headers.
as2-subject String No

A short string identifying the topic of the AS2 message.

By default, the value in the as2-subject element is the same with the one in the MIME Subject field.

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, 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

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

Responder Acknowledgement — Private Process to BusinessConnect

The Responder TIBCO BusinessConnect sends this acknowledgement after it receives the Responder Response. The acknowledgement indicates whether the Responder Response has been forwarded to the trading partner.

Subject Name

prefix.installation.EZComm.RESPONDER.ACK

External example: AX.BC.BC-ACME.EZComm.RESPONDER.ACK

Table 15 Private Message: Responder.Ack
Field Type Required Description
statusCode String Yes Code indicating the status of the message (200 for success). Otherwise, a code that represents the type of error.
statusMsg String Yes OK or a description of the cause of the error.
operationType String No Represents the type of the operation. In this case it is ack, indicating that the message is of the type Acknowledgement.
closure String Yes A closure sent by the Responder Response message.