Skip to content

Latest commit

 

History

History
164 lines (104 loc) · 8.48 KB

fetch-file-activity.md

File metadata and controls

164 lines (104 loc) · 8.48 KB

Jitterbit Harmony Dropbox Fetch File Activity

Introduction

A Dropbox Fetch File activity retrieves data from a Dropbox connection and is intended to be used as a source to provide data to an operation. After configuring a Dropbox connection, you can configure as many Dropbox activities as you like for each Dropbox connection.

Creating a Dropbox Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Use the Show dropdown to filter on Endpoints, and then click the Dropbox connection block to display activities that are available to be used with a Dropbox connection:

Dropbox activities

To create an activity that can be configured, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Dropbox activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: Opens the activity configuration screen for you to configure the activity. For details, see Configuring a Dropbox Fetch File Activity later on this page.

  • Delete: Permanently deletes the activity. A message asks you to confirm that you want to delete the activity.

  • Rename: Positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: Changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Removes the activity as a step in the operation without deleting it from the project. (This is available only from the actions menu on the design canvas.) When you remove an activity that is adjacent to a transformation and schemas are provided within that activity, the schemas are longer referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: Deploys the activity and any components it is dependent on.

  • Configurable Deploy: Opens the deployment screen, where you can select project components to deploy.

  • Add to Group: Opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: Creates a copy of the activity as a new, unreferenced component. On creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Dropbox Fetch File Activity

Follow these steps to configure a Dropbox Fetch File activity:

  • Step 1: Enter Basic Information
  • Step 2: Review Data Schema

Step 1: Enter Basic Information

Dropbox Fetch File Activity Configuration Step 1

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin by either typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to use to identify the Dropbox Fetch File activity. The name must be unique for each Dropbox Fetch File activity and must not contain forward slashes (/) or colons (:).

  • Folder Path: Enter a valid path. The path should point to an existing directory on the Dropbox server. For example, /inbound.

  • Name of the File Being Downloaded: Enter the name of the file(s) that you want to fetch from the path entered above. This field may also include an asterisk * to use as a wildcard (for example, *.dat or *.*) or a question mark ? to match exactly one character (for example, file?.txt).

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to continue to the next step and temporarily store the configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review Data Schema

Dropbox Fetch File Activity Configuration Step 2

  • Data Schema: The request and response data schemas for Dropbox will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Dropbox connector uses the Dropbox Java SDK API. Refer to the SDK documentation for information on the schema fields.

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to return to the previous step and temporarily store the configuration.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Dropbox Fetch File activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Dropbox Fetch File activities can be used as a source with these operation patterns:

Other patterns are not valid using Dropbox Fetch File activities. See the validation patterns on the Operation Validity page.

A typical use case is to use a Dropbox Fetch File activity in the Two-Transformation Pattern. In this example, the first transformation (Dropbox Fetch File Request) creates a request structure that is passed to the Dropbox Fetch File activity. The second transformation (Dropbox Fetch File Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Dropbox Fetch Response) and a message is then logged by the Write to Operation Log script:

Dropbox Fetch File operation

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

Related Pages