If you were using version 2.4 of the Database Connector in your previous installation, you can use the configuration files from that installation with version 2.5+ of the connector. This will work if you are running the connector in the tomcat bundle or standalone.

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

 On This Page:

Configure the v2.5+ connector using the 2.4 configuration files in the tomcat bundle

Follow these steps:

  1. Stop if it is running. You do not have to stop the Insight Server.
  2. Copy the v2.5 database.war into  <frevvo-home>\tomcat\webapps directory in your the v7.2+installation.
  3. Copy the JDBC driver appropriate for your database into <frevvo-home>\tomcat\lib if it is not there already.

    The database connector contains some pre-installed drivers. So you may be able to skip this step. See the Install a JDBC driver topic.

  4.  Add this parameter to the v7.2+ frevvo-home>\tomcat\conf\Catalina\localhost\context.xml.default file. This file contains the path parameter to the configuration.xml file. The connector will pick up the configuration.xml file if it is located in the current working directory (where the DB Connector was launched) or you can create a <frevvo-home>/config/ directory and copy the v2.4 configuration.xml there. It can also be manually set by using the frevvo.connectors.database.configuration property in the context.default..xml file if you are deploying the connector in the tomcat bundle. Here is an example:

    <Parameter name="frevvo.connectors.database.configuration" value="<path>\<to>\configuration.xml" override="false"/>

    Be sure to add it OUTSIDE of the manager tags in the file. Also, verify that your path to the configuration file is correct. Here is an example of how the file should look after editing:

    <Context swallowOutput="true" unloadDelay="40000" useHttpOnly="true">
            <Manager className="org.apache.catalina.session.PersistentManager" saveOnRestart="false">
                    <Store className="org.apache.catalina.session.FileStore"/>
            </Manager>
            <Parameter name="insight.server.url" value="http://localhost:8983/solr" override="false"/>
            <Parameter name="frevvo.connectors.database.configuration" value="C:\frevvo-721-DLGA\frevvo\dbconfig\configuration.xml" override="false"/>
    </Context>
  5. Copy the configuration.xml file from your previous installation to the path specified in the frevvo-home>\tomcat\conf\Catalina\localhost\context.xml.default file.

    • If you used <resource-def>...</resource-def> to configure database resources in the 2.4 configuration.xml, you can just leave them there.

    • If you used <resource-ref>...</resource-ref> to configure database resources in the 2.4 configuration, make sure  the <Resource-ref>  definition is included in <frevvo-home>\tomcat\conf\Catalina\localhos\context.default.xml file. 
    • Click the arrow below for more information about resource-def and resource-ref elements.
  6. Start Live Forms

  7. Browse  http://localhost:8082/database/status page

  8. Log into your tenant  and test your forms and flows that interact with your database.

Defining Datasources in the configuration.xml file

The Database Connector need to know where and how to connect to your database. Datasources are defined using resource-def/resource-ref elements for each queryset in your configuration.xml file

The Live Forms database connector needs to know:

Using <resource-def> in the v2.4 configuration.xml file

. If you are using the configuration.xml file from your previous DB connector installation, the format of the <resource-def> element that you will see in your configuration.xml file is shown below:

<resource-def>
    <url>YOUR database Url HERE</url>   
    <driver>YOUR driver HERE</driver>
    <user>YOUR database user HERE</user>
    <password>YOUR password HERE</password>
</resource-def>

Using the v2.4 configuration.xml file that contains <resource-ref> with the v2.5 connector

There is an alternate approach that defines the database connection in the application container (Tomcat if you are using the frevvo-tomcat bundle) instead of inside the database connector. To use this approach:

  1. Edit frevvo\tomcat\conf\Catalina\localhost\context.xml.default file in your v7.2+ installation to add the "frevvo.connectors.database.configuration' and Resource Name parameters if they are not already defined.

  2. Define a <resource> as shown below. The XML samples below assume a MySql database driver. You will need to replace this sample values to match your database type.

    This is the format of the <resource> element in context.xml.default.

     

    <Resource name="jdbc/mystore_ds"
              auth="Container"
              factory="org.apache.commons.dbcp.BasicDataSourceFactory"            
              driverClassName="com.mysql.jdbc.Driver"
              username="YOUR database user HERE"
              password="YOUR database password HERE"
              type="javax.sql.DataSource"
              url="jdbc:mysql://localhost/mystore?autoconnect=true"/>
    
    

     

    A sample context.xml.default file for MySQL is shown below

     

    <Context swallowOutput="true" unloadDelay="40000" useHttpOnly="true">
            <Manager className="org.apache.catalina.session.PersistentManager" saveOnRestart="false">
                    <Store className="org.apache.catalina.session.FileStore"/>
            </Manager>
            <Parameter name="insight.server.url" value="http://localhost:8983/solr" override="false"/>
            <Parameter name="frevvo.connectors.database.configuration" value= "<path to the configuration.xml file>" override="false"/>
            <Resource name="jdbc/<your database name>"
              auth="Container"         
              driverClassName="com.mysql.jdbc.Driver"
              username="<your database user>"
              password="<your database password>"
              type="javax.sql.DataSource"
              url="jdbc:mysql://localhost/<your queryset name>?autoconnect=true"/>
    </Context>
  3. Replace the <resource-def> element in your configuration.xml with a <resource-ref> element as shown below.

    <resource-ref>
        <description>MySQL Customers</description>
        <res-ref-name>jdbc/mystore_ds</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
    </resource-ref>
  4. Verify that the resource-ref is defined in your configuration.xml file for each queryset.
  5. Alternatively, you can copy frevvo\tomcat\conf\Catalina\localhost\context.xml.default and dbconfig\configuration.xml to appropriate location in the v7.2+ tomcat bundle.

Configure the v2.5 connector using the 2.4 configuration files in Standalone mode

  1. Stop the Db Connector if it is running. You can do this by closing the window if you started the DB Connector with the java command, running the Stop-DB Connector.sh file for *nix OS or the Stop-Db Connector-Service.bat file for Windows OS.
  2. Copy the 2.4 configuration.xml file to the <db-home>\database\database-connector-2.5.0\config folder.
  3. Copy the JDBC driver appropriate for your database into <db-home>\lib. Remember the database connector contains some pre-installed drivers. So you may be able to skip this step. See the Install a JDBC driver topic.

  4. Restart the connector using one of these methods
    1. Open a command prompt and navigate to the <db-home>\database\database-connector-2.5.0 directory
      1. Type java -jar database.war
    2. Click the Restart-DBConnector-Service.bat to restart  the service for a Windows operating system or execute the Restart - DBConnector.sh shell script for *nix operating systems.

Examples of Datasource Definitions in the configuration.xml file

Examples of datasources that can be used in the configuration.xml file for some common databases are shown below. Always check with your database administrator or the documentation for your database driver to verify the details are correct.

MySQL example

A mySql database named "test" running on localhost on the default port when the login for user "root" requires no password:

<resource-def>
    <url>jdbc:mysql://localhost/test</url>    
    <driver>com.mysql.jdbc.Driver</driver>
    <user>root</user>
    <password></password>
</resource-def>

A database URL is a Universal Resource Locator (URL) that specifies a particular type of database server (compatible with the JDBC driver you installed or was pre-installed in database\WEB-INF\lib) and a particular host.  In addition you can also specify the database name to use for the connection.

The format for the database URL is database driver specific. In the example above for mySql the correct format is:

jdbc:mysql://[host][:port optional]/[database name]

Check with your database administrator or the documentation for your database driver for details on the correct database URL format.

HSQLDB example

Here is an example that connects to an '''HSQLDB driver'''.

<resource-def>
    <url>jdbc:hsqldb:file:mystore</url>       
    <driver>org.hsqldb.jdbcDriver</driver>
    <user>sa</user>
    <password></password>
</resource-def>

The following examples are for several common databases. Please consult your database documentation and version for the exact configuration settings.

SQL Example

Here is an example that connects to a '''SQL Server driver'''.

<resource-def>
    <url>jdbc:sqlserver://192.168.1.102;DatabaseName=mystore;</url>       
    <driver>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver>
    <user>yourUser</user>
    <password>yourPassword</password>
</resource-def>

SQL jTDS Example

This Url connects to a SQL Server using the jTDS driver that works with Microsoft SQL 2008

<resource-def>   
  <url>jdbc:jtds:sqlserver://localhost:1433;DatabaseName=db;</url>
  <driver>net.sourceforge.jtds.jdbcx.JtdsDataSource</driver>
  <user>yourUser</user>
  <password>yourPassword</password>
</resource-def>

For SQL server, the database name can also be specified as part of the Url rather than using the DatabaseName optional parameter. For example if your database name is acswa and the SQL server is running on 59377:

<url>jdbc:jtds:sqlserver://<sqlhost>:59377/acswa</url>

As of SQL 2000, Microsoft SQL allows installation of multiple SQL named instances. If your SQL server was installed this way you must use the instance parameter. For example if you database instance was named xyzzy:

<url>jdbc:jtds:sqlserver://<sqlhost>:59377/acswa;instance=xyzzy</url>

Oracle 11g

Here is an example that connects to an Oracle 11g driver.

<resource-def>
    <url>jdbc:oracle:thin:@localhost:1521:ServiceName</url>                  
    <driver>oracle.jdbc.driver.OracleDriver</driver>
    <user>yourUser</user>
    <password>yourPassword</password>
    <validationQuery>select 1 from dual</validationQuery>
</resource-def>