Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

Snap type:

Read


Description:

This Snap is 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]


Support and limitations:Works in Ultra Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Box Accounts for information on setting up this type of account.


Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


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



Required. The metadata for the provided folder ID. This field is suggestible once a valid account is applied.
Example: root/My Folder:7665147994

Default value: root:0 

Include subfolders


Specifies whether the subfolders should be included or not.
Number of retries

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

Minimum value: 0

Default value: 3

Retry interval (seconds)

Enter the time interval in seconds between retry attempts.

Example: 3

Minimum value: 1

Default value: 5

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Info

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.
  • If the folder you want to use is further down, select Include sub-folders and send the results to a file. 

Troubleshooting

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

Examples

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.


Excerpt Include
Box Snap Pack
Box Snap Pack
nopaneltrue