How do I connect Yellowfin to a database that supports ODBC?

Use the JDBC-ODBC Bridge with an Easysoft ODBC driver to connect Yellowfin to a database that supports ODBC, enabling you to analyse data stored in data stores such as MongoDB and Salesforce from your Yellowfin views, dashboards, and reports.

Yellowfin is a Java application. To interact with a data source such as Salesforce, a Java application uses a JDBC driver. (JDBC is a Java application programming interface (API) that connects Java to relational databases and other tabular data such as spreadsheets and flat files.)

Easysoft ODBC drivers use ODBC to connect to the database for which they provide access. ODBC is another data access technology, the Microsoft implementation of which is included with Windows.

The JDBC-ODBC Bridge allows a Java application using JDBC to access an ODBC driver. The JDBC-ODBC Bridge and ODBC driver do not have to be installed on the same machine.

By default, Yellowfin expects to use Oracle's JDBC-ODBC Bridge. However, the Oracle Bridge has been removed from more recent versions of Java, and was never intended for production use anyway. It is a simple process, however, to install the Easysoft Bridge under Yellowfin.

Example: How to connect Yellowfin to Salesforce

The components necessary to connect Yellowfin to Salesforce are:

Yellowfin <-> JDBC-ODBC Bridge <-> Salesforce ODBC driver <-> Salesforce

Example: How to connect Yellowfin to MongoDB

The components necessary to connect Yellowfin to MongoDB are:

Yellowfin <-> JDBC-ODBC Bridge <-> MongoDB ODBC driver <-> MongoDB

The JDBC-ODBC Bridge, Salesforce ODBC driver and MongoDB ODBC driver are available to download from the Easysoft web site.

Installing, licensing, and testing the Easysoft ODBC driver

  1. Download the Windows Salesforce ODBC driver or Windows MongoDB ODBC driver as required.
  2. Install and license the Easysoft ODBC driver on a Windows machine.

    For installation instructions, refer to the Salesforce ODBC driver documentation or MongoDB ODBC driver documentation.

Before you can use the Easysoft ODBC driver to connect Birst to Salesforce or MongoDB, you need to configure a System ODBC data source in ODBC Data Source Administrator. An ODBC data source stores the connection details for the target database (in this case, Salesforce or MongoDB) and the ODBC driver that's required to connect to it (in this case, the Salesforce ODBC driver or the MongoDB ODBC driver).

To run ODBC Data Source Administrator, in the Windows Run dialog box, type this command:

%windir%\syswow64\odbcad32.exe

Creating a Salesforce ODBC data source

  1. Choose the System DSN tab, and then choose Add.
  2. In the Create New Data Source dialog box, choose Easysoft ODBC-Salesforce Driver, and then choose Finish.
  3. Complete the DSN Setup dialog box:
    Setting Value
    DSN Salesforce
    User Name The name of your Salesforce user. For example, myuser@mydomain.com.
    Password The password for your Salesforce user.
    Token The security token for your Salesforce user, if required.

    To find out whether you need to supply a security token, choose the Test button. If the connection attempt fails with an error which contains LOGIN_MUST_USE_SECURITY_TOKEN, you need to supply one.

    Salesforce emails the security token to the email address associated with your Salesforce user account. If you have not received a security token, you can regenerate it. Salesforce will then email the new security token to you. To regenerate your security token, log in to Salesforce and then choose Setup from the user menu. Search for "security token" in the Quick Find box. Choose Reset Security Token in the Reset Security Token page. When you receive the token in your email client, copy it and then paste it into the Token field.

  4. Use the Test button to verify that you can successfully connect to Salesforce.

Creating a MongoDB ODBC data source

  1. Choose the System DSN tab, and then choose Add.
  2. In the Create New Data Source dialog box, choose Easysoft ODBC-MongoDB Driver, and then choose Finish.
  3. Complete these fields in the Easysoft ODBC-MongoDB Driver DSN Setup dialog box:
    Setting Value
    DSN MongoDB
    Description Easysoft MongoDB ODBC driver
    Server The name or IP address of the host where your MongoDB instance is running.
    User Name If you need to supply a user name to access your MongoDB database, enter it here.
    Password The password for your MongoDB user name.
  4. Use the Test button to verify that you can successfully connect to your MongoDB database.

Installing and licensing the JDBC-ODBC Bridge

  1. Download the JDBC-ODBC Bridge.
  2. Install and license the JDBC-ODBC Bridge on the machine where the Easysoft ODBC driver is installed.

    For installation instructions, refer to the JDBC-ODBC Bridge documentation.

  3. In Windows Services, make sure that the Easysoft JDBC-ODBC Bridge Server x64 service is running, and that the Easysoft JDBC-ODBC Bridge Server service is stopped (stop the service and in the server properties, set the Startup type to Manual).

Connecting Yellowfin to your ODBC database

You can now connect Yellowfin to Salesforce or MongoDB:

  1. Copy EJOB.jar to the the YELLOWFIN_install_dir\appserver\webapps\ROOT\WEB-INF\lib folder.

    EJOB.jar is installed in the following location on the machine where you installed the JDBC-ODBC Bridge:

    install_dir\Jars

    The default location for install_dir is drive:\Program Files (x86)\Easysoft Limited\Easysoft JDBC-ODBC Bridge.

  2. Open web.xml in a text editor.

    web.xml is located in the YELLOWFIN_install_dir\appserver\webapps\ROOT\WEB-INF folder.

  3. Add the JDBC-ODBC Bridge to Yellowfin's list of installed JDBC drivers. Do this by adding the JDBC-ODBC Bridge driver name, easysoft.sql.jobDriver, to the JDBCDrivers list. For example:
    <init-param>
    <param-name>JDBCDrivers</param-name>
    <param-value>
       easysoft.sql.jobDriver,
       com.connectioncloud.jdbc.Driver,
       com.ddtek.jdbc.openedge.OpenEdgeDriver,
       com.filemaker.jdbc.Driver,
       .
       .
       .
  4. Start or restart the Yellowfin service.
  5. In your web browser, log into Yellowfin.
  6. Choose Administration > Admin Console.
  7. Choose Data Sources.
  8. Complete the Connection Details page:
    Setting Value
    Source Name Easysoft
    Connection Method JDBC
    Database Generic JDBC Data Source
    JDBC Driver easysoft.sql.jobDriver
    Connection String jdbc:easysoft://localhost:8831/my_odbc_system_dsn:logonuser=my_windows_user:logonpassword=my_windows_password
  9. Choose Save.
  10. Choose Create > View.
  11. Complete the Initialize View page:
    Setting Value
    I want to author the view using Drag and Drop Editor
    The data I need for my view is sourced from Easysoft
    Category List General Views
  12. Use the drag and drop editor to populate and save your View.
  13. Choose Create > Report.
  14. Create a report based on the data from your new view.