Box

How to Configure a Box connection

This document describes the Dataworkz connector configuration required to access Box.

Prerequisite

Before configuring Dataworkz for Box, a "Connected App" needs to be configured in Box. Follow the steps listed below for creating an OAuth App in Box for Dataworkz.

1. Use Box Developer Console to create a new app

2. Follow this document to enable connected app and to configure Oauth2 - https://developer.box.com/guides/mobile/ios/quick-start/configure-box-app/

3. Keep in mind the following points while doing the same.

   • Callback URL can be found in Dataworkz UI (Refer Connecting to Box section for details)

   • Permissions/scopes need to be added for Box API. Files and folders access need to be provided to allow Dataworkz connector to read files data and to list folders.

4. Make note of the Client ID & Secret. These details would be required at the time of creating the connector in Dataworkz

Create Box configuration in Dataworkz

1. Navigate to the configurations section of the Dataworkz platform (Gear Icon)

2. Click on SaaS Applications

3. Select Box

4. Click the + icon to add a new Box connection

   
5. Add the Box instance name

6. Select the OAuth option

   1. Private connected app

   2. Dataworkz OAuth

   3. OAuth JWT Bearer)

7. If selected authentication type is Private Connected App then

   1. Select "Yes" if app has already been created.

   2. Select "No". Screen with the redirect URL would pop-up. Copy the redirect URL and goto Prerequisite section.

      
8. Select the Dataworkz workspace you would like to connect to

9. Select the Dataworkz collection that you want dataset to be part of

10. Save the configuration. This would prompt you to login to Box account and to authorize Dataworkz to access Box APIs

11. For Oauth JWT bearer a public/private key pair should be generated and public key needs to be configured in box instance.

    
12. Provide the details from the downloaded certificate configuration on above screen.

13. Test the connection.

14. If the connection is successful, save the configuration

Add Task Configuration

Click the newly created connector and then click + icon to add new task configuration for Box

1. Select the source directory or subdirectory from which files data need to be retrieved.

2. Enter file filter if specific set of files need to be retrieved from a folder.

3. Enter name for the dataset

4. Enable/disable recurring job

5. Click Add to save the configuration

This would complete the Dataworkz configuration for Box