On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Snap type:
Write
Description:
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]
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
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.
| 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
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
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 pipelinePipeline. | |||||||||
File path | Required. The * | N/A | Specify the destination path of the file to be written. Default value: None Default value: [None] | ||||||||
ActionAction | N/A | The action to be performed if the file already exists. Choose from the following options in the drop-down menu:
ExampleDefault value: Overwrite Append | |||||||||
| Number of retries | Specifies the maximumRetries | N/A | Specify the number of retry attempts when the Snap fails to write. must make in case of connection failure or timeout. If the retry value is larger more than 0zero, 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 Interval (seconds) | N/A | Specifies the minimum number of seconds the Snap must wait before each retry attempt. Example: 3 Minimum value: 1 Default value: 5 |
| ||||||||
| Multiexcerpt include macro | |||||||||||
| name | Execution_Detail_Write | page | SOAP1 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. | ||||||||
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 | ||||||
|---|---|---|---|---|---|---|
|