Previous Next
Opalis Integration Pack for FTP > Objects > Download File

Download File
The Download File object is used to download files from an FTP server to the Action Server computer.
How it is used
The Download File object can be used to download log files from a remote server to backup the information.
Configuration
To configure the Download File object, you need to know the server name, port, username, password, and security settings of the FTP server that you are connecting to. You also need to know the path of the files that will be downloaded.
Details tab
 
Server name or IP
Type the URL or IP address of the FTP server.
Port
Type the port for the FTP server. (Default 21)
Username
Type the username that will be used to log in to the FTP server.
Password
Type the password that is associated with the FTP user you specified.
Confirm
Re-type the password specified in the Password field.
Server Type
Select the type of server that you are connecting to. Only change this option if you are experiencing problems communication with an IBM or a DEC VMS FTP server.
Security
Select the security mode for the FTP transfer. The security method you choose will depend on the configuration of the FTP server. Select FTP to transfer without any security. Select ALTFTP if you are having trouble transferring to your FTP server.
Key authentication
Select to use the SSH private key that you specified in the FTP Options dialog.
Passive mode (firewall friendly)
Select to use Passive mode (PASV) when connecting to the FTP server. Use this option if you are having trouble transferring files through a firewall.
Path
Type the path of the files that you want to download. Use wildcards to create a pattern for the filenames of the files that you want to download. The asterisk (*) will match any number of characters and the question mark (?) will match any single character. If supported by your FTP server, paths that begin with '/' are relative to the root FTP folder and paths that begin with './' are relative to the user's home folder.
Include sub-directories
Select to include files found in sub-directories of folder specified in the Path field. When this option is selected, the files found in the sub-directories will also be matched against the pattern. This option only applies to filenames that have been specified using wildcards.
Transfer
Select Binary to transfer the files as binary and ASCII to transfer files as plain text. Consult your FTP server configuration for the best transfer type.
Destination tab
 
Directory
Type the path where you want to save the files you are downloading from the FTP server or use the ellipsis () button to browse for the location.
Advanced tab
 
If file exists
Select the action you would like to take when a file that is being transferred already exists in the destination folder:
overwrite – Overwrite the destination file with the source file that is being copied.
skip – Ignore the file if it already exists in the destination.
and is a different size, overwrite – Overwrite the destination file with the source file if they have different sizes.
and is smaller, overwrite – Overwrite the destination file with the source file if the destination file is smaller than the source file.
and is older, overwrite – Overwrite the destination file with the source file if the destination file's modified date is older than the source file.
Convert underscores to spaces
Select to replace underscores in the file name with spaces after they have been downloaded.
Delete source files after transfer
Select to delete the source files that match the filter after they have been transferred.
Retain server datetime stamp
Select to change the modified date of the file to the same modified date that was set on the server.
Timeout
Type the timeout period in seconds to wait for the server to come back online after a transfer has been interrupted. Once the time has expired, if there is no communication with the server, the Download File object fails.
Available
 
Name
Description
Number successfully downloaded
The number of files taht were successfully downloaded.
Source Path
The path of the root source folder.
Download Folder
The path of the root of the destination folder. This will be the same as the destination path you specified when configuring the operator.
FTP Server name
The name of the FTP server.
FTP Server port
The port used to communicate with the FTP Server.
Protocol
The security protocol that was selected.
For each file deleted:
Filename
The name of the file.
Destination path
The path of the destination folder.
Status
The result of the download as either “success” or “failure”.
Common

Previous Next