Accesses the Dropbox file storage service to upload, download, or delete files and folders or list the contents of a folder from a Dropbox account.
Typical Uses
- Manage datasets on Dropbox by uploading, downloading, and deleting files and folders
- Transfer a file's contents (such as XML or raster) into or out of an attribute in FME
- Read downloaded Dropbox data using the FeatureReader, or upload data written by the FeatureWriter to Dropbox
- Retrieve file and folder names, paths, links and other information from Dropbox to use elsewhere in a workspace.
How does it work?
The DropboxConnector uses your Dropbox account credentials (either via a previously defined FME web connection, or by setting up a new FME web connection right from the transformer) to access the file storage service.
Depending on your choice of actions, it will upload or download files, folders, and attributes; list information from the service; or delete items from the service. On uploads, link attributes are added to the output features. On List actions, file/folder information is added as attributes.
Examples
Example: Downloading a dataset
In this example, the DropboxConnector is used to download an Autodesk AutoCAD DWG file from Dropbox. After creating a valid web connection to a Dropbox account (which can be done right in the Dropbox Account parameter), the path and filename to download both from and to are entered.
s
A FeatureReader is added to read the newly downloaded dataset. Here, the ParcelLines feature type will be further processed elsewhere in the workspace.
By executing the download here in the workspace, the source dataset will be refreshed every time the workspace is run.
Example: Downloading and using a raster as an attribute
In this example portion of a workspace, the DropboxConnector is used to download a raster orthoimage from Dropbox into an attribute.
The file is read from Dropbox, and the contents stored as a blob attribute. Then a RasterReplacer is used to interpret the blob into a usable raster format.
The combination of these two transformers avoids having to download the image to local storage and re-read it. A similar technique can be used for point cloud files, using the PointCloudReplacer transformer.
Usage Notes
- This transformer cannot be used to directly move or copy files between different Dropbox locations. However, multiple DropboxConnectors can be used to accomplish these tasks.
Notes on Java Virtual Machine (JVM)
The performance of this transformer is dependent on the amount of memory allocated to the Java Virtual Machine (JVM). The following environment variables allow you to specify memory available to Java Plugins:
- FME_JVM_MIN_HEAP_SIZE: Initial heap size for initializing the JVM. If unset, the default value is 1024K.
- FME32_JVM_MIN_HEAP_SIZE: Same as FME_JVM_MIN_HEAP_SIZE, but applies to 32-bit FME Desktop on Windows, and if set, takes precedence over FME_JVM_MIN_HEAP_SIZE.
These variables must be set in multiples of 1024 and greater than 1 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:
6291456
6144k
6m
- FME_JVM_MAX_HEAP_SIZE: Maximum heap size for initializing the JVM. If unset, the default value is 16384K.
- FME32_JVM_MAX_HEAP_SIZE: Same as FME_JVM_MAX_HEAP_SIZE, but applies to 32-bit FME Desktop on Windows, and if set, takes precedence over FME_JVM_MAX_HEAP_SIZE.
These variables must be set in multiples of 1024 and greater than 2 MB. To indicate kilobytes, megabytes, or gigabytes, append k or K, m or M, or g or G respectively. For example, any of these values is acceptable:
83886080
81920k
80m
Note: To pass additional parameters used by FME to the Java Virtual Machine, use the JAVA_TOOL_OPTIONS environment variable.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
The output of this transformer will vary depending on the Dropbox Action performed.
- After an Upload action, URLs to the file may be saved to the Sharable Link and Direct Download Link attributes.
- A Download action can save to either a file or attribute.
- A Delete action will save the number of files/folders deleted to the Deleted File Count attribute.
- Finally, a List action will output a new feature for each file/folder found in the path specified. Each of these new features will have attributes listing various pieces of information about the object.
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note: If a feature comes in to the DropboxConnector already having a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Request
| Dropbox Action |
The type of operation to perform. Choices include:
|
| Dropbox Account |
Performing operations against a Dropbox account requires the use of OAuth2 authentication using a Web Connection. To create a Dropbox connection, click the 'Dropbox Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
The remaining parameters available depend on the value of the Request > Dropbox Action parameter. Parameters for each Dropbox Action are detailed below.
Parameters - Delete Action
Dropbox Path
|
Delete File at Path |
Path to a file/folder on Dropbox to delete. |
Output Attributes
|
Deleted File Count |
Specify the attribute that will store a count of the number of files/folders that were deleted. |
Parameters - Download Action
Dropbox Source
|
Download File at Path |
The Dropbox path to the file to download. |
Destination
| Download as |
Select whether to store the downloaded data in a File or Attribute.
|
| Download to File | Specify the path to the file that will store the downloaded file. |
| Download to Attribute | Specify the attribute that will store the contents of the downloaded file. Valid for Download as Attribute only. |
Parameters - List Action
Dropbox Path
|
List Contents at Path |
The path on Dropbox to list the contents of. |
Output Attributes
Default attribute names are provided, and may be overwritten.
|
File or Folder Name |
Specify the attribute to hold the name of an object on Dropbox. |
|
Full Path |
Specify the attribute to hold the full path of an object on Dropbox. |
|
File Size |
Specify the attribute to hold the size of a file object on Dropbox. |
| Revision | Specify the attribute to hold the revision string of an object on Dropbox. |
|
Last Modified |
Specify the attribute to hold the last modified date of an object on Dropbox. |
|
File or Folder Flag |
Specify the attribute to hold the type (file or folder) of an object on Dropbox. |
Parameters - Upload Action
Source
|
Upload from |
The type of data to be uploaded.
When working with large objects, File is a better choice than Attribute Content as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature. |
|
File to Upload |
The file to be uploaded to Dropbox if Upload from is set to File. |
|
Source Folder |
The folder to be uploaded to Dropbox if Upload from is set to Folder. |
|
Include Subfolders |
Choose whether to upload subfolders of the Source Folder or not. |
|
Attribute to Upload as File |
The data to be uploaded, supplied from an attribute if Upload from is set to Attribute Content. |
| Data Encoding | The encoding type of Attribute to Upload as File. |
Dropbox Destination
| Upload to Path | The path on Dropbox to upload the source file to. To upload to the root directory, enter “/”. |
| Upload with File Name | The name of the file created from the data supplied in Attribute to Upload as File. The name must include a filename extension (for example, .txt, .jpg, .doc). |
Output Attributes
| Shared Link |
Specify the output attribute that will store a temporary publicly accessible URL that links to the file on Dropbox. |
| Direct Download Link |
Specify the output attribute that will store a URL that links to the file on Dropbox. The URL can only be used by authenticated users. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
Content Types
| These functions manipulate and format strings. | |
|
Special Characters |
A set of control characters is available in the Text Editor. |
| Math functions are available in both editors. | |
| Date/Time Functions | Date and time functions are available in the Text Editor. |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Table Tools
|
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
|
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
|
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
|
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | Dropbox account |
| Aliases | DropboxCaller |
| History |
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for all results about the DropboxConnector on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver and/or the Open Government Licence – Canada.