File Listener

Description

The File Listener monitors a directory for files.

Configuration

To add the File Listener to a stream, follow the steps below:

  1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
  2. From the toolbox on the left expand the Listener option and scroll down until you can see “File Listener”
    • You can also use the search in the header to find the stream object quickly
  3. Click and drag the File Listener from the toolbox onto the canvas
  4. Rename the Listener by clicking into the text button on the action bar
  5. Save the Stream by clicking the save button in the action bar
  6. Hover over the icon for the stream object until it turns orange and then double click to open the configuration page
    • You can optionally use the configure option on the action bar once you have selected the specific stream object and then clicking this option
  7. Configuration options
    • The drop down allows you to associate this stream object with a specific collection. The default option is derived from the default specified against the specific use case and is generated left as the same option. If you do need to change it to another collection make the change by selecting the new collection in the drop down.
    • Enter a value for the Polling Interval (the interval at which new records are accessed/checked for, in seconds)
  8. Enter File Monitor Settings
    • Enter the Target Directory Path that need to be monitored.
    • Tick “Include sub directories” if sub directories need to be included
    • Specify the Search Pattern to use when matching files. This can contain the wildcard characters * and ?.
    • Specify Archive Directory Path, which is the directory where files will be moved once detected
  9. Click Apply on the action bar, and then save the stream using the save button.
Limitations

None at this time

Release Notes
Version: 2.27
Released: 04-March-2019
Release Notes: Updated help URL
Version Released Release Notes
2.71 13-Aug-2018 Added error endpoint
2.70 25-June-2018 Removed explicit call to Poll() from Start() method
2.60 20-June-2018
  • Changed to polling agent
  • Added archiving of files to archive directory
  • Added validation of target and archive directories

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X