Versions Compared

Old Version 6

changes.mady.by.user Megan Ellis

Saved on

compared with

New Version 7

changes.mady.by.user Megan Ellis

Saved on

Key

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

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

While you are demo-ing you do not
Section
Column
Tip
Section
Column

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

Tip

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

Your  server requires an SQL database for storing users and form submissions.

Info

frevvo only supports/certifies the  running in the Apache Tomcat container. Refer to our Supported Platforms for the list of Application Servers and databases supported/certified by frevvo.

Tip
  • If you are using Oracle12c as your database, the jdbc driver must be version 7 ojdbc.jar for the Refresh Searchable Fields process to function properly. Refer to the Install a JDBC Driver topic for the details.
  • It is recommended practice to use a named user (schema) account with the proper privileges when connecting to Oracle databases. The built in SYSTEM user account will not work.

The default HSQLDB is ONLY sufficient for demo/trial versions of . All production users MUST switch their software to a production quality database.

Warning
  • You cannot migrate the data (user, roles, applications) automatically from HSQL to your production database. See this topic for the manual procedure details.

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.

Column
width240px

On This page:

Table of Contents
maxLevel1

...

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 to Oracle databases. The built in SYSTEM user account will not work.

Configure the frevvo database

...

Info

See the certified database list above for all the databases officially supported by frevvo.by frevvo.

  •  org.hibernate.dialect.HSQLDialect
  •  org.hibernate.dialect.MySQL5Dialect
  •  org.hibernate.dialect.MySQL5InnoDBDialect
  •  org.hibernate.dialect.Oracle9Dialect
  •  org.hibernate.dialect.HSQLDialectOracleDialect
  •  org.hibernate.dialect.MySQL5DialectPostgreSQLDialect
  •  org.hibernate.dialect.MySQL5InnoDBDialectSQLServerDialect
  •  org.hibernate.dialect.Oracle9Dialect
  •  org.hibernate.dialect.OracleDialect
  •  org.hibernate.dialect.PostgreSQLDialect
  •  org.hibernate.dialect.SQLServerDialect
  •  org.hibernate.dialect.Sybase11Dialect

UTF-8 Encoded Database

Warning

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

If you're using a improperly encoded database for sharedfrevvoDS you may run into one or more of the following runtime issues:

  1. International characters will not work correctly without the proper encoding.
  2. Workflows directed to a specific user may not appear on the user's task list.

Setting the encoding depends upon the database you are using. Please consult your database documentation.

MySQL UTF-8 Example

These commands will create the proper frevvo utf8 encoded database in mySql:

Code Block
languagesql
create database if not exists frevvo default character set "utf8" default collate "utf8_unicode_ci";

You can convert a database and/or table to UTF-8 using the MySQL configuration file or the MySQL cmd tool.

Configuration file:

Code Block
[mysqld]
default-character-set=utf8
default-collation=utf8_unicode_cii

MySQL cmd tool:

Code Block
ALTER DATABASE frevvo CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `frevvo16089`.`formsubmission` CHARACTER SET utf8 COLLATE utf8_unicode_ci;

Configure Snapshot Isolation for SQL Server Databases

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 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:
  • Turn on the “Is Read Committed Snapshot On” Option under database properties.

Install a JDBC Driver

database relies on the JDBC API. See the list of certified databases. If you choose a database that's not in this list you do so at your own risk.

Warning

You MUST use a JDBC4 type driver.

The  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-7.2.2.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 v7.2.2.jre11 version of the SQL Server JDBC driver.  This version of the driver is included in the frevvo tomcat bundle.

If you don't find what you need pre-installed you will need to locate a driver compatible to 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

Info

Once you have the driver you need, copy it to <frevvo-home>/tomcat/lib.

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

Image Removed

...

  • .dialect.Sybase11Dialect

UTF-8 Encoded Database

Warning

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

If you're using a improperly encoded database for sharedfrevvoDS you may run into one or more of the following runtime issues:

  1. International characters will not work correctly without the proper encoding.
  2. Workflows directed to a specific user may not appear on the user's task list.

Setting the encoding depends upon the database you are using. Please consult your database documentation.

MySQL UTF-8 Example

These commands will create the proper frevvo utf8 encoded database in mySql:

Code Block
languagesql
create database if not exists frevvo default character set "utf8" default collate "utf8_unicode_ci";

You can convert a database and/or table to UTF-8 using the MySQL configuration file or the MySQL cmd tool.

Configuration file:

Code Block
[mysqld]
default-character-set=utf8
default-collation=utf8_unicode_cii

MySQL cmd tool:

Code Block
ALTER DATABASE frevvo CHARACTER SET utf8 COLLATE utf8_unicode_ci;
ALTER TABLE `frevvo16089`.`formsubmission` CHARACTER SET utf8 COLLATE utf8_unicode_ci;

Configure Snapshot Isolation for SQL Server Databases

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 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:
  • Turn on the “Is Read Committed Snapshot On” Option under database properties.

Install a JDBC Driver

database relies on the JDBC API. See the list of certified databases. If you choose a database that's not in this list you do so at your own risk.

Warning

You MUST use a JDBC4 type driver.

The  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-7.2.2.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 v7.2.2.jre11 version of the SQL Server JDBC driver.  This version of the driver is included in the frevvo tomcat bundle.

If you don't find what you need pre-installed you will need to locate a driver compatible to 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

Info

Once you have the driver you need, copy it to <frevvo-home>/tomcat/lib.

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

Image Added

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

...