In this article
File Writer Snap allows you to read a binary data stream from the input view and write it to a specified file destination. Possible file destinations include: SLDB, HTTP, S3, FTP, SFTP, FTPS, or HDFS. If you provide file permissions for the file, the Snap sets those permissions to the file.
This Snap has the ability to use an MD5 checksum that automatically checks for data integrity and corruption while uploading the file. |
Works in Ultra Pipelines.
Files uploaded to SLFS have a 100-MB per file limit. This limit does not apply when writing to external storage.
View Type | View Format | Number of views | Examples of Upstream/Downstream Snaps | Description | ||
---|---|---|---|---|---|---|
Input | Binary | Min: 1 Max: 1 | Any Snap with a binary output view can be connected upstream, such as CSV Formatter, JSON Formatter, XML Formatter, or File Reader. | Any binary data stream. | ||
Output | Document | Min: 0 Max: 1 | Downstream Snap is optional. Any Snap with a document input view can be connected downstream. | 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:
The value of the "result" field can be "overwritten", "created", "ignored", or "appended". The value "ignored" indicates that the Snap did not overwrite the existing file because the value of the File action property is "IGNORE".
| ||
Error | Document |
| N/A | The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline. |
Field names marked with an asterisk ( * ) are mandatory. |
Field | Field Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Label* | String |
Default Value: File Writer | |||||||||
File name* | String | Specify the URI of the destination file to which the the data (binary input from the upstream input view) is written. It may start with one of the following protocols:
Default Value: [None] Examples:
| |||||||||
File action* | Dropdown list | Specify the action to perform if the file already exists. The available options are:
Default Value: Overwrite | |||||||||
Write empty file | Checkbox | Select this checkbox to write an empty file 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. | |||||||||
Write header file | String | Select this checkbox to allow the Snap to write a header file 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
Default Value: Not selected | |||||||||
Validate after write | Checkbox | Select this checkbox to enable the Snap to check 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 | |||||||||
Number of retries | Integer/Expression | Specify the maximum number of retry attempts to make 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 | |||||||||
Retry interval (seconds) | Integer/Expression | Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure. Minimum value: 1 Default Value: 1 | |||||||||
File permissions for various users | Use this field set to provide any combination of permissions to the available users. This field set contains the following fields:
| ||||||||||
User type | String/Expression | Choose one of the three standard user types. The available options are:
Each row can have only one user type and each user type should appear only once. Select one from the suggested list. Specify at most one row per user type. Default Value: N/A | |||||||||
File permissions | String/Expression/Suggestion | Specify the privilege to provide to the user on the file. The available permissions are:
Default Value: N/A | |||||||||
Create directory if not present | Checkbox | Select this checkbox to enable the Snap to create a new directory if the specified directory path does not exist. This field is not supported for HTTP, HTTPS, SLDB and SMB file protocols. Default Value: Not selected | |||||||||
Flush interval (kB) | Integer | Specify the flush interval in kilobytes during the file upload.
Default Value: -1 | |||||||||
Advanced properties | Use this field set to add advanced properties, such as SAS URI. This field set contains the following fields:
| ||||||||||
Properties | String | ||||||||||
Values | String/Expression | Specify the value for the SAS URI.
| |||||||||
Snap Execution | Dropdown list |
For HDFS file access, please use a SnapLogic on-premises Groundplex and make sure that its instance is within the Hadoop cluster and SSH authentication has already been established. You can access HDFS files in the same way as other file protocols in File Reader and File Writer Snaps. There is no need to use any account in the Snap.
HDFS 2.4.0 is supported for the hdfs protocol. |
An example for HDFS is:
hdfs://<hostname>:<port number>/<path to folder>/<filename> |
hdfs://ec2-54-198-212-134.compute-1.amazonaws.com:8020/user/john/input/sample.csv |
Example pipeline file for an sldb file write as shown below: |
Error | Reason | Resolution |
---|---|---|
Could not evaluate expression: filepath Mismatched input ':' expecting {<EOF>, '||', '&&', '^', '==', '!=', '>', '<', '>=', '<=', '+', '-', '*', '/', '%', '?', '[', PropertyRef}. | The expression toggle (=) is selected on the File name field, so it is trying to evaluate the filepath as an expression. | Check the expression syntax. Click on the toggle to take the field out of expression mode. |
Failure: | The expression toggle (=) is selected on the File name field, so it is trying to evaluate the filename as an expression. | Check expression syntax and data types. Disable the expression toggle to take the field value out of expression mode. |