Box Permissions

is used to add a collaborator to a folder.

Overview

This Snap is used to add a collaborator to a folder.

Support and limitations

Works in Ultra Tasks.

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 ID of the folder to which you want to add collaboration.

Example: 34567

Login Email ID

String
Required. The email address used to create the collaboration (it does not need to be a Box user).

Example: [email protected]

Role

Dropdown list
Required. The access level of this collaboration. The options available include:
  • editor
  • viewer
  • previewer
  • uploader
  • previewer uploader
  • viewer uploader
  • co-owner
Note: The type of Box account you can restrict and the type of access level that you can set. For more information, see: Box Documentation

Example: editor

Collaboration operation

Dropdown list
Adds/Removes collaboration to/from the given folder.

Default value: Add collaboration

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: 1

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