Skip to Content

Box copy activity

Introduction

A Box Copy activity, using its Box connection, copies a file or folder in Box and is intended to be used as a target to consume data in an operation.

Create a box copy activity

An instance of a Box Copy activity is created from a Box connection using its Copy 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 Copy activity can be edited from these locations:

Configure a box copy activity

Follow these steps to configure a Box Copy activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and select the copy type, file or folder name to copy, and destination folder. Each user interface element of this step is described below.

Box copy activity configuration step 1

Tip

Fields with a 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 Copy activity and must not contain forward slashes / or colons :.

  • Copy File or Folder: Select the copy type to be used, one of Copy File or Copy Folder.

  • File or Folder Name: Enter the file name if Copy File is selected or the folder name if Copy Folder is selected.

  • Destination Folder: Enter the folder name to copy to.

  • 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 copy 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 the documentation for information on the schema nodes and fields.

    The Copy activity uses JSON in its response schema.

  • Refresh: Click the 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 Copy 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 Copy activities can be used as a target 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.