Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

Connecting Denodo to Box

In Denodo, you can query files in Box by creating connections to individual files. In general, you will need to create one connection and one base view for each file you want to query. You can either execute the following VQL in the VQL shell (faster), or follow the steps below.

In either case, you need to share the file you want to query with the Denodo Box as shown in the screenshot below.

...

VQL

Copy and paste this VQL into the VQL shell and replace {CONNECTION_NAME} with the desired name for the Box file connection and replace {BOX_FILE_ID} with the ID of the file in Box (see step 3 in Step-by-Step). Make sure you have the correct database selected in the top left corner of the VQL shell.

After running the below VQL, navigate to, and double click on the new connection, then click Create Base View.

Code Block
languagesql
CREATE OR REPLACE FOLDER '/01-base_layer' ;

CREATE OR REPLACE FOLDER '/01-base_layer/01-connections' ;

CREATE OR REPLACE FOLDER '/01-base_layer/01-connections/Box' ;

DROP DATASOURCE DF IF EXISTS {CONNECTION_NAME} CASCADE;

CREATE DATASOURCE DF {CONNECTION_NAME}
    FOLDER = '/01-base_layer/01-connections/box'
    ROUTE HTTP 'http.CommonsHttpClientConnection,120000' GET 'https://api.box.com/2.0/files/{BOX_FILE_ID}/content'
    CHECKCERTIFICATES
    AUTHENTICATION OAUTH20 ( 
      ACCESSTOKEN = 'QdwTWOBaEREKeA5X30NqMRRwjEGY094b5uJp8q/eD38cycmYXTvY43eg8BvtHHm/X8tbbR9GDexgux5dm9STG8VFbDxhgKJMNoEl4jabdPodBkn5vcwrA9kcaDUxgwZh' ENCRYPTED
      REQUESTSIGNINGMETHOD = HEADER
      AUTHENTICATION_GRANT = CLIENT_CREDENTIALS_GRANT
      TOKENENDPOINTURL = 'https://api.box.com/oauth2/token'
      EXTRA_PARAMETERS_OF_REFRESH_TOKEN_REQUEST (
          'box_subject_type' = 'enterprise', 
          'box_subject_id' = '192935'
      )
      CLIENTIDENTIFIER = '0jngdws659fyhpkb80f8fbt26q7olovd'
      CLIENTSECRET = '4fMN87hoo/bjczYeTKGDn+d4kxRCxmjLiy5MQcuYpFlNiT1WMX1BP/m7Ggj5LeUROHpwKOC3872PkcfQLuOK40zjLG5MQ07G7Jro0gK+PG4QpUidG6TmsK86WHylZbf/ZvRGBc0pGr9SzpAccK2MiEsXenWuY5Uju6HPPYRF7IA=' ENCRYPTED
      ACCESSTOKENEXPIRESIN = 4155
    )
    PROXY OFF
    COLUMNDELIMITER = ','
    ENDOFLINEDELIMITER = '\n'
    HEADER = TRUE;

...

Creating a Box App
Anchor
creating-box-app
creating-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.

  1. Go to the Box developer console: https://tufts.app.box.com/developers

  2. Click Create a New App

    Image Added

  3. Select Custom App

    Image Added

  4. Select Server Authentication and give the app the name Denodo

    Image Added

  5. Request authorization of the app in Box and create a TechConnect ticket requesting authorization of the Box app.

    Image Added

  6. 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 and base view for a Box file is covered in the Quick Start guide below. The Step-by-Step section walks through basic process using the GUI.

Quick Start

Denodo-Box Quick Start

Step-by-Step

  1. Create a new Data Source file connection (Delimited file, JSON, XML, Excel)

    Alternatively, you can use the following VQL:

  2. Select ‘HTTP Client’ as the Data Route

  3. 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/

  4. 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/




  5. Fill out the bottom section to match your file configuration. The screenshot below shows a common configuration for a CSV

  6. Test the connection, confirm it works, then click Save.

  7. Click Create Base View to create a base view for the file.

Creating a Box App
Anchor
isMissingRequiredParameterstrue

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.

...

App Link

...

https://tufts.app.box.com/developers/console/app/1958391

...

Email

...

AutomationUser_1958391_MbvCoOnEz5@boxdevedition.com

  1. Go to the Box developer console: https://tufts.app.box.com/developers

  2. Click Create a New App

    Image Removed

  3. Select Custom App

    Image Removed

  4. Select Server Authentication and give the app the name Denodo

    Image Removed

  5. Request authorization of the app in Box and create a TechConnect ticket requesting authorization of the Box app.

    Image Removed

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

...

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.

...

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
Anchor
ds-drop-folder
ds-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

...