Skip to Content

Box Query Activity

Introduction

A Box Query activity, using its Box connection, queries object data from Box and is intended to be used as a source to provide data in an operation.

Create a Box Query Activity

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

Configure a Box Query Activity

Follow these steps to configure a Box Query activity:

Step 1: Enter a Name and Select an Object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

Box Query Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Box Query activity and must not contain forward slashes / or colons :.

  • Select an Object: This section displays objects available in the Box endpoint.

    • Selected Object: After an object is selected, it is listed here.

    • Search: Enter any part of the object name into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload objects from the Box endpoint. This may be useful if objects have been added to Box. This action refreshes all metadata used to build the table of objects displayed in the configuration.

    • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the Box endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available objects, the Box connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • 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: Select an Action

In this step, select a specific query action. Each user interface element of this step is described below.

Box Query Activity Configuration Step 2

  • Select an Action: This section displays actions available in the Box endpoint.

    • Selected Object: The object selected in the previous step is listed here.

    • Selected Action: After an action is selected, it is listed here.

    • Search: Enter any part of the action name into the search box to filter the list of actions. The search is not case-sensitive. If actions are already displayed within the table, the table results are filtered in real time with each keystroke. To reload actions from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload actions from the Box endpoint. This may be useful if actions have been added to Box. This action refreshes all metadata used to build the table of actions displayed in the configuration.

    • Selecting an Action: Within the table, click anywhere on a row to select an action. Only one action can be selected. The information available for each action is fetched from the Box endpoint:

      • Name: The name of the action.

      • Description: The description of the action.

    Tip

    If the table does not populate with available actions, the Box connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

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

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

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

Box Query Activity Configuration Step 3

  • 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 Query activity uses JSON 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 Query 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 Query 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.