Versions Compared

Key

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

Before you begin the migration process:

  • Please check the Supported Platforms to confirm the latest requirements.
  • Please read and understand the Planning for v7.1 which may require your action before you begin your upgrade.

Determine Your Upgrade Path

Your Live Forms Version

Recommended Upgrade Path to v7.

0

1.x

6.1.x

Upgrade directly to v7.1.x

6.2.x

Upgrade directly to v7.1.x

6.3.xUpgrade directly to v7.1.x
7.0.xUpgrade directly to v7.1.x

 Please follow the instructions on this page, to perform your upgrade.

Table of Contents
maxLevel1

...

Frevvoproduct
 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
Frevvoproduct
 supported production databases BEFORE you can use the automated migration scripts to upgrade to later versions of Live Forms.

Upgrading from v5.3.9

Warning

Although

Frevvoproduct
v5.3.9 is no longer supported, we are happy to help you upgrade to v7.1. If you are upgrading from v5.3.9  you must upgrade your v5.3.9 installation to v7.0 first and then upgrade your v7.0 installation to v7.1. Please refer to the v7.0 Update Guide for the instructions. When the v7.0 upgrade is complete, return to this page and continue with the instructions below. 

Upgrading from
Frevvoproduct
v6.1, v6.2, v6.3 or v7.0

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

Warning
  • v7 License Key Required:

  • A v7 license key is required for this version of 
    Frevvoproduct
    if you are upgrading from a version prior to v7.0. Request a v7 license by emailing support@frevvo.com 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. 

  1. Please read and understand the Migration Considerations which may require your action before beginning.

  2. Backup the forms and users databases database from your current
    Frevvoproduct
    installation.
  3. Backup the current
    Frevvoproduct
     server's installation directory so that you have a copy of all custom configuration parameters.
  4. If you are upgrading from v7.0.x, back up the
  5. Stop the 

    Frevvoproduct
    server using stop-frevvo.[bat,sh]

    or

    . Stop

    Frevvoproduct
     and the Insight Server through the Computer Management Services console if they are running as Window's services.

    Warning

    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

    Frevvoproduct
    v7.1.

    is running as a window's service

    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.
  6. Install a fresh v7.01.x
    Frevvoproduct
     server:
    1. Download the latest v7.1.x software.
    2. Request a v7 license if you have not already done so, before continuingare upgrading from a
      Frevvoproduct
      version prior to v7.0.x.
    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).
    4. 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
    5. Navigate to <frevvo-home>\tomcat\conf\server.xml in the v7.1.x directory structure.

      Warning

      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.1.x server.xml. Do not copy configured sections from a frevvo.xml of a previous release into the v7.1.x server.xml file.

    6.  Point the v7.1.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.

      Note

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

      Frevvoproduct
      v7.01.x startup.

  7. If you are using the tomcat servlet, follow the steps below to configure the v7.1.x <frevvo-home>\tomcat\conf\catalina\
  8. If you are upgrading from
    Frevvoproduct
    v6.1+,
    copy

    Copy the frevvo.users.schemaName property from

    v6

    <frevvo-home>\tomcat\conf\catalina\

    ocalhost

    localhost\frevvo.xml to the v7<frevvo-home>\tomcat\conf\catalina

    \ocalhost

    \

    frevvo.xml.
    If you are upgrading from
    Frevvoproduct
    v6.1+, you can skip steps 7a  - 7b and go directly to step 8.If you are upgrading from a
    Frevvoproduct
    version prior to v6.1, then you MUST perform these steps:
Warning
  • 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.
  1. localhost\frevvo.xml

  2. file for migration.
  3. 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"/>". 
  4. Set the value of
  5. .

    Info

    Compare the frevvo.users.schemaName property in the

  6.  v7.1.x
  7. frevvo.xml file

  8. to the name of the users database of the version you are migrating
  9. from

  10. .  If you didn't change
  11. the

  12. name of the users schema in the
  13. version

  14. 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
  15. of

  16. 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: 

    Code Block
    GRANT  select ON users.resources  TO frevvo;
    GRANT  select ON users.roles  TO frevvo;
    GRANT  select ON users.spaces  TO frevvo;
    GRANT  select ON users.tenantcategories  TO frevvo;
    GRANT  select ON users.tenants  TO frevvo;
    GRANT  select ON users.users  TO frevvo;
    GRANT  select ON users.usersroles  TO frevvo;
    GRANT  select ON users.tenantroles  TO frevvo;

    If you are using a database other than Oracle, similar statements need to be executed. Please consult your database documentation for the correct syntax. 

    Info

    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
  17. Customers upgrading to v7.1.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.1.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.1.x UI.

8. Configure the new installation

...

  1. Frevvoproduct
    you are upgrading from to the frevvo.xml file in v7.1 installation directory. If they are the same, do not do the copy in Step 6 - proceed to Step 7.


  2.  Configure the new installation

     9   8. Follow the steps for your Operating system to start the Insight server BEFORE starting 

Frevvoproduct
. If you are running
Frevvoproduct
and the Insight Server as Windows services, go to Step 10.

           Windows:

    1. 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:



      Warning

      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.

    2. 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-5.4.1/bin. Run this command to make the solr startup file executable:
      chmod +x solr
    3. Navigate back to the solr-5.4.1 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:

     10   9 Start the

Frevvoproduct
 v7.01.x server by running the start-frevvo.bat or start-frevvo.sh files in the <frevvo-home>\frevvo directory depending on your Operating system.

Info

During the upgrade the Insight server batch job will automatically run preparing your submission data for the Reports feature and the submissions view.

   10. The Insight Server that is bundled with v7.1 has an updated schema. If you are running

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

    1. Remove the Insight Server (Solr) service. Login as an administrator and execute the correct command for your operating system. Refer to this article for a quick review.
    2. Remove the
      Frevvoproduct
      service by running the <frevvo-home>\Remove-Service batch file.
    3. Perform these steps to reinstall the Insight Server and Live Form services.

Things to Check:

  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. View submissions that existed before
    3. Test forms/flows 
  3. Login as the superuser admin.
  4. Verify that the Insight server batch job ran and completed successfully.

...

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:

  1. Navigate to your <frevvo-home> directory.
  2. Run the stop-frevvo.bat or stop-frevv.sh file depending on your Operating system to stop
    Frevvoproduct
    .
  3. Open a command prompt. Navigate to <frevvo-home>\solr-5.4.1.
  4. Start the Insight server. Refer to Step 98 above for the instructions.
  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 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 <>.
  6. Start
    Frevvoproduct
    .

Live Forms for Confluence

If you are running Live Forms for Confluence please follow the same instructions above to upgrade your 

Frevvoproduct
server. Please refer to the Confluence Add-on Release Notes compatibility matrix. The
Frevvoproduct
server and the
Frevvoproduct
Confluence Add-on versions must match.

If you do not find your Confluence server version in the Confluence Add-on Release Notes compatibility matrix, please contact support@frevvo.com.

Database Connector

If you are using the

Frevvoproduct
database connector, you must reinstall and configure it again for the v7.1.x installation.

Google, PVE, Filesystem Connectors

If you are using any of the

Frevvoproduct
connectors, you must reinstall and configure them for the v7.1.x installation.

Box.com Connectors

The Box Connector is available for

Frevvoproduct
cloud customers. Installation instructions for in-house customers are listed in the Box.com Connector chapter.

Applying a Minor Patch Update

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

Note

The latest major

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

  1. Unzip the downloaded build zipfile to a temp directory. 
  2. Copy the \temp\frevvo\tomcat\webapps\frevvo.war file.

  3. Stop Stop 

    Frevvoproduct
    .

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

  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.1.x web.xml 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 the Insight server if it is not already running. Refer to to Step 98 above for  for the instructions.

  8. Start

    Frevvoproduct

Live Forms for Confluence

If you are running Live Forms for Confluence please follow the same instructions above to upgrade your 

Frevvoproduct
server. If you are upgrading from
Frevvoproduct
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
Frevvoproduct
server and the
Frevvoproduct
Confluence Add-on versions must match.

If you do not find your Confluence server version in the Confluence Add-on Release Notes compatibility matrix, please contact support@frevvo.com.

Database Connector

If you are using the

Frevvoproduct
database connector, you must reinstall and configure it again for the v7.1.x installation.

Google, PVE, Filesystem or Box.com Connectors

If you are using any of the

Frevvoproduct
connectors, you must reinstall and configure them again for the v7.1.x installation.

 

 

  1. Start 

    Frevvoproduct
    .