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.

Upgrading from Live Forms v6.3.x, v7.0.x, v7.1.x, v7.2.x or v7.3.x

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. Stop with one of the methods listed below:

   1. Execute <frevvo-home>\stop-frevvo.[bat,sh] for versions previous to v7.x.

   2. 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-5.4.1 directory of your existing installation.
      
      bin\solr.cmd stop -all
      
      

   3. Stop Live Forms and the Insight Server through the Computer Management Services console if they are running as Window's services.

3. Backup the forms database from your current installation.

4. Backup the current  server's installation directory so that you have a copy of all custom configuration parameters.
   
   

   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 v7.4.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:

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

   2. Using SQL Server Management Studio:
      1. Turn on the “Is Read Committed Snapshot On” Option under database properties.
5. Request a v7 license if you are upgrading from a version prior to v7.0.x.
6. Download the latest v7.4.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).
7. Install a JDBC Driver.

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

9. Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v7.4.x installation

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

10. Configure the Database and Email
    
    1. Select your database type
    2. Refer to Configure the Connection URL to point the v7.4.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.
    3. Configure Email
    4. If you made changes to the Default Port in previous releases, make those changes again in the v7.4.x server.xml file.  
    5. Save the changes to the server.xml file. 

     Convert parameters to properties
    

    The frevvo.xml and insight.xml files are embedded in the frevvo war in v7.4. 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
      • frevvo schema name settings needed for 6.0 upgrade only
      • 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
      • Box Connector Settings for the client id and the client secret
      • 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 v7.4+ Installation.

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

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

    2. For SQL server database migration:
       

       1. Uncomment " frevvo.users.schemaName" value=users.dbo
          

       2. 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.xml from previous release

    <!--  
            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-config.properties in v7.4+

    # frevvo schema name settings - needed for 6.0 upgrade only
    frevvo.users.schemaName=users
    # SQL Server schema name 
    #frevvo.users.schemaName=users.dbo

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

     Click here for conversion instructions

    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:

    frevvo.xml from your previous Live Forms installation

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

    1. Navigate to <frevvo-home>/tomcat/conf directory.

    2. Edit the frevvo-config.properties file.

    3. The Parameter name becomes the property name.
    4. Add an equal sign
    5. Add the value after the equal sign
    6. Repeat this for all custom parameters that were added to the frevvo.xml file of your previous installation
       
       

    frevvo-config.properties file in the v7.4.x installation

    #Custom Tenant Id and Placeholder
    frevvo.default.login.tenant.id=<your_tenant_id>
    frevvo.login.username.placeholder=<@<your tenant name>

12. 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.
    1. 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.
    2. Edit c:\tmp\frevvo\WEB-INF\web.xml.
    3. Locate the parameters that were changed, convert them to properties and add them to the frevvo-config.properties file.

13. 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 v7.4 installation. You can skip this step if you are upgrading from a version of previous to v7.0

14. Save the changes to the frevvo-config.properties file.
15. Verify that you do NOT have files named frevvo.xml or insight.xml in the <frevvo-home>\tomcat\conf\catalina\localhost directory.
16. The Manage Insight Data Batch job will run automatically as part of the upgrade. If it does not, you can run it manually once the upgrade is complete. The batch job should be run after hours when your users are not using your forms/flows. 
17. Follow the steps for your Operating system to start the Insight server BEFORE starting .
    

    1. Windows:

       1. Open a command prompt. Navigate to <frevvo-home>\solr-6.6.2. 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.

       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:

       
       
       Linux:

       1. Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
       2. Navigate to <frevvo-home>/solr-6.6.2/bin. Run this command to make the solr startup file executable:
          chmod +x solr
       3. Navigate back to the solr-6.6.2 directory.
          cd ..    
          Start the Insight server by typing: bin/solr start - this starts the Insight server in the background.
       4. 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:

       

    
    
18. Start the  v7.4.x server by running the start-frevvo.bat or start-frevvo.sh files (depends on your Operating system) in the <frevvo-home>\frevvo directory  Proceed to Step 19.  If you are running and the Insight Server (Solr) as Windows services, continue with Step 18.
    
    
19. 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.
    1. Follow these steps to delete the existing Insight Server service for Windows Vista, 7, 8 or 10 operating systems:
       1. Login as an administrator.
       2. Verify the Insight Server service name by double clicking it in the Windows Services list

       3. Type this command: If your service name has spaces in it, use quotes around the service name.
          

          sc delete <ServiceName>

          
          

       4. The message "DeleteService SUCCESS' will display when successful.
          
          
    2. Remove the Live Forms service by running the <frevvo-home>\Remove-Service batch file.
       
    3. Perform these steps to reinstall the Insight Server and Live Form services.
       
       
20. If you are using the Database Connector, you must reinstall and configure it again for the v7.4.x installation.
21. If you are using the Google or PVE connectors  you must reinstall and configure them for the v7.4.x installation.
22. If you are using the Filesystem Connector, you must reinstall and configure it again for the v7.4.x installation.

23. If you are using the /wiki/spaces/frevvo74/pages/355087059 you must reinstall and configure it again for the v7.4 installation.

24. If you are using the SharePoint Connector you must reinstall and configure it again for the v7.4 installation.

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

Things to Check:

1. Verify that any Connectors are up and running.
2. 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.
3. Login as a tenant designer user
   1. View and edit a form/flow
   2. Verify that your submissions are displayed when you click the Submissions and Legacy submissions icons.
   3. Test forms/flows 
      
4. Login as the superuser admin.
5. 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.4.x.  If the property is changed or deleted post migration you may see this error:

Follow these steps to rectify the situation:

1. Change the property back to what it was during migration and restart.
2. 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. 

Starting the Insight server before 

Applying a Minor Patch Update

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

1. Unzip the downloaded build zipfile to a temp directory. 

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

3. Stop .

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, 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. Refer to Steps 11 - 15 above for instructions. This keeps all your changes in one place and makes migration to major new versions easier.

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

7. Start . 

Apply a Patch with Tomcat Upgrade

If you are applying a patch release that includes an Apache Tomcat upgrade to your installed v9.0  server, follow these modified upgrade instructions. Refer to the sections above for detailed steps.

1. Stop .

2. Backup the current  server's installation directory so that you have a copy of all custom configuration parameters.

3. Install the Upgraded Version.
   1. Download the latest v7.4.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).
   2. Install a JDBC Driver.
   3. 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.
   4. Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v7.4.x installation
4. Configure the database and email.
5. Install any Connectors that were installed in your previous version.
6. Start the Insight Server.
7. Start .