Knowledgebase:
Workflow Windows Executable Installer Upgrade Guide
Posted by Jeyram Sachchithananthan, Last modified by Aly Essa on 19 June 2019 02:19 PM

Overview

This article describes how to upgrade an existing Windows Executable FileCatalyst Workflow to the latest version of FileCatalyst Workflow 5.0. Please note if after your upgrade your Language File entries do not show, you will need to restart the FileCatalyst Workflow service from the Windows Services Manager.

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

  • Java 8 (x64) and Tomcat 8 are now required. Java 9, 7 and 6 and Tomcat v4,v5,v6,v7,v8.5, and v9 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 file transfer method
  • Calculate Pricing features removed

Environment


Windows 7/8/10 and Windows Server 2008/2012/2016  (64-bit)
FileCatalyst Workflow v4.7 and later
Oracle Java 8 (x64)
FileCatalyst Server v3.7.1 and later
Tomcat 8 only

Resolution

Note: Please upgrade your Java installation to Java 8 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 install_fc_webworkflow.exe. This file is for all upgrades as well as new deployments.
Download the most recent FileCatalyst Server application package for your Windows Operating System.


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 the FileCatalyst Web Workflow service using Windows Services Manager (services.msc).
  3. Make a backup copy of the Configuration Folder.
  4. Backup workflow.war and \workflow\ folder to a location outside of Tomcat. This folder and WAR file is located in \apache-tomcat\webapps\.
  5. Delete the workflow.war and \workflow\ folder from \apache-tomcat\webapps\.
  6. Make a backup of MySQL Database, using a MySQL dump tool, or by any other method that you find convenient.
  7. Copy all the contents of \apache-tomcat\conf  to a location outside of your Workflow installation folder.
  8. It is also recommended to backup your existing installer install_fc_webworkflow.exe for rollback purpose.
  9. Delete the \apache-tomcat\work\Catalina directory.
  10. Run the installer install_fc_webworkflow.exe. You must have administrator privileges to run it.
  11. Follow the installation wizard with default settings including the Installation path unless it had been customized in the path which we do not recommend.
  12. Stop the service FileCatalyst Workflow through Windows Services Manager (services.msc).
  13. Modify the Tomcat web.xml file using this guide to prevent JSP Servlet Errors.
  14. Start the service FileCatalyst Workflow through Windows Services Manager (services.msc).
  15. 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)
  16. Log in with username init with the password aaaaa.
  17. FileCatalyst Workflow will re-initialize and all your previous settings will be imported into the new deployment.
  18. 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.
 

Roll-Back Guide

  1. Stop the Service FileCatalyst Workflow via Windows Services Manager. 
  2. Delete the \apache-tomcat\webapps\workflow directory.
  3. Delete the  \apache-tomcat\work\Catalina directory.
  4. You can either backup the existing configuration folder or delete it.
  5. Place the previously backup Configuration Folder in the original location.
  6. Run the existing installer which was copied prior to the upgrade install_fc_webworkflow.exe
  7. Follow the installation wizard with default settings
  8. Start the service FileCatalyst Workflow via Windows Services Manager.
  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. FileCatalyst Workflow will re-initialize and all your previous settings will be imported into the new deployment.