Configuring the Database Connector

The database connector can be installed in standalone mode or in the frevvo-tomcat in-house bundle. Depending on your installation choice, follow

• Configuring the Database Connector in the tomcat bundle, or

• Configuring the Database Connector in Standalone mode.

Configuring the Database Connector in the frevvo-tomcat bundle

These steps assume you have already installed the frevvo-tomcat bundle and the Database Connector and have verified that the connector is up and running.

1. Stop frevvo. You do not have to stop the Insight Server.

2. Create a folder named <frevvo-home>\config i.e. c:\frevvo\config.

   1. Create the file <frevvo-home>\config\configuration.xml. Your SQL statements will be added to this file.

   2. Copy/Paste the follow text into configuration.xml. This skeleton defines test querysets named myStore and BIRT to get you started.

      <dbconnector> <queryset name="myStore"> </queryset> <queryset name="BIRT"> </queryset> </dbconnector>

3. Create the file <frevvo-home>\tomcat\conf\dbconnector.properties. If this file already exists you will add your database datasource properties to it.

   1. Copy/Paste one of the two following samples into dbconnector.properties.

   2. Edit the frevvo.connectors.database.configuration line to be the path to your configuration.xml file.

      Use this sample if all querysets use the same database

      frevvo.connectors.database.configuration=file:///C:/frevvo/config/configuration.xml dbconnector.queryset.resource-def.url=<the url to your database> dbconnector.queryset.resource-def.user=<your database username> dbconnector.queryset.resource-def.password=<your database password>

      The @myStore and @BIRT in the this sample will be your queryset names in your configuration.xml

      Use this sample if querysets use different databases

      frevvo.connectors.database.configuration=file:///C:/frevvo/config/configuration.xml dbconnector.queryset@myStore.resource-def.url=<the url to your database #1> dbconnector.queryset@myStore.resource-def.user=<your database username> dbconnector.queryset@myStore.resource-def.password=<your database password> dbconnector.queryset@BIRT.resource-def.url=<the url to your database #2> dbconnector.queryset@BIRT.resource-def.user=<your database username> dbconnector.queryset@BIRT.resource-def.password=<your database password>

      
      Your Datasource Properties depend on your JDBC driver type. To see examples of Datasource Definitions,

4. Restart frevvo

5. Browse the status url http://<host>:<port>/database/status

6. Your skeleton database configuration is successful when the status returns Passed! for each queryset.
   
   

   
   
   

7.  You are now ready to define your SQL Queries.

Configuring the Database Connector in Standalone mode

These instructions assume you have already installed the Database Connector Standalone bundle and have verified that the connector up and running.

Follow these steps:

1. Stop the Standalone Database Connector

2. Navigate to the <db-home>\database-connector-2.5.x\config directory.

   1. Create the a file named configuration.xml.

   2. Copy/Paste the following text into configuration.xml. This skeleton defines test querysets named myStore and BIRT to get you started.
      
      

   <dbconnector> <queryset name="myStore"> </queryset> <queryset name="BIRT"> </queryset> </dbconnector>

3. Edit <db-home>\database-connector-2.5.x\config\dbconnector.properties. The dbconnector.properties file is where you can customize database connection properties (such as server port) and configure datasource definitions.

   1. Copy/Paste one of the two following samples under the server.port property.

      Use this sample if all querysets use the same database

      # Customize the DbConnector here logging.file=./logs/database-connector.%d{yyyy-MM-dd}.log server.port=8081 dbconnector.queryset.resource-def.url=<the url to your database> dbconnector.queryset.resource-def.user=<your database username> dbconnector.queryset.resource-def.password=<your database password>

      The @myStore and @BIRT in the this sample will be your queryset names in your configuration.xml

      Use this sample if querysets use different databases

      # Customize the DbConnector here logging.file=./logs/database-connector.%d{yyyy-MM-dd}.log server.port=8081 dbconnector.queryset@myStore.resource-def.url=<the url to your database #1> dbconnector.queryset@myStore.resource-def.user=<your database username> dbconnector.queryset@myStore.resource-def.password=<your database password> dbconnector.queryset@BIRT.resource-def.url=<the url to your database #2> dbconnector.queryset@BIRT.resource-def.user=<your database username> dbconnector.queryset@BIRT.resource-def.password=<your database password>

      Your Datasource Properties depend on your JDBC driver type. To see examples of Datasource Definitions,

4. Restart the connector using one of these methods:

   • 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 file 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
        
        

5. Browse http://localhost:8081/database/status

6. Your skeleton database configuration is successful when the status returns Passed! for each queryset. 
   
   

   
   
   

7. You are now ready to define your SQL Queries.

Database Connector FAQ

What is a database URL?

A database URL is a Universal Resource Locator (URL) that specifies a particular type of database server compatible with the JDBC driver you installed. In addition you can also specify the database name to use for the connection.