Open topic with navigation

Use the File Detection property page to configure the following properties for your integration.

Source

• Location: Specifies the file system or location where the folder that you want to monitor resides. File systems or locations can include a path that is relative to the folder that contains the integration file, a temporary storage folder, local file systems or network shares, Librarian, or a supported cloud storage location. For more information about supported cloud storage locations, refer to the Administration Console Cloud Storage Page.

• Last Published Revision: Specifies that the integration uses the last published revision of a Librarian file as a trigger file. This option takes effect only when the Librarian file is assigned to a workflow. Available when Location is set to Librarian.

• Folder to Scan: Specifies the folder location where you want the action to look for the file. You can enter the folder location or click Browse to locate and select the folder that you want (the Browse option is not available when Location is set to Relative to Integration or Temporary Storage). Alternatively, you can add a variable that specifies the folder to scan or add a special character to the value that you enter.

  • Scan child folders: Specifies that the action also monitors all the subfolders of the folder that is specified by the Folder to Scan property.

  • Folder is scanned by integrations on multiple servers: Specifies that the scan folder is left open to other applications or instances and does not create an exclusive lock file token on the scan folder.

  • Read event contents: Specifies that the contents of the trigger file are read when the integration is run. When you do not need or want the contents to be read, click to clear this check box to improve performance.

• Scan Method: Specifies the method that the Integration Service uses to monitor the scan folder for the arrival of the trigger file.

  • Notification and Polling: Specifies that the action monitors the scan folder continuously and also scans it at timed intervals. This option is useful when you have concerns about the reliability of your file system. If a continuous scan missed an event, a polled scan would ensure that it was detected. When you select this option, you can specify the polling interval in milliseconds, seconds, minutes, or hours.

  • Notifications Only: Specifies that the action monitors the scan folder continuously.

  • Polling Only: Specifies that the action scans the scan folder at timed intervals. When you select this option, you can specify the polling interval in milliseconds, seconds, minutes, or hours.

• Polling Interval: Specifies how often the action scans for the file. Available when Notification and Polling or Polling Only is selected for the Scan Method.

• File Pattern: Specifies the filter that the Integration Service uses to identify the file. This filter can include wildcard characters (such as ? and *) or regular expressions (such as (?i)^.*\.csv$). Click to view a list of supported regular expression or wildcard modifiers, and then click a modifier to add it. You can also add a variable that specifies the file pattern or add a special character to the value that you enter.

  • Use Regular Expression: Specifies that the action uses regular expressions to identify the file pattern. When you select this option, you can add regular expression modifiers to the previous property for more control over the search criteria.

Detection Options

• Detection Events: Specifies the type of event that the integration monitors for, as follows:

• File Created: Specifies that the integration monitors for a file to be created. When Location is set to Librarian and Last Published Revision is selected, this event can be detected only after the created file has been moved to a published state or after the file is initially created in a published state.

• File Changed: Specifies that the integration monitors for a file to be changed in size, last modified time, or revision number. When Location is set to Librarian and Last Published Revision is selected, this event can be detected only when the changed file is in a published state.

• Workflow State Changed to: Specifies that the integration monitors for a file's workflow state to be changed to the specified state. Enter the workflow state that you want in the field (this field is case-sensitive). When Last Published Revision is selected, this event can be detected only when the specified target state is a published state. Available when Location is set to Librarian.

• 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 waits before it processes the trigger file. The Integration Service begins counting from the time the file was last written to.

• Locked-File Timeout: Specifies how long the Integration Service tries to open a detected file that is initially locked by another application.

Multiple File Sort Order

Defines the order in which the action processes 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, the sorting process defaults to creation time (in ascending order) and then file name (in ascending order). You can specify up to four sort criteria.

• Order: Displays the order in which the sort 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 whether ascending or descending order is used when the sort field criterion is applied to the matching files.

• Add Sort Criteria: Specifies additional sort criteria.

Actions After Detection

Specifies the action that you want to be performed on the trigger file after it is detected by the Integration Service.

• Action: Specifies which action you want to be applied to the trigger file.

• None: Specifies that no action is applied to the trigger file.

• Rename File: Specifies that the trigger file is renamed. If the trigger file is a Microsoft Excel file, you must enter a valid Excel file name extension (such as *.xls or *.xlsx).

• 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 location of the folder to move the trigger file to. You can enter the folder location or click Browse to locate and select the folder that you want (the Browse option is not available when Location is set to Temporary Storage). Alternatively, you can add a variable that specifies the destination folder or add a special character to the value that you enter. Available when Move File is specified.

• New Extension: Specifies the file name extension that you want to be applied to the file when it is renamed or moved. Enter the file name extension. Alternatively, you can add a variable that specifies the file name extension or add a special character to the value that you enter. Available when Rename File or Move File is specified.

• Replace file if it already exists: Specifies that any previously existing file of the same name is deleted when a trigger file is moved or renamed. Available when Rename File or Move File is specified.

• Make file name unique by appending serial number: Specifies that a serial number is appended to the file name. Available when Rename File or Move File is specified.

• Make file name unique by appending time stamp: Specifies that a time stamp is appended to the file name. Available when Rename File or Move File is specified.

Actions After Failure

Specifies the actions that you want to be performed on the trigger file if one or more of the integration actions fail.

• Action: Specifies which action you want to be applied to the trigger file.

• None: Specifies that no action is 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 location of the folder to move the trigger file to. You can enter the folder location or click Browse to locate and select the folder that you want (the Browse option is not available when Location is set to Temporary Storage). Alternatively, you can add a variable that specifies the destination folder or add a special character to the value that you enter. Available when Move File is specified.

• New Extension: Specifies the file name extension that you want to be applied to the file when it is renamed or moved. Enter the file name extension. Alternatively, you can add a variable that specifies the file name extension or add a special character to the value that you enter. Available when Rename File or Move File is specified.

• Replace file if it already exists: Specifies that any previously existing file of the same name is deleted when a trigger file is moved or renamed. Available when Rename File or Move File is specified.

• Make file name unique by appending serial number: Specifies that a serial number is appended to the file name. Available when Rename File or Move File is specified.

• Make file name unique by appending time stamp: Specifies that a time stamp is appended to the file name. Available when Rename File or Move File is specified.

Related Topics

• File Integrations