Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column

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.
Warning
titlev11 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.


Column
width25%

Table of Contents
maxLevel2


...

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

Note

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.

    Expand
    titleClick here for steps to install Chrome...

    PDF Snapshot Generator: Install Chrome/Chromium

    A stable version of chrome or chromium browser needs to be installed on same server where frevvo is installed. First, check to see if Chrome is already installed. If not, use one of the following links to install Chrome or a Chromium browser.

    The snapshot generator looks for the chrome browser at the following paths. If found, it launches the browser.

    • /usr/bin/chromium

    • /usr/bin/chromium-browser

    • /usr/bin/google-chrome-stable

    • /usr/bin/google-chrome

    • /Applications/Chromium.app/Contents/MacOS/Chromium

    • /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

    • /Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary

    • C:/Program Files (x86)/Google/Chrome/Application/chrome.exe

    If the browser is not installed at any of these paths then set the CHROME_PATH environment variable to point to the correct path of the browser binary or set frevvo.chrome.path property in frevvo-config.properties file.

    Windows Os:

    • Open the Start Search, type in “env”, and choose “Edit the system environment variables”

    • Click the “Environment Variables…” button

    • Click the "New..." button in the "System Variables" section

    • Set the variable name to "CHROME_PATH" and the value to <path to chromium browser exe>

    MacOs/Linux

    • Set the CHROME_PATH environment variable in system profile files (/etc/profile, ~/.bash_profile, ~/.bashrc)
      export CHROME_PATH=/opt/bin/chromium


...

  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. 

...

Info

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:



    Warning

    If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or see these instructions to remove existing services and set up frevvo and the Insight Server to run as Windows services:


  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.

...

  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.

...

  1. Login as a tenant admin
    1. Click on the Configuration Checklist link to verify that all configurations are complete.
    2. Click on the Reports link. Click on one of the Reports to verify that submission data is displayed.
  2. Login as a tenant designer user
    1. View and edit a form/flow
    2. Verify that your submissions are displayed when you click the Submissions icon.
    3. Test forms/flows 

Login as the superuser admin.

  1. Verify that the Refresh Searchable Items process ran and completed successfully.

Troubleshooting


Warning

If you start frevvo before the Insight server, you will see this message when you browse the frevvo login URL. Follow these steps to start the servers in the correct order:

Navigate to your <frevvo-home> directory.

Run the stop-frevvo.bat or stop-frevvo.sh file depending on your Operating system to stop frevvo.

Open a command prompt. Navigate to <frevvo-home>\solr-6.6.2

Start the Insight server. Refer to Start the Insight Server above for the instructions.

Browse http://<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to your server name and 8983 to the port the Insight server is running on if they are different from the defaults.Do not include the angle brackets <>.

Start frevvo.

Applying a Minor Patch Update

If you're applying a minor patch update, for example, applying patch v11.0.x to your installed v11.0.2 frevvo server, you can follow these simple steps instead of the more lengthy upgrade steps.  

Note

The latest major frevvo version and the compatible frevvo connectors are available from the frevvo Software Downloads Directory.

...

  1. Stop frevvo.

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

  3. Install the 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. 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.
    4. Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v10.1.x new installation
  4. Configure the database and email.
  5. Install any 1069267765 that were installed in your previous version.
  6. Restore the contents of the <frevvo-home>\data\solr directory from the previous installation directory backup that you made in Step 2 to your latest version's <frevvo-home>\data directory. Then, start the Insight Server.

  7. Start frevvo.