The database connector is a web application and can be deployed under any Servlet container. The connector relies on the JDBC API. You can use any relational database as long as you have a JDBC driver for that database.
- A Servlet Container compatible with the Servlet 2.5 specification. For instance, Tomcat (6 or higher) or Jetty (6 or higher). If you have installed the tomcat In-house bundle you already have what you need.
- A JDBC driver for your database.
The database connector download comes with several pre-installed drivers. See Install a JDBC driver below.
On this page:
Installation Steps
Throughout this documentation we are using the tomcat bundle as the installation location for the database connector. This is just an example as the connector will work under any compatible servlet container. This documentation assumes that the tomcat bundle is installed in c:\frevvo. We'll refer to this directory below as <frevvo-home>.
If you have already downloaded the tomcat bundle for In-house then you already have the database connector. It is located in the unpacked tomcat bundle in <frevvo-home>\frevvo\ext\connectors and is named database.zip. If not or if you wish to download the latest version then download the database connector from the web site. You will need to login with your account
Follow these steps to install the connector:
1) Unpack the database.zip file to a temporary location of your choice: e.g. c:\tmp. This will create a folder c:\tmp\database. We'll refer to this directory below as <db-tmp>
2) Copy <db-tmp>\database.war to <frevvo-home>\tomcat\webapps
- If is running this will automatically expand database.war into a <frevvo-home>\webapps\database sub folder
3) If is not running, start : Double click <frevvo-home>\start-frevvo
- This will start and it will automatically expand database.war into a <frevvo-home>\webapps\database sub folder
4) Test the connector installation by copying this Url directly into your browser:
- For v2.2 http://localhost:8082/database/myStore/allOrders
- For v2.3 http://localhost:8082/database/status
If the Connector Test failed then:
- Review the previous installation steps
- See starting and testing the connector installation for more detailed instructions and common problems.
- If you cannot get the database connector working please see Getting Help to contact support.
Follow these steps to configure the connector:
If the connector test above was successful you are now ready to configure the database connector to work with your own database.
1) Copy the JDBC driver appropriate for your database into <frevvo-home>\tomcat\webapps\database\WEB-INF\lib
- The database connector contains pre-installed drivers for the most popular databases. So you may be able to skip this step. See Install a JDBC driver below
2) If you did have to copy a JDBC driver into lib you must then Restart frevvo, Double click <frevvo-home>\stop-frevvo. Wait until stops. Then Double click <frevvo-home>\start-frevvo
3) Configure your database connector Data Source by editing <frevvo-home>\tomcat\webapps\database\WEB-INF\etc\configuration.xml
4) Define SQL Statements to read/write to your database by editing <frevvo-home>\tomcat\webapps\database\WEB-INF\etc\configuration.xml.
We recommend that you do not leave your database configuration.xml file in its default locations. See configuration file location below.
Install a JDBC driver
The connector relies on the JDBC API. You can use any relational database as long as you have a JDBC driver for that database. The database connector download database.zip comes with several pre-installed drivers.
You MUST use a JDBC4 type driver, version 5.1.26 or later.
The download package comes with several pre-installed drivers. Look in <frevvo-home>/tomcat/lib and you will see (among other jar files) the following pre-installed driver jar files:
- hsqldb-2.2.4.jar - HSQLDB driver
- jtds-1.2.5.jar - SQL Server driver
- postgresql-9.0-801.jdbc4.jar - Postgress driver
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
- SQL Server JDBC Driver
- Oracle
- Mysql - Versions 5.1.31 - 5.1.36 of the MySQL JDBC driver are recommended if you are using MySQL 5.6+
Once you have the driver you need, copy it to <frevvo-home>/tomcat/lib.
It is also appropriate to copy the driver into any location that is in the CLASSPATH of your servlet container. In a tomcat installation another location would be <CATALINA_HOME>/lib.
Previous Pre-Installed Driver Versions
Previous versions of include these drivers:
- hsqldb-1.8.0.7.jar - HSQLDB jdbc driver
- com.microsoft.sqlserver.jdbc-1.1.3.jar - SQL Server driver
- jtds-1.2.5.jar - SQL Server driver
- org.objectweb.rmijdbc-1.0.0.jar - Access driver (also can be used for SQL Server)
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