Connecting Dropbox
editConnecting Dropbox
editUse the Workplace Search Dropbox connector to automatically capture, sync and index the following items from your Dropbox service:
Stored Files |
Including ID, File Metadata, File Content, Updated by, and timestamps |
Dropbox Paper |
Including ID, Metadata, Content, Updated by, and timestamps |
Configuring the Dropbox Connector
editConfiguring the Dropbox connector is the first step prior to connecting the Dropbox service to Workplace Search, and requires that you create an OAuth App from the Dropbox platform. To get started, first log in to Dropbox and access your administrative dashboard:
Step 1. Login to Dropbox’s App Developer Portal.
Step 2. Click the Create app button:
You should see the Create a new app form.
Before we create a new app, there are two important things to understand:
- The app can stay in Developer Mode. You do not need to publish it.
- Make sure that you create this app with a trusted and stable Dropbox account.
Creating an app with a team-owned (Dropbox Business) account is required if you enable document-level permissions.
Step 3. Choose Scoped access and Full Dropbox, and enter a name in the Name your app field. The name must be unique within Dropbox (e.g. Organization Name Workplace Search).
Step 4. Choose create app to submit the Create a new app form.
Your app is created, and you should now see the Settings form.
Step 5. Within OAuth 2 and Redirect URIs, add the Workplace Search OAuth redirect URL for your deployment.
Choose Add to save the URL.
Step 6. Reveal the App Key and App Secret and keep them in a secure and handy location: they will be required shortly.
Step 7. Choose Permissions to change to the Permissions form.
Choose only the following permissions:
-
files.content.read
-
sharing.read
-
account_info.read
- This should be automatically selected for you. -
files.metadata.read
- This should be automatically selected for you whenfiles.content.read
is selected.
Adding permissions beyond the instructed list can cause errors when syncing content from Dropbox.
If and only if you intend to enable document-level permissions then you must also choose these additional permissions:
-
team_info.read
-
team_data.member
-
team_data.team_space
-
members.read
In order to fetch document level permissions, you must use an OAuth App that is created using a team-owned (Dropbox Business) account.
Adding permissions beyond the instructed list can cause errors when syncing content from Dropbox.
Choose Submit to save your changes within the Permissions form.
Step 8. From the Workplace Search administrative dashboard’s Sources area, locate Dropbox, click Configure and provide both the Client ID and Client Secret.
App Key and App Secret correspond to Client ID and Client Secret, respectively.
Voilà! The Dropbox connector is now configured, and ready to be used to synchronize content. In order to capture data, you must now connect a Dropbox instance with the adequate authentication credentials.
Connecting Dropbox to Workplace Search
editOnce the Dropbox connector has been configured, you may connect a Dropbox instance to your organization.
Step 1. Head to your organization’s Workplace Search administrative dashboard, and locate the Sources tab.
Step 2. Click Add a new source.
Step 3. Select Dropbox in the Configured Sources list, and follow the Dropbox authentication flow as presented.
Step 4. Upon the successful authentication flow, you will be redirected to Workplace Search.
Dropbox content will now be captured and will be ready for search gradually as it is synced. Once successfully configured and connected, the Dropbox synchronization automatically occurs every 2 hours.
Limiting the content to be indexed
editIf you don’t need to index all the available content, you can specify the indexing rules via the API. This will help shorten indexing times and limit the size of the index. See Customizing indexing.
For Dropbox, applicable rule types would be path_template
and file_extension
.
Synchronized fields
editThe following table lists the fields synchronized from the connected source to Workplace Search. The attributes in the table apply to the default search application, as follows:
- Display name - The label used when displayed in the UI
- Field name - The name of the underlying field attribute
- Faceted filter - whether the field is a faceted filter by default, or can be enabled (see also: Customizing filters)
-
Automatic query refinement preceding phrases - The default list of phrases that must precede a value of this field in a search query in order to automatically trigger query refinement. If "None," a value from this field may trigger refinement regardless of where it is found in the query string. If
''
, a value from this field must be the first token(s) in the query string. IfN.A.
, automatic query refinement is not available for this field by default. All fields that have a faceted filter (default
orconfigurable
) can also be configured for automatic query refinement; see also Update a content source, Get a content source’s automatic query refinement details and Customizing filters.
Display name | Field name | Faceted filter | Automatic query refinement preceding phrases |
---|---|---|---|
Id |
|
No |
N.A. |
URL |
|
No |
N.A. |
Title |
|
No |
N.A. |
Type |
|
Default |
None |
Path |
|
No |
N.A. |
Updated at |
|
No |
N.A. |
Last updated |
|
No |
N.A. |
Size |
|
No |
N.A. |
Updated by |
|
Configurable |
[ |
Updated by email |
|
Configurable |
[ |
Media type |
|
Default |
None |
Extension |
|
Default |
None |