...
Snap type:
...
Write
...
Description:
...
On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
You can use this Snap to write binary data to a file on Box.
- Expected upstream Snaps: File Reader.
- Expected downstream Snaps: Not applicable.
- Expected input: File path.
- Expected output: Writes the file to the specified file path.
...
[None]
...
- Ultra pipelines: May work in Ultra Pipelines.
- Spark mode: Not supported in Spark mode.
...
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Box Account for information on setting up this type of account.
...
| Input | This Snap has exactly one binary input view. |
|---|---|
| Output | This Snap has exactly one document output view. |
| Error | This Snap has at most one document error view and produces zero or more documents in the view. |
...
Settings
...
Label
...
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations
None.
Snap Input and Output
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| File path. |
| Output | Binary |
|
| Writes the file to the specified file path. |
Snap Settings
| Field Name | Field Dependency | Description | |
|---|---|---|---|
Label* | N/A | Specify 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. Default Value: Box Write | |
File path* | |
| N/A | Specify the destination path of the file to be written. Default Value: None | ||||
| Write empty file | N/A | Select this checkbox to write an empty file when the incoming binary document has empty data, in which case a zero bye file is written to the output.
Default Value: Selected | |||
Action | |||||
...
| N/A | Select the action to perform if the file already exists | ||
...
Example: Overwrite
Default: Append
Execute during preview
...
Enables you to execute the Snap during the Save operation so that the output view can produce the preview data.
...
| title | Snap History |
|---|
January 2014
...
. The available options are:
Default value: Append | |||||
| Number of Retries | N/A | Specify the number of attempts the Snap must make in case of connection failure or timeout.
Minimum value: 0 Default value: 0 | |||
| Retry Interval (seconds) | N/A | Specify the minimum number of seconds the Snap must wait before each retry attempt. Default value: 1
| |||
Snap Execution | N/A | Select one of the three modes in which the Snap executes. Available options are:
| |||
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 | ||||||
|---|---|---|---|---|---|---|
|