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:

Write


Description:

This Snap performs move, copy, and delete operations in Box.

  • Expected upstream Snaps: Not applicable
  • Expected downstream Snaps: JSON Formatter followed by File Writer.
  • Expected input: Box Operations (It can be move, copy or delete), Source ID (It can be a 'file' or 'folder'), and Destination ID.
  • Expected output: It gives New 'file ID' or 'folder ID', Status of the Item. This Snap is used to move a 'file' or 'folder' to the destination.


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.

Box operations



Required. The operation in Box to perform. The options available include:

  • Move
  • Copy
  • Delete

If Copy or Move is selected, Destination ID is mandatory.

If Delete is selected, Destination ID and New name are not applicable. 

Example: Copy

Default value: Move


Source type


Required. The type of item to be moved. Can be a 'file' or 'folder'.
Example: File
Default value: File


Source ID


Required. The ID of the item you wish to move. If the target is a folder, this will be the folder ID. If the target is a file this will be the file ID.
Example: 1234


New name


The item will be renamed to this in its new destination. This is an optional property
Example: new_file


Destination ID


Required. The folder ID of the folder to which the item will be moved.
Example: 34567


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

Minimum value: 1

Default value: 5

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Example

To move a file with File ID '1234' to a chosen location with destination ID '34567' from its existing destination and the name of the file changed to 'new_name', supply the following property values:
 
Box operations: Move
Source type: File
Source ID: 1234 (can be found in the URL when the file is selected)
New name: new_name
Destination ID: 34567 (can be found in the URL when the folder is selected)

Excerpt Include
Box Snap Pack
Box Snap Pack
nopaneltrue