This Snap reads a binary data stream from the input view and writes it to a specified file destination. Possible file destinations include: SLDB, HTTP, S3, FTP, SFTP, FTPS, or HDFS. If File permissions for the file are provided, the Snap set those permissions to the file.

• Expected upstream Snaps: Any Snap with a binary output view can be connected upstream, such as CSV Formatter, JSON Formatter, XML Formatter, or File Reader.
• Expected downstream Snaps: Downstream Snap is optional. Any Snap with a document input view can be connected downstream.
• Expected input: Any binary data stream
• Expected output: The output view for this Snap is optional. If an output view is open and the file write action is successful, the output view provides a document with information on the filename, result, and original data. An example is:

{
        "filename": "ftp://ftp.Snaplogic.com/home/qatest/user_manual.pdf",
        "result": "overwritten",
        "original": {
            "content-type" : "application/json"
        }
    }

• Works in Ultra Pipelines.

• Files uploaded to SLFS have a 100-MB per file limit. 

  Note
  title Note
  This limit does not apply when writing to external storage.

  
  

Required. This property specifies the URL for the destination file, which the binary data read from the input view is written to. It may start with one of the following protocols:

• http:
• https:
• s3:
• sftp:
• ftp:
• ftps:
• hdfs:
• sldb:
• smb:

• file: (only for use with a Groundplex)

• wasb:

• wasbs:

• gs:

• adl: 

For SLDB files, if you enter:

• just a file name, such as file.csv, then it writes the file to: /<org>/projects/<pipeline project>/file1.csv (where <org> is your organization name and <pipeline project> is the project where the pipeline is stored) if the pipeline is in a project other than the shared project.

• shared/file1.csv, then it writes the file to: /<org>/shared/file1.csv.

The Snap can write a file to its own project directory or the shared project, and cannot write it to another project directory.

For S3, your account must have full access.
The File property can be a JavaScript expression with the "=" button pressed.
For example, if the "File" property is:

"sldb:///out_" + Date.now() + ".csv"
then the evaluated filename can be:

sldb:///out_2013-11-13T00:22:31.880Z.csv

Fields in the binary header can be also be accessed when computing a file name. For example, if a File Reader Snap was directly connected to a File Writer, you could access the "content-location" header field to get the original path to the file.

You could then compute a new file name based on the old one, for instance, to make a backup file:
    $['content-location'].match('/([^/]+)$')[1] + '.backup'

For http: and https: protocols, the Snap uses http PUT method only. This property should have the syntax:

  [protocol]://[host][:port]/[path]

Please note "://" is a separator between the file protocol and the rest of the URL and the host name and the port number should be between "://" and "/". If the port number is omitted, a default port for the protocol is used. The hostname and port number are omitted in the sldb and s3 protocols. 

This property should be an absolute path for all protocols except sldb.

The file:/// protocol is supported only on Groundplex. In Cloudplex configurations, please use sldb or other file protocols. When using the file:/// protocol, the file access is conducted using the permissions of the user in whose name the Snaplex is running (by default Snapuser). File system access is to be used with caution, and it is the customer's own responsibility to ensure that file system is cleaned up after use. 

For HDFS, if you want to be able to suggest information, use the HDFS Writer Snap. 

Examples: 

• s3:///<S3_bucket_name>@s3.<region_name>.amazonaws.com/<path>

  For region names and their details, see AWS Regions and Endpoints.
  Example:

•  s3:///mybucket@s3.eu-west-1.amazonaws.com/test.json

• sftp://ftp.snaplogic.com:22/dir/filename
• smb://smb.Snaplogic.com:445/test_files/csv/input.csv
• _filename (A key/value pair with "filename" key should be defined as a pipeline parameter.)
• file:///D:/testFolder/  (if the Snap is executed in the Windows Groundplex and needs to access D: drive)
• wasb:///snaplogic/testDir/sampl/csv (to write 'sample.csv' file into the 'testDir' folder in the 'Snaplogic' container)
• gs:///mybucket/csv/test.csv (to read 'test.csv' file in the 'csv/' folder of the 'mybucket' bucket)
• adl://storename/folder/filename (to read the file from a location of the storage) 

Default value:  [None]

Required. The action to perform if the file already exists. The available options include:

• Overwrite - If Overwrite is selected, the Snap attempts to write the file without checking for the file's existence for a better performance, and the "fileAction" field will be "overwritten" in the output view data.
• Append - Append is supported for file, FTP, FTPS and SFTP protocols only.
• Ignore - If Ignore, it will not overwrite the file and will do nothing but write the status and file name to its output view.
• Error -  If Error is selected, the error displays in the Pipeline Run Log. If an error view is defined, the error will be written there as well.

Default value: Overwrite

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

Minimum value: 0

Default value: 0

The user type to assign the permissions. This field is case-insensitive. Suggestible options are:

• owner
• group
• others