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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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 Database Connector war file that is compatible with the version of that you are running to <frevvo-home>\tomcat\webapps.
  3. Rename the downloaded file to database.war
  4. Install the JDBC driver

  5. Start your server

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

  7. If the status returns failures or disabled:

    1. Review the previous installation steps.

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

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

Upgrading from a previous version (for frevvo-tomcat Bundle)

To upgrade a previous version of the Database Connector to the latest version in your existing Tomcat bundle installation:

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

  2. Stop Live Forms

  3. Download the latest version of the Database Connector

  4. Extract the filesystem.war to your <frevvo-home>\tomcat\webapps directory.

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

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

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.

Upgrading from a previous version (for standalone)

To upgrade a previous version of the Database Connector to the latest version using the standalone connector:

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

  2. Stop Live Forms

  3. Download the latest version of the Database Connector

  4. Install the bundle.

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

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

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

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

    Additional Information for In-House Customers

    The initial release of version 9.0 will be deployed to the frevvo Cloud on August 10, 2019. Version 9.0 will be released for in-house customers on 10/16/2019. In-house customers should review the topics below, the instructions in the Upgrade Guide and Supported Platforms before migrating. It is recommended that you perform a full installation of  v9.0.0 when upgrading.  Please remember that In-house customers must upgrade to JDK 11 before upgrading to  v9.0.

    v9.0 License

    v9 License Key Required

    A v9 license key is required for this version of . Request a v9 license by completeing this form  BEFORE you begin the upgrade. v7 licenses will not work. 

    v9.0 license required for this release. v7.0 licenses will not work (TIP-22386)

    JDBC Driver Upgrade

    • MySQL Connector/J 8.0 is highly recommended for use with MySQL Server 8.0, 5.7, 5.6, and 5.5. Note the difference in the driver classname:

    Connector/J 5.1: driverClassName="com.mysql.jdbc.Driver"
    Connector/J 8.0: driverClassName="com.mysql.cj.jdbc.Driver"

    • The SQL Server JDBC Driver (mssql-jdbc-7.2.2.jre11.jar ) is included in the frevvo tomcat bundle in the <frevvo-home>\frevvo\tomcat\lib directory.

    Tomcat and Insight Server version Upgrades

    The version of tomcat has been upgraded to 9.0.19 in the frevvo Cloud. and in the frevvo tomcat bundle for the v9.0 release.

    The version of the Insight Server has been upgraded to Solr 7.5.0 in the frevvo Cloud and in the frevvo tomcat bundle. Server functionality remains the same with the exception of the name of the directory in the tomcat bundle where Solr resides. In-house customers should review the Start the Insight server before frevvo topic for the changes.

    Hardware and Memory Requirements for your frevvo Server

    The minimum recommended hardware configuration for your frevvo server is:

    • 2 gigahertz (GHz) 64-bit (x64) processor with 4 cores
    • 5 gigabyte (GB) of system memory
    • 100 GB hard drive

    However you must size your hardware platform to your specific form usage characteristics. As the number of concurrent users and forms/flows increases so must the system memory. Refer to the memory configuration topic for the details.

    Insight Server Memory Requirements

    It may be necessary to increase heap size for the Insight server, when reporting on/indexing a large number of submissions. Refer to the memory configuration topic for the details.

    Windows:

    1. Open a command prompt. Navigate to <frevvo-home>\solr-7.5.0. 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: "Started Solr server on port 8983. Happy searching!"
       

    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 frevvo and the Insight Server to run as Windows services.

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

    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 .

    Batch User Uploads 

    Uploading a CSV file to add or edit users normally runs quickly. However, if uploading a file in which the notifyIfNewUser property is TRUE for a large number of rows, this process may slow down on some email servers. Tenant Admins can configure frevvo to run CSV-file user uploads in batches to improve upload time if needed. To adjust batch load size, configure the following property in <frevvo-home>\tomcat\conf\frevvo-config.properties. 

    frevvo.userloader.batchSize=25

    frevvo.war file

    As of the v9.0.11 patch upgrade, the frevvo.war file is now shipped unpacked in the <frevvo home>\tomcat\webapps\frevvo directory. If you are working with a pre-v9.0.11 version and need to perform customization in these files, you will need to unzip your frevvo.war file to make changes, and rezip/replace it to run frevvo with your customization. 

     Steps to unzip/edit/rezip frevvo.war file...
    1. Stop frevvo if it is running.
    2. Navigate to <frevvo-home>\tomcat\webapps directory.
    3. Copy the frevvo.war file to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary. Unzip it.
    4. Edit the desired file. 
    5. Save the changes to the default file. 

    6. Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, frevvo may not load correctly:

      This is the correct structure for the frevvo.war zipfile.

    7. Make sure you create the zipfile with the directory structure as shown in the image above (select all files, then send to compressed folder.) It is an easy mistake to include the containing directory in the zipfile. If you do this, frevvo may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension. 

    8. Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.

    9. Restart your frevvo server.

    sameSiteCookies attribute

    Recent browser versions (especially Chrome v80+), by default, allow cookies to be sent only with top-level navigation and GET request initiated by third party websites. When you need to expose cookies to a third party site, such as using the SAML security manager or embedding in an iframe, you need to use https (Chrome only) and explicitly set the samesite attribute of the cookie to "none". frevvo v9.0.10+ includes a tomcat upgrade that allows configuring the cookie processor with this attribute.

    For third party access, you must use https and update the provided tomcat/conf/context.xml CookieProcessor element to add the sameSiteCookies attribute.

    <CookieProcessor className="org.apache.tomcat.util.http.LegacyCookieProcessor" allowEqualsInValue="true" sameSiteCookies="none"/>

    On premise customers who do not want to make these updates need to turn on the legacy behavior in the chrome browser. Please see this Chrome documentation for details.

  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.


  • No labels