Dropbox Reader

Note

This adapter is in preview and is available on Striim Developer only. See Striim Developer for more information.

Dropbox is a popular cloud file storage or file hosting service. It enables individual users and businesses to store, locate, manage, and share digital assets. The Dropbox Reader connects to the Dropbox platform and reads supported objects.

Feature summary

Feature		Supported?	Notes
Objects	Standard objects	✓
Objects	Custom objects	✓
Authentication	Basic authentication		Username and password
	OAuth authentication	✓	Manual configuration based
	Custom authentication methods		Not all methods may be supported
Operations	Automated mode	✓
	Initial load	✓
	Pull-based incremental load	✓
	Push-based incremental load
	Automated pipeline
Governance	Connection profile
	Sherlock AI
	Sentinel AI
Schema handling	Initial schema creation	✓	Works with supported targets
Schema handling	Schema evolution
Setup	Wizard template
	Flow Designer	✓
	Striim TQL	✓
Runtime	Resilience/recovery	✓
	Parallel execution
	Metrics	✓	Standard metrics

Supported authentication method

The Dropbox Reader supports OAuth authentication. Creating a connection requires creating an application in Dropbox, obtaining the OAuth credentials from Dropbox, obtaining an authorization code and exchanging it for an access token and refresh token, and setting the connection properties in Striim.

To create a connection using OAuth authentication on Dropbox:

Create an app on Dropbox:
1. Go to Dropbox Developer Console.
2. Select Scoped access and choose the appropriate permissions for your app.
3. After creation, note down the App key (Client ID) and App secret.

Get the access token and refresh tokens:

Use the OAuth 2.0 flow by sending the user to the authorization URL:

https://www.dropbox.com/oauth2/authorize?client_id=YOUR_CLIENT_ID&response_type=code
&redirect_uri=YOUR_REDIRECT_URI

After user authorization, exchange the code for tokens by making a POST request.

POST https://api.dropbox.com/oauth2/token
grant_type=authorization_code
code=<AUTHORIZATION_CODE_FROM_URL>
client_id=<YOUR_CLIENT_ID>
client_secret=<YOUR_CLIENT_SECRET>
redirect_uri=<YOUR_REDIRECT_URI>

The above call will return the access token and refresh token in the response.

Supported objects

The following are the supported objects for reading from Dropbox:

DeletedResources
Events
FileLinks
FileRequests
FileSharedMembers
Files
FolderLinks
FolderSharedMembers
Folders
SharedFiles
SharedFolders
TeamMembers
Teams
Users

Dropbox Reader properties

Property	Type	Default value	Notes
Client ID	String		The client ID assigned when you register your application with an OAuth authorization server.
Client secret	Password		The client secret assigned when you register your application with an OAuth authorization server.
Access token	Password		The access token for connecting using OAuth. The access token is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
Refresh token	Password		The OAuth refresh token for the corresponding OAuth access token. Used to refresh the OAuth access token when using OAuth authentication.
Connection pool size	Integer	20	Specifies the maximum number of active connections.
Exclude tables	String		A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.
Incremental load marker	String		The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval. Specify the name of the column that contains the start position value. This column must meet the following criteria: It should have an integer or timestamp data type (for example, a creation timestamp or an employee ID). The values must be unique and continuously increasing to ensure proper incremental reading.
Migrate schema	Boolean	False	Only available in Initial Load or Automated mode. Set to `True` to enable initial schema migration, which propagates the object schema from the source to the target.
Mode	Select list: Automated mode Initial load Incremental load	Automated	Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.
Polling interval	Integer	5m	Specifies an interval as an integer followed by a unit. Supported units are days (`d`), hours (`h`), minutes (`m`), or seconds (`s`). The reader polls the source at the specified interval.
Refresh token	Password		An OAuth 2.0 refresh token.Use the value generated while creating the token.
Start Position	String	%=-1	Value of the incremental load marker that defines the initial reading position.
Tables	String		A semicolon-delimited (;) list of objects to read from the source. Supports the `%` wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.
Thread pool count	Integer	10	The number of parallel running threads. The default value of zero specifies single-threaded operation. When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.