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

You can use this Snap to write binary data to a file on Box.

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.

Default Value: Box Write
Example
Box Write

File path*



N/A

Specify the destination path of the file to be written.

Default Value: None
Examplefolder1/folder2/file 

Action


N/A

Select the action to perform if the file already exists. The available options are:

  • Append: Appends the incoming documents to the file.
  • Overwrite: Overwrites the file with the content from the incoming documents.

Default valueAppend
ExampleOverwrite

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.

Minimum value: 0

Default value: 0
Example: 3

Retry Interval (seconds)N/A

Specify the minimum number of seconds the Snap must wait before each retry attempt.
Minimum value: 1

Default value: 1
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.

Excerpt Include
Box Snap Pack
Box Snap Pack
nopaneltrue