In this section (Sun B2B Suite eXchange Integrator User's Guide)

Sun B2B Suite eXchange Integrator User's Guide

In this section

associate

ChannelManagerClient.associate is used to associate a response to a request. This operation can only be used for message level documents — in other words envelopes, as opposed to business documents.

The service associates the response to the request using a message identifier to tie the two messages to each other.

Table 3–8 Input Containers for ChannelManagerClient.associate


Name	Description
OrigPkgHdrId	Database ID of the original message
AckPkgHeaderId	Database ID of the acknowledgement message
PkgType	Name of the messaging or packaging envelope used for the message, such as ISA or GS.
TPId	The database’s unique ID for the trading partner; in other words, the foreign key to ex_trading_partner.
MsgUniqId	Unique ID for the message.
ErrorFlag	A value of Y signifies that the message contains a “business” type of error: could not decrypt, could not verify signature, and so forth.
ErrorNo	(reserved)
ErrorStr	A description of the error.

Table 3–9 Output Container for ChannelManagerClient.associate


Name	Description
PkgAssocId	Association ID used to associate the response package to the request package.

associateActions

ChannelManagerClient.associateActions is similar to the associate operation, in that it associates a document response to a document request (for example, in X12, a 997 or 855 response to an original 850 request).

Table 3–10 Input Containers for ChannelManagerClient.associateActions


Name	Description
OrigPkgHdrId	Database ID of the original message
AckPkgHeaderId	Database ID of the acknowledgment message
PkgType	Name of the messaging or packaging envelope used for the message, such as ISA or GS.
TPId	The database’s unique ID for the trading partner; in other words, the foreign key to ex_trading_partner.
MsgUniqId	Unique ID for the message.
ErrorFlag	A value of Y signifies that the message contains a “business” type of error: could not decrypt, could not verify signature, and so forth.
ErrorNo	(reserved)
ErrorStr	A description of the error.

Table 3–11 Output Container for ChannelManagerClient.associateActions


Name	Description
isAssociated	A value of Y signifies that an associated action exists.

duplicatecheck

ChannelManagerClient.duplicatecheck is used to check for duplicates of a generic inbound or outbound message.

track

ChannelManagerClient.track performs a track operation to store the message to the eXchange Integrator database

Table 3–12 Input Containers for ChannelManagerClient.track


Name	Description
Protocol	Name of the protocol being used to handle the message.
ReceiveFlag	A value of Y signifies that the request message was inbound.
BufferId	ebXML only. Conversation ID.
OrderNumInBuffer	ebXML only. Reserved for use in message ordering.
MsgUniqId	Unique ID for the message.
TPId	The database’s unique ID for the trading partner; in other words, the foreign key to ex_trading_partner.
OrdMsgId	(not currently used)
Multiple Content	(not currently used)
PkgType	Name of the messaging or packaging envelope used for the message, such as ISA or GS.
ErrorFlag	A value of Y signifies that the message contains a “business” type of error: could not decrypt, could not verify signature, and so forth.
RespRequired	A value of Y signifies that a response to this message is required.
MsgBlob	Container for the message payload.
SignedFlag	A value of Y signifies that the message is signed.
CompressedFlag	A value of Y signifies that the message is compressed.
EncryptedFlag	A value of Y signifies that the message is encrypted.
MessageType	Message type for the message, such as Message or Ack.
Resendable	A value of Y signifies that the message can be re-sent.
Service	Service name for the request message for which the response is received.
Action	Action name for the request message for which the response is received.

Table 3–13 Output Container for ChannelManagerClient.track


Name	Description
MsgHdrId	Message header ID, used for message association.

trackDialogue

ChannelManagerClient.trackDialogue is used to write the initial message — that is, the first business document in a conversation — to message tracking. To write subsequent messages in the same conversation, the trackDialogueAction operation is used.

Table 3–14 Input Containers for ChannelManagerClient.trackDialogue


Name	Description
tpNetworkId	eXchange-generated unique ID identifying the trading partner.
dialogueID	Database-assigned unique ID identifying the business conversation.
dialogueIdentifier	Dialog ID in the message.
serviceName	Name of the messaging service or business service being used to handle the message.
activeFlag	A value of Y signifies that the business conversation is active.
Status	Status of the business conversation.
startDate	Timestamp recording when the business conversation initiated.
endDate	Timestamp recording when the business conversation terminated.
protocol	Name of the protocol being used to handle the message.
hostNetworkId	eXchange-generated unique ID identifying the B2B host.
isResponse	A value of true signifies that the message is a response to a previous message.

Table 3–15 Output Containers for ChannelManagerClient.trackDialogue


Name	Description
tpNetworkId	eXchange-generated unique ID identifying the trading partner.
dialogueID	Database-assigned unique ID identifying the business conversation.
dialogueIdentifier	Dialog ID in the message.
serviceName	Name of the messaging service or business service being used to handle the message.

trackDialogueAction

ChannelManagerClient.trackDialogueAction also writes to message tracking, but it writes subsequent messages in a business conversation (after the initial message was written by trackDialogue operation).

Table 3–16 Input Containers for ChannelManagerClient.trackDialogueAction


Name	Description
messageId	(deprecated) Duplicate of actionMessageId
actionName	Name of the messaging action that is processing the message.
receiveFlag	A value of Y signifies that it is an inbound message.
resendFlag	A value of Y signifies that this is a re-send of the message
sendCount	A value of Y signifies that the business conversation is active.
sequenceNum	Status of the business conversation.
referToType	(not used)
actStatus	(not used)
pkgMsgHdrId	Database-assigned unique ID for the message packaging.
msgType	Message type for the message, such as Message or Ack.
msgEncoding	Encoding to which the message conforms.
compressedFlag	A value of Y signifies that the message is compressed.
encryptedFlag	A value of Y signifies that the message is encrypted.
envelopedFlag	A value of Y signifies that the message is enveloped.
signedFlag	A value of Y signifies that the message is signed.
msgContent	The payload of the message.
attributeMap	Extended attributes for the message.
isStoreOriginal	(not used) A value of Y signifies that the original (raw) message is to be stored in the database.
errorFlag	A value of Y signifies that the message has an error associated with it.
respRequiredFlag	A value of Y signifies that a response is required for the message.
actionMessageId	Message ID.
messageType	A value of msg signifies a message; ack signifies an acknowledgment.

Table 3–17 Output Containers for ChannelManagerClient.trackDialogueAction


Name	Description
ActionId	ID of the service action (business transaction)