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 server frevvo server installation to a production/test installation.

Tip

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

Your  server frevvo 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 Insight Data batch 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 frevvo running in the Apache Tomcat container. Refer to our Supported Platforms for the list of Application Servers and databases supported/certified by frevvo.

    The default HSQLDB is ONLY sufficient for demo/trial versions of frevvo. All production users frevvo users MUST switch their software frevvo 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.

    • Notice the database resource name has been changed to jdbc/sharedfrevvoDS

    When you configure your database, make the changes to the server.xml in the tomcat frevvo tomcat bundle that you are installing . Do not copy configured sections from a frevvo.xml of a previous release into the newly installed server.xml file.

    • The sendStringParametersAsUnicode=false property has been added to the SQL Server database URL. This property is needed for better performance. Refer to Configure the Connection URL for more information.
    Tip

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


    Configure the frevvo database

    ...

    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 configure the connection Url below.
    2. Create a UTF-8 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 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.

      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.


    5. The frevvo database setup is now complete.  will  frevvo will create all the necessary tables upon startup.
    Info
    • Where did the SQL scripts go? The server frevvo server no longer needs the SQL scripts that used to be in <frevvo installdir>\frevvo\data\sql. The server automatically creates the necessary tables at first startup.

    ...

    Configuration of the connection Url is key to successfully connect the  server frevvo server to your database. Consult your DBA to assist with connection issues.

    ...

    1) Set the sharedfrevvoDS data source url parameter to your database server. If  and frevvo and the database server are collocated "localhost" may be fine. The url parameters depend on the database type and installation choices made when your DBA installed your database software. Consult your DBA for the correct connection values. For example, SQL server installed on a non-default port and running on a machine named e00sca will require that you add a port number and host name to the Url. For example:

    ...

    Info

    If you are using SQL Server, it is recommended that you append the sendStringParametersAsUnicode property with a value of false to your database connection URL. This property will improve performance. You can find more information about this property on this Microsoft website. If you do not see the property, when configuring the Connection URL to your database, add it.

    Code Block
    url="jdbc:sqlserver://localhost:1433;databaseName=frevvo;sendStringParametersAsUnicode=false"/> 


    Non Standard Databases

    If you are trying a different database type and do not see an example in server.xml for your database, you can create a new data source entry. Hibernate supports the following dialects however  has frevvo has only been certified to run with a subset of these databases. For additional dialects see Hibernate documentation. 

    Info

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

    ...

    • Turn on the “Is Read Committed Snapshot On” Option under database properties.

    Install a JDBC Driver

    database frevvo 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 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-6.1.0.jre8.jar ) is included in the frevvo tomcat bundle in the <frevvo-home>\frevvo\tomcat\lib directory.

      Warning

      At this time, frevvo only supports the v6.1.0.jre8 version of the SQL Server JDBC driver.  This version of the driver is included in the frevvo tomcat bundle. v6.2+ of the driver may cause an issue with downloading larger attachment files from the

    • submission
    • frevvo submission repository. v6.2+ versions should not be used until further notice.


    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 - 5.1.45 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.jdbc.Driver". Starting without 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.

    ...

    Transferring Your frevvo Data from HSQL to a Production Database

    The bundle frevvo bundle includes an HSQL embedded database. If you use the HSQL database during your trial period, you cannot migrate the data (user, roles, applications) automatically from HSQL to your production database. Once your production database is in place, you must manually: 

    ...