File Detection Property Page |
The File Detection property page enables you to configure the following properties for your File integration:
Detection Options
Location: Specifies the file system where the folder that you want to be monitored exists. File systems or locations can include local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, see Administration Console's
Folder to Scan: Specifies the folder location where the Integration Service needs to look for the file. You can type the folder location or click Browse to locate and select the desired folder. Alternatively, you can add a variable that specifies the folder to scan, or add a special character to the value you have entered.
Scan child folders: When enabled, the Integration Service will also monitor all sub-folders of the folder specified by the Folder to Scan property.
Folder is scanned by integrations on multiple servers: When enabled, leaves the scan folder open to other applications or instances and does not create an exclusive lock file token on the scan folder.
Scan Method: Specifies the method the Integration Service will use to monitor the scan folder for the arrival of the trigger file.
Notification and Polling: Specifies that the Integration Service will both monitor the scan folder continuously and scan the folder at timed intervals. This option may be useful when you have concerns about the reliability of your file system. If an event were to be missed during the continuous scan, a polled scan would ensure its detection. When selected, you can specify the polling interval in milliseconds, seconds, minutes, or hours.
Notifications Only: Specifies that the Integration Service monitors the scan folder continuously.
Polling Only: Specifies that the Integration Service scans the scan folder at timed intervals. When selected, you can specify the polling interval in milliseconds, seconds, minutes, or hours.
Polling Interval: Specifies how often the Integration Service scans for the file, Available when Notification and Polling or Polling Only is selected for the Scan Method.
File Pattern: Specifies the filter for files to look for. The default is *.dat. Enter a different file extension if you wish. Alternatively, you can add a variable that specifies the file pattern, or add a special character to the value you have entered.
Use Regular Expression: When enabled, specifies that the Integration Service will use regular expressions to identify the file pattern. Once this option is enabled, you can add regular expression modifiers to the previous property for more control over the search criteria.
Minimum File Size: Specifies the minimum file size that the trigger file must be for the Integration Service to accept it as the integration trigger.
Maximum File Size: Specifies the maximum file size that the trigger file cannot exceed for the Integration Service to accept it as the integration trigger.
File Idle Time: Specifies the amount of time that the Integration Service will wait before it processes the trigger file. The Integration Service begins counting from the time the file was last written.
Locked-File Timeout: Specifies how long to attempt to open a detected file that is found to be initially locked by another application.
Multiple File Sort Order
Defines the order in which the Integration Service will process files in the specified folder when more than one file matches the indicated file pattern. If no sort order is specified on the property page, sorting defaults to creation time (ascending order), and then by file name (ascending order). You can specify zero to four sort criteria.
Order: Displays the order in which the sorting criteria are applied to the matching files in the specified folder.
Sort Field: Specifies the criterion to be applied to the matching files.
Direction: Specifies ascending or descending order is used when the sort field criterion is applied to the matching files.
Add Sort Criteria: Allows you to add additional sorting criteria.
Actions After Detection
Specifies the action that you want to be performed on the trigger file after it has been detected by the Integration Service.
Action: Allows you to select which action you want applied to the trigger file.
None: Specifies that no action will be applied to the trigger file.
Rename File: Specifies that the trigger file is renamed.
Delete File: Specifies that the trigger file is deleted.
Move File: Specifies that the trigger file is moved to another location.
Move to Folder: Specifies the folder location to move the trigger file. You can type the folder location or click Browse to locate and select the desired folder. Alternatively, you can add a variable that specifies the destination folder, or add a special character to the value you have entered. Available when Move File has been specified.
New Extension: Specifies the file extension you want applied to the file when it is being renamed or moved. Enter the file extension. Alternatively, you can add a variable that specifies the file extension, or add a special character to the value you have entered.. Available when either Rename File or Move File has been specified.
Replace file if it already exists: When moving or renaming a trigger file, specifies that any previously existing file of the same name will be deleted. Available when either Rename File or Move File has been specified.
Make file name unique by appending serial number: Specifies that a serial number will be appended to the file name. Available when either Rename File or Move File has been specified.
Make file name unique by appending time stamp: Specifies that a time stamp will be appended to the file name. Available when either Rename File or Move File has been specified.
Actions After Failure
Specifies the actions that you want to be performed on the trigger file after one or more of the integration actions has failed.
Action: Allows you to select which action you want applied to the trigger file.
None: Specifies that no action will be applied to the trigger file.
Rename File: Specifies that the trigger file is renamed.
Delete File: Specifies that the trigger file is deleted.
Move File: Specifies that the trigger file is moved to another location.
Move to Folder: Specifies the folder location to move the trigger file. You can type the folder location or click Browse to locate and select the desired folder. Alternatively, you can add a variable that specifies the destination folder, or add a special character to the value you have entered. Available when Move File has been specified.
New Extension: Specifies the file extension you want applied to the file when it is being renamed or moved. Enter the file extension. Alternatively, you can add a variable that specifies the file extension, or add a special character to the value you have entered.. Available when either Rename File or Move File has been specified.
Replace file if it already exists: When moving or renaming a trigger file, specifies that any previously existing file of the same name will be deleted. Available when either Rename File or Move File has been specified.
Make file name unique by appending serial number: Specifies that a serial number will be appended to the file name. Available when either Rename File or Move File has been specified.
Make file name unique by appending time stamp: Specifies that a time stamp will be appended to the file name. Available when either Rename File or Move File has been specified.