How to Upgrade FileCatalyst Workflow
Posted by Aly Essa, Last modified by Aly Essa on 18 July 2019 09:25 AM

Overview

This article describes how to upgrade an existing FileCatalyst Workflow installation to the latest version of FileCatalyst Workflow 5.0. It is assumed that Workflow is deployed on Apache Tomcat and that the Windows Executable Installer was not used. Please note if after your upgrade your Language File entries do not show, you will need to restart the Tomcat Web Server.

Please use the following link to Windows Executable Installer Upgrade Guide.

Note: The upgrade guide for older Workflow Deployments (4.X) is located here.

Before you proceed please make sure the following System Requirements are met:

  • Java 8 (x64) and Tomcat 8.X or 9.X are now required. Java 9, 7 and 6 and Tomcat v4,v5,v6,v7 and v8.5 are NOT supported.
  • FileCatalyst Direct Server 3.7.1 or higher is only supported.

The following features have been removed in Workflow 5.0:

  • Third-party FTP Servers are no longer supported (including IIS-FTP, Filezilla, ProFTPd and others)
  • Webmail WAR file is no longer produced
  • Older Workflow 4.X page templates are no longer supported
  • Java Applets are no longer available as a file transfer method
  • Calculate Pricing features removed

Environment

FileCatalyst Workflow v4.7 and later
Oracle Java 8 (x64)
FileCatalyst Server v3.7.1 and later
Tomcat 8.0.X or 9.0.X only

Resolution

Note: Please upgrade your Java installation to Java JDK (x64) you can download it from Oracle.

Download the upgrade packages:

You will need to download the upgrade packages from our website http://filecatalyst.software. Contact your FileCatalyst Sales Representative in order to obtain a username and password.

Locate and download the FileCatalyst Workflow 5.0 application package called fcwebworkflow_war.zip. This file is for all upgrades as well as new deployments.
Locate and download the FileCatalyst Server 3.7.1 or higher application package chosen based on your Operating system. This file is for all upgrades as well as new deployments.


Upgrade Instructions:

Upgrade FileCatalyst Server using the following documentation: http://filecatalyst.software/download/filesFCDirect/current/documentation/server/Help.html#upgrades

Upgrade Workflow:

  1. Log in as Super Admin to FileCatalyst Workflow. Click on the About FileCatalyst icon and make a note of the path to your Configuration Folder. Look for it in the field named Configuration Path.
  2. Stop Tomcat service.
  3. Make a backup copy of the Configuration Folder.
  4. Make a backup of MySQL Database, using a MySQL dump tool, or by any other method that you find convenient.
  5. Backup workflow.war and /workflow folder to a location outside of Tomcat. This folder and WAR file are located in /<Tomcat-Home>/webapps/
  6. Delete the workflow.war and /workflow folder from /<Tomcat-Home>/webapps/.
  7. Unzip the workflow.war from the fcwebworkflow_war.zip file and place it in /<Tomcat-Home>/webapps/.
  8. Delete the /<Tomcat-Home>/work/Catalina directory.
  9. Stop the service FileCatalyst Workflow.
  10. Modify the Tomcat web.xml file using this guide to prevent JSP Servlet Errors.
  11. Start Tomcat service. Tomcat will re-deploy the new WAR file and make a new directory /<Tomcat-Home>/webapps/workflow/ automatically.
  12. Open a web browser of your choice and access FileCatalyst Workflow as usual. If you are on the local machine, go to http://localhost/workflow or http://localhost:8080/workflow. (Assuming the Tomcat default port 8080, otherwise, substitute an appropriate port)
  13. Log in with username init with the password aaaaa.
  14. Click on the button for Existing or Custom Configuration Folder.
  15. Enter the path you noted in Step 1 from the Configuration Path.
  16. FileCatalyst Workflow will re-initialize and all your previous settings will be imported into the new deployment.
  17. Once you completed your upgrade to FileCatalyst Workflow 5.0, your current FileCatalyst Workflow license will be invalidated. Please contact your sales rep and email them your request string to get a new key.
  18. If you upgraded your Java during the upgrade, you will need to update cacerts file if you use LDAP/Ad over SSL, consult online help for Workflow for more details

Roll-Back Guide

  1. Stop the Tomcat service.
  2. Delete the /<Tomcat-Home>/webapps/workflow/ directory.
  3. Delete the /<Tomcat-Home>/webapps/workflow.war file.
  4. Delete the /<Tomcat-Home>/work/Catalina directory.
  5. Place the backup version of workflow.war into /<Tomcat-Home>/webapps/ folder.
  6. You can either backup the existing configuration folder or delete it.
  7. Place the previously backup Configuration Folder in the original location.
  8. Start the Tomcat service. Tomcat will redeploy the WAR file and make a new directory /<Tomcat-Home>/webapps/workflow/ automatically.
  9. Open a web browser of your choice and access FileCatalyst Workflow as usual. If you are on the local machine, go to http://localhost/workflow or http://localhost:8080/workflow. (Assuming the Tomcat default port 8080, otherwise, substitute an appropriate port)
  10. Log in with username Init with the password aaaaa.
  11. Click on the button for Existing or Custom Configuration folder.
  12. Enter the path you noted in Step 1 from the Configuration Path.
  13. FileCatalyst Workflow will re-initialize and all your previous settings will be imported into the new deployment.