Live Forms v7.4 is no longer supported. Please visit Live Forms Latest for our current Cloud Release. Earlier documentation is available too.

DB Connector Installation

Owned by Former user (Deleted)
Last updated: Jan 25, 2019 by Former user (Deleted)

The Database Connector is a web application that allows you to easily integrate your forms and flows with your external database. The connector can be added to your  tomcat bundle. A Standalone Bundle is also available.

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

Cloud customers, who are integrating with their database in their on-premise installation and in-house customers, can choose to:

  • install the Database Connector in your tomcat bundle on their in-house server OR
  • install the Standalone Bundle on their in-house server

We recommend the frevvo-tomcat bundle for in-house customers. Follow the frevvo-tomcat bundle Instructions.

We recommend the Standalone bundle for cloud customers as no additional servlet container is needed. Standalone is also useful for in-house customers who want to run the connector on a different server than the server installation. Follow the Standalone Bundle Instructions

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.

When you complete the Installation instructions then follow the Connector Configuration Instructions - detailed steps to integrate the connector with your database.

Cloud customers must also verify connector connectivity to the frevvo Cloud Server.

On this page:

Installation Steps

We recommend:

frevvo-tomcat Bundle Instructions

These instructions assume that your frevvo-tomcat bundle is already installed and running successfully.

  1. Stop your server.
  2. Download the Database Connector zip file that is compatible with the version of that you are running to your desktop.
  3. Extract all the files to a temporary location.
  4. Locate the database-X.X.X.war file in the temp directory. Replace the X.X.X with the version of the Database Connector.
  5. Rename the database-X.X.X.war to database.war.  Replace the X.X.X with the version of the Database Connector.
  6. Copy database.war to <frevvo-home>\tomcat\webapps.
  7. Install the JDBC driver

  8. Start your server

  9. Browse http://<host>:<port>/database/status

  10. If the status returns failures or disabled:

    1. Review the previous installation steps.

    2. See starting and testing the connector installation for troubleshooting.

  11. When the status returns Passed for each queryset, your installation is complete
  12. Follow the Connector Configuration Instructions with the detailed steps to integrate the connector with your database.

 


Standalone Bundle Instructions

Review Supported Platforms. Verify that the certified version of Java is installed and the Java_Home environment variable has been configured .

  1. Download the Database Connector Standalone bundle.
  2. Unzip the database.zip file to a location of your choice. We will refer to this directory as <db-home>
  3. Install the JDBC Driver
  4. Choose one of these methods to start the connector:

    • Method 1: Using java in a command window
      1. Navigate to <db-home>\database-connector-2.5.x .Type java -jar database.war
    • Method 2: for Windows OS

      1. Double click the <db-home>\database-connector-2.5.x\Install-Service.bat file to install the connector as a Windows service. Click the Start-DBConnector-Service.bat to start it

         Click to see standalone bundle content details

        The Standalone Database Connector bundle includes the files shown in the image:

        Note the files in the database-connector-2.5.x directory that are used to manage the Database Connector as services on *nix and Windows operating systems: These files should be run as an administrator.

        • Install-Service.bat - installs the Database Connector on a Windows system as a service named frevvo Database Connector.

        • Uninstall-service.bat - uninstalls the frevvo Database Connector on a Windows operating system

        • Start-DB Connector-Service.bat - starts the frevvo Database Connector on a Windows operating system

        • Start-DBConnector.sh - starts the frevvo Database Connector as a *nix console instance.

        • Restart-DBConnector-Service.bat - restarts the frevvo Database Connector on a Windows operating system

        • Restart-DBConnector.sh - restarts the frevvo Database Connector as a *nix console instance.

        • Stop-DBConnector-Service.bat - stops the frevvo Database Connector on a Windows operating system.

        • Stop-DbConnector.sh - stops the frevvo Database Connector *nix console instance.

    • Method 3 for *nix OS
      1. Execute the  DB Connector.sh shell script for Unix/Linux operating systems.
    • Method 4 for Linux
      1. The Database Connector can also run as a service under Linux systemd

     Click here for the details

    It is possible to manage the Database Connector using systemd ‘service’ scripts.

    1. Copy the sample service file located in /bin/dbconnector.service to /etc/systemd/system
    2. Review it's contents and
    3. Make sure it is executable.

    You can now use systemd to manage the dbconnector service:

    • systemctl start dbconnector.service

    • systemctl stop dbconnector.service

    • systemctl restart dbconnector.service

    • systemctl status dbconnector.service

    To flag the service to start automatically on system boot use the following command:

    systemctl enable dbconnector.service

    Consult the service unit configuration man page for more details.

  5. Browse http://<host>:<port>/database/status - Note the standalone connector defaults to port 8081.

  6. If the status returns failures or disabled Connector Test failed then:

    1. Review the previous installation steps
    2. See starting and testing the connector installation for more detailed instructions and common problems.
     

  7. When the status returns Passed for each queryset, your installation is complete
  8. Cloud customers must also verify connector connectivity to the frevvo Cloud Server.
  9. Follow the Connector Configuration Instructions with the detailed steps to integrate the connector with your database.

Install a JDBC Driver

The connector relies on the JDBC API. You must have a JDBC driver for your database. Refer to Supported Platforms for the list of databases certified by frevvo.

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

The preinstalled drivers are listed below.

  • MS SQL driver - This is embedded in the database.war file with standalone bundle, however it is not embedded in the frevvo-tomcat bundle.

  • DERBY driver

If your database driver is not pre-installed, you will have to locate a compatible driver from the internet. Try these locations.

Copy your driver to

  • <frevvo-home>/tomcat/lib in the frevvo-tomcat bundle
  • <db-home>\database-connector-2.5.x\lib Standalone bundle

  • You MUST copy the MS SQL (sqljdbc.jar) to the <frevvo-home>/tomcat/lib directory when running the connector in the frevvo-tomcat bundle AND using MS SQL as your external database
  • The jTDS driver requires an adidtional property, Refer to Datasource  Examples  for information
  • You can copy the driver into any location that is in the CLASSPATH of the tomcat installation. Another location would be <CATALINA_HOME>/lib 

DB Connector Quick Demo

The BIRT (ClassicModels) and myStore querySets are preloaded with in-memory Derby databases and test data.  This make it very easy to try out the connector.  No configuration is necessary.

Follow the steps below to deploy the connector in the the frevvo-tomcat bundle and you can get started very quickly

Review Supported Platforms. Verify that the certified version of Java is installed and the Java_Home environment variable has been configured .

  1. Download  the latest frevvo-tomcat bundle from the frevvo website.

  2. Download the Database Connector war zipfile. 

  3. Extract all the files to a temporary location.
  4. Locate the database-X.X.X.war file in the temp directory. Replace the X.X.X with the version of the Database Connector.
  5. Rename the database-X.X.X.war to database.war.  Replace the X.X.X with the version of the Database Connector.

  6. Extract the tomcat bundle zipfile to a location of your choice. We will refer to this directory as <frevvo-home>.

  7. Copy database.war to <frevvo-home>\tomcat\webapps.

  8. Start the Insight server, then start Live Forms.

     Click here for the instructions to start the Insight Server and Live Forms

     requires Insight software for the Reporting and Submissions View feature. The Insight software is included in the tomcat bundle. The Insight server MUST be started BEFORE starting . Instructions for Windows and Linux operating systems are listed here:

     Windows:

    1. Open a command prompt. Navigate to <frevvo-home>\solr-6.6.2. Type bin\solr.cmd start to run the Insight server in the background, listening on the default port 8983.
       

      Use the bin\solr.cmd -all command to stop all instances of the Insight Server. The -p option allows you to specify the port number for the instance you want to stop

      You will see this message:
       


    2. Browse http;<your server:your port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change <your server>  to the server name and <your port> to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status:

    If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or set up Live Forms and the Insight Server to run as Windows services.

    Linux:

    1. Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
    2. Navigate to <frevvo-home>/solr-6.6.2/bin. Run this command to make the solr startup file executable:

      chmod +x solr
    3. Navigate back to the solr-6.6.2 directory.
    4. Start the Insight server by typing:

      bin/solr start - this starts the Insight server in the background, listening on the default port 8983.
    5. Browse http;<your server:your port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change <your server>  to the server name and <your port> to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status:

       

      You do not have to restart the Insight server every time you restart .

  9. 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
  10. Log into as the superuser (admin@d, admin). Create a tenant.
  11. Create a designer user in the tenant
  12. Download the Database Connector Application, then upload it to your designer user. This application includes some example forms that demonstrate the power of the Database Connector using built-in databases.