/
Upgrade Guide

Upgrade Guide

Apr 11, 2025

STOP! Before you begin the migration process:

  • Please check the Supported Platforms to confirm the latest requirements. Note that v11.0.x is certified on OpenJDK (11.0.10).
    • IMPORTANT: Check that your frevvo database is a supported version; v11 will not work on some older unsupported versions.
  • Please read and understand the Planning for v11.0 which may require your action before you begin your upgrade. Note that v11 includes changes introduced in v10.2 and v10.3. There are important migration considerations to review before you upgrade.
  • The v11 upgrade will take longer than previous frevvo upgrades due to significant model migration. Please plan for frevvo to be unavailable for up to an hour during your upgrade.

v11 License Key Required

  • A v11 license key is required for this version of frevvo if you are upgrading from a prior version. Request a v11 license by completing this form before you begin the upgrade. 

Determine Your Upgrade Path

Your frevvo Version

Recommended Upgrade Path to v11.0.x

v9.0.x

Upgrade to v10+ (see v10.0 Upgrade Guide), then upgrade to v11.0

v10.0.x, v10.1.xUpgrade directly to v11.0

Note: Upgrades from frevvo 6.3.9 - 6.3.12 through v7.4.x are supported but these versions are not available for general release.

Migrating from HSQLDB

frevvo does not support the use of HSQLDB for use beyond demo/trials of the frevvo software. If by mistake you continued to use the demo/trial HSQLDB database for production use, you will need to first migrate your data to one of frevvo supported production databases BEFORE you can upgrade to later versions of frevvo.

Please follow the instructions on this page to perform your upgrade.

Upgrading frevvo 

Please read the following upgrade steps prior to starting the migration.

frevvo recommends that you test the upgrade process on your test server before performing it on your production server. Contact your frevvo Account Manager for information if you do not have a test environment.

Prepare for the upgrade

  1. Please read and understand the Migration Considerations that may require your action before beginning.

  2. Install OpenJDK (11.x) before beginning.

  3. If upgrading from a version prior to v10.1, install Chrome on that same server as your frevvo installation. This is required for PDF Snapshot generation to work in your v11 installation.

  1. Stop frevvo with one of the methods listed below:

    1. Execute <frevvo-home>\stop-frevvo.[bat,sh]

    2. Stop the Insight Server by closing the window or if you are using the tomcat bundle by typing these commands in the <frevvo-home>\solr directory of your existing installation.

      bin\solr.cmd stop -all


    3. Stop frevvo and the Insight Server through the Computer Management Services console if they are running as Window's services.

  2. Back up the forms database from your current frevvo installation.

  3. Back up the current frevvo server's installation directory so that you have a copy of all custom configuration parameters.

  4. Request a v11 license if you are upgrading from a frevvo version prior to v11.0.x.

Oracle DB Permission

Customers using Oracle DB should grand the following permission before upgrading.

GRANT EXECUTE ON SYS.DBMS_CRYPTO TO <frevvo user>;

If you do not do this, you may see an error like "liquibase.exception.DatabaseException: ORA-00904: "DBMS_CRYPTO"."HASH": invalid identifier" in the log file while upgrading, and the upgrade will fail.

Install Upgraded Version

  1. Download the latest v11.0.x software. The download is a zip file. Extract the contents to any folder of your choice. This folder will be referred to as <frevvo-home> (note that the zip already contains a top-level frevvo folder).

  2. Install a JDBC Driver.

  3. Ensure that Chrome or a Chromium browser is installed on the same server as the frevvo installation for PDF Snapshot generation. See the related Installation Task for details.

  4. If you increased Memory Settings in your previous installation, make those changes to the appropriate files in the new installation. Refer to Hardware and Memory Requirements for the details.

  5. Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v11.0.x installation

Configure the Database and Email

  1. Select your database type

  2. Refer to the Configure the Connection URL topic to point to your current frevvo database. If you are using SQL Server, remember to add the sendStringParametersAsUnicode property with a value of false to your database connection URL if it is not already there.

  3. Configure Email

  4. If you made changes to the Default Port in previous releases, make those changes again in the v11.0.x server.xml file.  

  5. Configure SSL for tomcat if it was configured in prior version of frevvo. 

  6. Save the changes to the server.xml file. 

All database initialization and/or required upgrades will be automatically done by frevvo.war as part of the frevvo v11.0.x startup.

Copy Properties

See Installation Tasks for commonly used properties. Read the Detailed Release Notes to be sure that all properties you are using are valid in the upgraded version.

  1. Edit the frevvo-config.properties file in your prior version. This file is usually located in the<frevvo home>/tomcat/conf directory.

  2. Copy the properties you added or changed.

  3. Edit the frevvo-config.properties file in the upgraded version, and paste the properties you copied from your prior version. 

  4. Save the frevvo-config.properties file.

Start the Insight Server

If there was not a solr upgrade between the versions you upgrading from and to, you may restore the contents of the <frevvo-home>\data\solr directory from the previous installation directory backup that you made in the Prepare for the Upgrade section to your latest version's <frevvo-home>\data directory.

Follow the steps to start the Insight server BEFORE starting frevvo.

Windows:

  1. Open a command prompt. Navigate to <frevvo-home>\solr. Type bin\solr.cmd start to run the Insight server in the background, listening on the default port 8983.



  2. You will see this message:




  3. Browse http://<your server:port>/ solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to the server name and 8983 to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status.

Linux:

  1. Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh

  2. Navigate to <frevvo-home>/solr/bin. Run this command to make the solr startup file executable:
    chmod +x solr

  3. Navigate back to the solr directory. 
    cd ..     

  4. Start the Insight server by typing: bin/solr start - this starts the Insight server in the background.

  5. Browse http:<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to the server name and 8983 to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status.