B2B Integration : Trading Networks Built-In Services Reference : Transport Folder : Summary of Elements in this Folder : wm.tn.transport:batchFtp
wm.tn.transport:batchFtp
Delivers all documents on the specified scheduled delivery queue using FTP. This service is provided as a reference implementation that you can use as a basis for your own scheduled delivery service. For more information about creating scheduled delivery services, see webMethods Trading Networks Administrator’s Guide.
Input Parameters
queue
String The name of the scheduled delivery queue from which to deliver documents.
host
String The host name or IP address of the target FTP server.
port
String The port number on which the target FTP server listens for requests. The default is 21.
user
String (optional) The name of the account to log on the target FTP server.
password
String (optional) The password of the account to log on the target FTP server.
directory
String (optional) The directory on the target FTP server in which you want the documents written.
transfermode
String The FTP data transfer mode: either ascii or binary.
transfertype
String The FTP data transfer type: either active or passive.
fileExtension
String (optional) The extension to use for target file names. If you do not specify a value for fileExtension, this service uses the value returned from BizDocType.getFtpFileExtension. For XMLDocTypes, this value is xml. The target file name is:
task/Envelope/InternalID.fileExtension
dataport
String (optional) The listener port number of the data transfer channel. If you do not specify dataport, Trading Networks chooses the listener port number. This service only uses dataport when you specify active for transfertype.
encoding
String (optional) Character set in which the document is encoded. This variable is required to convert the String object to bytes correctly. Specify an IANA-registered character set. If this variable is null, the default JVM encoding is used.
Example: ISO-8859-1
timeout
String (optional) Number of seconds to wait for a response from the ftp server before timing out and aborting the request. The default is to wait indefinitely.
Output Parameters
logMsg
String FTP log messages for the entire user session.
Usage Notes
You create a scheduled delivery queue using My webMethods. If you select Batch FTP as the delivery service for the queue, Trading Networks invokes this service to deliver documents from the queue. When you define or update the settings for the scheduled delivery queue, you can supply values for the service inputs. The procedures for defining, updating, and managing schedule delivery queues are described in webMethods Trading Networks Administrator’s Guide.
You should not invoke this service directly. If you want to programmatically deliver documents from a queue, invoke the wm.tn.queuing:deliverBatch service and supply the queue name.
Copyright © 2016- 2017 Software AG, Darmstadt, Germany.
Product LogoContact Support   |   Community   |   Feedback