ActiveTransfer Server 10.5 | webMethods ActiveTransfer Documentation | Administering ActiveTransfer Server | Server Configuration Parameters and Variables | Server Variables | File Reference Variables
 
File Reference Variables
Note:
In event actions such as Write File to Database and Send Email which process multiple files, use the variables as per the following example:
<LINE>{stem}{ext}
</LINE>
This syntax ensures that all the files in the list are processed by these actions instead of just the first file.
Variable
Description
Supported Event Type
{command}
Command forwarded to remote FTP servers to list files.
N/A
{end}
End time for the file transfer.
Post-processing event
{error}
Error messages related to the file transfer.
Post-processing and scheduled events
{ext}
Last part of the file name, including the period.
Post-processing and scheduled events
{file_metadata}
Applicable only to FTP remote servers. Raw response from the remote server for each file while performing MLST, MLSD, LIST, or NLST commands.
Example:
Type=file;Modify=20151006091701;
Perm=r,w,a,d,f;Size=584;
UNIX.owner=user;UNIX.group=group;
properties_4.cnf
Scheduled event
{group}
Applicable only to FTP remote servers. Retrieves information from the UNIX ownership class group, os-depend-fact in MLST RFC 3659.
Scheduled event
{md5}
MD5 hash of the uploaded file.
N/A
{modified}
Applicable only to FTP remote servers. Date when the file was last modified in UNIX epoch time (milliseconds).
Scheduled event
{name}
Name of the file.
Post-processing and scheduled events
{owner}
Applicable only to FTP remote servers. Retrieves information from the UNIX ownership class owner, os-depend-fact in MLST RFC 3659.
Scheduled event
{parent_path}
Path to the parent folder.
Scheduled event
{path}
Path of the file:
*Local file system. Local directory path.
*Remote file system. Relative path of the file in a file system with respect to the current folder.
Post-processing and scheduled events
{permissions}
Applicable only to FTP remote servers. Permission for the file on the remote server to which ActiveTransfer is connected. The format is -rw-r--r--. For MLST, this format is maintained only when unix.modeis available. If unix.mode is not available, the format is r,w,a,d,f, and is retrieved from perm.
Scheduled event
{real_parent_path}
Local path of the parent folder for the file on the disk.
Post-processing and scheduled events
{real_parent_path_decoded}
Decoded value of the variable {real_parent_path}
Post-processing and scheduled events
{real_path}
Complete path to the file in the local or remote file system.
Post-processing and scheduled events
{real_path_decoded}
Decoded value of the variable {real_path}
Post-processing and scheduled events
{resume_loc}
Location in the file where the transfer should resume if interrupted.
Post-processing and scheduled events
{size}
Size of the file.
Post-processing and scheduled events
{speed}
Speed of the file transfer.
Post-processing event
Note that when the actual speed is 0, this variable value might be inaccurate.
{start}
Start time for the file transfer.
Post-processing event
{stem}
First part of the file name, before the period.
Post-processing and scheduled events
{the_file_error}
Any error during file transfer.
Post-processing and scheduled events
{the_file_name}
Name of the file.
Post-processing and scheduled events
{the_file_size_formatted}
Size of the file.
Post-processing and scheduled events
{the_file_speed}
Speed of the file transfer (upload/download) for post-processing events.
Post-processing event
{the_file_path}
Path of the file.
Post-processing and scheduled events
{url}
Actual URL that points to the file.
Post-processing and scheduled events
{url_decoded}
Decoded value of the variable {url}
Post-processing and scheduled events
{user_dir}
Folder that the user sees when uploading the file.
Post-processing and scheduled events
{user_session_download_count}
Total download count per user session for post-processing events.
Post-processing event
{user_session_upload_count}
Total upload count per user session for post-processing events.
Post-processing event
{user_time}
User upload/download time for post-processing events.
Post-processing event
{items_count} or {item_count}
Count of the number of files an events consists.
Post-processing and scheduled events