Trading Networks 10.3 | Administering and Monitoring B2B Transactions | Trading Networks Built-In Services Reference | Transport Folder | Summary of Elements in this Folder | wm.tn.transport:Sftp
 
wm.tn.transport:Sftp
Delivers documents through SFTP. This service uses the delivery method information from the receiving partner's profile to determine the SFTP user alias and the location to which the document must be delivered.
Input Parameters
serviceName
String The name of the service you must use to deliver a document using SFTP.
bizdoc
Document The document you want to deliver. The document must be an instance of com.wm.app.tn.doc.BizDocEnvelope.
retriesRemaining
String The number of retries remaining. The delivery engine passes this information into the server at every attempt of job delivery.
Output Parameters
serviceOutput
Document The output from the delivery. For the structure of serviceOutput, see wm.tn.rec:SftpDeliveryServiceOutput. The document contains the following keys:
*status String The outcome of the delivery: success or fail.
*statusMessage String The status message from the last attempt to deliver the document. For example, the status message might be 221.
*transportTime String Total time (in milliseconds) it took to deliver the document.
*output Document The header and body that was returned from the SFTP put. For the structure of output, see wm.tn.rec:SftpOutput.
Usage Notes
*The service throws an exception if the receiver identified to receive the document in bizdoc is a local partner. And the local partner is a host of the network.
*The service performs a passive transfer.
*The file name of the delivered document is the internal document ID and the extension is either .xml if the content-type is text, xml, or .bizdoc.