Box

How to Configure a Box connection

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

Prerequisite

Before configuring Dataworkz for Box, create a Connected App in Box. Follow the steps below to create an OAuth app in Box for Dataworkz.

1. Use the Box Developer Console to create a new app.

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

3. Keep the following in mind:

   • The Callback URL can be found in Dataworkz UI (see Connecting to Box for details).

   • Add the necessary permissions and scopes for the Box API. Grant files and folders access so the Dataworkz connector can read file data and list folders.

4. Record the Client ID and Secret. These are required when creating the connector in Dataworkz.

Create Box Configuration in Dataworkz

1. Navigate to the Configuration section of the Dataworkz platform (gear icon).

2. Click SaaS Applications.

3. Select Box.

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

   
5. Enter the Box instance name.

6. Select the OAuth option:

   1. Private Connected App

   2. Dataworkz OAuth

   3. OAuth JWT Bearer

7. If the authentication type is Private Connected App:

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

   2. Select No. A screen with the redirect URL appears. Copy the redirect URL and go to the Prerequisite section.

8. Select the Workspace to connect to.

9. Select the Collection that the dataset should belong to.

10. Click Save. Dataworkz prompts you to log in to Box and authorize access to the Box APIs.

11. For OAuth JWT Bearer, generate a public/private key pair and configure the public key in the Box instance.

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

13. Click Test Connection.

14. If the connection succeeds, click Save.

Add Task Configuration

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

1. Select the source directory or subdirectory from which to retrieve file data.

2. Enter a file filter if only specific files within a folder are needed.

3. Enter a name for the dataset.

4. Enable or disable the Recurring Job toggle.

5. Click Add to save the configuration.

This completes the Dataworkz configuration for Box.