Hotfolder Receiver

This default hotfolder option enables the setup of a monitored directory as the receiver. Files are placed into this folder and are processed by the integration endpoint. Typically this is on the application server or can be reached from the application server. When the endpoint polls the hotfolder and finds more than one file, the files are handled in sequence starting with the oldest file first, based on the last modified data stamp. All formats supported by the standard import functionality are available via hotfolder import.

Note: The Asset Importer Processing Engine requires the use of the Hotfolder Receiver. For more information, refer to the IIEP - Configure Asset Importer Processing Engine topic.

To control the order of the files to be imported, set up either a Hotfolder Receiver Using Meta Files or a Hotfolder Receiver Using File Sequence instead.

Prerequisites

The location of the 'Hotfolder' and 'In folder' parameters are determined by the sharedconfig.properties file Install.HotfolderRoot property. Changes to the properties file are implemented when the server is restarted.

Configuration

After completing the prerequisite steps, edit the receiver of the IIEP. Use the following parameters to configure the IIEP. For information on a parameter, hover over the parameter field to display help text.

  1. For Receiver, choose Hotfolder Receiver.

  2. For Hotfolder, enter the name used to create a folder on the application server in the 'upload' directory.

  3. For Keep file after load, specify if files dropped in the hotfolder should be removed after processing the files.

    • Yes - requires periodic manual cleanup on the server.

    • No - removes the files automatically and is the common setup to prevent the need for manual cleanup.

  4. For Number of files to keep in save, specifies the number of files to be saved in the save folder after automatic cleanup. Parameter can save up to 1,000 files.

  5. For Time to keep files in save (in days), specifies the number of days the files are saved in the save folder. Parameter can save files for up to 365 days.

  6. For Number of files to keep in failed, specifies the number of files to be saved in the failed folder. Parameter can save up to 1,000 files.

  7. For Ignore sub folders, specify if subfolders within the hotfolder (which contain files) should be ignored.

    • Yes - files in these folders will not be imported.

    • No - in order to process all files, regardless of their location within the hotfolder or a folder below it is the common setup.

  8. For In folder is optional. Enter a name for an 'In' folder. The name entered is used to create a new folder under the directory specified above in the 'Hotfolder' parameter. If no folder is specified, files are dropped at the hotfolder top level.

  9. Click the Next button to continue with the IIEP - Configure Endpoint and subsequent steps.