Box.com Connector 1.0.0.4
The Box Connector lets you upload, download, and move files in Box.com.
New Features in Box.com Connector 1.0.0.4
-
If you select one of this Connector's Process Definitions (or a Chain that uses one of them), and you choose Export with related objects, the entire Connector is no longer exported.
-
Added support for the Modern UI.
Prerequisites
- RunMyJobs 9.2.9 or later.
- Connection Management Extension 1.0.0.5 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
| Object Type | Name |
|---|---|
| Application | GLOBAL.Redwood.REDWOOD.Box |
| ConstraintDefinition | Redwood_BoxConnectionConstraint |
| ExtensionPoint | Redwood_Box |
| Process Definition | Redwood_Box_Upload_File |
| Process Definition | Redwood_Box_Download_File |
| Process Definition | Redwood_Box_Move_Item |
| Process Definition | Redwood_Box_Rename_Item |
| Library | Redwood_Box |
Setup
-
To install the Box.com Connector, click its tile in the Catalog, select the version you want, and then click Install <version number>.
-
Set up Box.com for the type of authentication you want to use: JWT or OAuth 2.0.
-
Create a Box.com Connection.
Process Definitions
Redwood_Box_Download_File
Lets you download a file from Box.com.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection object that defines the connection to the Box.com application. | String | In |
|
|
| Parameters | folder
|
Folder Path | The folder path in Box that the file currently exists in. If omitted, the root folder (/) will be used. | String | In |
|
|
| Parameters | name
|
File Name | The name of the file to download. Wildcards such as * are allowed. If a wildcard is used, all files in the specified folder that match the pattern will be downloaded. | String | In |
|
|
| Parameters | archiveFolder
|
Archive Folder Path | 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. | String | In |
|
|
| Parameters | asUser
|
Box User Override | The user id of the Box user to use for the operation. This will only work if the ‘Make API calls using the as-user header’ setting is enabled in the Box app. | String | In |
|
|
Redwood_Box_Move_Item
Lets you move files or folders within a Box.com account.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection object that defines the connection to the Box.com application. | String | In |
|
|
| Parameters | sourceFolder
|
Source Folder | The path to the folder to move (or the parent folder of the file to be moved). | String | In |
|
|
| Parameters | fileName
|
File Name | The name of the file to move. If omitted, the folder specified in the Source Folder parameter will be moved. Wildcards * and ? are supported. | String | In |
|
|
| Parameters | targetFolder
|
Target Folder | The folder path to move the specified file or folder to. | String | In |
|
|
| Parameters | conflictAction
|
Name Conflict Action | What to do if an item with the same name exists in the target. Skip: Skip the conflicting item but do not fail the job. Rename: Give the item being moved a unique name in the destination. Fail: Fail the job if a name conflict occurs. |
String | In | SKIP | SKIP, RENAME, FAIL |
| Parameters | asUser
|
Box User Override | The user id of the Box user to use for the operation. This will only work if the ‘Make API calls using the as-user header’ setting is enabled in the Box app. | String | In |
|
|
Redwood_Box_Rename_Item
Lets you rename a file or folder within a Box.com account.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection object that defines the connection to the Box.com application. | String | In |
|
|
| Parameters | folder
|
Folder Path | The path to the folder to rename (or the parent folder of the file to be renamed). | String | In |
|
|
| Parameters | fileName
|
File Name | The name of the file to rename. If left blank, the folder specified in the Folder Path parameter will be renamed. If a filename is specified and it does not exist, the job will fail. | String | In |
|
|
| Parameters | newName
|
New Name | The new name to give to the file or folder. If an item with the same name as the new name already exists in the target folder, the job will fail. | String | In |
|
|
| Parameters | asUser
|
Box User Override | The user id of the Box user to use for the operation. This will only work if the ‘Make API calls using the as-user header’ setting is enabled in the Box app. | String | In |
|
|
Redwood_Box_Upload_File
Lets you upload a local file to a location in Box.com.
Parameters
| Tab | Name | Description | Documentation | Data Type | Direction | Default Expression | Values |
|---|---|---|---|---|---|---|---|
| Parameters | connection
|
Connection | The Connection object that defines the connection to the Box.com application. | String | In |
|
|
| Parameters | file
|
File to upload | The file that will be uploaded to Box.com. | File | In |
|
|
| Parameters | folder
|
Path to folder | The folder path in Box to upload to, separated by /. If any folders in the path do not exist, they will be created automatically. | String | In |
|
|
| Parameters | name
|
New Name | The name that should be given to the uploaded file in Box. | String | In |
|
|
| Parameters | asUser
|
Box User Override | The user id of the Box user to use for the operation. This will only work if the ‘Make API calls using the as-user header’ setting is enabled in the Box app. | String | In |
|
|
| Parameters | sharedFolderLink
|
Link to upload folder | If the Box folder that the file was uploaded into is shared, the share url will be returned as the value of this parameter. | String | Out |
|
|
| Parameters | sharedFileLink
|
Link to uploaded file | If the uploaded file is shared, the share url of the file will be returned. NOTE: currently, files uploaded by the Upload definition do not have sharing applied to them, even if the Folder Share Access Type is set to something other than none. This output parameter will only have a value if a new version of an existing file is uploaded and that file is already shared. | String | Out |
|
|
| Parameters | shareAccessType
|
Folder Share Access Type | The type of sharing to apply to created folders. None: Any folders created as part of the upload process will not be shared. Inherit: Any created folders will have the same sharing settings as their parent folder applied to them. |
String | In | `NONE` | NONE,INHERIT,COLLABORATORS,COMPANY,DEFAULT,OPEN |
Connecting via Proxy
If your RunMyJobs server is behind a firewall and cannot directly connect to the Box.com internet endpoint, you can configure the connection to go through an HTTP proxy service. To do this, 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 adminThis 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 administratorThis indicates that your enterprise administrator has disabled the app.