Module for EDIINT Version 8.2 SP1.November 2013 | Installing and Using EDIINT Module | webMethods Module for EDIINT Services | wm.EDIINT:send
 
wm.EDIINT:send
Constructs an outbound EDIINT message according to the configuration of the input parameters, and then submits the message to Trading Networks.
Input Parameters
type
String The SMIME type that you want to use for the outbound EDIINT message. Specify one of the following:
Value
Meaning
plain
Neither sign nor encrypt the outbound EDIINT message.
signed
Sign the outbound EDIINT message.
encrypted
Encrypt the outbound EDIINT message.
signedAndEncrypted
Sign and encrypt the outbound EDIINT message.
getFromProfile
Whether to sign and/or encrypt the outbound EDIINT message using the value of the SMIME Type extended field from the receiver's profile.
compressed
String (optional) Whether the EDIINT message that you are sending is compressed before it is signed and/or encrypted. Specify one of the following:
Value
Meaning
true
Compress the outbound message before signing and encrypting.
false
Do not compress the outbound message before signing and encrypting. This is the default.
getFromProfile
Whether to compress the outbound message using the value of the Compression extended field from the receiver's profile.
deliveryMethod
String The delivery method you want to use to send the EDIINT document. The wm.EDIINT:send service obtains the Trading Networks profile for the receiver (specified by the receiverID input parameter) and delivers the EDIINT document to the receiver's system using the information specified for the delivery method. Specify a delivery method that is defined in the receiver's Trading Networks profile.
*For EDIINT AS1, specify one of the following:
*PrimarySMTP (corresponds to the Trading Networks Primary E-mail delivery method)
*SecondarySMTP (corresponds to the Trading Networks Secondary E-mail delivery method)
*For EDIINT AS2, specify one of the following:
*PrimaryHTTP
*SecondaryHTTP
*PrimaryHTTPS
*SecondaryHTTPS
*For EDIINT AS3, specify AS3.
You can also specify getFromProfile if you want the service to obtain the delivery method from the Delivery Method extended field from the receiver's profile.
data
Document The payload that you want to send.
Parameter
Description
contentType
The content type to assign to the outbound message.
stream
The java.io.InputStream that you map from the EDI or XML data.
otherHeaders
(optional) The name and value of the header for outbound messages. This header information is saved for each inbound payload document in Trading Networks in the payloadMimeHeaders content part.
attachments
Document array Any attachments to a message.
Parameter
Description
stream
The java.io.InputStream for the attachment you want to add.
contentType
The content type of the attachment. For example, application/zip if the attachment is a zip file.
otherHeaders
(optional) The name and value of the headers you want to add to the attachments. This information will be saved in Trading Networks as a content type for both sender and receiver.
requestMDN
String Whether you want the receiver to return an MDN. Specify one of the following:
Value
Meaning
none
Do not request a return MDN.
synchronousMDN
Request a return synchronous MDN.
asynchronousMDN
Request a return asynchronous MDN.
getFromProfile
Whether to request a return MDN using the value of the Request MDN extended field from the receiver's profile and what type of MDN to return.
Note:
If you specify PrimarySMTP, SecondarySMTP, PrimaryFTPS, or SecondaryFTPS for deliveryMethod, you can only receive an asynchronous MDN.
requestSignedReceipt
String Whether you want the MDN to be signed.
Note:requestSignedReceipt is ignored when requestMDN is none.
Value
Meaning
true
Request a signed MDN.
false
Request a plain (unsigned) MDN.
getFromProfile
Whether the MDN is signed using the value of the Request Signed Receipt extended field from the receiver's profile.
senderID
Document Identification of the sender of the EDIINT message.
Parameter
Description
id
The sender's external ID. That is, the identification that you want for the sender in the message.
idTypeDesc
Optional. The external ID type for the sender ID you specified in id. This is an external ID type as defined in Trading Networks.
Note:
By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.
receiverID
Document Identification of the receiver of the EDIINT message.
Parameter
Description
id
The receiver's external ID. That is, the identification that you want for the receiver in the message.
idTypeDesc
Optional. The external ID type for the receiver ID you specified in id. This is an external ID type as defined in Trading Networks.
Note:
By default, the service uses the appropriate external ID type based on the value you specify for the deliveryMethod parameter. For example, if you specify AS3 for the deliveryMethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idTypeDesc only if you want to override this default.
ConversationID
String (optional) Conversation ID for the outbound EDIINT message.
The conversationID parameter is an identifier that links all documents that are part of the same business process (also called a conversation). That is, all documents in the same business process need to have the same conversationID. Trading Networks can extract conversationIDs from EDI documents and use them to pass documents to webMethods Process Engine after Trading Networks performs the actions identified by a processing rule. For more information, see the webMethods Trading Networks Administrator’s Guide for your release.
In this field, you might want to specify the same conversation ID as that of the payload that you are sending. Module for EDIINT automatically assigns the same conversation ID that is assigned here to a return MDN.
Note:
Leave this field blank unless you own a license for webMethods Process Engine.
TNFlags
Document Data to pass as input to the wm.tn.route:routeBizDoc service (for example, TN_parms).
Parameter
Description
prtIgnoreDocument
String Whether the wm.tn.route:routeBizDoc service invokes the pub.prt.tn:handleBizDoc service. Set this parameter to true if the WmPRT package is not installed.
Value
Meaning
true
wm.tn.route:routeBizDoc invokes the pub.prt.tn:handleBizDoc service.
false
wm.tn.route:routeBizDoc does not invoke the pub.prt.tn:handleBizDoc service.
enableAS2Restart
String (optional) Whether transmission of an AS2 message restarts automatically if the transmission fails. Specify one of the following:
Value
Meaning
true
Restart message transmission if transmission fails.
false
Do not restart message transmission if transmission fails.
enableHTTP Chunking
String Enables HTTP chunking.
Value
Meaning
true
HTTP chunking enabled.
false
HTTP chunking disabled.
customHeaders
Document Custom headers you can include on your EDIINT message.
Parameter
Description
Name
String Specify a name for the custom header.
Value
String Specify the information to display in the custom header.
Output Parameters
None.
Usage Notes
For information about how to use this service, see Creating a Client to Submit a Document Using EDIINT and Viewing and Managing Information About EDIINT Documents and MDNs.