Add or Edit a Box Business Source

Members of the Administrators and Content Managers built-in groups can add the content of users’ Box enterprise accounts to a Coveo organization. In a Coveo-powered search interface, the source content is accessible to either everyone or specific users as determined by source permissions (see Content Security).

The Box Business Legacy connector has been deprecated for security reasons. If you still have a Box Business Legacy source, it will still work, but we recommend that you create a Box Business source to replace it.

The difference between the two connectors lies in how you identify your Box account when creating the source: with a Box Business Legacy, you entered a Box Enterprise ID, whereas with a Box Business source, a JSON configuration containing credentials is required. Moreover, Box Business Legacy sources provided a Coveo application API key to enter in your Box application to authorize Coveo. With the new connector, this is no longer required.

Source Key Characteristics

Features Supported Additional information
Box version Latest cloud version Following available Box releases
Searchable content types Files, folders, enterprises, users, and web links
Content update operations Refresh

Takes place every three hours by default. A rescan or rebuild is required to:

  • Remove deleted users in Box

  • Update the subitems of a renamed folder
Rescan  
Rebuild  
Content security options Determined by source permissions 1  
Source creator  
Everyone  

Note 1: By default, shared link permissions are ignored, meaning that an item only shared with a link is only visible by its owner in your Coveo-powered search interface. Contact Coveo Support for help on how to take shared link permissions into account.

Add or Edit a Box Business Source

Follow the instructions below when adding or editing a Box Business source.

“Configuration” Tab

On the Add/Edit a Box Business Source subpage, the Configuration tab is selected by default. It contains your source general and authentication information, as well as other parameters.

General Information

Source Name

Enter a name for your source.

Use a short and descriptive name, using letters, numbers, hyphens (-), and underscores (_). Avoid spaces and other special characters.

Authorization

Provide the Box application credentials in JSON format, either by pasting the configuration in the box or clicking Choose File and selecting the file to upload.

If you still have a Box Business Legacy source, an enterprise ID is required instead. In the Box Enterprise ID box, enter the unique identifier that’s displayed in your Box Enterprise Admin Console, in the Account & Billing tab.

Character Optical Recognition (OCR)

Check this box if you want Coveo Cloud to extract text from image files or PDF files containing images. OCR-extracted text is processed as item data, meaning that it’s fully searchable and will appear in the item Quick View. See Enable Optical Character Recognition for details on this feature.

Index

When adding a source, if you have more than one logical (non-Elasticsearch) index in your organization, select the index in which the retrieved content will be stored (see Leverage Many Coveo Indexes). If your organization only has one index, this drop-down menu isn’t visible and you have no decision to make.

  • To add a source storing content in an index different than default, you need the View access level on the Logical Index domain (see Manage Privileges and Logical Indexes Domain).

  • Once the source is added, you can’t switch to a different index.

“Users to Include” Section

Choose whether you want to make all your managed Box accounts searchable or only some specific accounts. If you select Specific, enter the user email addresses corresponding to the Box accounts you want to make searchable.

When you want users to be included as separate items, add "IndexUsers": true to the parameters section of the source JSON configuration (see Source JSON Modification Examples). The default value is false.

“Content Security” Tab

Select who will be able to access the source items through a Coveo-powered search interface. For details on this parameter, see Content Security.

“Access” Tab

In the Access tab, determine whether each group and API key can view or edit the source configuration (see Resource Access):

  1. In the Access Level column, select View or Edit for each available group.

  2. On the left-hand side of the tab, if available, click Groups or API Keys to switch lists.

Completion

  1. Finish adding or editing your source:

    • When you want to save your source configuration changes without starting a build/rebuild, such as when you know you want to do other changes soon, click Add Source/Save.

      To add the source content or to make your changes effective, on the Sources page, you must click Start initial build or Start required rebuild in the source Status column.

      OR

    • When you’re done editing the source and want to make changes effective, click Add and Build Source/Save and Rebuild Source.

      Back on the Sources page, you can review the progress of your source addition or modification.

    Once the source is built or rebuilt, you can review its content in the Content Browser.

  2. Optionally, consider editing or adding mappings.

    You can only manage mapping rules once you build the source (see Refresh, Rescan, or Rebuild Sources).

What’s Next?

Adapt the source update schedule to your needs.

Recommended Articles