Before you begin the migration process:
- Please check the Supported Platforms to confirm the latest requirements.
- Please read and understand the Planning for v7.0 which may require your action before you begin your upgrade.
Determine Your Upgrade Path
Your Live Forms Version
Recommended Upgrade Path to v7.0.x
Upgrade directly to v7.0.x
Upgrade directly to v7.0.x
|6.2.x||Upgrade directly to v7.0.x|
|6.3.x||Upgrade directly to v7.0.x|
Please follow the instructions on this page, to perform your upgrade.
Migrating from HSQLDB
frevvo 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 frevvo supported production databases BEFORE you can use the automated migration scripts to upgrade to later versions of Live Forms.
Upgrading from frevvo v5.3.9, v6.1, v6.2 or v6.3
Please read the following upgrade steps prior to starting the migration.
v7 License Key Required: A v7 license key is required for this version of frevvo. Request a v7 license by emailing firstname.lastname@example.org BEFORE you begin the upgrade. v5 and v6 licenses will not work.
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.
Please read and understand the Migration Considerations which may require your action before beginning.
- Backup the forms and users databases from your current frevvo installation.
- Backup the current frevvo server's installation directory so that you have a copy of all custom configuration parameters.
Stop the frevvo server using stop-frevvo.[bat,sh] or through the Computer Management Services console if frevvo is running as a window's service.
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.
You do not have to do this if you are using MySQL or Oracle databases because the READ SUBMITTED SNAPSHOT is turned on by default.
There are two ways to turn on the option:
Using DDL ( Data Definition Language) - Run the commands listed below
- Using SQL Server Management Studio:
- Turn on the “Is Read Committed Snapshot On” Option under database properties.
- Install a fresh v7.0.x frevvo server:
- Download the latest v7.0.x software.
- Request a v7 license if you have not already done so, before continuing.
- 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).
- If you increased Memory Settings in your previous installation, make those changes to the appropriate files in the v7.4.x installation. Refer to Hardware and Memory Requirements for the details
Navigate to <frevvo-home>\tomcat\conf\server.xml in the v7.0.x directory structure.
Database configuration has been removed from the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. It is now done in the <frevvo-home>\tomcat\conf\server.xml file. Also, notice the database resource name has been changed to jdbc/sharedfrevvoDS. When you configure your database, make the changes to the v7.0.x server.xml. Do not copy configured sections from a frevvo.xml of a previous release into the v7.0.x server.xml file.
Point the v7.0.x frevvo database to your current frevvo database. Remember to add the sendStringParametersAsUnicode property with a value of false to your database connection URL if it is not already there.
All database initialization and/or upgrade will be automatically done by frevvo.war as part of the frevvo v7.0.x startup.
- If you are upgrading from frevvo v6.1+, copy the frevvo.users.schemaName property from v6 <frevvo-home>\tomcat\conf\catalina\ocalhost\frevvo.xml to v7 <frevvo-home>\tomcat\conf\catalina\ocalhost\frevvo.xml.
If you are upgrading from frevvo v6.1+, you can skip steps 7a - 7b and go directly to step 8.
- If you are upgrading from a frevvo version prior to v6.1, then you MUST perform these steps:
- The users schema for the version you are migrating from must be located on the same database server instance as the new frevvo 7.0 schema. The upgrade process directly selects from the old users schema and inserts into the new frevvo 6.3 schema using a single sql statement.
- Only attempt the upgrade ONCE against a particular users and frevvo schema combination. If you need to run it again, RESTORE BOTH schemas from backup. If you encounter an exception reporting a migration failure, restore both schemas, verify that you have performed ALL the steps listed here and try again.
If you are using the tomcat servlet, follow the steps below to configure the v7.0.x <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file for migration.
- For SQL server database migration: Uncomment " <Parameter name="frevvo.users.schemaName" value="users.dbo" override="false"/>" in frevvo.xml and comment out "<Parameter name="frevvo.users.schemaName" value="users" override="false"/>".
- Set the value of frevvo.users.schemaName in the v7.0.x frevvo.xml file to the name of the users database of the version you are migrating from. If you didn't change the name of the users schema in the version you are migrating from, then you can leave it as the default, users. Make sure you append .dbo to the users schema name if you are using an SQL server database.
During the upgrade Live Forms copies the data in the old users schema into the corresponding new tables in the frevvo schema. The users and frevvo schemas are consolidated in this release. Live Forms uses the frevvo database user to select the data from the old users schema. Therefore, the frevvo database user must have select access to all of the tables in the old user. In case your database is not already configured for this, you must grant select permission to the frevvo user on these tables BEFORE upgrading.
Below is an example of the queries needed to grant select permission on the users schema to the frevvo user for the Oracle database:
If you are using a database other than Oracle, similar statements need to be executed. Please consult your database documentation for the correct syntax.
The frevvo db user id requires the database level privileges listed below on first startup. If your database is not set up for this already, privileges will be needed for the following actions:
- Create Table
- Alter Table
- Drop Table
- Create Index
- Create Sequence (Oracle)
- Create Trigger
Customers upgrading to v7.0.x from a Live Forms version prior to v6.1, using LDAP, must copy their LDAP config parameters from the frevvo.xml file of the version you are migrating from to the v7.0.x version frevvo.xml BEFORE starting the v7.0.x server for the first time. Live Forms will then migrate the config to the tenant level on startup. LDAP parameters can then be edited in the v7.0.x UI.
8. Configure the new installation
- If you made changes to the following files in your previous installation, you will need to make the same changes in the new v7.0 configuration files.
- We recommend that any changes that were made to the web.xml file be moved to frevvo.xml instead.
- The three files mentioned above include:
In-house customers using an httpclient-auth properties file for HTTP Authentication to external web services, must ensure the file is present in the frevvo.war, BEFORE you perform the first startup of v7.0.x. When you start v7.0.x the upgrade process will run and copy the credentials to the existing tenants on your server. This is a one-time upgrade. Changes to this file will be ignored once this upgrade is done. In v7.0.x, the tenant admin or superuser can modify the HTTP Authentication information through the Add/Edit tenant screens of the frevvo UI.
9. Follow the steps for your Operating system to start the Insight server BEFORE starting frevvo.
Open a command prompt. Navigate to <frevvo-home>\solr-5.4.1.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 set up Live Forms and the Insight Server to run as Windows services.
- Browse 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-5.4.1/bin. Run this command to make the solr startup file executable:
chmod +x solr
- Navigate back to the solr-5.4.1 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:
10. Start the frevvo v7.0.x server by running the start-frevvo.bat or start-frevvo.sh files in the <frevvo-home>\frevvo directory depending on your Operating system.
During the upgrade the Insight server batch job will automatically run preparing your submission data for the Reports feature.
Things to Check:
- Login as a tenant admin
- Login as a tenant designer user
- View and edit a form/flow
- View submissions that existed before
- Test forms/flows
- Login as the superuser admin.
- Verify that the Insight server batch job 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 v7.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.
You may see an unexpected error due to a misconfiguration. One likely cause is that you have copied an older version of frevvo.xml or web.xml from your old Live Forms server into your new Live Forms server. The upgrade will detect this error and alert you that an upgrade error may have occurred. To solve this replace frevvo.xml and/or web.xml with the version that came with your new Live Forms software. To transfer configuration customizations from your old server software to you new server, edit frevvo.xml and/or web.xml and copy the changes over manually.
Starting the Insight server before frevvo.
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-frevv.sh file depending on your Operating system to stop frevvo.
- Open a command prompt. Navigate to <frevvo-home>\solr-5.4.1.
- Start the Insight server. Refer to Step 9 above for the instructions.
- Browse 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 7.0.2 to your installed v7.0.x Live Forms server, you can follow these simple steps instead of the more lengthy upgrade steps.
The latest major frevvo version and latest connector versions are available on the public Software Downloads page.
- Unzip the downloaded build zipfile to a temp directory.
Copy the \temp\frevvo\tomcat\webapps\frevvo.war file.
Replace the frevvo.war file in your installation with the one copied above.
- Copy the <frevvo-home\frevvo\tomcat\lib\logback.xml file
- Replace the logback.xml file in your installation with the one copied in step 5.
If you made any configuration changes in the web.xml file inside the frevvo.war, we recommend that the configuration context parameters be moved to the <frevvo-home>\tomcat\conf\localhost\frevvo.xml instead. This keeps all your changes in one place and makes migration to major new versions easier. If you choose not to move the configuration to frevvo.xml, you can follow the steps here to make the changes in the v7.0.x web.xml or you can just copy the old web.xml and replace the new one with it.
Delete everything inside \frevvo\tomcat\temp directory of your installation.
Start the Insight server if it isn't already running. Refer to Step 9 above for the instructions.
Live Forms for Confluence
If you are running Live Forms for Confluence please follow the same instructions above to upgrade your frevvo server. If you are upgrading from frevvo for Confluence v5.3, then this upgrade does not require an upgrade to your frevvo-Confluence Add-on. Please refer to the Confluence Add-on Release Notes compatibility matrix. The frevvo server and the frevvo Confluence Add-on versions must match.
If you are using the frevvo database connector, you must reinstall and configure it again for the v7.0.x installation.
Google, PVE or Filesystem Connectors
If you are using any of the frevvo connectors, you must reinstall and configure them again for the v7.0.x installation.