Versions Compared

Key

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


Section


Column

These steps are required when you convert from a demo/trial frevvo server installation to a production installation.

Tip

While you are demo-ing frevvo you do not need to do the Database Setup steps discussed below.

Your frevvo server requires a SQL database for storing users and form submissions. The default HSQLDB is ONLY sufficient for demo/trial versions of frevvo. All production frevvo users MUST switch their frevvo software to a production quality database. The following steps describe how to change the underlying database from the demo/trial HSQLDB to a production-quality SQL database. The database configuration file, server.xml is located in <frevvo-home>/frevvo/tomcat/conf directory.

Before you start:

  1. Refer to our Supported Platforms for the list of Application Servers and databases supported/certified by frevvo. frevvo only supports/certifies the frevvo running in the Apache Tomcat container.
  2. Download csv files of your users and roles, as well as any applications from designer user accounts in the trial database. You cannot migrate the data (user, roles, applications) automatically from HSQL to your production database. See thisTransferringYourfrevvoDatafromHSQLtoaProductionDatabase this topic for the manual procedure details.
Tip



Column
width240px

On This page:

Table of Contents
maxLevel1


Select your database type

  1. InstallaJDBCDriverLocate and copy the necessary jdbc driver for your database into <frevvo-home>\tomcat\lib.
  2. Edit the file <frevvo-home>\tomcat\conf\server.xml
  3. You will see a data source definition for the frevvo database type name="jdbc/sharedfrevvoDS". See the sample below of the HSQLDB data source in the server.xml file.
  4. Comment out the pair of the definitions for the default database (HSQLDB) using the <!-- --> comment characters. The entire section must be commented out:

...

Warning

Database configuration has been removed from the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. It is now done in the C:<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 server.xml. Do not copy configured sections from a frevvo.xml of a previous release into the server.xml file.



Tip

It is recommended practice to use a named user (schema) account with the proper privileges when connecting frevvo to Oracle databases. The built in SYSTEM user account will not work.


Configure the frevvo database

Note

The frevvo database below must be created with UTF-8EncodedDatabase8 encoding.

For your selected database type in server.xml:

  1. Locate the sharedfrevvoDS data source url parameter and decide on a name for the frevvo database. For the SQL Server it would look like this: "url="jdbc:sqlserver://localhost:1433;databaseName=frevvo". You can change the name "frevvo" to whatever you wish, "frevvo" for example. But it must match the database name you create in your SQL server. See ConfiguretheConnectionUrl Configure the Connection Url below.
  2. Create a UTF-8EncodedDatabase8 encoded database "frevvo" (assuming you left the url parameter database name as the default) in your SQL server
  3. Set the sharedfrevvoDS data source url parameter to your database server. See ConfiguretheConnectionUrl Configure the Connection Url below.
  4. Set the sharedfrevvoDS data source username and password parameters to a user that has read and write permissions to the frevvo database.

  5. The frevvo database setup is now complete. frevvo will create all the necessary tables upon startup.

...

  1. The frevvo download package comes with pre-installed drivers. For example:
    • the HSQLDB.jar file is located in WEB-INF/lib in the frevvo.war.
    • the SQL Server JDBC Driver - this driver (mssql-jdbc-8.4.1.jre11.jar) is included in the frevvo tomcat bundle in the <frevvo-home>\frevvo\tomcat\lib directory.

      Warning

      At this time, frevvo only supports the mssql-jdbc-8.4.1.jre11.jar version of the SQL Server JDBC driver.  This version of the driver is included in the frevvo tomcat bundle.


  2. If you don't find what you need pre-installed you will need to locate a driver compatible with your database. Usually, you can download your driver from the internet. Try one of these locations: 
    • MySQL - 8.0.x or later is recommended if you are using MySQL 5.6+
    • Oracle
  3. Once you have the driver you need, copy it to <frevvo-home>/tomcat/lib.
    1. The <frevvo-home>\tomcat\logs\frevvo.log file will report an error if you do not copy the JDBC driver to lib directory. The verbiage may differ depending on the driver and database. For example, the error for MySQL is "Cannot load JDBC driver class 'com.mysql.cj.jdbc.Driver". Starting frevvo without the correct jdbc driver displays an HTTP 404 error. Copying the correct jdbc driver to the <frevvo-home>/tomcat/lib directory should resolve the issue.
    2. It is also appropriate to copy the driver into any location that is in the CLASSPATH of your tomcat installation. Another location would be <CATALINA_HOME>/lib.
Info

Users on Mac OS may see this exception:

Caused by: com.mysql.cj.exceptions.InvalidConnectionAttributeException: The server time zone value 'EDT' is unrecognized or represents more than one time zone. You must configure either the server or JDBC driver (via the serverTimezone configuration property) to use a more specific time zone value if you want to utilize time zone support.

Customers facing this error should add the serverTimezone=EST5EDT (insert correct timezone) parameter to the jdbc url.

Transferring Your frevvo Data from HSQL to a Production Database

...