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.
Determine Your Upgrade Path
Your Live Forms Version
Recommended Upgrade Path to v9.0.x
|7.2.x||Upgrade directly to v9.0.x|
|7.3.x||Upgrade directly to v9.0.x|
|7.4.x||Upgrade directly to v9.0.x|
Note: Upgrades from 6.3.9 - 6.3.12 through v7.4.x are supported but these versions are not available for general release.
Migrating from HSQLDB
does not support the use of HSQLDB for use beyond demo/trials of the Live Forms 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 supported production databases BEFORE you can upgrade to later versions of Live Forms.
Please follow the instructions on this page to perform your upgrade.
Upgrading Live Forms
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
Please read and understand the Migration Considerations which may require your action before beginning.
- Install OpenJDK (11.x) before beginning.
Stop with one of the methods listed below:
Execute <frevvo-home>\stop-frevvo.[bat,sh] for versions previous to v9.x.
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
Stop Live Forms and the Insight Server through the Computer Management Services console if they are running as Window's services.
- Backup the forms database from your current installation.
Backup the current server's installation directory so that you have a copy of all custom configuration parameters.
- Request a v9 license if you are upgrading from a version prior to v9.0.x.
If you are using SQL Server as your Live Forms database, it is highly recommended that you turn on the READ COMMITTED SNAPSHOT setting in the database BEFORE performing the upgrade to 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:
Using DDL ( Data Definition Language) - Run the commands listed below:
ALTER DATABASE <your frevvo database schema> - replace <your frevvo database schema> with the name of your frevvo database schema SET READ_COMMITTED_SNAPSHOT ON
Using SQL Server Management Studio:
- Turn on the “Is Read Committed Snapshot On” Option under database properties.
Install Upgraded Version
- 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).
- Install a JDBC Driver.
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
Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v9.0.x installation
Configure the Database and Email
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.
- Select your database type
- 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.
- Configure Email
- If you made changes to the Default Port in previous releases, make those changes again in the v9.0.x server.xml file.
Save the changes to the server.xml file.
Convert parameters to properties
This section applies only to upgrades from versions prior to 7.4.x.
The frevvo.xml and insight.xml files are embedded in the frevvo war in v9.0.x. Configuring 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.
- Examine the frevvo.xml file from your previous installation and open the <frevvo-home>\tomcat\conf\frevvo-config.properties in the v9.0+ Installation.
- 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.
- Remove the # in front of any properties you are going to use.
- Compare the frevvo.users.schemaName property in the frevvo.xml file from the version of Live Forms 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:
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.
For SQL server database migration:
Uncomment " frevvo.users.schemaName" value=users.dbo
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.
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"/>
# frevvo schema name settings - needed for 6.0 upgrade only
# SQL Server schema name
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 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.
- 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.
- Edit c:\tmp\frevvo\WEB-INF\web.xml.
- Locate the parameters that were changed, convert them to properties and add them to the frevvo-config.properties file.
- 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 previous to v7.0
- Save the changes to the frevvo-config.properties file.
- Verify that you do NOT have files named frevvo.xml or insight.xml in the <frevvo-home>\tomcat\conf\catalina\localhost directory.
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:
<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:
- Navigate to <frevvo-home>/tomcat/conf directory.
Edit the frevvo-config.properties file.
- The Parameter name becomes the property name.
- Add an equal sign
- Add the value after the equal sign
- Repeat this for all custom parameters that were added to the frevvo.xml file of your previous installation
Refresh Searchable Fields
The Refresh Searchable Fields process will run automatically as part of the upgrade. If it does not, you can run it manually once the upgrade is complete. The process should be run after hours when your users are not using your forms/flows.
Start the Insight Server
Follow the steps for your Operating system to start the Insight server BEFORE starting .
- 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.
You will see this message:
If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or go to Step 18 for instructions to remove existing services and set up Live Forms and the Insight Server to run as Windows services.
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.
- Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
- Navigate to <frevvo-home>/solr-x.x.x/bin. Run this command to make the solr startup file executable:
chmod +x solr
- Navigate back to the solr-x.x.x directory.
- Start the Insight server by typing: bin/solr start - this starts the Insight server in the background.
- 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 the 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.
If you are running Live Forms and the Insight Server (Solr) as Windows services, you must delete the existing services then reinstall them for the services to run properly.
- Follow these steps to delete the existing Insight Server service for Windows Vista, 7, 8 or 10 operating systems:
- Login as an administrator.
- Verify the Insight Server service name by double clicking it in the Windows Services list
Type this command: If your service name has spaces in it, use quotes around the service name.
The message "DeleteService SUCCESS' will display when successful.
Remove the Live Forms service by running the <frevvo-home>\Remove-Service batch file.
Perform these steps to reinstall the Insight Server and Live Form services.
Ensure you upgrade to the supported version of the connectors for your upgraded version of . Version information can be found at the links below.
- If you are using the 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 Filesystem Connector, you must reinstall and configure it again for the v9.0.x installation.
- If you are using the SharePoint Connector you must reinstall and configure it again for the v9.0.x installation.
All database initialization and/or required upgrade will be automatically done by frevvo.war as part of the v9.0.x startup.
Things to Check
Verify that any Connectors are up and running.
- Login as a tenant admin
- Click on the Configuration Checklist link to verify that all configurations are complete.
- Click on the Reports link. Click on one of the Reports to verify that submission data is displayed.
- Login as a tenant designer user
- View and edit a form/flow
- Verify that your submissions are displayed when you click the Submissions and Legacy submissions icons.
- Test forms/flows
Login as the superuser admin.
- Verify that the Refresh Searchable Fields process ran and completed successfully.
It is recommended that you do not change or delete the frevvo.users.schemaName property in frevvo.xml 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 step 1 does not fix the problem, delete all rows from the DATABASECHANGELOG database table and then restart. Use the command: delete from DATABASECHANGELOG.
If you start before the Insight server, you will see this message when you browse the 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 .
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 <>.
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 Live Forms server, you can follow these simple steps instead of the more lengthy upgrade steps.
- Unzip the downloaded build zipfile to a temp directory.
- Copy the \temp\frevvo\tomcat\webapps\frevvo.war file.
- Stop .
- Replace the frevvo.war file in your installation with the one copied above.
- If you made any configuration changes in the web.xml file inside the frevvo.war, or if you added configuration parameters to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml in your previous installation, we recommend that the configuration context parameters be converted to properties and added to the <frevvo-home>\tomcat\conf\frevvo-config.properties file instead. This keeps all your changes in one place and makes migration to major new versions easier.
- Delete everything inside \frevvo\tomcat\temp directory of your installation.
- Start .