Box Directory Browser

is used for browsing Box files and folders.

Overview

This Snapis used for browsing Box files and folders.
  • Expected upstream Snaps: File reader followed by any file parser followed by Structure.
  • Expected downstream Snaps: CSV Formatter followed by File Writer.
  • Expected input: Parent ID.
  • Expected output: This Snap provides the path of the files of the Parent ID that was entered.

Prerequisites

None.

Limitations and known issues

None.

Snap Views

View 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.
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when the Snap encounters an error.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (): Indicates that you can add fields in the field set.
  • Remove icon (): Indicates that you can remove fields from the field set.
Field / Field set Type Description
Label String 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 status: root:0

Example: root/My Folder:7665147994
Include subfolders String 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 should make to perform the selected operation in case of connection failure or timeout.

Example: 3

Mininum value: 0

Default status: 3
Retry interval(seconds) Integer Enter the time interval in seconds between retry attempts.

Example: 3

Mininum value: 1

Default status: 5
Snap execution Dropdown list Select 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.
Warning: 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.

Examples

To add a folder to Box, provide the following property values:

This Snap retrieves the metadata of the files and the folders of the parent ID that was provided. Supply the following property values:

Folder ID: root/My Folder:7665147994 (The ID of the parent folder. The default is the root folder, 0.)

Include sub folders: Select the check box to obtain the path of the files in a folder.

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.