Versions Compared

Key

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

Before you begin the migration process:

  • Please check the Supported Platforms to confirm the latest requirements. Note that v9.0.x is certified on OpenJDK (11.0.2).
  • Please read and understand the Planning for v9.0 which may require your action before you begin your upgrade.
Warning
titlev9 License Key Required
  • A v9 license key is required for this version of 

    Frevvoproduct
    if you are upgrading from a prior version. Request a v9 license by completing this form before you begin the upgrade. 

Determine Your Upgrade Path

Your frevvo Version

Recommended Upgrade Path to v9.0.x

7.2.xUpgrade directly to v9.0.x
7.3.xUpgrade directly to v9.0.x
7.4.x

Upgrade directly to v9.0.x

v9.0.0-10

Upgrade to v9.0.11 (Tomcat Upgrade)

v9.0.0-11Upgrade to v9.0.12 (Tomcat Upgrade) coming soon

Note: Upgrades from 

Frevvoproduct
 6.3.9 - 6.3.12 through v7.4.x are supported but these versions are not available for general release.

Migrating from HSQLDB

Frevvoproduct
 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 
Frevvoproduct
 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

Upgrading frevvo 

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 which may require your action before beginning.

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

    Frevvoproduct
    with one of the methods listed below:

    1. Execute <frevvo-home>\stop-frevvo.[bat,sh] for versions previous to v9.x.

    2. If you are upgrading from v7.x, you will also need to 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-x.x.x 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.

  3. Backup the forms database from your current
    Frevvoproduct
    installation.
  4. Backup the current

    Frevvoproduct
     server's installation directory so that you have a copy of all custom configuration parameters. 

  5. Request a v9 license if you are upgrading from a
    Frevvoproduct
    version prior to v9.0.x.
Info
titleSQL Database Option

If you are using SQL Server as your frevvo database, it is highly recommended that you turn on the READ COMMITTED SNAPSHOT setting in the database BEFORE performing the upgrade to

Frevvoproduct
v9.0.x. You do not have to do this if you are using MySQL or Oracle databases because this option is turned on by default.

There are two ways to turn on the option:

  1. Using DDL ( Data Definition Language) - Run the commands listed below:

    Code Block
    ALTER DATABASE <your frevvo database schema> - replace <your frevvo database schema> with the name of your frevvo database schema SET READ_COMMITTED_SNAPSHOT ON
  2. Using SQL Server Management Studio:

    1. Turn on the “Is Read Committed Snapshot On” Option under database properties.


Install Upgraded Version

  1. Download the latest v9.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 v9.0.x installation

Configure the Database and Email

Note

Database and Email configuration is done in the <frevvo-home>\tomcat\conf\server.xml file. The database resource name was changed to jdbc/sharedfrevvoDS in v7.0. When you configure your database, make the changes to the v9.0.x server.xml. Do not copy configured sections from a frevvo.xml of a previous release into the v9.0.x server.xml file.

  1. Select your database type
  2. Refer to the Configure the Connection URL topic to point the v9.0.x frevvo database 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.

    Expand
    titleExpand for optional manual step for db's with large submission volumes...

    When upgrading from v7.4 or prior to v9.0+ frevvo runs the following sql statement on your database automatically in the startup process. However, this process can take awhile (as long as 30 minutes or more) for databases with large submission volumes. If you need to reduce the down-time when restarting, please run this statement manually for your database type before upgrading (frevvo will skip them if they are already complete.) It is safe to run these statements while your current version of frevvo is running.

    mySQL
    Code Block
    alter table formsubmission add column email varchar(255);
    alter table activitysubmission add column anonymous tinyint(1) not null default 0;
    Microsoft SQL Server
    Code Block
    alter table [formsubmission] add [email] varchar(255);
    alter table [activitysubmission] add [anonymous] bit not null default 0;
    Oracle
    Code Block
    alter table "formsubmission" add "email" varchar2(255);
    alter table "activitysubmission" add "anonymous" number(1,0) default 0 not null;
    Postgres
    Code Block
    alter table formsubmission add column email varchar(255);
    alter table activitysubmission add column anonymous boolean not null default false;
  3. Configure Email
  4. If you made changes to the Default Port in previous releases, make those changes again in the v9.0.x server.xml file.  
  5. Save the changes to the server.xml file. 

Copy Properties

This section applies to upgrades from versions v7.4.x+.

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.

Convert parameters to properties

This section applies only to upgrades from versions prior to 7.4.x.

Expand
titleClick here to expand if you are upgrading from a version prior to v7.4...

The frevvo.xml and insight.xml files are embedded in the frevvo war in v9.0.x. Configuring

Frevvoproduct
features is now done by adding properties to the <frevvo-home>\tomcat\frevvo-config.properties file.

The properties follow a simple property=value syntax. The frevvo-config.properties file provided in the frevvo tomcat bundle contains default values for the following properties:

    • frevvo war settings for email
    • HTTP Proxy Configuration for licensing
    • Insight Settings to enable/disable Insight and the URL to the location of the Insight Server
    • SAML certificate keystore settings for the key and password
    • Filesystem Connector Settings for the URL to the Filesystem Connector and the metadata prefix
    • SharePoint Connector Settings for the URL to the connector

Context parameters, previously added to the frevvo.xml or modified in web.xml and insight.xml files, must be converted to the property format. Follow the instructions below.

  1. Examine the frevvo.xml file from your previous installation and open the <frevvo-home>\tomcat\conf\frevvo-config.properties in the v9.0+ Installation.
    1. Add the values of any parameters that were changed in the frevvo.xml after the equal sign to the appropriate property in the frevvo-config.properties file.
    2. Remove the # in front of any properties you are going to use.
    3. Compare the frevvo.users.schemaName property in the frevvo.xml file from the version of frevvo you are upgrading from to the properties in the frevvo schema name settings - needed for 6.0 upgrade only section of the frevvo-config.properties file. If they are not the same, follow these steps:
      1. If the value in the parameter in the frevvo.xml file is not users, copy the value from the frevvo.xml and add it after the equal sign for the frevvo.users.schemaName property in frevvo-config.properties. 

      2. For SQL server database migration: 

        1. Uncomment " frevvo.users.schemaName" value=users.dbo 

        2. Comment out frevvo.users.schemaName.  If the value in the parameter in the frevvo.xml file is not users.dbo, copy the value from the frevvo.xml and add it after the equal sign for the frevvo.users.schemaName property in frevvo-config.properties.

Section
Column
width50%
Code Block
titlefrevvo.xml from previous release
<!--  
        frevvo schema name settings - needed for 6.0 upgrade only
     -->
    <Parameter name="frevvo.users.schemaName" value="users" override="false"/>
    <!--  SQL Server 
    <Parameter name="frevvo.users.schemaName" value="users.dbo" override="false"/>
     -->
Column
width50%
Code Block
titlefrevvo-config.properties in v7.4+
# frevvo schema name settings - needed for 6.0 upgrade only
frevvo.users.schemaName=users
# SQL Server schema name 
#frevvo.users.schemaName=users.dbo

2. Add properties for any parameters that you added to the frevvo.xml in your previous installation. Refer to Installation Tasks for information about additional configuration properties that can be added to the frevvo-config.properties file to customize 

Frevvoproduct
 features.

3. Any parameter changes that were made to the web.xml file in previous releases must be converted to properties and added to the frevvo-config.properties file.

    1. Unpack the frevvo.war file from your previous installation to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary.
    2. Edit c:\tmp\frevvo\WEB-INF\web.xml.
    3. Locate the parameters that were changed, convert them to properties and add them to the frevvo-config.properties file.
    4. If you are upgrading from v7.0+ or v7.1+ and you made changes to the <frevvo-home>/tomcat/conf/Catalina/localhost/insight.xml file, convert those parameters to properties and add them to the frevvo-config.properties file in your v9.0 installation. You can skip this step if you are upgrading from a version of 
      Frevvoproduct
       previous to v7.0
    5. Save the changes to the frevvo-config.properties file.
    6. Verify that you do NOT have files named frevvo.xml or insight.xml in the <frevvo-home>\tomcat\conf\catalina\localhost directory.
Info

Let's say you had context parameters to default the tenant login and customize the placeholder on the login screen in the frevvo.xml file of your previous installation. The context parameters in frevvo.xml would look like this:

Code Block
titlefrevvo.xml from your previous Live Forms installation
<Parameter name="frevvo.default.login.tenant.id" value="your_tenant_id" override="false"/>
<Parameter name="frevvo.login.username.placeholder" value="user@<your_tenant_name>" override="false"/>

The configuration properties follow a simple property name=value syntax. Follow these steps:

  1. Navigate to <frevvo-home>/tomcat/conf directory.
  2. Edit the frevvo-config.properties file.

  3. The Parameter name becomes the property name.
  4. Add an equal sign
  5. Add the value after the equal sign
  6. Repeat this for all custom parameters that were added to the frevvo.xml file of your previous installation

Restore the contents of the <frevvo-home>\data\solr directory from the previous installation directory backup that you made in the Prepare for Your Upgrade section to your latest version's <frevvo-home>\data directory. Then, follow the steps to start the Insight server BEFORE starting 

Frevvoproduct
.

Windows:

  1. Open a command prompt. Navigate to <frevvo-home>\solr-x.x.x. 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.

Linux:

  1. Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
  2. Navigate to <frevvo-home>/solr-x.x.x/bin. Run this command to make the solr startup file executable:
    chmod +x solr
  3. Navigate back to the solr-x.x.x 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.

Start 
Frevvoproduct

Start the 

Frevvoproduct
 v9.0.x server by running the start-frevvo.bat or start-frevvo.sh files (depends on your Operating system) in the <frevvo-home>\frevvo directory. Then follow these instructions to login and enter your upgrade license key.

If you are running frevvo and the Insight Server (Solr) as Windows services, you must delete the existing services then reinstall them for the services to run properly.

  1. Follow these steps to delete the existing Insight Server service for Windows Vista, 7, 8 or 10 operating systems:
    1. Login as an administrator.
    2. Verify the Insight Server service name by double clicking it in the Windows Services list
    3. Type this command: If your service name has spaces in it, use quotes around the service name.

      Code Block
      sc delete <ServiceName>
    4. The message "DeleteService SUCCESS' will display when successful.

    5. Remove the frevvo service by running the <frevvo-home>\Remove-Service batch file. 

  2. Perform these steps to reinstall the Insight Server and frevvo services.

Connectors

Ensure you upgrade to the supported version of the connectors for your upgraded version of 

Frevvoproduct
. Version information can be found at the links below.

  • If you are using the
    Frevvoproduct
    Database Connector, you must reinstall and configure it again for the v9.0.x installation.
  • If you are using the Google or PVE connectors  you must reinstall and configure them for the v9.0.x installation.
  • If you are using the
    Frevvoproduct
    Filesystem Connector, you must reinstall and configure it again for the v9.0.x installation.
  • If you are using the
    Frevvoproduct
    SharePoint Connector you must reinstall and configure it again for the v9.0.x installation.
  • If you are integrating with IIS, review these updated steps to configure Tomcat. 
Info

All database initialization and/or required upgrade will be automatically done by frevvo.war as part of the

Frevvoproduct
v9.0.x startup.

Things to Check

Verify that any

Frevvoproduct
 Connectors are up and running.

  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 and Legacy submissions icons.
    3. Test forms/flows 

Login as the superuser admin.

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

Troubleshooting

It is recommended that you do not change or delete the frevvo.users.schemaName property in the frevvo-config.properties file after the first startup of v9.0.x.  If the property is changed or deleted post migration you may see this error:

Follow these steps to rectify the situation:

Change the property back to what it was during migration and restart.

If that does not fix the problem, delete all rows from the DATABASECHANGELOG database table and then restart. Use the command: delete from DATABASECHANGELOG. 

Warning

If you start

Frevvoproduct
before the Insight server, you will see this message when you browse the
Frevvoproduct
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

Frevvoproduct
.

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

Start the Insight server. Refer toStart 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

Frevvoproduct
.

Applying a Minor Patch Update

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

Note

The latest major

Frevvoproduct
version and the compatible frevvo connectors are available from the frevvo Software Downloads Directory.

  1. Unzip the downloaded build zipfile to a temp directory. 
  2. Copy the \temp\frevvo\tomcat\webapps\frevvo directory.
  3. Stop 
    Frevvoproduct
    .
  4. Delete the frevvo.war and/or frevvo directory file from your <frevvo-home>\tomcat\webapps directory.
  5. Paste the frevvo directory copied above in your <frevvo-home>\tomcat\webapps directory. 
  6. Delete everything inside \frevvo\tomcat\temp directory of your installation.
  7. Start 
    Frevvoproduct

Apply a Patch with Tomcat Upgrade

If you are applying a patch release that includes an Apache Tomcat upgrade to your installed v9.0 

Frevvoproduct
 server, follow these modified upgrade instructions. Refer to the sections above for detailed steps.

Warning

Please review the sameSiteCookies Attribute documentation below to ensure compatibility with your installation settings.

  1. Stop

    Frevvoproduct
    .

  2. Backup the current

    Frevvoproduct
     server's installation directory so that you have a copy of all custom configuration parameters.

  3. Install the Upgraded Version.
    1. Download the latest v9.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. Copy any properties that you might have added/updated in the frevvo-config.properties file in the <frevvo-home>\tomcat\conf directory of your v9.0.x installation to the latest installation's frevvo-config.properties.
    5. Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v9.0.x installation.
  4. Configure the database and email.
  5. Install any Connectors 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 
    Frevvoproduct
    .

sameSiteCookies Attribute

Recent browser versions (especially Chrome v80+), by default, allow cookies to be sent only with top-level navigation and GET request initiated by third party websites. When you need to expose cookies to a third party site, such as using the SAML security manager or embedding in an iframe, you need to use https (Chrome only) and explicitly set the samesite attribute of the cookie to "none". frevvo v9.0.10+ includes a tomcat upgrade that allows configuring the cookie processor with this attribute. This documentationprovides more information and details across browsers.

Info

The sameSite value "none" is not supported prior to iOS 13 (macOS before version 10.15). Setting sameSite to "none" in tomcat may require iPhone/iPad to be upgraded.

For third party access, you must use https and update the provided tomcat/conf/context.xml CookieProcessor element to add the sameSiteCookies attribute.

Code Block
<CookieProcessor className="org.apache.tomcat.util.http.LegacyCookieProcessor" allowEqualsInValue="true" sameSiteCookies="none"/>

On premise customers who do not want to make these updates need to turn on the legacy behavior in the chrome browser. Please see this Chrome documentation for details.