FME Transformers: 2024.2

Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
AzureBlobStorageConnector
AzureFileStorageConnector
BoxConnector
CesiumIonConnector
FMEFlowResourceConnector
GoogleCloudStorageConnector
GoogleDriveConnector
HDFSConnector
OneDriveConnector
ProjectWiseWSGConnector
S3Connector
Categories
Integrations

Integrations

Web

Web

Workflows

Workflows

Related Transformers
AzureBlobStorageConnector
AzureFileStorageConnector
BoxConnector
CesiumIonConnector
FMEFlowResourceConnector
GoogleCloudStorageConnector
GoogleDriveConnector
HDFSConnector
OneDriveConnector
ProjectWiseWSGConnector
S3Connector

DropboxConnector

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.

Jump to Configuration

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.

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.

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.

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.

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

This transformer accepts any feature.

Output Ports

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.

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

Dropbox Action

The type of operation to perform. Choices include:

  • Delete
  • Download
  • List
  • Upload

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.

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.

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.

  • File: The downloaded object will be stored in the specified file.
  • Attribute: The downloaded object will be stored in the specified 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.

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.

Source

Upload from

The type of data to be uploaded.

  • File: The specified file will be uploaded.
  • Folder: The specified folder and its contents will be uploaded.
  • Attribute Content: The contents of the specified attribute will 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

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

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.

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.

Text Editor

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.

Arithmetic Editor

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.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

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.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior

Feature-Based

Feature Holding

No
Dependencies Dropbox account
Aliases DropboxCaller
History  

FME Community

The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.

Search for all results about the DropboxConnector on the FME Community.

 

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.