Skip to Content

Box delete file activity

Introduction

A Box Delete File activity, using its Box connection, deletes a file from Box and is intended to be used as a target to consume data in an operation.

Create a box delete file activity

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

Configure a box delete file activity

Follow these steps to configure a Box Delete 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 delete 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 Delete File activity and must not contain forward slashes / or colons :.

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

    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 delete file activity configuration step 2

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

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    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.

    The Delete File activity uses XML in both its request and response schemas.

  • 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 Delete 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 Delete File 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.