Versions Compared

Old Version 15

changes.mady.by.user Ankur Parekh

Saved on

compared with

New Version Current

changes.mady.by.user Sandhya Sriram

Saved on

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

Snap type:

Write

Description:

This Snap writes

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.
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:
InputThis Snap has exactly one binary 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

Image Added

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
InputDocument
  • Min:0
  • Max:1
  • File Reader
  • File Parser
File path.
OutputBinary
  • Min:1
  • Max:1
  • File Writer
Writes the file to the specified file path.

Snap Settings

Field NameField DependencyDescription

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.

Pipeline.

Default Value: Box Write
Example: Box Write

File path

Required. The

*



N/A

Specify the destination path of the file to be written.

Default Value: None
Example: folder1/folder2/file 

Write empty fileN/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.

Info

If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.

Default Value: Selected

Default value: [None]

Example: Deselected

Action

The


N/A

Select the action to

be performed

perform if the file already exists.

Choose from the following options in the drop-down menu

The available options are:

  • Append:
Append
  • Appends the incoming documents to the file.
  • Overwrite: 
Overwrite
  • Overwrites the file with the content from the incoming documents.
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

Note

Ensure that there is sufficient free disk space, at least as much as the expected size of the temporary files.

Number of retriesSpecifies the maximum number of retry attempts when the Snap fails to write. If the value is larger than 0

 Append
Example: Overwrite

Number of RetriesN/A

Specify the number of attempts the Snap must make in case of connection failure or timeout.

Info

If the retry value is more than zero, 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
Example: 3

Retry
interval
Interval (seconds)N/A
Specifies

Specify the minimum number of seconds the Snap must wait before each retry attempt.

Example: 3


Minimum value: 1

Default value: 1

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macronameExecution_Detail_WritepageSOAP


Example: 3

Note

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:

  • 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.

    Default Value: Execute only
    Example: Validate & Execute

Multiexcerpt include macro
nameTemporary Files
pageJoin

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
Box Snap Pack
Box Snap Pack
nopaneltrue