Overview
Connecting Denodo to a Box file is a two step process. The first step involves creating an app that will give Denodo access to Box via OAuth and that people can share files with. This only needs to be done once and can be used for all files. This is outlined in the section below. The second step involves creating a connection to a Box file in Denodo using the credentials of the app.
Creating a Box App
This outlines how to create a Box App for Denodo. Since an app has already been created for Denodo, this guide is just for reference. The link to the app and it’s assigned email address are below.
App Link | |
|---|---|
Email (used for sharing files) |
Go to the Box developer console: https://tufts.app.box.com/developers
Click Create a New App
Select Custom App
Select Server Authentication and give the app the name Denodo
Request authorization of the app in Box and create a TechConnect ticket requesting authorization of the Box app.
Once authorized, note down the email address/Service Account ID of the app, accessible from the General Settings tab. Use this email address to grant the app access to files.
Connecting Denodo to Box
The basic setup of a connection is covered in the Quick Start guide below which uses VQL. The Step-by-Step section walks through each step using the GUI.
Quick Start
Step-by-Step
Create a new Data Source file connection (Delimited file, JSON, XML, Excel)
Alternatively, you can use the following VQL:
Select ‘HTTP Client’ as the Data Route
Fill in the Base URL using this format, https://api.box.com/2.0/files/{FILE_ID}/content, replacing {FILE_ID} with the ID of the file in box.
https://developer.box.com/reference/get-files-id-content/
Under the Authentication section, fill in the fields as follows. The Token endpoint URL is https://api.box.com/oauth2/token. You’ll need to click on Extra parameters of the refresh token requests and fill in the additional parameters that Box requires (screenshot , as outlined in the linked documentation below
https://developer.box.com/guides/authentication/client-credentials/
Fill out the bottom section to match your file configuration. The screenshot below shows a common configuration for a CSV
Test the connection, confirm it works, then click Save.
Click Create Base View to create a base view for the file.
Interacting with the Denodo Service Account
File can be uploaded to the Denodo Box service account to prevent dependency on the Box accounts of individuals. While you can’t log in to Box and interact with the service account using the traditional UI, you can perform all essential tasks via the API. The sections below outline how to perform essential Box tasks.
The API can be accessed through a number of different methods including cURL, Postman, and Python, with Postman being the easiest method for most.
Files uploaded to the Denodo service account are, by design, accessible by the Denodo service account and do not need to go through the share process outlined above.
Data Strategy Drop Folder
A general Data Strategy Drop Folder has been created to that members of the Data Strategy team can request access to. Sub folders can be created in here and shared with other teams within the university for uploading of shared data files.
Sharing Files with the Service Account
In the event that files can’t be uploaded to the drop folder, files can be shared with Denodo Service Account by using the service account email in the Share dialog for a file and selecting Invite as Viewer.
See Creating a Box App for the email address.
Importing API Collection into Postman
An API collection for Postman has been created and can be downloaded here.
To import into Postman, click Import, then find and select the Box.postman_collection.json file.
Once imported, you’ll need to obtain the client ID and client secret for the service account and add them to the collection variables. You can obtain these from the app configuration page here (if you’ve been added as a collaborator): https://tufts.app.box.com/developers/console/app/1958391/configuration, or by sending a request to denodo-devs-request@elist.tufts.edu.
Once you have the client ID and secret, set them in the collection variables page and you’re ready to start making API requests.
Obtaining an Access Token
https://developer.box.com/reference/post-oauth2-token/
Access tokens are temporary and typically only valid for an hour.
Creating a Folder
https://developer.box.com/reference/post-folders/
Once a folder is created, you can add people as collaborators so that they interact with the folder using the Box UI, as outlined in Adding Collaborators.
To make uploading files to a folder easy, it’s recommended that you enable the folder upload email and make the access open.
When people upload files to the folder, they should receive a response from Box like the one below indicating that the upload was successful.
If a file being uploaded via email already exists, rather than add it as a new version of that file, it will create a new file with a randomly generated string as part of of the filename.
Listing Folder Items
https://developer.box.com/reference/get-folders-id-items/
Get Folder Information
https://developer.box.com/reference/get-folders-id/
Shared Links
https://developer.box.com/reference/put-files-id--add-shared-link/
https://developer.box.com/reference/put-folders-id--add-shared-link/
Adding Collaborators
https://developer.box.com/reference/post-collaborations/