Versions Compared

Old Version 15

changes.mady.by.user Megan Ellis

Saved on

compared with

New Version Current

changes.mady.by.user Megan Ellis

Saved on

Key

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

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.

Info

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.

Column
width300px

On this page:

Table of Contents
maxLevel2

 



Installation Steps

We recommend:

...

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

  1. Stop your server.
  2. Download Database Connector war file that is compatible with the version of that you are running.
  3. Extract the .zip file, then open the extracted filefolder. You should see a single file named database.war.
  4. Copy the database.war file to <frevvo-home>\tomcat\webapps.
  5. Install the JDBC driver

  6. Start your server

  7. Browsehttp://<host>:<port>/database/status

  8. If the status returns failures or disabled:

    1. Review the previous installation steps.

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

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

...

  1. Ensure you have downloaded the supported version of OpenJDK. Check Supported Platforms before beginning.

  2. Stop Live FormsStop frevvo

  3. Download the latest version of the Database Connector

  4. Extract the .zip file, then open the extracted folder. You should see a single file named database.war to your .
  5. Copy the database.war file to <frevvo-home>\tomcat\webapps directory.

  6. Verify that the Database Connector configuration is correct for the new version. 

  7. Browse the status URL http(s)://<host>:<port>/database/status.  Your database configuration is successful when the status returns Passed! for each queryset. 

...

Note

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. Right click the <db-home>\database-connector-2.5.x\Install-Service.bat file and select Run as Administrator to install the connector as a Windows service. 

        Expand
        titleClick to see standalone bundle content details
        Excerpt

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

        Image Modified

        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.

      2. Click the Start-DBConnector-Service.bat to start it

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

...

  1. Ensure you have downloaded the supported version of OpenJDK. Check Supported Platforms before beginning.

  2. Stop Live FormsStop frevvo

  3. Download the latest version of the Standalone Database Connector bundle

  4. Install the bundle.

  5. Verify that the Database Connector configuration is correct for the new version. 

  6. Browse http(s)://localhost:8081/database/status. Your database configuration is successful when the status returns Passed! for each queryset. 

...

Note

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 file. Rename it to database.war.

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

  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.