Settings
Name (Label) |
Type |
Req'd |
Single Setting Value |
Substitution Allowed |
Default |
Validation Enforced by Call Studio |
Notes |
filename (Name of file to be transferred) |
string |
Yes |
|
|
None |
Must be a valid Windows filename. |
This setting specifies the full pathname of the file to transfer. Alternatively, a path relative to the application directory can be used. |
remote_filename (Remote Filename) |
string |
No |
|
|
None |
If specified, must be a valid Windows filename. |
This is the FTP server target filename. If a remote filename is not specified, the remote filename will be the same as the input filename. |
ftp_hosts (FTP Server or FTP Servers) |
string |
Yes |
|
|
None |
Must conform to the format listed in "Notes". Validation will fail if the password is set, but the username is not. |
This is
the list of FTP server host names or IP addresses to transfer the file to. Each
FTP server entry may optionally specify a port number (default port:21),
username and password in the format
|
ftp_user (Default Username) |
string |
Yes |
|
|
None |
Validation will fail if the password field is set while this field is not set. |
User name to use when transferring the file. This value may be overridden on a per-server basis. If left blank, "anonymous" will be assumed. |
ftp_password (Default Password) |
string |
No |
|
|
None |
n/a |
This is the password to use when transferring the file. This value can be overridden on a per-server basis. |
ftp_path (FTP Path) |
string |
No |
|
|
None |
Must be a valid Windows pathname. |
This is the directory on
the FTP server where to transfer the file. Use the forward slash as the
directory delimiter |
delete_file_on_success (Delete file if file transferred successfully) |
boolean |
No |
|
|
true |
n/a |
This setting deletes the file after it has been successfully transferred to all FTP Server(s). |
Note |
Default ftp_user/ftp_password will be used if ftp_hosts setting does not include a username/password in its definition. |
Note |
It is important to ensure that the FTP Server(s) are open for write access. |
Note |
The file to be uploaded is assumed to be a binary file. |
Note |
If a large file is to be transferred and the network connection to the FTP servers is slow and there are multiple FTP servers, consider implementing VXML 'fetchaudio' functionality in the element before the FTP element so that the caller does not hear silence while the FTP operation is in progress. |
Note |
The http client response timeout setting on the gateway must be set to accommodate the time it takes to complete the largest anticipated FTP file transfer. If an FTP file transfer takes longer than the configured duration in seconds for http client response timeout, the FTP transfer will complete correctly, but the call will drop as soon as the configured timeout duration is met. |