Box data source
This topic provides details on how to capture Box with Collect.
Task checklist
The table lists the order to set up this data source for RelativityOne Collect.
Order | Task |
---|---|
1 | Create and authorize Collect as an application in Box |
2 | Create the Box data source instance in Collect |
3 | Configure the Box data source in Collect |
Box application setup
Before using the Box data source in Collect, you must create and authorize Collect as an application in Box.
Creating an application with Box
Create and download a config.json file. For more information, see Box's
The config.json file will contain the values required to configure a data source connection in Collect.
- Log into Box and navigate to the Developer Console.
- Click Create New App.
- Click Custom App.
- Select Server Authentication (with JWT).
- Enter an App Name.
- Click Create App.
- In App Access level, select App Access + Enterprise Access.
- In Content Actions, select Read all files and folders stored in Box and Write all files and folders stored in Box.
- In Advanced Features, select Make API calls using as-user header and Generate user access tokens.
- Add and Manage Public Keys clicking Generate a Public/Private Keypair. Authentication is required for this step.
A .json file will be downloaded to your machine. Save the file in a secure location. This file contains the values required to configure a data source connection in Collect. This file can also be downloaded from the App Settings section.
Authorizing an application
Ensure you get approval to use the Box application within your enterprise. Follow the steps provided by Box to submit for approval.
Finally, you must get authorization from a Box admin to use the authentication application.
Creating the data source instance in Collect
In RelativityOne, use the following procedure to connect the Box data source instance to Collect.
On the Collection Admin page in RelativityOne:
- Click the New Collection Source Instance button.
- Enter in a unique name for the data source instance.
- Select the Box data source.
- Enter the required Settings information. For more information on the fields, see Settings fields.
- Click Save.
Settings fields
Gather the information listed from the .json file, and enter it into the Settings fields:
- Client ID—enter the Client ID of the requesting application. This can be found with authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
- Client Secret—enter the client secret of the requesting application to gain an access token.
- Public Key ID—enter the Public Key ID of the requesting application that you found in your app configuration settings .json file.
- Private Key—enter the encrypted private key that you found in your app configuration settings .json file.
- Passphrase—enter the pass phrase that you found in your app configuration settings .json file.
- Enterprise ID—enter the Enterprise ID that you found in your app configuration settings .json file.
Data source details
Each data source details page includes an Actions console. Each data source has different actions.
On the data source page, you should see an Actions console. In the console, you can Validate Connection. Click to validate the client ID, client secret, and other credentials with Box.
Configuring the data source in Collect
Configure the data sources chosen in the Collection Details step. If you select multiple data sources in the first step, you will configure all sources in the step. Switch between each source by clicking the name of the data source in the left navigation menu. Clicking Next and Previous also moves you through the data sources. Select individual data sources by clicking on the checkbox and then using the right arrows to select them. After selecting the data sources to configure, fill out the criteria. Each data source has different criteria to enter.
Add search criteria to collect specific data. To configure the data sources, complete the following fields:
- Select and unselected tabs—choose the data sources to collect from by moving unselected data sources to the selected list.
- Field—choose the field to filter on within the data source.
- Notes: This field is only required when you select a calendar source.
- Operator—choose an operator such as equals, contains, greater than, or less than.
- Value—enter a value to find in the selected field.
The following table lists the filter criteria support for Box collections. Entering the start date and end data criteria isn't required.
Criteria | Operators | Description | Example |
---|---|---|---|
Created Date | Greater Than or Equals, Less Than or Equals | When you use the Creation Date property in a query, the search returns all messages that equal/doesn’t equal, greater/less than the date entered. | If you search “Greater Than 1/1/2001,” your results include all messages created after January 1, 2001. |
Modification Date | Greater Than or Equals, Less Than or Equals | When you use the Modification Date property in a query, the search returns all updated files that equal/doesn’t equal, greater/less than the date entered. | If you search “Less Than 1/1/2020,” your results include all files modified before January 1, 2020. |