Box.com Connector 1.0.0.2

The Box Connector lets you upload, download, and move files in Box.com.

Prerequisites

• RunMyJobs 9.2.9 or later.
• Connection Management Extension 1.0.0.2 or later. Note that the Connection Management Extension will be installed or updated automatically if necessary when you install this Connector.
• A Box.com Connection.
• Privileges Required to Use the Box Connector.

Contents

Setup

1. To install the Box.com Connector, click its tile in the Catalog, select the version you want, and then click Install <version number>.

2. Set up Box.com for the type of authentication you want to use: JWT or OAuth 2.0.

3. Create a Box.com Connection.

Download a File

To download a file from Box, use the Box_Download_File Process Definition.

Parameters

• Connection: The name provided in the Connections component.
• Path to folder: the folder path in Box to download from, separated by /.
• Name of the file to download: the file name in Box.
• Path to archive folder: The folder path in Box to move the file to after it is downloaded successfully. If omitted, the file will remain in its original location in Box.
• Box User Override: the user ID of the Box user to use for the operation (overwrite App User).

Move Item

To move a File or Folder to a new location within the Box account, use the Box_Move_Item Process Definition.

Parameters

• Connection: The name provided in the Connections component.
• Source Folder:
  • When moving a folder: The path of the folder to move.
• When moving a file: The parent path of the file to move. Leave empty if the file is at the root.
• File Name:
  • When moving a file: The name of the file to move. Wildcards * and ? are supported.
  • When moving a folder: Leave empty.
• Target Folder: The folder path in Box to move the file to. If left empty, the file will be moved to the root.
• Name Conflict Action: What to do if an item with the same name already exists in the target.
  • SKIP: Skip the conflicting item but do not fail the job. If a wildcard is used, other items will continue to be processed.
  • RENAME: The item being moved will have a numeric suffix added to its name to make it unique in the destination.
  • FAIL: Fail the job if a name conflict occurs.
• Box User Override: the user ID of the Box user to use for the operation (overwrite App User).

Rename Item

To rename a File or Folder in the Box account, use the Box_Rename_Item Process Definition.

Parameters

• Connection: The name provided in the Connections component.
• Folder Path:
  • When renaming a folder: The path of the folder to rename.
  • When renaming a file: The parent path of the file to rename. Leave empty if the file is at the root.
• File Name:
  • When renaming a file: The name of the file to rename.
  • When renaming a folder: Leave empty.
• New Name: The new name to assign to the specified file or folder.
• Box User Override: the user ID of the Box user to use for the operation (overwrite App User).

Connecting via Proxy

When your Redwood application server is behind a firewall and cannot directly connect to the box.com internet endpoint you configure the connection to go through an HTTP proxy service. You set up an HTTP Credential to specify the proxy server connection details.

Troubleshooting

Not Authorized

Assume you click Test Connection on the Box.com Properties tab and get the following error:

com.box.sdk.BoxAPIResponseException: The API returned an error code [400] unauthorized_client -
This app is not authorized by the enterprise admin

This indicates that your enterprise administrator has not authorized and enabled the app.

Blocked

Assume you choose Test Connection on the Box.com Properties tab and get the following error:

com.box.sdk.BoxAPIResponseException: The API returned an error code [403] service_blocked - The application is blocked by your administrator

This indicates that your enterprise administrator has disabled the app.