How to Upgrade FileCatalyst HotFolder in a Windows Environment
Posted by Aly Essa, Last modified by Chris Kuhlman on 19 May 2021 11:40 AM

Overview

The following article describes how to perform an upgrade of FileCatalyst HotFolder. While the installer itself will operate gracefully under most situations, the following steps will provide the maximum insurance that no steps are being overlooked. The article assumes that the application is set to run as a service.

Environment

FileCatalyst HotFolder v3.4 and later.

 

Resolution

  1. Shut down the application:

    1. Stop the service:
      1. Close all FileCatalyst Remote Admin Applications.
      2. Hit Start and open the Run command.
      3. Open the Service Manager console opening services.msc.
      4. Scroll down to FileCatalyst HotFolder and hit Stop.

    2. Stand-alone:
      1. Close the FileCatalyst Remote Admin Application by clicking on File and selecting Exit Administration.
      2. Check the system tray to for any other open sessions of the Remote Admin Application.

  2. Backup the old configuration files:

    The following list of files will be required for the rest of the upgrade. Move them into a folder outside of the install location for now.
    These files and folders will be located in the root of the installation directory of the FileCatalyst HotFolder:

    • fchf.conf: This file contains the settings and license of the FileCatalyst HotFolder.
    • sites.xml: All sites that are configured in the HotFolder have their relevant information stored in this file.
    • hotfolders.xml: The storage information and paths for the FileCatalyst HotFolder are found in this file.
    • schedule.xml: All task information and transfer settings are stored in this file.
    • bandwidth.xml: All bandwidth-related settings are stored in this file.
    • backup folder: Archived copies of the configuration files are stored in this folder.
     
  3. Run the installer of the new build. If you intend to use the same configuration and data, the installation path should match the current one.

  4. Replace back backup files from step 2. This step is optional for Windows, as the installer should not overwrite configuration files if it already finds them on the system.

  5. Edit the fchf.conf and modify the wrapper.java.command=./jre/bin/java. This will force the application and service to use the Amazon Corretto Java that we package with the deployment. Save the file and close it.

  6. Once the installer has finished, run the application in stand-alone mode. As the application runs, watch to see that it is successfully imported the Sites, Hotfolders, Schedule Tasks and Bandwidth list. 

  7. If you intend to run the FileCatalyst HotFolder as a service, install the service by selecting Run at Startup from the File menu.

  8. Close the GUI by clicking File and selecting Exit FileCatalyst HotFolder.

  9. Start the service from the Service Manager:
    1. Hit Start and open the Run command.
    2. Open the Service Manager console opening services.msc.
    3. Scroll down to FileCatalyst HotFolder and hit Start.

  10. Launch the FileCatalyst Remote Admin Application (FCHotFolderAdmin.exe) to connect to the FileCatalyst HotFolder service.