Box search activity¶
Introduction¶
A Box Search activity, using its Box connection, searches for matching content in Box and is intended to be used as a source to provide data in an operation.
Create a box search activity¶
An instance of a Box Search activity is created from a Box connection using its Search 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 Search activity can be edited from these locations:
- The design canvas (see Component actions menu in Design canvas).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
Configure a box search activity¶
Follow these steps to configure a Box Search activity:
-
Step 1: Enter a name and specify settings
Provide a name for the activity and specify the search settings. -
Step 2: Review the data schemas
Any request or response schemas are displayed.
Step 1: Enter a name and specify settings¶
In this step, provide a name for the activity and specify the search settings. Each user interface element of this step is described below.
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 Search activity and must not contain forward slashes
/
or colons:
. -
Query: Enter the query.
-
Scope: Enter the scope.
-
File Extensions: Enter the file extensions.
-
Owners User IDs: Enter the owner user IDs.
-
Ancestor Folder IDs: Enter the ancestor folder IDs.
-
Type: Select the type, one of File, Folder, or Web Link.
-
Trash Content: Select the trash content setting, one of Non Trashed Only or Trashed Only.
-
Limit: Enter the limit.
-
Offset: Enter the offset.
-
Size Range: Enter the size range.
-
Sort: Select the sort, one of Modified At or Relevance.
-
Direction: Select the query result direction, one of Ascending or Decsending.
-
Include Recent Shared Links: Select to include recently accessed shared link items.
-
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.
-
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 Search 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 Search 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 Search activities can be used as a source with these operation patterns:
- Transformation pattern
- Two-target archive pattern (as the first source only)
- Two-target HTTP archive pattern (as the first source only)
- Two-transformation pattern (as the first source only)
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.