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

5.3.9

Upgrade directly to v7.0.x

6.1.x

Upgrade directly to v7.0.x

6.2.xUpgrade directly to v7.0.x
6.3.xUpgrade directly to v7.0.x

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

Table of Contents
maxLevel1

...

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

  2. Backup the forms and users databases from your current installation.
  3. Backup the current  server's installation directory so that you have a copy of all custom configuration parameters.
  4. Stop the  server using stop-frevvo.[bat,sh] or through the Computer Management Services console if is running as a window's service.

    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.

    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:

    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:
    • Turn on the “Is Read Committed Snapshot On” Option under database properties.
  5. Install a fresh v7.0.x  server:
    1. Download the latest v7.0.x software.
    2. Request a v7 license if you have not already done so, before continuing.
    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.0.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.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.

    6. 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.

      Note

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

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

...

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

      1. 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"/>". 
      2. 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.
      3. 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: 

        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
    2. 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.

...

    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:

...

  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.

Troubleshooting:

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:

...

Warning

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:

  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 .
  3. Open a command prompt. Navigate to <frevvo-home>\solr-5.4.1.
  4. Start the Insight server. Refer to Step 9 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 .

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.  

Note

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

...