The following table lists the methods and parameters that can be used. Parameters in bold are mandatory.
|
|
|
|
|
Delete: Scans local directory or server and deletes indicated files.
|
Source Type
|
Select the source directory type that File watcher will scan.
The possible values are:
|
|
FTP Transfer Mode
|
This property is available when you select FTP as a Source Type above. It lets you determine in which format your files are transferred. The possible formats are:
|
|
Source Directory
|
Enter the location of the directory to scan.
|
|
Search Subdirectories
|
Select a value from the drop-down list to indicate whether File Watcher will scan the subdirectories of the selected directory. The possible values are:
|
|
Filter
|
Enter the names of files or group of files that should be watched. You can use wildcard characters when entering this criteria. For example, if you want to watch only files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Order
|
Select one of the following from the drop-down list to indicate the order in which the directories are scanned:
-
Ascending (Default)
-
Descending
|
|
Criteria
|
Select one of the following from the drop-down list to indicate the scanning criteria:
|
|
Timestamp criteria can be applied on Modified Time value of the files which are moved by the trigger.
|
|
|
Criteria Operator
|
Select one of the following from the drop-down list to indicate the order of the scanned files if the Criteria parameter (above) is Size or TimeStamp:
-
Greater than
-
Less than
-
Equal to
|
|
File Size
|
Enter the file size in bytes, if the Criteria parameter is Size.
|
|
File Date
|
Enter the file date (DD/MM/YYYY), if the Criteria parameter is TimeStamp.
|
|
File Time
|
Enter the file time (HH:MM:SS), if the Criteria parameter is TimeStamp.
|
|
When working with an FTP server, seconds are not considered in the time criteria for the time stamp.
|
|
|
Exclude
|
Enter the name of a file or group of files (separated with comma) that should not be scanned. You can use wildcard characters when entering this criteria. For example, if you want to exclude all files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Timeout
|
Define the time (in seconds) for which the File Watcher should scan the files or directories (only available in Step mode). If no file is found before the timeout period ends, the flow will move to the next step.
|
|
A timeout of 0 indicates that the File Watcher will not wait for any amount of time. The timeout will be disabled. In other words, if a file is not found immediately, the flow moves to the next step without waiting. A timeout with a negative number indicates that the File Watcher will wait indefinitely until a file is found.
|
|
|
Polling Interval
|
Enter the time interval (in milliseconds) after which the File Watcher will scan or poll the directories. For example, if you enter 1000 milliseconds, the File Watcher will scan the directory every second.
The default is 3000 milliseconds.
|
|
Return File To
|
Click  to open the Variables List. Select where the file being scanned for is returned. The file can be returned to a variable defined by the user or to a User BLOB.
|
|
Return Source Filename To
|
Click to open the Variables List. Select where the filename is returned if you are moving or renaming a file. The file can be returned to a variable defined by the user or to a User String.
|
|
Error Code
|
A File Watcher error code.
Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
|
|
Move: Scans local directory or server and moves or renames indicated files.
|
Source Type
|
Select the source directory type that File watcher will scan.
The possible values are:
|
|
FTP Transfer Mode
|
This property is available when you select FTP as a Source Type above. It lets you determine in which format your files are transferred. The possible formats are:
|
|
Source Directory
|
Enter the location of the directory to scan.
|
|
Search Subdirectories
|
Select a value from the drop-down list to indicate whether File Watcher will scan the subdirectories of the selected directory. The possible values are:
|
|
Filter
|
Enter the names of files or group of files that should be watched. You can use wildcard characters when entering this criteria. For example, if you want to watch only files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Order
|
Select one of the following from the drop-down list to indicate the order in which the directories are scanned:
|
|
Criteria
|
Select one of the following from the drop-down list to indicate the scanning criteria:
|
|
Timestamp criteria can be applied on Modified Time value of the files which are moved by the trigger.
|
|
|
Criteria Operator
|
Select one of the following from the drop-down list to indicate the order of the scanned files if the Criteria parameter (above) is Size or TimeStamp:
-
Greater than
-
Less than
-
Equal to
|
|
File Size
|
Enter the file size in bytes, if the Criteria parameter is Size.
|
|
File Date
|
Enter the file date (DD/MM/YYYY), if the Criteria parameter is TimeStamp.
|
|
File Time
|
Enter the file time (HH:MM:SS), if the Criteria parameter is TimeStamp.
|
|
When working with an FTP server, seconds are not considered in the time criteria for the time stamp.
|
|
|
Exclude
|
Enter the names of files or group of files that should not be scanned. You can use wildcard characters when entering this criteria. For example, if you want to exclude all files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Timeout
|
Define the time (in seconds) for which the File Watcher should scan the files or directories (only available in Step mode). If no file is found before the timeout period ends, the flow will move to the next step.
|
|
A timeout of 0 indicates that the File Watcher will not wait for any amount of time. The timeout will be disabled. In other words, if a file is not found immediately, the flow moves to the next step without waiting. A timeout with a negative number indicates that the File Watcher will wait indefinitely until a file is found.
|
|
|
Polling Interval
|
Enter the time interval (in milliseconds) after which the File Watcher will scan or poll the directories. For example, if you enter 1000 milliseconds, the File Watcher will scan the directory every second.
The default is 3000 milliseconds.
|
|
Destination Directory
|
Enter the location of the local directory to where the files will be moved.
|
|
Destination Type
|
Select the source directory type that File watcher will scan.
The possible values are:
|
|
Destination Transfer Mode
|
This property is available when you select FTP as a Destination Type above. It lets you determine in which format your files are transferred. The possible formats are:
|
|
Rename Mask
|
Enter the structure for the name of the moved file or the renamed file. You can use wildcard characters. For example:
-
If you want all files to have the same suffix, you can enter *.txt and all files will be saved in the destination directory with their original name and the .txt suffix.
-
If you want all files to take only the first two letters of the original name, enter ??.* to create files with their original suffix and only the first two letters of the original name.
|
|
The Move operation supports a special case for renaming the file. For renaming to work, the file should be pointing to the same resource (directory and type). The Rename Mask field is mandatory when you have to perform the renaming operation.
If ignored or left blank, an error will be raised at the runtime.
|
|
|
Return File To
|
Click to open the Variables List. Select a variable where the file being scanned for is returned. The file can be returned to a variable defined by the user or to a User BLOB.
|
|
Return Source Filename To
|
Click to open the Variables List. Select a variable that returns the name of the original file that was copied or moved.
|
|
Return Destination Filename To
|
Click to open the Variables List. Select a variable where the filename is returned if you are moving or renaming a file. The file can be returned to a variable defined by the user or to a User String.
|
|
Error Code
|
A File Watcher error code.
Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
|
|
Read: Scans local directory or server and reads selected files.
|
Source Type
|
Select the source directory type that File watcher will scan.
The possible values are:
|
|
FTP Transfer Mode
|
This property is available when you select FTP as a Source Type above. It lets you determine in which format your files are transferred. The possible formats are:
|
|
Source Directory
|
Enter the location of the directory to scan.
|
|
Search Subdirectories
|
Select one of the following from the drop-down list to indicate whether File Watcher will scan the subdirectories of the selected directory:
|
|
Filter
|
Enter the names of files or group of files that should be watched. You can use wildcard characters when entering this criteria. For example, if you want to watch only files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Order
|
Select one of the following from the drop-down list to indicate the order in which the directories are scanned:
-
Ascending (Default)
-
Descending
|
|
Criteria
|
Select one of the following from the drop-down list to indicate the scanning criteria:
|
|
Timestamp criteria can be applied on Modified Time value of the files which are moved by the trigger.
|
|
|
Criteria Operator
|
Select one of the following from the drop-down list to indicate the order of the scanned files if the Criteria parameter (above) is Size or TimeStamp:
-
Greater than
-
Less than
-
Equal to
|
|
File Size
|
Enter the file size in bytes, if the Criteria parameter is Size.
|
|
File Date
|
Enter the file date (DD/MM/YYYY), if the Criteria parameter is TimeStamp.
|
|
File Time
|
Enter the file time (HH:MM:SS), if the Criteria parameter is TimeStamp.
|
|
When working with an FTP server, seconds are not considered in the time criteria for the time stamp.
|
|
|
Exclude
|
Enter the names of files or group of files that should not be scanned. You can use wildcard characters when entering this criteria. For example, if you want to exclude all files that start with Customer, enter Customer * to indicate all files with the word customer and any other name after. The * wildcard character can be in any position.
You can enter more than one file, separating them with a comma. For example, *.txt,*.doc.
|
|
Timeout
|
Define the time (in seconds) for which the File Watcher should scan the files or directories (only available in Step mode). If no file is found before the timeout period ends, the flow will move to the next step.
|
|
A timeout of 0 indicates that the File Watcher will not wait for any amount of time. The timeout will be disabled. In other words, if a file is not found immediately, the flow moves to the next step without waiting. A timeout with a negative number indicates that the File Watcher will wait indefinitely until a file is found.
|
|
|
Polling Interval
|
Enter the time interval (in milliseconds) after which the File Watcher will scan or poll the directories. For example, if you enter 1000 milliseconds, the File Watcher will scan the directory every second.
The default is 3000 milliseconds.
|
|
Return File To
|
Click to open the Variables List. Select a variable where the file being scanned for is returned. The file can be returned to a variable defined by the user or to a User BLOB.
|
|
Return Source Filename To
|
Click to open the Variables List. Select a variable that returns the name of the original file that was copied or moved.
|
|
Error Code
|
A File Watcher error code.
Click to open the Variables List. Select a variable where the error code is returned, and then click Select.
|
