FileMover Service Configuration

Owned by Mahnoor Khan (Deactivated)
Last updated: Jun 05, 2024 by Linyan Becky Li
2 min read

Summary

The FileMover service resides in the services folder with all EngageIP installations. It allows automated FTP and SFTP transfer of files from a source directory to a remote directory.

Configuration Requirements

  1. FileMover config file with temp file line item

  2. Temp folder existing on local system

  3. FTP Source directory existing on local system

  4. FTP Destination folder existing on remote system

  5. Custom code - this installs profile questions for connection details. These connection details show as a list of profile questions on the admin user

  6. FTP or SFTP user account created and working

Configuration

  1. Add key to FileMover config file if it does not exist: <add key="TempFilePath" value="C:\TempFiles" />

    1. Starting from EIP 9.3.9, the file mover supports GCP, sample config

      1. <!-- Sample GCP Setting, upload to GCP --> <!-- <add ConfigUniqueIdentifier="57" SourceMoveType="Folder" SourceFolder="C:\\temp\\Src" SourceFileRegexFilter=".+csv" RenameFileOnMove="false" DestinationMoveType="GCP" DestinationBucket="bucketName" CompressionType="Zip" DestinationKeyLocation="C:\\path\\to\\key.json" DestinationFolder="folderName" /> --> <!-- download from GCP --> <!-- <add ConfigUniqueIdentifier="58" SourceMoveType="GCP" SourceFolder="folderName" SourceFileRegexFilter=".+csv" SourceBucket="bucketName" SourceKeyLocation="C:\\path\\to\\key.json" RenameFileOnMove="false" RemoveFromRemote="true" DestinationMoveType="Folder" DestinationFolder="C:\\temp\\Dst" /> -->

  2. Install the GenericFileMoverSettingsCustomCode custom code provided below

  3. Go to admin user and add the FileMoverSettings component

  4. Start FileMover service in services list on APP server

GenericFileMoverSettingsCustomCode

Testing

  1. Place test file in source directory and wait for the file mover to pick up and transfer the file

  2. Check the Logs folder for any related errors if the file is not being moved

Notes

  • Destination directory should not have starting forward slash

  • Keys can be left blank initially for basic implementation and basic SFTP account

  • Ensure write permissions exist on all folders (temp, source, destination)