Skip to Content

Box Download File Activity

Introduction

A Box Download File activity, using its Box connection, downloads a file from Box and is intended to be used as a source to provide data in an operation.

Create a Box Download File Activity

An instance of a Box Download File activity is created from a Box connection using its Download File activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing Box Download File activity can be edited from these locations:

Configure a Box Download File Activity

Follow these steps to configure a Box Download File activity:

Step 1: Enter a Name and File ID

In this step, provide a name for the activity and specify the file ID. Each user interface element of this step is described below.

Box Download File Activity Configuration Step 1

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by 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 identify the activity. The name must be unique for each Box Download File activity and must not contain forward slashes / or colons :.

  • File ID: Enter the ID of the file to download.

    Note

    File IDs can be retrieved using the Box Search and Query activities.

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

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • 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 the Data Schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Box Download File Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Box connector uses the Box Java SDK v2.28.1 and Box API. Refer to Box API File and the supporting documentation for information on the schema nodes and fields.

    Important

    Downloaded fileContent will be a Base64-encoded string.

    The Download File activity uses XML in its response schema.

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

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

  • 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 Box Download File activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Box Download File activities can be used as a source with these operation patterns:

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.