Versions Compared

Old Version 13

changes.mady.by.user Mohammed Iqbal

Saved on

compared with

New Version 14

changes.mady.by.user Chandna Mitra

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 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:Ultra pipelines: Works in Ultra Pipelines.
  • Spark mode: Not supported in Spark mode.
    • Account: 

    This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Box AccountAccounts 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 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:

    • Append: Append the incoming documents to the file.
    • Overwrite: Overwrite 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 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
    nameSnap Execution
    pageSOAP Execute

    Multiexcerpt include macro
    nameExecution_Detail_Write
    pageSOAP Execute

    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