queue | String Name of the queue from which to get the EDI documents that you want to send to the VAN. Trading Networks provides the name of the queue when it invokes this service. | ||
connectionInfo | Document The information needed to connect to the VAN. | ||
Key | Description | ||
serverName | String The name or IP address of the VAN, e.g., ftp.icctrade.com. | ||
userName | String Valid user on the remote VAN server, e.g., anonymous. | ||
passWord | String A valid password for the VAN user specified in userName, e.g., someone@somewhere. | ||
portNum | String (optional) The port number on which the FTP server listens for requests, e.g., 4566. The default is 21. | ||
account | String (optional) A valid account for the VAN user specified in userName, e.g., someone. | ||
dataPort | String (optional) The listener port number of the data transfer channel, e.g., 3345. If you do not specify this information, the Integration Server chooses the listener port number. | ||
encoding | String (optional) Character set in which the document is encoded, e.g., ISO-8859-1. This parameter converts the String object to bytes correctly. Specify an IANA-registered character set. If this parameter is null, the default JVM encoding is used. | ||
timeout | String (optional) The number of seconds to wait for a response from the FTP server before timing out and aborting the request. The default is zero (0), which signifies to wait indefinitely. | ||
waitTime | String (optional) The number of seconds to wait between attempts to build the connection to the VAN. If you do not specify the value, the default is zero (0). | ||
retryLimits | String (optional) The number of times to attempt to reconnect to the VAN in the event the initial FTP connection fails. The default is zero (0). | ||
secureFTP | String Indicates whether the remote FTP server is a secure server. Specify true or false. | ||
secureFTPOption | Document Whether and how to protect the FTP data channel. securedata - Specify true to protect the FTP data channel or false to not protect it. auth - Specify the authentication/security mechanism if securedata is set to true. Valid values are SSL, TLS, or TLS-P. | ||
outboundDirpath | String (optional) Local path to the directory in which you drop off documents to the VAN. | ||
getInbound | String Whether you would like to get inbound documents from the VAN after sending outbound documents to the VAN. This occurs within the same session. All documents retrieved are submitted to Trading Networks for processing. | ||
Value | Meaning | ||
yes | Retrieve EDI documents during the same session. You must specify InboundInfo. | ||
no | Do not retrieve EDI documents during the same session. | ||
InboundInfo | Document Information describing the files to retrieve from the VAN. This parameter is required when getInbound is set to yes. | ||
Key | Description | ||
command | String The command to use to get inbound documents from the VAN. Specify one of the following: | ||
Value | Meaning | ||
GET | Get only the files that you specify from the VAN. | ||
MGET | Get all files from the VAN. | ||
remotefile | String List Name(s) of the specific inbound document(s) you would like to get. You must specify remotefile if you set command to GET. | ||
filenamepattern | String (optional) A pattern that specifies to get files with a specific file pattern. For example, if you want to get all files ending in a .dat extension, specify *.dat. You can use filenamepattern when you set command to MGET (but is not mandatory). This input parameter is ignored if you set command to GET. | ||
inboundDirpath | String (optional) Local path to the directory from which you pick up documents from the VAN. | ||
getReport | String Whether you want to get VAN-generated reports. This occurs within the same session. | ||
Value | Meaning | ||
yes | Get VAN-generated reports. | ||
no | Do not get VAN-generated reports. | ||
transfermode | String The FTP file transfer mode. Specify either ascii or binary. | ||
reportInfo | Document Information about the reports you want retrieved and where to store them on your system. | ||
Key | Description | ||
reports | String List Name(s) of the reports you want to get, e.g., statfile. This key is required if getReport is enabled. | ||
repDir | String (optional) Local path to the directory from which you pick up VAN-generated reports. e.g., root\records. | ||
saveToDir | String (optional) Local file path directory in which you want to save reports, in addition to saving them in the Trading Networks activity log. The activity log truncates messages that are larger than 1KB, so it is recommended that you provide a local file path in which to save reports that exceed 1KB. The default directory is Integration Server_directory\instances\$instance_name\packages\WmEDIforTN\pub\VANReports. To save reports to a directory other than the default, the directory must be listed in the Integration Server_directory\instances\$instance_name\packages\WmEDIforTN\config\VANReportsDirectory.cnf file. Open the file and add any additional directories in which you want to allow reports to be saved. | ||
logout | String Whether you would like to terminate the FTP session after transactions have been completed. | ||
Value | Meaning | ||
yes | Terminate the FTP session. | ||
no | Do not terminate the FTP session. | ||
For more information about using this service to send EDI documents to a VAN and how to set up the scheduled delivery queue, see the chapter on retrieving and delivering EDI documents from and to VANs in webMethods Module for EDI Installation and User’s Guide.This service will not publish a Notification Failure document if it is unable to connect to the VAN.