Variables representing file names on the server and on the local computer, dates and times

FTPGetter provides a set of variables that represent full file names on the SFTP server and local computer, current date, file modification dates on the SFTP server and local computer, and more. During task execution, these variables contain information related to the file currently being uploaded or downloaded. These values can be used as parameters for executing bat-files, PowerShell scripts, shell scripts on the SFTP server, sending email notifications, and more. Below is the complete list.

Variables to substitute data such as paths to file, dates and times.

Local File Path

%local_file% - substitutes with a full path including the file name to a file on a local or network disk, e.g. C:\my-docs\report.txt

%local_file_path% - substitutes with just a path without the file name to a file on a local or network disk, e.g. C:\my-docs\

%local_file_name% - substitutes with just a file name without the path to a file on a local or network disk, e.g. report.txt

%local_file_name_only% - substitutes with just a file name without the path to a file and extension on a local or network disk, e.g. report

%local_file_name_ext% - substitutes with just a file name extension, e.g. txt

Remote File Path

%remote_file% - substitutes with a full path including the file name to a file available remotely on a network server, e.g. /pub/user/file.txt

%remote_file_path% - substitutes with just a path without the file name to a file available remotely on a network server, e.g. /pub/user/

%remote_file_name% - substitutes with just a file name without the path to a file available remotely on a network server, e.g. file.txt

%remote_file_name_only% - substitutes with just a file name without the path to a file and extension available remotely on a network server, e.g. file

%remote_file_name_ext% - substitutes with just a file name extension, e.g. txt

Current Date and Time

%c_dd% - substitutes with the current day in two-digit format with leading zero, 01 to 31.

%c_mm% - substitutes with the current month with leading zero, 01 to 12.

%c_yyyy%, %c_yy% - current year in 4-digit or 2-digit format, e.g. 2026 or 26.

%c_hh% - current time (hours) in 24-hour format with leading zero, 00 to 23.

%c_min% - current time (minutes) with leading zero, 00 to 59.

%c_sec% - current time (seconds) with leading zero, 00 to 59.

%y_dd% - substitutes with yesterday’s day in two-digit format with leading zero, 01 to 31.

%y_mm% - substitutes with yesterday’s month with leading zero, 01 to 12.

%y_yyyy%, %y_yy% - yesterday’s year in 4-digit or 2-digit format, e.g. 2025 or 25.

%t_dd% - substitutes with tomorrow’s day in two-digit format with leading zero, 01 to 31.

%t_mm% - substitutes with tomorrow’s month with leading zero, 01 to 12.

%t_yyyy%, %t_yy% - tomorrow’s year in 4-digit or 2-digit format, e.g. 2027 or 27.

Examples

Assuming that today is June 07, 2026, the following file path:

/pub/user/reports/%c_yyyy%-%c_mm%-%c_dd%/file.txt

Will be substituted into:

/pub/user/reports/2026-06-07/file.txt

, with 2026 representing the year, 06 meaning June, and 07 being the day of the month.

The substitution variables (%c_*****%) can be used to specify paths to source and destination files as well as passed as parameters to external applications.

File Modification Date and Time

%s_dd% - source file modification date (day): substitutes with the day number in two-digit format with leading zero, 01 to 31.

%s_mm% - source file modification date (month): substitutes with a month number with leading zero, 01 to 12.

%s_yyyy%, %s_yy% - source file modification date (year): substitutes with a year in 4-digit or 2-digit format, e.g. 2026 or 26.

%s_hh% - source file modification time (hours): substitutes with an hour in 24-hour format with leading zero, 00 to 23.

%s_min% - source file modification time (minutes): substitutes with a minute with leading zero, 00 to 59.

%s_sec% - source file modification time (seconds): substitutes with a second with leading zero, 00 to 59.

Examples

The source file specified as:

/pub/user/reports/%s_yyyy%-%s_mm%-%s_dd%/file.txt

Will be accessed with variable substitution by the following real path:

/pub/user/reports/2026-06-07/file.txt

, with 2026 representing the year, 06 meaning June, and 07 being the day of the month when the file was last modified.

The variables that represent source file modification date (%s_*****%) can only be used to specify paths to destination files as parameters specified to the program that is launched after transferring the files.

Misc

%remote_host% - substitutes with an FTP site name, e.g. ftp.example.com:21

%task_number% - substitutes with the current task number.

%action% - substitutes with the performed action, e.g. Download or Upload

%result% - substitutes with the performed action result, e.g. Success or Failed

%list% - substitutes with the transferred files list. Available only in the email body when the Send email AFTER all files are transferred option is used.

%list_file_name% - substitutes with the transferred file names list (without paths). Available only in the email body when the Send email AFTER all files are transferred option is used.

%files_total% - substitutes with the total number of processed files.

%files_success% - substitutes with the number of successfully processed files.

%files_failed% - substitutes with the number of failed processed files.

Back on top