...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Section | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Select your database type
- Locate and copy the necessary jdbc driverInstallaJDBCDriver for your database into <frevvo-home>\tomcat\lib.
- Edit the file <frevvo-home>\tomcat\conf\server.xml
- 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.
- 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.
|
Configure the frevvo database
| Note |
|---|
The frevvo database below must be created with UTF-8 encoding8EncodedDatabase. |
For your selected database type in server.xml:
- 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 ConfiguretheConnectionUrl below.
- Create a UTF-8 encoded database8EncodedDatabase "frevvo" (assuming you left the url parameter database name as the default) in your SQL server
- Set the sharedfrevvoDS data source url parameter to your database server. See configure the connection Url ConfiguretheConnectionUrl below.
Set the sharedfrevvoDS data source username and password parameters to a user that has read and write permissions to the frevvo database.
- 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.
...
- 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:
...
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. Refer to our Supported Platforms for the list of Application Servers and databases supported/certified by frevvo.
...
Configure Snapshot Isolation for SQL Server Databases
If you are using SQL Server as your frevvo database Database Setup, 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:
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
- Using SQL Server Management Studio: 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-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.
- 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
- If you are using Oracle19 as your database, the jdbc driver must be the version 8 ojdbc.jar.
- If you are using Oracle12c as your database, the jdbc driver must be the version 7 ojdbc.jar which is certified for JDK 7 and 8 for the Insight Data batch process to function properly.
- If you are using Oracle 11g, continue to use the the ojdbc6 driver version 11.2.0.3+ which is certified for JDK 6, 7 and 8. Remember JDK 6 and 7 are no longer supported by frevvo.
- 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 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.
- 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.
- 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 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.
| 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
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:
...