Box Directory Browser

This Snap is used for browsing Box files and folders.

Snap Views

Type Description Examples of upstream and downstream Snaps
Input This Snap has at most one document input view.
Output This Snap has exactly one document output view.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String 		Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Folder ID

String 		Required. The metadata for the provided folder ID. This field is suggestible once a valid account is applied.

Default value: root:0

Example: root/My Folder:7665147994

Include subfolders

Checkbox 		Specifies whether the subfolders should be included or not.

Number of retries

Integer 		Enter the integer value to specify the number of attempts the Snap makes to perform the selected operation in case of connection failure or timeout.

Minimum value: 0

Default value: 3

Example: 3

Retry interval (seconds)

Integer 		Enter the time interval in seconds between retry attempts.

Minimum value: 1

Default value: 5

Example: 3

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only
Note: If you don't know the ID of the parent folder:
  • If the folder you want to use is a direct child of the root folder, set Folder ID to 0 and deselect Include sub-folders, then save the pipeline. When the pipeline verifies and generates preview data, the first 50 results of folders are listed. Open the preview data and find the Folder ID for that folder.
  • If it is not within the first 50 results, you would send the results to a file and run the pipeline.

Troubleshooting

If you enter an invalid Folder ID, the error message: Error retrieving contents of the folder with id: Folder ID is displayed.

File Limit

In release 4.6 and earlier, a maximum of 100 entries would be returned. The Snap has been enhanced so that transparently to the user, multiple calls will be made to retrieve 1000 entries at a time until all of the entries in the selected folder or folders are returned.