FTP_GET Type Uproc

Click OK to save the Uproc and close the window or Cancel to close the window without saving.

FTP_GET type Uproc characteristics:

• The folder and file names may contain a variable or a code, refer to Use Variables.
• Empty origin and destination file names will be interpreted as a multiple download (like if * is used), refer to Use Wildcards.
• On OpenVMS, using FTP_GET type Uprocs with the Replace option will write the file with the same name. If OpenVMS is configured to create a new version after each rewrite, a new version of the file is created.

From

• Host

  Host name of the machine to connect to (the FTP server) or its IP address. Format: alphanumerical characters (mandatory).

• Login

  User name for connection to the FTP server (optional). Format: Maximum of 32 alphanumerical characters.

  By default, the connection will be made in anonymous mode (if this is authorized by the FTP server).

• Password

  Password of the specified user name (optional). Format: maximum of 32 alphanumerical characters.

  By default, the connection will be made with an empty password field. The connection will only be established if the FTP server authorizes users (or anonymous user if the user is not specified) to connect without a password.

  If the SFTP protocol is used with the public / private key authentication, this field will be ignored (refer to section: Dollar Universe – FTP settings).

• Source file name

  Name of the file to be retrieved from the FTP server (optional). Format: Maximum of 256 alphanumerical characters.

  By default, all files in the remote folder (source path name) will be transferred from the FTP server. (Multiple transfer: "MGET").

• Source path name

  Name of the source folder on the FTP server from which the files are to be retrieved (optional). Format: Maximum of 256 alphanumerical characters, * forbidden.

  If not specified, the FTP server will determine the folder where the files will be retrieved, based on its default values.

To

• Host

  Name of the Node associated with the Management Unit where the Uproc will execute. This field cannot be modified with the type FTP_GET.

• Destination file name

  Name of the local file, only when the transfer concerns a single file (optional). Format: Maximum of 256 alphanumeric characters.

  By default, the transfer will maintain the source file name.

• Destination path name

  Local folder name to which the target files will be copied (mandatory). Format: maximum of 256 alphanumerical characters, * forbidden.

  The folder will be created on the local server if it does not exist.

Settings

• Transfer mode

  Choice between "ASCII" and "BINARY". Click on the arrow to select one of the two options.

  • The BINARY type transfers files without conversion.
  • The ASCII type uses CR/LF options described below.

  In SFTP mode, select BINARY. SFTP protocol uses binary mode only.

• Delete source file

  Deletes the source file(s) after the transfer.

  • Selected: The source file(s) will be deleted if the transfer is successful.
  • Not selected: the source file(s) are kept (by default).

• Recursive

  When enabled, the recursive option allows the transfer of whole files and sub-directories of the Source path name set in the General section (the Source file name and the Destination file name can't be edited). When using the recursive option, the recursion depth limit is set to 150 directories.

  The Recursive option uses the FTP LIST command internally to get a list of files and directories on the remote server. The expected server answer must be formatted so each line starts with the file permissions in UNIX format. Since this answer varies from a server to another, the feature will not work if the answer has a different format. Should this happen, a fail-over option is available: it tests each single file on the specified remote server location with a FTP CWD command to check the existence of a directory. The fail-over option is less performing but it can be enabled with the U_FT_GET_DIR_FAILOVER node setting in the Dollar Universe – FTP settings category.

  When downloading a folder in recursive mode using FTP_GET, the Append mode is not supported. Default action Abort is used instead.

• Action if exists

  This option determines what should happen if the file already exists on the FTP server. The choices are "Replace", "Abort", "Append" and "None". Click on the arrow to select one of the actions in the list.

  • Replace: Replaces the local file (if it exists) by the remote file retrieved from the FTP server.
  • Abort: Aborts the transfer and returns an error (default).
  • Append: Appends the file retrieved to the local file (if it exists), (ASCII mode only).
  • None: Cancels the transfer without any error.

• CR/LF stripping

  (ASCII mode only). This option determines if the CR/LF characters are converted to LF (UNIX format).

  • Selected: The CR/LF characters are converted to LF (conversion to UNIX format).
  • Not selected: The file is transferred without conversion.

  In SFTP mode, clear this box.

• Buffer Size

  Size of the communication buffer for the transfer, set in blocks of 512 Bytes. The user should specify a positive number between 0 and 64. The default value used is 32 Blocks (16 384 Bytes).

• Retry

  Number of additional attempts if a transfer fails, before leaving in error (default = 0). The user must enter a positive or null number on one digit. This field applies only for the FTP transfer part of the Uproc in case of failure. It does not retry the whole Uproc in case of error.

• UMASK

  Mask applied to local file permissions. Format: 3 numerical characters. If UMASK is not set or set to 000, files are downloaded with 666 permissions by default (for a root user) or 640 (for a non-root user). Otherwise, file permissions are obtained by subtracting UMASK from the default value (666 or 640).

• Newer only

  Date comparison before transfer. This option is ignored if the action "Abort" or "None" were selected.

  • Selected: The remote file is only retrieved if it is more recent than the local file.
  • Not selected: The remote file is retrieved without checking its date (default).

  Warning! This option is not supported by SFTP by default. To see if SFTP has been configured, see the node setting U_FT_SFTP value.