Write

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. This Snap supports several account types, as listed in the table below, or no account. See Configuring Binary Accounts for information on setting up accounts that work with this Snap.

Account types supported by each protocol are as follows:

Required settings for account types are as follows:

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]

If selected, an empty file is written when the incoming binary document has empty data. 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: Not selected.

The binary data stream in the input view may contain header information about the binary data in the form of a document with key-value-pair map data. If this property is checked, the Snap writes a header file whose name is generated by appending ".header" to the value of the File name property. The same header information is also included in the output view data, as shown in the "Expected output" section above, under the key "original". Note that if the header has no keys other than Content-Type or Content-Encoding, the .header file will not be written

Default value: Not selected 

If selected, the Snap checks if the file exists after the completion of the file write. This may delay a few more seconds for the validation.

Default value: Not selected 

Specifies the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure.

Example:  3

Minimum value: 1

Default value: 1

File permission sets to be assigned to the file.
Note:

• Supported for sftp, ftp, ftps, file, and hdfs protocols only.
• FTP/FTPS servers on Windows machines may not be supported.

Specify any combination of {read, write, execute}, separated by a plus sign (+).  This field is case-insensitive. Suggestible options are:

• read
• write
• execute
• read+write
• read+execute
• write+execute
• read+write+execute

When selected, checks if the specified directory path exists and if it does not exist, creates a new directory. This property is not supported for HTTP, HTTPS, SLDB and SMB file protocols.

Default value: Not selected

Flush interval in kilobytes during the file upload. The Snap can flush a given size of data output stream written to the target file server. If the value is zero, the Snap flushes in maximum frequency after each byte block is written. Larger the value is, the less frequent flushes the Snap performs. Leave the property at default -1 for no flush during the upload. This property may help if the file upload experiences an intermittent failure. However, more frequent flushes will result in a slower file upload.

Example:   100

Default value:  -1

Reason:

Could not evaluate expression: filepath

Mismatched input ':' expecting {<EOF>, '||', '&&', '^', '==', '!=', '>', '<', '>=', '<=', '+', '-', '*', '/', '%', '?', '[', PropertyRef}.

Resolution:

Please check expression syntax

The expression toggle (=) is selected on the File name field, so it is trying to evaluate the filepath as an expression.

Click on the toggle to take the field out of expression mode.

Reason:

Failure:
filename is undefined

filename was not found in the containing object.

Resolution:

Please check expression syntax and data types.

The expression toggle (=) is selected on the File name field, so it is trying to evaluate the filename as an expression.

Click on the toggle to take the field out of expression mode.