Connecting to Box

The Sisense Box connector is a certified connector that allows importing data related to the Box metadata and configuration, such as users, groups, folders, etc. For importing the files and their content from Box, use dedicated file-based drivers, such as the Connecting to CSV and Connecting to JSON drivers by CData.

The support for the connector is provided by Sisense and will be assisted by the certification partner's support, if needed. For any support issues or additional functionality requests, contact your Sisense representative or open a request through the Sisense Help Center . For advanced inquiries specific to driver functionality, you can also contact the certification partner’s support directly via support@cdata.com .

After you have downloaded the driver, you can connect through a connection string. The connection string is used to authenticate users who connect to the Box APIs. Once you have connected to Box, you can import a variety of tables from the Box API.

This page describes how to download the Box driver and deploy it, how to connect to Box with a connection string, provides information about the Box data model, and more.

Downloading the Box JDBC Driver

You can download the Box JDBC driver here .

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

Note:

  • The driver is certified for Sisense v7.2 and above.
  • Sisense v7.4 and above: Click the above link to download a ready-to-use driver.
  • Sisense prior to v7.4: Click the above link to download a 30-days free-trial of the driver. Contact Sisense for the full license version.

Deploying the Driver

Prerequisite: The install file (setup.jar) is a Java Application that requires Java 6 (J2SE) or above to run.
To install the driver, double-click the setup.jar file and proceed with the instructions in the installation wizard.
Depending on the machine on which you are accessing the Sisense application, install the driver in one of the following locations:

  • When Sisense is installed on your local machine , deploy the driver locally.

  • For a non-local installation (when accessing Sisense on a remote Windows server, or accessing the Sisense hosted cloud environment), select one of the below methods:

    • Deploy the driver on the Sisense server machine, and then perform all the authentication on the server machine. OR
    • Deploy the driver on your local machine (or any other machine, as convenient), perform all the authentication on that machine, and then copy the JAR file to the remote server.

Note:

The default location of the JAR file: C:\Program Files\CData\CData JDBC Driver for <Driver Name> 2019\lib

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

JAVA Troubleshooting

If you do not have Java 6 installed, you may download it from here .

If your system is not set up to run Java applications, execute the following command: java -jar setup.jar .

Connecting to Box

To access Box’s REST API from Sisense, you must create the connection string to be used in 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.

    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 . Press Enter and then 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 . Press Enter again.
    For example:


    The Connection String Builder opens.

  3. Click in the Value column of the Initiate OAuth property and select GETANDREFRESH .

  4. Click Test Connection .

  5. A browser window 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.

  6. Go back to the Connection String Builder dialog and click OK in the Test Connection Successful message to close it.

  7. 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).

The driver uses embedded credentials that 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. For details, see here

You need to follow the above instructions only once, to retrieve the Access and Refresh tokens. Once the tokens have been retrieved, the driver will be refreshing them in the background when they expire, with no further involvement from you.

Adding Box Tables to 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 .

    For a non-local installation, open Sisense on the hosted cloud environment.

  3. In the Model Editor, click . The Add Data dialog box is displayed.

  4. Click Generic JDBC to open the JDBC settings.


5. In Connection String , paste the string you obtained above. When you do so, the string is appended with some _persist properties. The following is an example of the connection string as it looks in Sisense:
jdbc:bing:ApiKey=73529b7a4994ytec8d4ca6c33049;InitiateOAuth=GETAND:
6. In JDBC JARs Folder , enter the name of the directory where the Box JAR file is located.
7. In Driver's Class Name , enter the following class name: cdata.jdbc.box.BoxDriver .
8. Leave the User Name and** Password** blank.
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).

Additional Resources

For the full documentation set for the Box connector, click here .

For connection string options, click here .

For information on the Box data model, click here.

Limitations

Aggregate functions are not supported.

To query the Collaborations table, specify an Id, FolderId, or a GroupId.

SELECT * FROM Collaborations WHERE Id = '123'

To select from the Tasks table you need to specify an Id or an ItemId.

SELECT * FROM Tasks WHERE Id = '123'

To select from the TasksAssignments table you need to specify an Id or a TaskId.

SELECT * FROM TasksAssignments WHERE Id = '123'

To select from the Memberships table you need to specify an Id or a GroupId.

SELECT * FROM Memberships WHERE Id = '123'

To select from SharedItems specify the Shared Link that points to the item.

SELECT * FROM SharedItems WHERE SharedLink = 'www.url.com'

If the SharedItem has a password also specify the password.

SELECT * FROM SharedItems WHERE SharedLink = 'www.url.com' AND SharedLinkPassword = 'password'

To query the Comments table specify an Id or a FileId.

SELECT * FROM Comments WHERE Id = '123'

Due to these limitations, the ElastiCube cannot be built without custom SQL.

.r.