How to connect NuoDB with Helical Insight

Helical Insight is an Open Source Business Intelligence (BI) tool which supports NuoDB database. In this article we will cover in detail, how you can connect, analyze, share and use other features of Helical Insight with NuoDB Database.

Following are the steps to be performed at file system of Helical Insight (hi-repository/System/Admin) when the database is configured for the first time :
  1. JDBC Driver Configuration
  2. Dialect Configuration
  3. Database Function List Configuration
Post configuration process involves report creation. Following are the steps to create report with Helical Insight using SQLite Database:
  1. Datasource Creation
  2. Metadata Creation
  3. Adhoc Reports

JDBC Driver Configuration

JDBC driver configuration is required through which a database connection can be established with Helical Insight Application. Following are the steps to configure JDBC Driver :
  • Download latest OpenEdge JDBC Driver.
  • Once you have downloaded the driver, you need to put that driver in a “Drivers” Folder of Helical Insight Application. 
    C:\Helical Insight\hi-repository\System\Drivers
    and then immediately it will start appearing in the drop down list of Datasource. Click here for more details

Dialect Configuration

Dialect is used for generating SQL query as per the database selected. In Helical Insight Application, following are the steps to configure dialect :
  1. Go to hi-repository/System/Admin.

    2. sqlDialects.properties file

  2. Open “sqlDialects.properties” file in edit mode using text-editor such as notepad, notepad++.
  3. Add the below present line at the end of the file in a new line. 
    org.sqlite.JDBC=org.hibernate.dialect.PostgreSQLDialect
    Note: Here, SQLite database does not have separate SQLite dialect and it directly supports PostgreSQL dialect. So, Postgresql dialect is mapped with the SQLite JDBC driver.
  4. Now, save the file.
Note : In case, dialect is not assigned then by default MySQL dialect is assigned to the selected database. In result, a sql query will be generated which may or may not support the selected database.

Database Function List Configuration

While creating Adhoc reports, there are database functions which can be applied on datatypes such as text, numeric, datetime, etc. Now, to view the database functions list following are the files needs to be configured :
  1. .xml file.
  2. javascript / js file.
  3. sqlFunctionsXmlMapping.properties

XML file

This file contains the database functions in the XML format. Using this file, user can modify database functions. The XML file is saved as “databasename.xml” for example, “nuodb.xml” or any name can be assigned. The required file has to be present inside the SqlFunctions folder.

Following are the steps to configure database XML file :
  1. Download the zip file which contains xml and js files.
  2. Now, extract the files and insert the nuodb.xml inside the SqlFunctions folder.
    Folder Path :
    3. hi-repository/System/Admin/SqlFunctions

javascript /js file

Javascript file contains code used for defining the query syntax for the respective database. The JS file name must be same as the name assigned to the xml file of the respective database. The filename is case sensitive.

Following are the steps to configure JS file :
  1. Download the zip file which contains xml and js files.
  2. Now, extract the files and insert the nuodb.js inside the SqlFunctions folder.
    Folder Path : 
    hi-repository/System/Admin/SqlFunctions


sqlFunctionsXmlMapping.properties file This file is used for configuring the xml file with the respective database. Following are the steps to configure :
  1. Open Admin folder present inside the helical insight repository.
    2. Folder Path : 
    hi-repository/System/Admin
  2. Open sqlFunctionsXmlMapping.properties file in edit mode using text-editor like notepad++, etc
  3. Insert the code com.nuodb.jdbc.Driver=nuodb in a new line.
  4. Now, save the file.
Note : In the above code, the name “nuodb” should match with the name assigned to xml file (nuodb.xml) and js file (nuodb.js) . nuodb mapping
database funtion list
Database Functions List

Create Datasource

This process involves establishing a connection between Helical Insight application and NuoDB database. There are 2 methods available for creating a Datasource in Helical Insight:
  1. Front End Approach
  2. Back End Approach
Method 1 : Front End Approach
  1. Login to Helical Insight Application.  ( For default credentials, click here )
  2. Click on “Home” button and select “Adhoc” from the list.
  3. On entering Adhoc Page, click on “Create” button in Datasources
  4. Select the “DataSource Type” from the given list. In this case, “Managed Datasource” will be used.
  5. Now, enter the following details as shown in the below image :
    6. NuoDB Managed Datasoure Creation
    Datasource Details : 
    Datesource Name : NuoDB Datasource  ( user-defined name )

Driver : com.nuodb.jdbc.Driver   ( NuoDB JDBC type4 driver )

URL : jdbc:com.nuodb://localhost:48004/sample_db

JDBC URL Format:
jdbc:com.nuodb://<server>:<port48004>/<databasename>

Username : domain
Password : serverpass

    Here, username and password will be the user and password created during nuoDB database server installation.

    Note: If NuoDB JDBC type 4 Driver is not present in the driver dropdown list of adhoc, then it can be added externally. Following are the steps to update driver list :
    • Download latest OpenEdge JDBC Driver.
    • Once you have downloaded the driver, you need to put that driver in a “Drivers” Folder of Helical Insight Application 
      C:\Helical Insight\hi-repository\System\Drivers
      and then immediately it will start appearing in the drop down list of Datasource.

  6. Now, click on “Test connection” to validate the filled details.
  7. If the entered details are correct then “The test connection is established” notification is shown.
  8. Click on “Save Datasource” to confirm.
  9. Then, next step involves creation of metadata. After saving datasource, from the same page click on “Metadata” (at the top right )
  10. Then, click on “Create”.
Further steps will be covered in “Create Metadata” step.

Method 2 : Back End Approach
  1. Go to “hi-repository” folder where Helical Insight Application is installed and then open the folder.
    2. C:\Helical Insight\hi-repository
  2. Create a New Folder with any name, say “NuoDB”, inside “hi-repository” folder.
    3. NuoDB-folder-hirepository
  3. Now, open a text-editor like notepad, notepad++ , and so on.
  4. Then enter the following details as given below :

    5. <EFWD>
      <DataSources>
          <Connection id="1" name="NuoDB EFWD" type="sql.jdbc">
                 <Driver>org.nuodb.jdbc.Driver</Driver>
                 <Url>jdbc:com.nuodb://localhost:48004/</Url>
                 <User>domain</User>
                 <Pass>server</Pass>
           </Connection>
      </DataSources>
</EFWD>
    • Connection ID : User can assign any ID (numeric only)
    • name : Name of the Datasource to be shown in the Datasource list
    • Url : For creating a URL, use the following NuoDB JDBC URL format
    JDBC URL format: 
jdbc:com.nuodb://<server>:<port48004>/<databasename>
    Database username and password is configured during the installation or can be created externally by creating a new database.
  5. After entering the details, save the file as “filename.efwd”

    Note: Saved file has to be present inside the “NuoDB” folder of “hi-repository“.

  6. Now, the NuoDB Database connection has been established. ( if entered details are correct )
  7. Then, next step involves creation on metadata.
  8. Now, login to Helical Insight Application using any web browser.
  9. Click on “Home” button and select “Adhoc” from the list.
  10. Then, Click on “Metadata” Tab and then select “Create”.
Further steps will be covered in “Create Metadata” step.

Create Metadata

For creating a metadata it is mandatory to have established datasource connection which is explained in create datasource.
  1. On clicking “Create” from “Metadata” tab, “Datasource Type” selection page is displayed.
  2. Select the “DataSource Type” from the given list.
    • For Method 1 : Select DataSource Type: Managed Datasource
    • For Method 2 : Select DataSource Type: Plain JDBC Datasource

  3. Click on the Datasource Name using which metadata will be created.
    • For Method 1 : Datasource Name “NuoDB Datasource” is used. Any name can be assigned during configuration.

    NuoDB-managed-datasource-list  
    • For Method 2 : Datasource Name “NuoDB EFWD” is used. Any name can be assigned during configuration.

    NuoDB-efwd-datasource-list
  4. Now , a metadata page appears where various operations can be performed such as table/column aliasing, defining joins, creating views and apply table/column/data security conditions.
  5. Click on “Save” to create metadata.
  6. After clicking “Save” button, a window will appear known as File Browser. Using File Browser, a metadata file is saved in the file-repository of Helical Insight.
  7. Then, click on “Save Metadata” to confirm.
  8. Now, metadata file is ready for creating Adhoc Reports.

Adhoc Reports :

Learn how to create Adhoc Report, click here

For further assistance, kindly contact us on support@helicalinsight.com or post your queries at forum.helicalinsight.com
, , , ,

Share with

Written by

helical_admin

Related Posts