ebXML Module 7.1 SP1 | Understanding and Using webMethods EBXML Module | Installing and Using ebxml Module | Built-In Services | MSH Folder (wm.ip.ebxml.MSH) | wm.ip.ebxml.MSH:sendUsingTPA
 
wm.ip.ebxml.MSH:sendUsingTPA
The send service that uses a TPA.
This service constructs an ebXML Message and submits it to the internal queue as a task to be processed. If the required TPA is not present, an exception is thrown.
At the receiver end, a payload processing service can be invoked in one of the following two ways:
*Setting thewm.ebxml.payloadProcessSvc property
This property is defined in the IntegrationServer_directory\packages\WmebXML\config\config.cnf file. The service assigned as the value of the wm.ebxml.payloadProcessSvc property will be invoked to process the payloads.
*Setting the corresponding parameters in the TPA
In the sender party section of the TPA, set the value of CollaborationProtocolAgreement/PartyInfo/CollaborationRole/ServiceBinding/Service/*body and CollaborationProtocolAgreement/PartyInfo/CollaborationRole/ServiceBinding/Service/type parameters as "webMethods".
The payload processing service should follow the specifications wm.ip.ebxml.rec:payloadProcess for ebMS 1.0 and wm.ip.ebxml.rec:payloadProcess_v2for ebMS 2.0. These specifications indicate available inputs for the implemented service.
Input Parameters
To
Document Information about the receiver.
ID
String The receiver's ID.
IDType
String The receiver's ID type.
From
Document Information about the sender. If it is absent, this service uses information about the host.
ID
String The sender's ID. If it is absent, this service uses the host's ID.
IDType
String The sender's ID type. If it is absent, this service uses the host's ID type.
CPAId
String The CPA ID. It must be a valid agreementID for a TPA.
ConversationId
String (optional) The conversation ID.
MessageId
String (optional) Used as the message ID for the message, if specified. It should be unique within the context of the message exchange between two trading partners.
RefMessageId
String (optional) The message ID of a message to which this message refers.
Payloads
Document list (optional) Any business document to be sent.
partID
String The package ID for wrapping this document. It must be one of CollaborationProtocolAgreement.Packaging.SimplePart.id in com.wm.estd.ebxml.documents.CPA1.cpa_1 (for CPA 1.0)and CollaborationProtocolAgreement.SimplePart.id in com.wm.estd.ebxml.documents.CPA1.cpa_2 (for CPA 2.0)
stream
InputStream A business document in Java.io.InputStream form.
action
String (optional) Specifies the action to be executed for any instance of the bizdoc. This value must correspond to one of the action values specified in TPA. By default, the first action specified by the TPA on the sender side is used.
If you do not specify an action, ebXML Module uses the first action within the first service specified in the TPA. If you specify an action but you do not supply a value for service, the action is assumed to be within the first service specified in the TPA.
service
String (optional) Specifies the service to be executed for any instance of the bizdoc. This value must correspond to one of the service values specified in the TPA.
If you do not specify a service, ebXML Module uses the first service specified in the TPA.
Output Parameters
messageId
String The message ID for the ebXML message.
errorMsg
Document Error information.
errorCode
String The ebXML error code.
severity
String The error severity. It can have two values, either Error or Warning.
location
String The XPATH of the error location.
errorMessage
String The error message.
codeContext
String The context of the error message.