Box Permissions

On this Page

Overview

Snap type:

Write


Description:

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

  • Expected upstream Snaps: File reader followed by any file parser followed by Structure.
  • Expected downstream Snaps: CSV Formatter followed by File Writer.
  • Expected input: Folder ID and Email ID.
  • Expected output: Provides the created collaboration Object. This Snap is used to supply Access permissions to a folder.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task 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 ID of the folder to which you want to add collaboration.

Example: 34567


Login Email ID


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

Example: you@example.com


Role


Required. The access level of this collaboration. The options available include:

  • editor
  • viewer
  • previewer
  • uploader
  • previewer uploader
  • viewer uploader
  • co-owner


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

Adds/Removes collaboration to/from the given folder. 

Default value: Add collaboration


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

Minimum value: 1

Default value: 5

Snap Execution

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.

Examples

The examples assume that you have configured & authorized a valid Box account (see Configuring Box Accounts) to be used with this Snap. The following examples show how to add a collaborator to and then delete the same collaborator from a Box folder.  

The following Box Permissions Snap adds a collaborator with the email ID girish.mahadevan@Snaplogic.com to a box folder with the folder ID 2793596227. The collaborator is assigned an editor role.


 


After a successful validation of the Snap, you will see a data preview that shows details of the new collaborator:

 
Note: After adding a collaborator, the Box user account that is added as a collaborator must accept the collaboration to start using the Box folder.


 


Similarly, you can use the Box Permissions Snap to remove a collaborator. To remove the girish.mahadevan@Snaplogic.com collaborator, you must specify the correct collaborator account ID and role else the remove collaboration process gives an error "No collaboration found":


  


After a successful validation of the Snap, you will see a data preview that shows details of the deleted collaborator:


 

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.27main12833 StableAdded Connection timeout and Read timeout fields in Box accounts that enable the Box Snaps to read and write data within the specified connection and read timeouts.
4.25Patch425patches10840Latest

Modified default values for the following fields in Box Read and Box Write Snaps:

  • Number of Retries - Changed from 3 to 0.
  • Retry Interval (seconds) -  Changed from 5 to 1.

For existing Pipelines which have the Enable Staging (deprecated field) checkbox selected, this Snap retries the connection once even if the Number of Retries is zero.

4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10072 LatestModified default values of the following fields across the Snap Pack to trigger automatic retries by default, in case of connection failures or timeouts:
  • Number of Retries - Changed from 0 to 3
  • Retry Interval (seconds) -  Changed from 1 to 5
4.25main9554
 
Stable

Enhanced the output view of the Box Directory Browser Snap to display the error message, Error retrieving contents of the folder with id:<Folder ID> instead of No folder exists with <Folder ID> when you enter an invalid folder ID.

4.24 424patches9242 Latest
  • Enhanced the Box Snap Pack with the Retry mechanism that includes the following settings:

    • Number of Retries: Specifies the number of attempts the snap should make to perform the selected operation in case of connection failure or timeout.
    • Retry Interval (seconds)Specifies the minimum number of seconds the Snap must wait before each retry attempt.
4.24main8556 StableUpgraded with the latest SnapLogic Platform release.
4.23 Patch423patches7526 Latest

Fixes the intermittent failure in access token refresh for the Box OAuth2 account by adopting the refreshAccessTokenIfExpired() method that checks and refreshes the access token within the last minute of its expiry.

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22 Patch422patches6992 Latest

Fixes the Box Write Snap connection retry issue by allowing the Snap to retry only when the given input is at least '1' in Number of retries field. This fix removes the Enable Staging field. 

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20 Patch

box8743

 Latest

Fixes an issue with the Box Snap Pack wherein the OAuth2 token auto-refresh fails for Box accounts. The fix includes a patch released by Box to restore functionality to the "https://www.box.com/api/oauth2/token URL" of the deprecated version 1 of the Box API. 

Box recommends users to start using the endpoint in version 2 of the Box API: "https://api.box.com/oauth2/token" as seen in the blogpost here: https://blog.box.com/start-migrating-to-v2-of-the-content-api-deprecating-v1-in-december 

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch azureactivedirectory8341
 
Latest

Fixes an issue with the Get Group Members Snap wherein the Snap is unable to return more than 100 users.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
Stable
  • Added a new account type, Box Service Account, which enables you to create user accounts that can only be accessed programmatically through the APIs.
  • Added new properties, Number of retries and Retry interval (seconds), in the Box Write Snap to handle failed write attempts.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12 Patchbox5181 Latest
  • Fixed the Box Write Snap that fails due to a network error.
  • Fixed the Box Read Snap that hangs while processing documents. 
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11 Patch

box4306

 Latest

Resolved an issue with the Box Read Snap that was unable to run for longer times due to the current token getting expired. The fix helped to proceed with new access token when the current access token expires.

4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

box1576

 
Stable
  • Box Permissions Snap is updated to allow removing collaboration from a Box folder. For more information, see Box Permissions.
  • Box File Operations Snap is updated to route failures due to invalid source file/folder name to error view.
  • Fixed an error in Box Permissions Snap execution that caused failure in adding collaboration when the Box folder accepted a user as a collaborator.
  • Fixed an error in Box Read Snap that caused unexpected missing property values failure.
4.5rcmsf231 
  • Box Permissions Snap updated to allow for future removal of collaboration permissions.
  • Box Permissions Snap updated to disallow assigning a user as an owner.
4.3.1


Resolved an issue with Snaps in this Snap Pack not being proxy-aware.