Migrate From Windows Workflow Installer (EXE) to Tomcat Standalone Deployment
Posted by Aly Essa, Last modified by Aly Essa on 14 April 2021 09:56 AM

Overview

This article is designed to migrate your FileCatalyst Workflow instance which was installed using the executable installer. This installer includes an embedded Tomcat Web Server.

As of November 30, 2020, we will no longer be producing this installer.

This article will walk you through all the necessary steps needed to back up your Workflow deployment and migrate the application over to a stand-alone Tomcat Web Server install.

Article Quick Links

Environment

FileCatalyst Workflow v4.9.9 and newer.
Windows OS only.


Resolution

Warning: Do not skip any steps in this section or you may experience problems with your migration. 

  1. Backup configuration and settings:

    1. Database
      1. If you are using an Internal HSQL DB, this will be copied when backing up the Workflow Configuration files in the next step.
      2. If you utilize a MySQL DB, it is recommended that you use MySQL Workbench or a MySQL command line to take a full backup of the database.

    2. Workflow Configuration.
      1. Log into the FileCatalyst Workflow deployment as the Super Admin User.
      2. Click on About FileCatalyst on the top menu bar.
      3. The path listed under Configuration Path will be the location of your deployment. Copy this into a text editor and then browse to this location.
      4. Copy this folder and its contents to a new location, such as C:\workflow-config\. For the rest of this article, we will reference C:\workflow-config\.


    3. Web Server Settings
      1. Shut down the FileCatalyst Web Workflow service.



      2. Navigate to the installation folder and copy the \apache-tomcat\conf\ folder to your backup location. The default location for this installation is "C:\Program Files\FileCatalyst Web Workflow" or "C:\Program Files\FileCatalyst Workflow".
      3. Browse to \apache-tomcat\webappts\ROOT\ and copy this folder and its contents to your backup location. This folder will maintain your redirectors if they have been configured in the index.html file.

    4. SSL Certificate (optional)
      1. Backup your SSL Certificate Directory to your backup location.
      2. Open the \apache-tomcat\conf\server.xml file in a text editor.
      3. Search for the element in your SSL connector that has the following:

        keystoreFile="c:\tomcat-ssl\.keystore"

        The path after the equal sign will point to the SSL directory. Backup your SSL certificates.

  2. Install Amazon Corretto Java JDK 8:

    1. Go to the Amazon Corretto Java JDK 8  page and download the MSI file.
    2. Install Amazon Corretto Java JDK 8 using the installation instructions provided by Amazon.
    3. As a quick test, open the command prompt and run java -version, if your output looks similar to the one below it is configured properly:



      Note: You may need to set your JAVA_HOME directory.


  3. Install Tomcat 9.0:

    1. Go to the Apache Tomcat Download page and look for "32-bit/64-bit Windows Service Installer". Note: We do not support the use of Tomcat 9.5 or 10.0, or versions below 9.0.
    2. Install the application outside of the Program Files directory. For this article, we will use the path C:\Tomcat 9.0\.
    3. Do not start the Tomcat Server at this moment.


  4. Internal FileCatalyst Server Modifications (optional)

    This step is only required if you are using the Internal FileCatalyst Server. If you are using your own custom SSL Certificates, instead of commenting out the parameters below ("#") specify the new path to each element.

    1. Navigate to the Workflow Config folder (C:\workflow-config\) and rename the backup folder to backup-old. (C:\workflow-config\backup-old\)
    2. Open the fcconf.conf file in a text editor.
    3. Search for FCServer.server.config.private.key and comment it out by adding a "#" in front of it. If you are using your own SSL Certificate point this parameter to your Private Key.

      #FCServer.server.config.private.key=C:/FileCatalyst Web Workflow/apache-tomcat/fcservercert.pvk

    4. Search for FCServer.server.config.certificate.file and comment it out by adding a "#" in front of it. If you are using your own SSL Certificate point this parameter to your Certificate File.

      #FCServer.server.config.certificate.file=C:/FileCatalyst Web Workflow/apache-tomcat/fcservercert.pem

    5. Search for FCServer.server.config.default.certificate.location and comment it out by adding a "#" in front of it. This parameter will the Internal FileCatalyst Server where to re-generate 

      #FCServer.server.config.default.certificate.location=C:/FileCatalyst Web Workflow/apache-tomcat

  5. Deploy FileCatalyst Workflow

    1. Download the FileCatalyst Workflow ZIP.
    2. You will need a Username and Password to access this file. Please contact your Account Executive to obtain access to this page.
    3. Unzip the file.
    4. Copy the WAR file contained in the zip file into the C:\Tomcat 9.0\webapps\ directory.
    5. Modify the Tomcat C:\Tomcat 9.0\conf\web.xml file using this guide to prevent JSP Servlet Errors.
    6. Start the Tomcat Web Server Service.
    7. Access FileCatalyst Workflow in your browser using http://127.0.0.1/workflow/ or http://127.0.0.1:<port>/workflow/. You should see a default demo landing page.
    8. Login using init and the password aaaaa.
    9. When prompted choose a Custom Directory to use an Existing Setup. 
    10. Specify the path to the configuration folder that you created in step 1b. For example, C:\workflow-config\, and hit Change Folder and Restart.
    11. Once the service has restarted, log back in using your username and password.
    12. From the Modify Configuration menu, click on the Licenses link and provide your Sales Representative with the request string. Enter the License key here and hit Save.
    13. Under the System Restart, section hit the Restart System link. This will remove the Demo Banner.
    14. Stop the Tomcat Web Server.
    15. Replace the contents of C:\Tomcat 9.0\webapps\ROOT\ with the files from your backup. If you have had redirectors setup before they would be in your index.html file.
    16. Start the Tomcat Web Server.

      Note: After completing step 4k, your older configurations, customizations, User DB and email preferences are restored. 

  6. SSL Install (optional)

    If you previously had an SSL Certificate installed on your Workflow and have backed up your Keystore you can use the following article to modify the connector in C:\Tomcat 9.0\conf\server.xml to enable SSL:

    https://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/439/0/tomcat-csr-generation-and-ssl-installation-gui-method#InstallSSL

  7. Some other useful articles for your Tomcat Web Server:

    Harden Tomcat: https://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/333/0/how-to-harden-tomcat-web-server

    Force SSL Redirection: http://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/317/0/how-to-force-https-connections-in-workflow-or-webmail

    Redirect HTTP Root to /workflow:
    https://support.filecatalyst.com/index.php?/Knowledgebase/Article/View/148/0/how-to-redirect-webmail-or-workflow-from-the-tomcat-root-to-fcweb-or-workflow