Versions Compared

Key

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

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.

The Database Connector can be configured to run in:

  • Any servlet container i.e. the frevvo tomcat bundle
  • Standalone mode - Cloud customers, who are integrating with their database in their on-premise installation, may prefer this mode as it eliminates the need to run a full application on their in-house server. This mode may also be helpful for in-house customers who want to run the connector on a different server than the installation.

The Database Connector requires a JDBC driver for your database. Some pre-installed drivers are included with the connector. See Install a JDBC driver to see if the driver for your database is provided.

The Database Connector contains a working sample Derby database with BIRT and MyStore query sets and some test data. This makes it very easy to test if the DB Connector is up and running when your installation is complete.

These instructions apply to Cloud and in-house customers.

Column
width240px

On this page:

Table of Contents
maxLevel1

Installation Steps

The Database Connector is available as a separate download. You can download it from here.

It is assumed that Cloud customers have already verified connectivity between the frevvo Cloud and your in-house database server.

Follow these steps to install the Database Connector:

Once the connector is installed and up and running, you must configure it to integrate with your in-house database. Refer to the DB Connector Configuration topic for the details.

Note

It is assumed that Cloud customers have already verified connectivity between the frevvo Cloud and your in-house database server.

Install the connector in the tomcat bundle

This portion of the documentation assumes that the  tomcat bundle is installed and up and running and installed in c:\frevvo . We'll refer to this directory below as <frevvo-home>.

  1. Download the Database Connector warfile.
  2. Unzip Rename the database.zip file to a temporary location of your choice: e.g. c:\tmp. This will create a folder c:\tmp\ database-connector-2.5.x. We'll refer to this directory as <db-tmp>Copy <db-tmp>\database-connector-2.5.x\.war
  3. Copy database.war to <frevvo-home>\tomcat\webapps.
  4. Install the JDBC driver, if required
  5. Start the Insight server. and then start Live Forms.

    Expand
    titleClick here for the instructions to start the Insight server and Live Forms

    Insert excerpt
    Planning for v7.3
    Planning for v7.3
    nopaneltrue

    Note

    The database.war does not extract after startup. You will not see a database subfolder in the <frevvo-home>\tomcat\webapps directory.

  6. Test the connector installation by copying this URL directly into your browser:

...

  1. Verify that Java 8 is installed and the Java_Home environment variable has been configured .
  2. Download the Database Connector Standalone connector zipfile herebundle.
  3. Unzip the database.zip file to a location of your choice. We will refer to this directory as <db-home>
  4. Install the JDBC driver, if required.
  5. You can start the connector using plain java command or execute one of the files in this directory to install the DB Connector as a Windows service or *nix console instance:
    1. Choose one of these methods to start the connector:
      1. Method 1: Using java in a command window
        1. Navigate to the <directory where you unzipped the database.zipfile>
        2. Type java -jar database.war
      2. Method 2: for Windows OS
        1. Install the DB Connector as a Windows service by double clicking the Install-Service.bat file. Click the Start DBConnector Service.bat to start the service.
      3. Method 2 for *nix OS
        1. Execute the  DB Connector.sh shell script for *nix operating systems.
  6. Test the connector installation by copying this URL directly into your browser:

...

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 pre-installed drivers.

Warning

You MUST use a JDBC4 type driver, version 5.1.26 or later.

...

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. Refer to the Using the jTDS driver topic for information if you are using the jTDS SQL Server driver.

...

  • <frevvo-home>/tomcat/lib if you are deploying the connector in the tomcat bundle
  • <directory where you unzipped the database zip file>Database Connector Standalone bundle \database-connector-2.5.x\lib

    Info

    If you are running the Database Connector in Standalone mode, the MSSQL driver is embedded in the database.war. However, you MUST copy the sqljdbc.jar to the <frevvo-home>/tomcat/lib directory if you are deploying the connector in the tomcat bundle

...

Code Block
queryset name="TEST">
     <resource-def>
          <url>jdbc:jtds:sqlserver://dbhost;DatabaseName=TEST;</url>
          <validationQuery>SELECT 1</validationQuery>
          <user>dbconnector</user>
          <password>************</password>
     </resource-def>
...

If you are using the dbconnector.properties or frevvo-config.properties file to define your datasources you must add the validationQuery property.

...

  1. Verify that Java 8 is installed and the Java_Home environment variable has been configured .
  2. Download the latest tomcat bundle from the frevvo website.
  3. Download the Database Connector from here.warfile. Rename the file to database.war
  4. Extract the files tomcat bundle zipfile to a location of your choice. We will refer to this directory as <frevvo-home>.
  5. Unzip the database.zip file to a temporary location of your choice: e.g. c:\tmp. This will create a folder c:\tmp\database-connecotr-2.5.x. We'll refer to this directory below as <db-tmp>
  6. Copy <db-tmp>\ database.war to <frevvo-home>\tomcat\webapps.
  7. Start the Insight server. and then start Live Forms.

    Expand
    titleClick here for the instructions to start the Insight Server and Live Forms

    Insert excerpt
    Planning for v7.3
    Planning for v7.3
    nopaneltrue

  8. Test the connector installation by copying this URL directly into your browser:

    http://localhost:8082/database/status

    After performing these steps you will have:

    • Successfully installed the  database connector and retrieved data from the built-in test database
  9. Create a tenant.
  10. Create a designer user in the tenant
  11. Download the Database Connector Application and upload it to the designer user for some example forms that demonstrate the power of the Database Connector using built-in databases.

Excerpt
hiddentrue

Standalone Mode:

  1. Download the Standalone connector zipfile here.
  2. Unzip the database.zip file to a location of your choice. We will refer to this directory as <db-home>
  3. Start the connector using plain java command or execute one of the files in this directory to install the DB Connector as a Windows service or *nix console instance:
    1. Choose one of these methods to start the connector:
      1. Method 1: Using java in a command window
        1. Navigate to the <db-home> directory.
        2. Type java -jar database.war
      2. Method 2: for Windows OS
        1. Install the DB Connector as a Windows service by double clicking the Install-Service.bat file. Click the Start DBConnector Service.bat to start the service.
      3. Method 2 for *nix OS
        1. Execute the  DB Connector.sh shell script for *nix operating systems.
  4. Test the connector installation by copying this URL directly into your browser:

    http://localhost:8081/database/status

    • Note the standalone connector runs on port 8081 by default. The port number can be changed when you configure the DB Connector in the next step. Use port 8081 to verify that the Db Connector is up and running for now. 
    • Verify that query validation page is loaded with status Passed for the built-in database BIRT and myStore querysets.



  5. Download the Database Connector Application and upload it to the designer user in your Cloud tenant for some example forms that demonstrate the power of the Database Connector using built-in databases.