On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Snap type: | Write | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap writes binary data to a file on Box.
| |||||||||||||
| 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: |
| |||||||||||||
Settings | ||||||||||||||
Label | Required. The name of the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |||||||||||||
File path | Required. The destination path of the file to be written. Example: folder1/folder2/file Default value: [None] | |||||||||||||
Action | The action to be performed if the file already exists. Choose from the following options in the drop-down menu:
Example: Overwrite Default value: Append | |||||||||||||
| Enable staging | If this is enabled, the Snap first stores the input data into a temporary file in its local disk. At the end of the input data stream, the Snap starts to copy the temporary file to the target Box server. This property helps avoiding the Box server's timeout when upstream Snaps take too long to process the documents, by maintaining a steady stream of input to the server. Default value: Not selected
| |||||||||||||
| Number of retries | Specifies the maximum number of retry attempts when the Snap fails to write. If the value is larger than 0, the Snap first stores the input data in a temporary local file before writing to the target Box file. Ensure that the local drive has sufficient free disk space as large as the expected target file size. Example: 3 Minimum value: 0 Default value: 0 | |||||||||||||
| Retry interval (seconds) | Specifies the minimum number of seconds the Snap must wait before each retry attempt. Example: 3 Minimum value: 1 Default value: 1 | |||||||||||||
|
| |||||||||||||
Multiexcerpt include macro name Temporary Files page Join
Example
To write a file to Box, send a file from the File Reader Snap to the Box Write Snap where the file path is set to the destination path. If the Action property is set to Overwrite, it overwrites the existing file. If the Action property is set to Append, it appends the content to the existing file.
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|