FME Flow: 2024.2

Dropbox Directory

The Dropbox Directory external action receives messages and uploads files to a folder of a Dropbox account.

The Dropbox Directory external action has two output ports. The success port (✔) can send a message if the upload is successful. The failure port (x) can send a message if the upload fails.

Note  When Retry settings are configured, the failure port renders with a Retry Configured (⟳) icon.

Configuring Your Dropbox Account App

Before creating a Dropbox Directory external action on a Dropbox account, you must configure the account with an app and generate an OAuth2 access token for it.

Note  The Dropbox access token expires after a four-hour session. For longer access, configure your app for offline access with a refresh token. For more information:
  1. Login to your Dropbox account and navigate to https://www.dropbox.com/developers/apps.
  2. On the My apps page, click Create app.
  3. On the Create a new app on the Dropbox Platform page:
    1. Choose an API: Select Dropbox API.
    2. Choose the type of access you need: Select Full Dropbox.
    3. Name your app: Provide a name for your app.
    4. Review the Dropbox API Terms and Conditions and check the box.
    5. Click Create app.
  4. A page opens for your app on the Settings tab.
    1. Under OAuth2 > Generated access token, click Generate.
    2. Copy the generated token.

Parameters

Note  See also Working with Parameters in Automations Workflows.
Tip  To test that your parameters work as expected, click Validate.
  • Access Token: Provide the OAuth2 access token for the Dropbox account to which you want to upload. For more information, see Configuring Your Dropbox Account App , above.
  • Source Path: The source file to upload. If the source file is saved to a Resources directory, click the ellipsis (...) and select the file. If the file is in a different location, enter the file path directly. File paths must use forward slashes (/) or escaped backslashes (\\).
  • Destination Path: The path to the Dropbox folder to upload the file.
Note  Specify file paths using forward slashes (/) or escaped backslashes (\\).

Output Attributes

See Also

Tip  To view the output attributes from upstream components, click Show Upstream Attributes.
Attribute Description
time Event time
source Event type
file.path (Success port only) File path
error.type

(Failure port only) Error type:

  • InvalidMessage: An error occurred while configuring this component, such as missing or malformed values.
  • DeadLetter: An error occured while connecting to an external resource. Examples may include connection issues, invalid credentials, or generic external resource exceptions.
error.message (Failure port only) Error message
dropbox.requestId (Failure port only) Request ID

Retry

  • Retry on failure: If checked, the automation attempts to run the action again if the initial attempt results in a failure to connect to the specified external resource for message delivery. The manner in which these retries are conducted is based on the remaining settings.
  • Use custom retry settings: If checked, the remaining retry settings are configurable. If not checked, they are set to the FME Flow default values.
  • Number of attempts: Maximum number of retries, if the action continues to fail.
  • Wait between attempts: Time to wait between retries. In conjunction with Backoff multiplier (below), the specified value is the wait time for the first retry.
  • Backoff multiplier: Factor by which to increase Wait between attempts on successive retries. For example, a value of 2.0 doubles the wait time for the next retry.
  • Randomization factor: Percentage by which to introduce randomness to Wait between attempts. For example, if Wait between attempts is 100 Seconds, and Randomization factor is 25, the wait time for each retry is randomly selected between 75 and 125 seconds.
  • Maximum wait between attempts: Maximum wait time between retries. In conjunction with Backoff multiplier, the specified value is the upper limit for wait time.