Connecting to Custom Connectors with JDBC Drivers

Connecting to Your Application via a Connection String

To access your application from Sisense , you must create a connection string and provide it to Sisense .

To create the connection string:

  1. Open the lib directory for the connector. This is the default path: C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib.
  2. Double-click the jar file in the lib directory.
    8-7lib-folderthumb0300.png
    Alternatively, to open the JAR file from the command line, enter the following command in the command prompt (change the driver name to your driver):
    cd C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib
  3. Press Enter .
  4. Enter the following command (change the driver name to your driver):
    "C:\Program Files\Sisense\infra\jre\bin\java.exe" -jar cdata.jdbc.<Driver Name>.jar.
  5. Press Enter.

    Example:

    8-7jar-command-linethumb0300.png

    The Connection String Builder opens.

  6. Click in the Value column and provide the values of the relevant properties:
    If your applicationEnter the properties
    requires OAuth
    • InitiateOAuth: set to GETANDREFRESH
    • Leave all the other properties empty

    The driver uses embedded credentials which originate from a OAuth App embedded into the driver. The embedded credentials provide full functionality, so you do not have to create an OAuth App.

    Note:

    If you want to configure the authentication or limit the scope of the data provided to Sisense, you will need to create your own OAuth App.

    does not require OAuth
    • InitiateOAuth: set to OFF.
    • Set the User and Password properties to the credentials for your application.
    • If relevant, the Connection String Builder will require additional properties, as your application requires.

    Note:

    Each application requires different properties in the connection string. Find out more about the properties relevant to your application here .

  7. Click Test Connection. A new browser tab opens where you need to log in to your application in order to grant access. (Each application will display a different window and messages.)
    Close the Authorization Successful! message that opens.
  8. Go back to the Connection String Builder dialog, and click OK in the Test Connection Successful message to close it.
  9. Click Copy to Clipboard to obtain the connection string.

For a short video of the process, see below (the video uses the Box driver as an example).

You need to follow the above instructions only on first connect, and then when your credentials to the application change.

To help you create a connection string and test the connection, see Connection String Builder for Certified Connectors.

If you have any issues connecting to your data source, see Troubleshooting JDBC Data Connectors.

Importing Your Application's Tables into Your ElastiCube

  1. Open Sisense.
    For a non-local installation, open Sisense on the hosted cloud environment.
  2. In the Data page, open an ElastiCube or create a new ElastiCube.
  3. In the Model Editor, click data_btn.png; the Add Data dialog box is displayed.
  4. Click Generic JDBC to open the settings.
  5. In Connection String , paste the string you obtained above:
    If your applicationThe connection string
    requires OAuth

    In Sisense the string will be appended with some _persist properties. The following is an example of the connection string as it looks in Sisense:

    jdbc:<your driver>:Initiate OAuth="GETANDREFRESH";_persist_oauthexpiresin=3199;_persist_token_timestamp=1561893244662;_persist_oauthaccesstoken=mswNfVDVpnBZc3pkQQja7WRHNebbaGZL;_persist_oauthrefreshtoken=ybofHX3Vrd7C8cPhE5ZysVxFiUmkJSiw2htjPL0nKDBgpqjcyGP6Am7KNaDzqhZz;

    does not require OAuth

    Paste your string as-is, for example:

    jdbc:<your driver>:Initiate OAuth="OFF";User=XXXX;Password=********;

  6. In JDBC JARs Folder, enter the name of the directory where the JAR file is located.
  7. In Driver's Class Name, enter the following class. To obtain it, click here.
  8. In User Name and Password:
    If your applicationUser Name and Password Fields
    requires OAuthLeave User Name and Password blank.
    does not require OAuth
    • If User Name and Password are part of the connection string, leave these fields blank.
    • If they are not part of the connection string, enter the credentials to your application here.
  9. Click Next. A list of tables in the database are displayed. All tables and views associated with the database will appear in a new window.

  10. From the Tables list, select the relevant table or view you want to work with. You can click next to the relevant table or click Preview to see a preview of the data inside it.
  11. (Optional) Click + to customize the data you want to import with SQL. See Importing Data with Custom Queries for more information.
  12. After you have selected all the relevant tables, click Done. The tables are added to your data model.

For a short video of the process, see below (the video uses the Box driver as an example).

Changing the Default Separator

For some data sources, you must change the default separator to the separator required by your data source.
You can change the default separator by modifying the value of tableNamePattern in the following configuration file:
/opt/sisense/storage/connectors/jdbc_configs/

Limitations

  • The driver samples the first X rows and determines the column type. When Sisense finds rows within the data that does not match the column type, Sisense driver returns an error.