Box connection¶
Introduction¶
A Box connection, created using the Box connector, establishes access to Box. Once a connection is configured, you can create instances of Box activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or edit a box connection¶
A new Box connection is created using the Box connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Box connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a box connection¶
Each user interface element of the Box connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection Name: Enter a name to use to identify the connection. The name must be unique for each Box connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the Box endpoint, which refers to both a specific connection and its activities. -
User ID: Enter the Box user ID previously saved for your application described in Prerequisites.
-
Client ID: Enter the Box client ID previously saved in the downloaded JSON file described in Prerequisites.
-
Client Secret: Enter the Box client secret previously saved in the downloaded JSON file described in Prerequisites.
-
Public Key ID: Enter the Box public key ID previously saved in the downloaded JSON file described in Prerequisites.
-
Private Key: Enter the Box private key previously saved in the downloaded JSON file described in Prerequisites.
-
Passphrase: Enter the Box passphrase previously saved in the downloaded JSON file described in Prerequisites.
-
Enable Keep-alive Strategy: Select to keep the connection from closing between signals for the amount of seconds specified in the Enter the Time in Seconds Between Signals to Keep the Connection Alive field.
-
Enter the Time in Seconds Between Signals to Keep the Connection Alive: If the Enable Keep-alive Strategy field is selected, enter the time in seconds between signals to keep the connection alive. Only numerical characters are allowed.
-
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a Box connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
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.