Folder Monitor transfer sites

Download settings for Folder Monitor transfer sites

The following table describes the download settings for a Folder Monitor transfer site.

Field Description
Download Folder Settings
Download Folder

The full path to the folder to which incoming file transfers are saved. To see the list of the folder's files and subfolders, click List. For more details, see List the contents of the Upload or Download folder.

You cannot enter spaces-only values in this field.

Note: The download folder should not be set to the root (/) folder of the operating system, because that can corrupt the whole operating system.

Note: ${DXAGENT_TRANSFERSAPI_*} expressions are not supported.

You can use the following expression to append dates:
folder_${date("yyyyMMdd")}

The download folder will be evaluated using the current date when the transfer site is being executed. For example folder_20210130.

Download File Filter
Pattern Type

Specify whether you want to use glob pattern matching or regular expression syntax to match the strings specified for the "Download Pattern" field.

Download Pattern

Specify a file name pattern to identify the files to be downloaded.

For regular expression syntax, see Regular expressions.

For globbing syntax, see Globbing in SecureTransport.

The download pattern is evaluated when the transfer site is being executed.
Examples:

  • The glob *_${date("yyyyMMdd")}.txt will be evaluated using the current date of the transfer site execution, e.g., on the 30.10.2022, it will match all files that end with _20210130.txt.

  • The regex *[a-z]_${date("yyyyMMdd")}.txt will also be evaluated using the current date, e.g., on the 30.10.2022, it will match all files that start with any combination of letters from a to z and end with _20210130.txt.

Case Sensitive Select this check box to enable case-sensitive file name matching.
Subfolder Monitoring
Do Not Monitor Subfolders Apply the Download pattern to the download folder only.
Monitor All Subfolders Apply the Download pattern to the download folder and all subfolders.
Monitor Subfolders to a Maximum Depth of ___

Apply the Download pattern to the download folder and subfolders to the depth specified.

For example, if the maximum depth is 2, apply the download pattern to the download folder and its immediate subfolders.

Download Subfolder Pattern Type Select the pattern matching syntax: Regular Expression or File Globbing.
Download Subfolder Pattern

(Displayed only when monitoring subfolders)

Specify a file name pattern to identify the subfolders to be monitored.

You cannot enter spaces-only values in this field.

Case Sensitive (Displayed only when monitoring subfolders) Select this check box to enable case-sensitive folder name matching.
Post Transformation Settings
Receive File As Select the check box to specify a file name. You can use the expression language to specify the criteria you want to match. The expression uses the criteria provided to create a new file name from the original file name when the transfer is received. You can use the SecureTransport-specific variable ${stenv.site_target} which takes the value from the remote file path. See Expression Language for information on SecureTransport-specific variables.

Upload settings for Folder Monitor transfer sites

The following table describes the upload settings for a Folder Monitor transfer site.

Field Description
Upload Folder

The folder from which files to be transferred to the remote host are taken. You cannot enter spaces-only values in this field. To see the list of the folder's files and subfolders, click List. For more details, see List the contents of the Upload or Download folder.

Note Making the Upload Folder the same as the Download folder may lead to an infinite loop condition when the Transfer Site is used.
Automatically create upload folder if it doesn't exist Upload Folder will be automatically created if it doesn't exist. The automatically created folder will be owned by the user running the SecureTransport TM Server process.
Allow Overwrite

Taken into account when the site is used by the Send To Partner step. If checked the value of "Upload folder" will be overwritten with the value of "Overwrite upload folder". For more details, see Advanced Routing

Post Transmission Settings
Send File As Select the check box to specify a file name. EL expressions are supported. The expression uses the criteria provided to create a new file name from the original file name.
On Failure

A failure occurs when the transfer is incomplete and all retry attempts were unsuccessful. Select one of the three choices: No Action, Delete Destination File, or Move/Rename File To.

Selecting No Action causes the file to stay in the new location with the file name you specified. If another file with the same name is transferred to this location, the original file is overwritten.

Selecting Delete Destination File removes the file from the new location.

Selecting Move/Rename File To requires you to specify a directory in the location where you are transferring the files to and to provide an expression used to rename the file.

On Success Select one of the choices: No Action, or Move/Rename File To. Selecting No Action causes the file to stay in the new location with the file name you specified. If another file with the same name is transferred to this location, the original file is overwritten. Selecting Move/Rename File To requires you to specify a directory in the location where you are transferring the files to and to provide an expression used to rename the file.

Folder Monitor specifics

The Folder Monitor protocol differs from the other supported protocols in the following aspects:

  • The folders listed in <FILEDRIVEHOME>/conf/unsafe.paths.conf file (and their sub-folders) cannot be specified in the Upload Folder and Download Folder fields.
  • The paths, specified in the Upload Folder and Download Folder fields, must be full system paths (not relative paths), such as:
    /tmp/folder_name/opt/TMWD/folder_name/
  • The files uploaded/moved into the specified upload folder are owned by the root user of the system.
  • If SecureTransport is installed as a non-root deployment, the files in upload folder are owned by the user running the SecureTransport Server.
  • If you configure the account to impersonate a user, the impersonated user must have full rights to the directories specified in the Folder Monitor.
  • If you upload or move a file in the specified upload folder and such a file already exists there, it is overwritten without a prompt.
  • If SecureTransport is installed as a non-root deployment, the user running the SecureTransport Server must have the necessary permissions to overwrite the file.
  • When the Folder Monitor starts to monitor the download folder, the download pattern is applied to all the files in the folder, even if they existed in the download folder before the Folder Monitor began monitoring.
  • If SecureTransport is installed as a non-root deployment, the user running the SecureTransport Server must have the necessary permissions to write to the upload folder.
  • SecureTransport does not support placing the download folder and the upload folder under a repository encryption user home folder.
  • If you create a service account and a Standard Router application that uses a Folder Monitor transfer site, and you specify the same directory for sending and receiving messages, file transfers fail.
  • A Folder Monitor transfer site can be used to receive messages for only one subscription.
  • The names of the download folder and the upload folder of a Folder Monitor transfer site cannot contain two or more of the following characters in a sequence: ( ) _ - + = { } ~ ! @ # $ % ^ & ; “ ” ‘ ’. For example, folder_name is supported, but folder_+name is not supported.
  • The name of a file processed by a Folder Monitor transfer site cannot contain two more of the following characters in sequence: < > | : ? " * / \ % [ ] ~ (at the beginning of the file only).
  • Two Folder Monitor transfer sites cannot have the same download folder and download pattern.
  • The Folder Monitor service runs on the primary server in a Standard Cluster (SC). If that server fails, the Folder Monitor service automatically fails over to the new primary server.
  • The Folder Monitor service runs on one server in an Enterprise Cluster (EC). If that server fails, the Folder Monitor service automatically fails over to the server in the cluster with the Transaction Manager that has been running the longest.

Related topics:

Related Links