Live Forms v5.3 is no longer supported. Click here for information about upgrading to our latest GA Release.

Upgrade Guide

Owned by Former user (Deleted)
Last updated: May 03, 2016 by Former user (Deleted)
7 min read

Though most forms/flows created on  v4.1.7+ or v5.1.1+ will not require further attention post migration. However, there are a few migration items that you need to consider. If your forms contain any of the following, please read and understand the Planning for v5.3 which may require your action before you begin your upgrade.

  1. Custom Themes
  2. Margin and Padding properties on form controls
  3. Controls with small widths 

Please follow the instructions on this page, to perform your upgrade. Click on the link for the section that applies to your upgrade.  

Using  version 4.1.7 or later and you want to upgrade to version 5 to take advantage of all the new features? A new menu import item on the Manage Server page is available to help with your upgrade.

The Import /frevvo/data feature is available to the superuser admin only and supports import from the following frevvo GA releases:

  • 4.1.7 and later  

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 use the automated migration scripts to upgrade to the latest version of Live Forms.

Upgrading from v4.x - 4.1.6

You will need to upgrade to version 4.1.7 before migrating to version 5. Refer to Upgrading Your In House Server to v4.1.7 for the details. When the upgrade to v4.1.7 is complete, return to this page and continue with the Upgrading from v4.1.7+ section below:

Upgrading from v4.1.7+

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

Migration from  v4.1.7+ to v5 is not supported for the Oracle database. Please contact frevvo customer support for details and help.

  1. Please read and understand the Migration Considerations which may require your action before beginning.
  2. Backup the v4 server's forms and users databases
  3. Backup the v4 server's installation directory so that you have a copy of all custom configuration parameters and the v4 server's data folder.
  4. Stop the v4 server using stop-frevvo.[bat,sh] or through the Computer Management Services console if  is running as a window's service. It is very important that the v4 server is stopped, otherwise the v5 server may not correctly migrate all existing tenant users.
  5. Download a fresh v5  server:
    1. Download the latest v5 software. 
    2. Request a v5 license key by emailing support@frevvo.com. Your v4 license key will not work with version 5 of . You must email frevvo to obtain a functional v5 license key.
    3. 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).   
  6. Migrate existing 4.1.7 forms & users databases using the upgrade scripts provided in <frevvo-home>/data/sql/upgrade. You must execute these SQL scripts to perform a few required database schema updates.
    1. Navigate to <frevvo-home>/data/sql/upgrade. 
    2. The scripts are named by database and by release number of the Live Forms version that you are upgrading from. For example, if your  databases use mySQL5, and since you can only upgrade form versions 4.1.7 or later - use the scripts that have "mysql5" and 417 in its name:
  • forms-mysql5-upgrade-417.sql
  • users-mysql5-upgrade-417.sql

Consult your DBA or your database specific documentation on how to run these scripts.

If you are upgrading from  v4.1.8, v4.1.9, v4.1.10 or v4.1.11, run the v4.1.7 scripts for Step 6.

7. Configure the new installation

Refer to Installation Tasks for more information.

8. Start the v5 server. Enter the new v5 license key obtained in Step 5b .

9.  Login as admin superuser

Do NOT login as any user in any tenant other than default before the import: it will create a .user file in the db and will make the import skip that user. 

10.  Click Import 4.1.7+ /data folder.

11,  Enter the path to the v4.1.7 <frevvo-home>/data folder that you want to import into this installation. 

checks the .user version and stops the import if the version is not 4.1.7+. Here is an example of the error message if the version you are migrating from is v4.1.4 : "Unsupported migration version: found 4.1.4, but expecting version 4.1.7 or later".


12. Click Import. 

  

       13, Restart the  Server after importing is complete.

        14. All tenants and users in the users database should now be imported into the v5 database. 

Things to Check:

  • login as a tenant admin
  • Click on the Configuration Checklist link to verify that all configurations are complete
  • login as a tenant designer user
  • view and edit a form/flow
  • view submissions that existed before
  • test forms/flows

Live Forms for Confluence

If you are running Live Forms for Confluence please follow the same instructions above to upgrade your  server. Then you must also install the new version of the Live Forms Confluence Add-on into your Confluence server. The  server and the  confluence add-on versions must match.

Database Connector

 If you are using the  database connector, you must reinstall and configure it again for the v5 installation. Version 5 includes the latest database connector, version 2.3 beta. 

Upgrading from v5.1.x

5.x versions of do not require the migration of the <frevvo-home>/data as all user data is already moved from the filesystem to the database. 

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

  1. Please read and understand the Migration Considerations which may require your action before beginning.
  2. Backup the v5 server's forms and users databases
  3. Backup the v5 server's installation directory so that you have a copy of all custom configuration parameters
  4. Stop the v5 server using stop-frevvo.[bat,sh] or through the Computer Management Services console if is running as a window's service. It is very important that the v5 server is stopped, otherwise the new v5 server may not correctly migrate all existing tenant users.
  5. Install a fresh v5 server:
    1. Download the latest v5 software. Note that you will need to provide your login credentials to download the software. 
    2. 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). 
  6. Migrate existing v5 forms & users databases using the upgrade scripts provided in <frevvo-home>/data/sql/upgrade. You must execute these SQL scripts to perform a few required database schema updates.
    1. Navigate to <frevvo-home>/data/sql/upgrade.
    2. The scripts are named by database and by release number of the Live Forms version that you are upgrading from. For example, if your Live Forms database is MySQL5 and you are upgrading from Live Forms v5.1.1, then use the scripts that have "mysql5" and 511 in their names. 

      • forms-mysql5-upgrade-511.sql
      • users-mysql5-upgrade-511.sql

                        Consult your DBA or your database specific documentation on how to run these scripts. 

If you are upgrading from  v5.0.1, v5.1.1 or v5.2, be sure to run the scripts with those version numbers in the name for Step 6.

       7. Configure the new installation

Refer to Installation Tasks for more information.

8.  Start the v5.3 server.

If you are upgrading v5.1 to v5.3 to v6.1, you MUST perform step 9.

If you are upgrading v5.1 to v5.3.8 to v6.2, you can skip this step.

9.  Upgrade all users and their forms to v5.3. This step is VERY IMPORTANT. Follow these instructions:

    1. After you have started the v5.3 server, login as admin@d user.
    2. Browse this URL in the same browser: http://localhost:8082/frevvo/web/upgradeUsers?force=true. Replace localhost:8082 in this URL with your frevvo server host :port

Things to Check:

  • login as a tenant admin
  • Click on the Configuration Checklist link to verify that all configurations are complete
  • login as a tenant designer user
  • view and edit a form/flow
  • view submissions that existed before
  • test forms/flows  

Applying a Minor Patch Update

If you're applying a minor patch update, for example, applying patch 5.3.5 to your installed 5.3.2 Live Forms server, you can follow these simple steps instead of the more lengthy upgrade steps.  

Check the release notes to see if a Minor Patch Update is ok for the patch you're applying. For example, if applying patch 5.3.5, see the detailed release notes before continuing.

The latest major version and latest connector versions are available on the public Software Downloads page. 

Follow these steps:

  1. Unzip the v5.3.5 build to a temp directory. 

  2. Copy the \temp\frevvo\tomcat\webapps\frevvo.war file.

  3. Stop frevvo.

  4. Replace the frevvo.war file in your installation with the one copied above.

  5. If you made any change in the web.xml file of your frevvo.war, then you will have to make those changes again in the web.xml file of the new frevvo.war. The steps to do this are explained here or you can just copy the old web.xml and replace the new one with it.

  6. Delete everything inside \frevvo\tomcat\temp directory of your installation.

  7. Start frevvo. 

Live Forms for Confluence

If you are running Live Forms for Confluence please follow the same instructions above to upgrade your  server. Then you must also install the new version of the Live Forms Confluence Add-on into your Confluence server. The server and the Confluence Add-on versions must match.

Database Connector

If you are using the database connector, you must reinstall and configure it again for the v5 installation. Version 5 includes the latest database connector, version 2.3.

Trouble Shooting

Unexpected Error

You maybe hit 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 transfer the copy the changes over manually.