Skip to Content

Box Connector

Summary

The Box connector establishes access to Box.

The Box connector provides an interface for creating a Box connection, the foundation used for generating instances of Box activities. These activities, once configured, interact with Box through the connection.

The Box connector is accessed from the design component palette's Project endpoints and connectors tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Box connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Box connection and its activities are referred to as a Box endpoint:

Box activity types

These activities can be used with any Box API object:

  • Search: Searches for matching content in Box and is intended to be used as a source in an operation.

  • Query: Queries object data from Box and is intended to be used as a source in an operation.

  • Create: Creates object data in Box and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Box and is intended to be used as a target in an operation.

  • Copy: Copies a file or folder in Box and is intended to be used as a target in an operation.

  • Update: Updates object data in Box and is intended to be used as a target in an operation.

These activities can be used only with File objects:

  • Download File: Downloads a file from Box and is intended to be used as a source in an operation.

  • Upload File: Uploads a file into Box and is intended to be used as a target in an operation.

  • Update File: Updates a file in Box and is intended to be used as a target in an operation.

  • Delete File: Deletes a file from Box and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Box connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Box connector uses the Box Java SDK v2.28.1 and Box API. Refer to the documentation for information on the schema nodes and fields.

To use the Box connector, you need the following as described in Box Prerequisites:

  • An authorized Box custom app with JWT authenticaton.
  • The clientID, clientSecret, publicKeyID, privateKey, and passphrase from the JSON file automatically downloaded during app creation.
  • The user ID associated with the app.

Troubleshooting

If you experience issues with the Box connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.box" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.