How To Upgrade FileCatalyst Central
Posted by Jeyram Sachchithananthan, Last modified by Jeyram Sachchithananthan on 26 October 2021 02:40 PM

Overview
The following article describes how to perform an upgrade of FileCatalyst Central on Windows, Mac OSX and Linux platforms.

Please note this document does not apply to any versions of FileCatalyst Central below 3.4.

Click on the links below to view the individual guide based on your Operating Systems:

Environment
FileCatalyst Central v3.4 and later.

Resolution

How To Upgrade FileCatalyst Central in a Windows Environment

  1. Shut down the application.
    FileCatalyst Central needs to be shut down prior to any upgrade. Do not skip this step as it could lead to a serious database issue. 

    • To stop a Central instance running as a service, close the FileCatalyst Central Web Portal.
    • Right-click on your Start button to open the WinX Menu. Select Run. This opens the Run box.
    • Type services.msc in it and hit enter to open the Services Manager.
    • Scroll down and find FileCatalyst Central service and select it. Right-click on it and hit Stop.

  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. These files and folders will be located in the root directory of the FileCatalyst Central Installation:

    • .fcdb folder: This folder is hidden on some operating systems and contains the database information.
    • backup folder: Archived copies of the configuration files and database are stored in this folder.
    • Custom maps and backgrounds: This folder contains custom map background images and icons uploaded by the user. It is located in www\Web Console\images\MapBackground
    • maconfig.conf: This file contains most of the settings that belong to the FileCatalyst Central and your license.
    • mawrapper.conf: This file contains Java-related settings and service wrapper configurations.
    • AuthenticationServices.json: This file contains all the Directory service-related information ( AD, OpenLDAP)

      Note: If you are upgrading a FileCatalyst Central that is version 3.6 or below, and are also performing the upgrade into a different location than the original install, please make sure to copy all the images from www\Web Console\images into a folder outside of the install location. 

  3. Download and run the Central installer. If you intend to use the same configuration and data, the installation path should match the current one being used.

  4. Skip step 4, If your current Central is  version 3.7.3 Build 25 or higher, 
    Edit the <path to>\FileCatalyst Central\mawrapper.conf have the following Java command property is present   " wrapper.java.command=./jre/bin/java."
    This will force the Central to use the inbuilt JRE. Save the changes and continue to the next step.

  5. Once the installation completes the FileCatalyst Central automatically starts as a Windows service.

  6. Launch the FileCatalyst Central Web Portal and verify if the upgrade was successful and the configuration was successfully migrated.

How To Upgrade FileCatalyst Central in a Linux Environment

  1. Shut down the application:
    FileCatalyst Central needs to be shut down prior to any upgrade. Do not skip this step as it could lead to a serious database issue.

    • Stand Alone Execution of Central

      To stop a stand-alone instance use the following steps:

      • Change your working directory to /opt/utechsoft/central/
      • Execute the following command from a Terminal:

        ./fc_central_stop.sh

      • Verify the service is down by running the command:

        ps -ef | grep "java"

    • Central Running as a Service

      • Execute the following command from a Terminal

        service fc_central stop

      • Verify the service is down by running the command: 

        ps -ef | grep "java"

  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.
    These files and folders will be located in the root directory of the FileCatalyst Central installation:

    cd /opt/utechsoft/central/
    mkdir ./upgrade
    cp maconfig.conf ./upgrade
    cp -Rp .fcdb ./upgrade 
    cp -Rp ./www/Web\ Console/images/MapBackground ./upgrade
    cp ./conf/wrapper.conf ./upgrade
    cp AuthenticationServices.json  ./upgrade

    If you are upgrading a FileCatalyst Central that is version 3.6 or below, and are performing the upgrade into a different location than the original install, also run the following backup commands:


    mkdir -p ./upgrade/images
    find ./www/Web\ Console/images -maxdepth 1 -type f -exec cp {} ./upgrade/images \;

  3. Download the new installer package into /opt/utechsoft/central/ from the FileCatalyst Download Portal.

  4. Unpack the software with the following commands:

    cd /opt/utechsoft/central/
    gunzip fc_central.tar.gz
    tar –
    xvf fc_central.tar
    chmod a+x *.sh

  5. Restore Configuration files that were overwritten by tar bundle.

    cd /opt/utechsoft/central/
    cp ./upgrade/maconfig.conf ./
    cp ./upgrade/AuthenticationServices.json ./
    cp -Rp ./upgrade/images ./www/Web\ Console
    cp -Rp ./upgrade/MapBackground ./www/Web\ Console/images
    cp ./upgrade/wrapper.conf ./conf/

    Note: the .fcdb directory should not be overwritten by tar bundle.

  6. Skip step 4, If your current Central version is V 3.8 or higher.
    Edit the /opt/utechsoft/central/conf/wrapper.conf and have the following Java command property is present "wrapper.java.command=./jre/bin/java."
    This will force the Central to use the inbuilt JRE. Save the changes and continue to the next step.


  7. Restart the FileCatalyst Central application (either as a service or standalone) based on your installation.

  8. Launch the FileCatalyst Central Web Portal and verify if the upgrade was successful and the configuration was successfully migrated.