mausart

September 2017 Release Deep Dive: Box Connector

Blog Post created by mausart Employee on Sep 6, 2017

Dell Boomi recently released a Box connector that makes it easy to integrate with the Box.com cloud file storage service. Let’s see what it takes to get up and running with the Box integration.

 

 

Overview

The Box connector enables government agencies and employees to safely and securely store, access, share, and collaborate on files and content across devices in a cloud-friendly and secure environment. Box is a FedRAMP approved solution. With the Box connector, agencies can securely collaborate and share content across agencies and jurisdictions. You can safely upload sensitive materials, easily find and work on the documents that you need, manage your content on-the-go from any device, and easily access the same relevant Box content whenever you need it.

 

 Get the example processes for integrating with Box from the Process Library here.

           

 

Maximum File Size Limit for Uploads

The maximum file size limit for uploads to Box will vary depending on your account type:

  • Free personal: 250MB 
  • Starter: 2GB
  • Business/Enterprise: 5GB

 

For more information about account types and the impact on maximum file size limits, see the Box community article Maximum File Size Limit for Uploads to Box.

 

Connecting to Box

 

Setting up your Box application

The Box connection represents a single Box account including login credentials. If you have multiple accounts, use a separate connection for each account and configure the URL accordingly. Pair a single connection with a different Box operation to perform unique actions on a Box account.

 

For more information about how to configure your Box application, see the BoxDevelopers documentation.

 

Configure the Box connection component

The Box APIs use the OAuth 2.0 protocol for authentication and authorization. Box supports common OAuth 2.0 scenarios for web server, installed, and client-side applications.

 

Steps

 

  1. Obtain OAuth 2.0 client credentials from the Box API Console.
  2. The client application requests an access token from the Box Authorization Server, extracts a token from the response, and sends the token to the Box API that you want to access.

 

The Box API Client Id must be created for a specific app, and can only be used under that scope.

 

Field NameField IdType
Client IDclientIdString
Client SecretclientSecretPassword

 

To set up the Box connection in AtomSphere, enter a Client ID, Client Secret, and click the Regenerate button.

 

 

Integrating with Box

 

Create a File

The Create operation is an outbound action to upload a new file to Box. The following image illustrates the steps in the Create Process.

 

 

Steps

 

1- Set the file content using a Message Shape. In this example, we will send a file using a Message shape with a hard coded document payload.

 

 

2- Set the file name using a Set Property Shape. The file name must be provided using a File Name document property. If the file name is not set, or if the file name already exists, the connector returns an error message.

 

 

 

3- Create a new Create Box operation and click Import in the operation.

 

 

4- You can set the Operation Property, Parent Folder ID, with a folder id for Box Platform. If you do not specify the Parent folder ID, the default value is the root folder (ID = 0).

Note:

 

You can override the Parent folder ID in the Operation Property using a document property (Parent folder ID). 

 

5- Execute the process to create the file.

 

6- Verify the file was uploaded in https://app.box.com/files

 

Update a File

You can create a new file version in the same way as uploading a file. This method is used to create a new version of an existing file in a user’s account. The Upsert operation is similar to the Create operation.

 

The steps to configuration Upsert is similar to the Create operation, except step 3.

 

 

Get a File

Get is an inbound action to download a file from Box. The file ID must be specified as an ID parameter in the configuration of the connector shape.

 

Steps

 

1- Create a new Get Box operation in AtomSphere by creating a new operation and clicking the Import button.

 

 

2- Configure the parameter, id on the Box connector shape and set the file id related to the file that you want to get.

 

 

3- Execute the Get operation.

 

4- You can verify the result by checking the document properties: File ID and File name.

 

 

Get Items in a Folder

Get Folder Items is an inbound action to get and return all of the items contained in the Box folder.

 

Steps

 

1- Create a new Get folder Items Box operation in AtomSphere by creating a new operation and clicking the Import button.

 

 

2- The Get Folder Items operation gets and returns all of the items contained in the Box folder. Configure the parameter, id, on the Box connector shape and set the folder ID (parent_id).

 

 

3- The Get Folder Items operation does not support sorting, and only supports a single (one) filter. The following image shows how to configure the filter.

 

 

4- Execute the Get Folder Items operation.

 

5- The operation returns a list of JSON documents.

 

 

Delete a File

Delete is an outbound action to delete a file from Box.

 

Steps

 

1- Create a new Delete Box operation in AtomSphere by creating a new operation and clicking the Import button.

 

 

2- To delete a file, configure the parameter, id, on the Box connector shape and set the file id.

 

 

3- Execute the Delete operation.

 

4- If the operation is successful, the operation returns an empty document.

 

And that's all there is to it! Now you can easily upload and download files with Box as part of your integration processes.

 

How do you plan to integrate with Box?

Outcomes