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 or run in a simple Standalone mode. The connector relies on the JDBC API. You can use any relational database as long as you have a JDBC driver for that database.

These instructions apply to Cloud and in-house customers.

Column
width300px

On this page:

Table of Contents
maxLevel1

...

  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

        Expand
        titleClick to see standalone bundle content details

        Excerpt

        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

    Expand
    titleClick 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:

    Code Block
    systemctl enable dbconnector.service

    Consult the service unit configuration man page for more details.

  5. 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.  

  6. When the status returns Passed for each queryset, you are ready to configure the Database Connector.



  7. 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.

...

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

  2. Download the Database Connector war file.

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

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

  5. Start the Insight server, 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

  6. 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
  7. Log into as the superuser (admin@d, admin). Create a tenant.
  8. Create a designer user in the tenant
  9. 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.

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.