Dropbox Connector#

Profiles: Project Creator

Note

This connector does not work with Dropbox for Teams accounts. If you have a Dropbox for Teams account you’d like to connect, contact Squirro Support for assistance.

This page describes how to set up and configure the Squirro 1-click connector for Dropbox.

This connector allows project creators to connect to a Dropbox account and select which data they’d like to index into Squirro.

When using the Dropbox Connector, all document types including sheets are converted to PDF before ingesting into a Squirro project.

Prerequisites#

To use this connector, you’ll need the following:

  • An existing Dropbox account with data.

  • OAuth set up for 1-click connectors enabled within Squirro.

Note

0Auth is set up by default on all cloud servers at https://start.squirro.com. For any other Squirro installation, ask your Squirro server admin to follow the steps in the OAuth Configuration section below.

Setting Up a Connector#

To connect Dropbox to Squirro, follow the steps below:

  1. Open your Squirro project.

  2. Navigate to the Setup space.

  3. Click the Data tab. By default, you will be on the Data Sources page, as shown in the example screenshot below:

Add Data Sources

  1. Click the orange plus sign (+) in the top-right corner of the page to add new data.

  2. Click the Enterprise tab, then the Dropbox icon.

  3. When prompted to authenticate your Dropbox account, click Authenticate.

image2

Once you click on the Authenticate button, you will be re-directed to the Dropbox sign-in page. The screen shown below (or similar) then asks you to provide consent for your Dropbox data to Squirro:

Note: Squirro will never ask you for your Dropbox password. This is requested by Dropbox itself.

image3

  1. After signing in or selecting your Dropbox account (if you are signed into multiple accounts), you will be brought back to Squirro’s Source Configuration screen. The screen shown below indicates which Dropbox account Squirro has connected to:

image4

  1. Click Save for Squirro to automatically configure the mapping of item fields and labels, as well as any other required source configuration. Alternatively, you can define those settings manually by clicking Next and going through the full source setup process.

Note

If you are specifying a folder path manually, you must include the leading slash (/) in the path. For example, /myfolder.

Now, your data will begin indexing into Squirro.

image5

OAuth Configuration#

To allow Squirro to connect to the Dropbox accounts of end users, you must register an OAuth2 app on the Dropbox portal.

Dropbox Configuration#

Follow the steps below to configure 0Auth on the Dropbox website:

Note

The exact process on the Dropbox platform may change. If you encounter any issues, contact Squirro Support for assistance.

  1. Open the Dropbox App Console, located at https://www.dropbox.com/developers/apps.

  2. Click Create App.

image7

  1. Select the options as shown in the screenshot below and then click Create App:

    • API: Scoped Access

    • Type: Full Dropbox

    • Name: <Insert Your Choice of Name>. This name will be shown to project creators when connecting to the source but does not otherwise appear in the indexed data.

image8

  1. Select the following options under the Settings tab:

    • Configure OAuth 2 Redirect URIs. This is the URL Dropbox will redirect the user to after successful authorization. This needs to be set to https://<your-server-url>>/dataloader/dropbox_plugin/pl/dropbox/authorized on your server.
      For example: https://squirro.example-company.com/dataloader/dropbox_plugin/pl/dropbox/authorized

    • Access token expiration: Short-lived

    • Leave all the other options untouched.

  2. Click the Permissions tab and ensure the following permissions are enabled:

  • account_info.read

  • files.metadata.read

  • files.content.read

  • sharing.read

Apply for Production#

Also note that the Development apps are limited in terms of users (up to 500) and will show a warning about Development status during the user authorization process when the users connect their Squirro instance to their Dropbox account.

To avoid that, you must apply for Production status of the Dropbox app.

To start that process you first have to configure the Branding. This will require a logo icon, portal URL, and a description of the application.

Squirro Configuration#

After creating the OAuth2 app on the Dropbox portal, you must configure the App Key and the App Secret on your Squirro instance.

To do so, follow the steps below:

  1. Obtain the Dropbox App key and the Dropbox app secret from the Settings screen of the app.

image9

  1. Edit /etc/squirro/common.ini on your Squirro cluster and add the following lines:

[dataloader]
dropbox_app_key=dummy4appk3y123
dropbox_app_secret=dummys3c3t12345

  1. If the [dataloader] header is already present in this file, add the two lines to the existing section. The section header can not appear more than once in the configuration file.

  2. Restart the frontend & datasource service to apply the settings:

sudo systemctl restart sqfrontendd
sudo systemctl restart sqdatasourced

You are now ready to connect your Squirro instance to Dropbox accounts!