S3 File Writer

In this article

Overview

S3 File Writer is a Write-type Snap that reads a binary data stream from its input view and writes it to an S3 file destination. If you provide values for File permissions, the Snap sets the 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. If the checksum that Amazon S3 calculates during the upload does not match the value that Snap has sent in the request, S3 fails to store the object and the Snap displays an error.
  • The current Snap functionality supports AWS S3 Cloud Service and is applicable for AWSGovCloud setup.

Prerequisites

None.

Supported Features

Works in Ultra Task Pipelines.

Limitations and Known Issues

None.

Snap Views

View TypeView FormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • CSV Formatter
  • JSON Formatter
  • XML Formatter
  • File Reader
Any binary data stream.
OutputDocument
  • Min: 0
  • Max: 1
  • File Reader
  • Mapper

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": "s3:///mybucket/qatest/user_manual.json",
        "result": "overwritten",
        "original": {
            "content-type" : "application/json"
        }
    }

Error

Document

  • Min: 1

  • Max: 1

N/A

The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline

Optional Configuration

IAM Roles for Amazon EC2

To access S3 files from Groundplex nodes hosted in the EC2 environment without specifying Access-key ID and Secret key in AWS S3 account configured for the Snap, enable the ‘IAM_CREDENTIAL_FOR_S3’ feature. When you enable this feature, the IAM credential stored in EC2 metadata is used to access S3 buckets.

To enable the IAM_CREDENTIAL_FOR_S3 feature:

  1. Open Manager.
  2. Open the Snaplexes tab of the project that contains the EC2-based Groundplex.
  3. Click the Groundplex to open its Properties.
  4. Open the Node Properties tab.
  5. Add a new row in the Global properties section.
  6. Specify jvm_options as the Key and -DIAM_CREDENTIAL_FOR_S3=TRUE as the Value.

    Restart the JCC (node) to apply the changes. For more information about IAM Roles, refer to IAM Roles for Amazon EC2.

Behavior Change

Behavior Change

In the 4.23 release, the Snap used to write an S3 file and then set ACL if the ACL property is not empty. If the file write is successful and the ACL setting fails, both output document in the output view and error document in the error view were displayed. This has been fixed in 4.24 release by enabling the Snap to configure ACL when writing the fileTherefore, the Snap produces an error document in the error view if the ACL configuration fails, irrespective of the file write action passing or failing.

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

Field NameField Type Description

Label*


String

Specify the name for 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 ValueS3 File Writer
ExampleS3 File Writer

File name*


String/Expression/Suggestion

Specify the URL for the S3 file, from where the binary data is to be read.

The file name must start with s3:///. You can use the suggest feature to view the list of buckets, subdirectories and files. Bucket names are suggested if the property is empty or s3:///. Once you select a bucket, it can list subdirectories and files immediately below the bucket. Names of subdirectories end with a forward slash ("/"). The suggest feature is not supported if the properties in the S3 Dynamic account are parameters.

Prerequisite: The provided account must have Read access to the specified S3 bucket in order to read the file successfully.

Using Expressions:

This property can be an expression with the Expression enabler  enabled.

For example, if the File property is "s3:///mybucket/out_" + Date.now() + ".csv" then the evaluated filename is s3:///mybucket/out_2013-11-13T00:22:31.880Z.csv.

Syntax:

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

Region Name

Region name is optional only if the region is us-east-1. In all other cases the region name must be specified based on the syntax above. For example, mybucket@eu-west-1. 

For more information about regions, see AWS Regions and Endpoints.

Acceptable File Paths

  • Relative paths

    • filename.json: Saves the file in the project.

    • ../shared/filename.json: Saves the file in the Project Shared Space.

    • ../../shared/filename.json: Saves the files in the Org Shared project.

  • Absolute path

    • /<org>/<projectSpace>/<project>/filename.json

Lint Warning

The Snap displays a Lint Warning in your Pipeline in the following scenarios:

  • INCORRECT_FILE_PATH: When you provide an incorrect file path to write a file, such as not following the given relative paths pattern or absolute path patterns.

  • INCORRECT_ORG_PATHWhen you create files or directories in a different org other than the one where the Pipeline is executing.

Therefore, we recommend that you:

  • confirm to any of the acceptable relative paths. Otherwise, use an absolute path, that is provide a file path that belongs to the same org where you want to write the file, OR
  • use the File Upload icon to specify the File path.


Default Value: s3:///

Examples

  • s3:///mybucket@s3.eu-west-1.amazonaws.com/test.json
  • _filename (A key/value pair with "filename" key should be defined as a pipeline parameter)
  • $filename (A key/value pair with "filename" key should be defined the input document)
Suggest fully-qualified file namesCheckbox

Select this checkbox to include the region and authority of the S3 bucket in the associated paths that appear in the Suggestion list.

We recommend you to use fully-qualified suggestions from the Suggestions list if you are using an instance in the gov cloud.

Default Value: Not Selected

File action*


Dropdown list

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

  • OVERWRITE - 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.
  • IGNORE The Snap will not overwrite the file and will do nothing but write the status and file name to its output view.
  • ERROR-  The error displays in the Pipeline Run Log. If an error view is defined, the error will be written there as well.

Even though it is listed, Append is not supported for the S3 file protocol.

Default ValueOVERWRITE 
ExampleIGNORE 

Write empty fileCheckbox

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


Checkbox

Select this checkbox to write a header file whose name is generated by appending ".header" to the value of the File name property. The header file provides metadata about the file such as content disposition or content type. The same header information is also included in the output view data, as shown in the "Expected output" section above, under the key "original". 

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

If the header has no keys other than Content-Type or Content-Encoding, the .header file is not written.

Default Value: Not selected

Validate after write

Checkbox

Select this checkbox to allow the Snap to check if the file exists after writing the file.

Default Value: Not selected 

Number of retriesInteger/Expression

Specify the maximum number of retry attempts the Snap must make when it 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.

Ensure that the local drive has sufficient free disk space as large as the expected target file size.

If the value is larger than 0, the Snap first downloads the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and attempts to download the file again from the beginning. When the download is successful, the Snap streams the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

Minimum value: 0

Default Value: 0
Example: 3

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
Example3

Buffer size(MB)


Integer

Specify the data (in MB) to load into the S3 bucket, at a time.

Default Value: 10 MB

  • The minimum data size you can upload is 6 MB.

  • The maximum data size you can upload is limited to 10000 times the buffer size.

  • To upload S3 files that are more than 100 GB in size, we recommend you to set the Buffer size to 100 MB or more. Also, set the Maximum upload threads to 10; otherwise, many parallel HTTP connections may be opened, leading to the following error: "AmazonClientException: Unable to execute HTTP request: Timeout waiting for connection from pool".

Refer to Upload Part for more information on uploading to S3. 

Maximum upload threadsInteger

Specify the maximum number of threads to be used for the concurrent multipart upload. The minimum value allowed is 1.

Default Value: 10
Example3

To upload S3 files that are more than 100 GB in size, we recommend you to set the Maximum upload threads to 10. Also, set the Buffer size to 100 MB or more; otherwise, many parallel HTTP connections may be opened, leading to the following error: "AmazonClientException: Unable to execute HTTP request: Timeout waiting for connection from pool".

AWS Canned ACLDropdown list

The predefined ACL grants (from AWS) to use when writing a file to S3. Choose a Canned ACL from the available options:

  • None
  • Private
  • PublicRead
  • PublicReadWrite
  • AuthenticatedRead
  • LogDeliveryWrite
  • BucketOwnerRead
  • BucketOwnerFullControl
  • AwsExecRead

Learn more about AWS Canned ACLs.

Default Value: None
Example: PublicRead

Access Control List


Use this field set to define the Access Control List (ACL) to the specified S3 file. This filed set contains the following fields:

  • Grantee
  • Read
  • View permissions
  • Full control

The account that you use for the Snap must have the required permissions to set the ACLs for the S3 object it is writing to.

GranteeString/Expression/Suggestion

Select a grantee from the suggested list or enter a valid email address or a canonical ID associated to an AWS account. Canonical AWS ID can be obtained in the Security Credentials page of the AWS console.

A grantee can be an AWS account or one of the predefined Amazon S3 groups. The following note is an excerpt from AWS document:

"An email grantee is a grantee identified by their email address and authenticated by an Amazon system. email grants are internally converted to the canonical user representation when creating the ACL. If the grantee changes their email address, it will not affect existing Amazon S3 permissions. Adding a grantee by email address only works if exactly one Amazon account corresponds to the specified email address. If multiple Amazon accounts are associated with the email address, an AmbiguousGrantByEmail error message is returned. This happens rarely, but usually occurs if a user created an Amazon account in the past, forgotten the password, and created another Amazon account using the same email address. If this occurs, the user should contact Amazon customer service to have the accounts merged. Alternatively, grant user access specifying the canonical user representation."

Examples:      

  • "Everyone"
  • "Authenticated user"
  •  an email address used to create AWS account
  • a canonical AWS ID, e.g. "1700891f3927e316dc4c9e18c789b32131880f48d3e03ac110aaf695b212573e"

"Everyone” option allows anyone in the world to access the file (authenticated or anonymous). Even when the bucket is protected with permission and if the file operation in the Snap under ACL->Grantee is set to 'Everyone', any user (authenticated or anonymous) can access the file. So, we highly recommend not to use this option as its unsafe. 

Email Address Grantee Access

You can use Email addresses to specify a grantee only in the following regions:

  • US East (N. Virginia)
  • US West (N. California)
  • US West (Oregon)
  • Asia Pacific (Singapore)
  • Asia Pacific (Sydney)
  • Asia Pacific (Tokyo)
  • EU (Ireland)
  • South America (São Paulo)

For more information, see Specifying Grantee.

ReadCheckboxGrants permission to read the file.
View permissionsCheckboxGrants permission to read the ACL.
Full controlCheckboxGrants full control to the file.
User-defined object metadataUse this field set to define key-value pairs for user-defined object metadata of an S3 object. For more information about user-defined object metadata, see Using Metadata

This field set contains the following fields:

  • Key
  • Value
KeyString/Expression

Specify the key name of the object metadata.

The key names of the object metadata are case-insensitive.  AWS S3 converts them to lower-case and prefixes them with “x-amz-meta-” when displayed in the AWS S3 web console.

When the S3 File Reader Snap reads an S3 file, this metadata is shown in the header of the output binary data, and the key names are displayed in lower-case without the prefix “x-amz-meta-”.

ValueString/ExpressionSpecify the value for the key entered above.
Object tags

Use this field set to define key-value pairs for object tags of an S3 object. Object tags enable you to categorize existing and new objects using key-value combinations. For details about the object tags, see Object Tagging. This field set contains the following fields:

  • Key
  • Value
KeyString/Expression

Specify the key name of the object tag.

The key names of object tags are case-sensitive. When the S3 File Reader Snap reads an S3 file, these object tags are displayed in the header of the output binary data. If a key name of an object tag is the same as another in the header, it is prefixed with “tag_”.

See example Providing User-defined Object Metadata and Object Tags using the S3 File Writer Snap below for more information. 

ValueString/ExpressionSpecify the value for the key entered above.

Snap Execution

Dropdown list

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.

Examples


Providing User-defined Object Metadata and Object Tags using the S3 File Writer Snap

This example is a basic use case for the S3 File Writer Snap. It also demonstrates how you can configure the Snap with custom object metadata and object tags to classify the data. 

In the sample Pipeline, the S3 File Writer Snap is configured as follows with the User-defined object metadata and Object tags

The following is a preview of the output data from the S3 File Writer Snap: 

When the S3 File Reader Snap reads this data, it picks up the user-defined object metadata and object tags we defined, as show below: 

Typical Configuration

Key configuration of the Snap lies in how the values are passed. Values can be passed to the Snap:

Without Expressions

For example, the File name is passed directly to the Snap in the image below.

With Expressions

The File name is passed using Pipeline Parameters:

Download the Pipeline.

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File S3FileWriter.slp

Mar 09, 2020 by Ritu Sachdeva


See Also

Snap Pack History

 Click to view/expand


Release Snap Pack VersionDateTypeUpdates
4.29 Patch429patches15842 Latest

Enhanced the SSH Auth Account with Expression enabler () for the following fields that allow the use of Pipeline parameters to populate the properties.

  • Username

  • Private key

  • Key passphrase

4.29main15993 Stable

Enhanced the following Snaps and Accounts that use SnapLogic File System (SLFS) to display Lint warnings in Pipelines when using incorrect file paths to read and write files. We recommend that you use the File Upload :Upload_icon: icon to specify the file path.

4.28 Patch428patches14919 Latest
  • Fixed an issue with the Directory Browser Snap where the Snap failed while parsing the value in the Amazon S3 client region.
  • Enhanced the File Writer Snap with the Prevent URL encoding checkbox to manage the URL encoding. Select this checkbox to prevent the encoding of the file path URL automatically. This allows the Snap to use the file path value as-is. Deselect this checkbox to automatically encode the characters in the File URL.
  • Fixed an issue with the ZipFile Write Snap where the Snap displayed a null pointer exception when the path in the upstream File Reader Snap started with "../".
  • Fixed an issue in the File Reader Snap where the Snap displayed an SMB Mount error when trying to connect to Mount Share. This Snap now supports SMB version 3.1.1.
  • Fixed an issue with the File Writer Snap where the Snap did not display an error when an error occurred while writing a file.
4.28 Patch

428patches14736

 Latest

Fixed an issue in the File Writer, S3 File Writer, and ZipFile Write Snaps where the Snaps failed with AccessControlListNotSupported error when using an external AWS account to write to the bucket if it has the bucket-owner-enforced setting enabled. With this fix, you can select the None option (the default value), from the AWS Canned ACL dropdown list, indicating that no Canned ACL request is set when writing a new file to prevent the error.

4.28main14627 Stable
  • Enhanced the File Operation Snap to support Azure Data Lake Storage (ADLS) Gen2 protocol for moving and copying files in the Azure Blob File System (ABFS).

  • Fixed an issue with the File Poller Snap to enhance performance of the polling operations that allows the Snap to poll the files without stopping.

  • Enhanced the File Writer, S3 File Writer, and ZipFile Write Snaps with the AWS Canned ACL (Access Control List) permission mode that enables you to use Canned ACLs when creating the S3 Object. This feature allows you to grant full access of the object to the S3 bucket owner.
4.27 Patch427patches14283 Latest
  • Fixed an issue with the File Writer Snap where the Server Message Block (SMB) mount failed to connect unless the Pipeline was restarted.

  • Enhanced the S3 File Writer Snap with the Suggest fully-qualified file names checkbox that allows you to use fully-qualified file names in the File name Suggestions list for gov cloud instances.

  • Fixed an issue with the File Poller Snap to handle indefinite polling operations without stopping in the process of execution.

  • Fixed an issue with the ZipFile Write Snap where the ZIP extension files were downloaded with an incorrect file extension.

  • Fixed an issue with the Zip File Read Snap where an archive failed to uncompress.

  • Fixed an issue with the File Writer Snap when a file greater than 10 MB failed to write when uploading to Google Storage.

  • Upgraded the Google Cloud Storage Java libraries from version 1.105.1 to version 2.2.2.

4.27 Patch

427patches13004

 Latest

Fixed an issue with the SMB Account where the Snaps could not re-establish a lost connection to the SMB mount point.

4.27main12833Stable
  • Enhanced the File Operation Snap with a new field Azcopy absolute path that enables the Snap to make a single API call to move an entire directory. This field supports directory and wildcard characters for Azure blob storage for all three operations: Copy, Move and Rename.
  • Enhanced the Azure Storage Account with a new option called SAS URI in the Auth Type dropdown. This enables you to select either Access Key or the SAS URI while configuring the account settings.
4.26 Patch426patches12288Latest

Fixed a memory leak issue when using HDFS protocol in Binary Snaps.

4.26 Patch426patches11922LatestFixed an issue with the File Writer Snap, where the Snap failed to open a channel while accessing through a SFTP protocol.
4.26 Patch426patches11529Latest
  • Fixed an issue with the Decompress Snap, where the Snap prematurely uncompressed multi-stream BZIP2 files.
  • Enhanced the PGP Encrypt Snap with improved memory usage and also fixed an issue with this Snap, where the Snap failed to encrypt large size files due to the lack of memory.
4.26 main11181
StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch

425patches10994

 
Latest
  • Removed duplicate strings in the request’s User Agent header sent by  S3 File Writer and S3 File Reader Snaps to display the string without any duplicates.
  • Enhanced the Directory Browser Snap to process the files with the owner field for the SFTP protocol. Upon validation, the output of the Snap fetches the owner’s name, which was previously displayed as unknown.
  • Fixed an issue with the File Writer Snap where the Snap fails to connect to the SFTP endpoint using the AWS Transfer Family.
  • Fixed an issue where integration Pipelines fail to connect the SFTP Server with the Binary Snap Pack when upgraded to the SnapLogic 4.25 release version (main9554).
4.25 Patch425patches10217
 
Latest
  • Fixed the following issues in the PGP Decrypt Snap caused due to the Snap patch 425patches9581:
    • The Snap writes an empty document to the output view when there is an error in the Snap. It will now decrypt the document and write it to the output view only if it succeeds.
    • The Snap fails to decrypt any non-signed encrypted file more than 500 bytes. It will now decrypt both non-signed and signed encrypted files. 
    • Removed the Project ID field from the Google Service Account, since the JSON Key already contains information about the Project ID. 
4.25 Patch425patches9581
 
Latest

Fixed an issue with the PGP Decrypt Snap where the Snap writes an empty document to the output view when there is an error in the Snap. It will now decrypt the document and write it to the output view only if it succeeds.

As of  we have discovered an issue with this Binary patch affecting the PGP Decrypt Snap. In case your Pipelines use the PGP Decrypt Snap, we recommend you to NOT use this patch. Else, your Pipelines will likely fail. We're working on a fix and will be deploying a Snap patch soon.

4.25 Patch425patches9564
 
Latest

Enhanced the SFTP session in Binary Snaps to support the SFTP servers which close SFTP sessions slowly.

4.25main9554
 
Stable

Enhanced the S3 File Writer Snap with an ability to write S3objects with Access Control List (ACL) details in a single API call.

In the 4.23 release, the S3 File Writer Snap used to write an S3 file and then set ACL if the ACL property was not empty. If the file write was successful and the ACL setting failed, both the output document in the output view and the error document in the error view was displayed. This issue has been resolved in the 4.24 release by enabling the Snap to configure ACL while writing the file. Therefore, the Snap produces an error document in the error view if the ACL configuration fails, irrespective of whether the file write action passes or fails.

4.24 Patch424patches9044-Latest

Enhanced the S3 File Writer to use an MD5 checksum that automatically checks for data integrity and corruption while uploading the file.  

4.24 Patch424patches9020 
 
Latest

Fixed the file operation error of copying large S3 files in the File Operation Snap by supporting the transfer of zero-byte S3 files while uploading a file.

4.24 Patch424patches8876
 
Latest
  • Fixed the missing library error in Binary Snap Pack when running Hadoop Pipelines in JDK11 runtime.
  • Enhanced the Binary Snap Pack by adding a new account Two-Factor Auth Account that supports two layers of authentication for Secure File Transfer Protocol (SFTP). The two secure layers of verification to grant access include the Basic Auth (username/password) and the SSH Key (username/private key) methods.


4.24main8556
 
StableUpgraded with the latest SnapLogic Platform release.
4.23 Patch423patches8453
 
Latest

Fixed an issue in the File Writer Snap with the ADL protocol, to perform the correct action when OVERWRITE is selected from the File Action drop-down field.

4.23 Patch423patches8368-Latest

Fixed an encryption issue with the File Operation Snap by implementing both SSE-KMS and SSE-S3 supports to the Snap.

4.23 Patch423patches8368-Latest

Fixed an issue in the Snap Pack by removing the plaintext credentials in file URL from JCC log messages.

4.23 Patch423patches8099-Latest

Enhanced the Snap Pack by upgrading SMB client library.

4.23 Patch423patches7958-Latest

Fixed an issue with the File Writer Snap by avoiding overwriting of documents when using appending the data to a CSV file in SFTP.

4.23 Patch423patches7958-Latest

Rolled back the recent patch to Binary Snap Pack (File Writer Snap - 423patches7923) that might have induced SSL handshake failures/terminations in existing Pipelines. 

4.23 Patch423patches7923
Latest
  • Fixed the SFTP connection failure issue in File Writer Snap by
    • Ensuring that the BouncyCastleProvider is the first in the list of providers in the Security object.
    • Upgrading the BouncyCastle version to 1.67.

Do not use the 423patches7923 build for the File Writer Snap, because it causes connectivity issues with the Snaplex nodes.

4.23 Patch423patches7795-Latest

Fixed an issue with File Writer Snap by skipping the validation of the SAS URI having write permission, if the SAS URI uses an access policy.

4.23 Patch423patches7660-Latest

Enhanced the File Poller Snap by adding a field, Exit on first matches, which when set to true stops the Snap from executing after the first file paths matching the filter are written to the output view. If the field is not configured or is set to false (default value), then the Snap continues to poll the directory until the Polling timeout is reached.

4.23main7430-Stable

Enhanced the ZipFile Write Snap to provide the ability to change the default content-type (application/octet-stream) for any file that is stored into the Azure Blob Storage (WASB: or WASBS: file protocol). Hence, the files that the ZipFile Write Snap writes into the Blob Storage can be saved with content-type asapplication/zipor any other type instead of application/octet-streamalways.

You can now prevent the Snap from writing files always to Azure Blob Storage (WASB: or WASBS: file protocol) with the application/octet-stream content-type. To do so, configure a binary header property in an upstream Snap, such as JSON Formatter or Mapper, to match the file's content – application/zipapplication/java-archive and so on; and pass it as the $content-type (case-sensitive) for the file.

Binary header property in upstream Snap

4.22 Patch422patches6947-Latest

Fixed the issue of the hanging thread in the SMB accounts.

4.22 Patch422patches6950-Latest

Enhanced the S3 Dynamic Account by allowing to use the Security token field in Directory Browser, File Operation, File Poller, Multi File Reader, and File Delete Snaps. 

4.22 Patch422patches6629-Latest

Fixed the ZipFile Write Snap error by allowing the number of retries to be set greater than 0.

4.22 Patch422patches6542-Latest

Fixed SMB hanging threads by upgrading SMB client library.

4.22main6403-Latest
  • Added the Cross Account IAM Role feature to the existing accounts, AWS S3 Account and S3 Dynamic Account, to enable the AWS account user to access the resources of another AWS account for a specified time without sharing the login credentials.
  • Enhanced the File Operation Snap by adding a new property Simple file operation that allows moving or copying a file, through FTP protocol, irrespective of the account's access permissions on source and target directories.
4.21 Patch421patches6136-Latest

Fixed the issue with Multi File Reader Snap that continues to look for a directory even when FileSystem information is unavailable.

4.21 Patch421patches6090-Latest

Fixed the 'Connection pool shut down' error in S3 File Writer Snap by keeping the AmazonS3Client class object open until all the documents are processed.

4.21 Patch 421patches6077-Latest

Fixed the UnknownHostException error in Binary Snaps due to intermittent failures in FileSystemProvider registration, by replacing ServiceLoader with direct instantiations of FileSystemProvider class objects.

4.21 Patch421patches5994-Latest

Fixed an error in Multi File Reader and File Delete Snaps during Pipeline execution where the Snaps fail to retrieve the temporary files from the given S3 location.

4.21 Patch 421patches5963-Latest

Enhanced the Directory Browser Snap by making the File filter field optional.

4.21 Patch421patches5975-Latest

Fixed the Directory Browser Snap that fails with an Unable to create filesystem object for smb:// error, by rolling back the SMB client library to the prior working version as in snapsmrc542.

4.21 Patch421patches5871-Latest

When configuring the SSH Auth account type, SSH passphrase is now optional, whereas it was a required field earlier. 

4.21 Patchbinary8849-Latest

Enhanced the Directory Browser Snap by adding a new advanced property Use fast file-type check for wasb/wasbs protocols for quick Snap execution. 

4.21 Patchbinary8843-Latest

Fixed the issue in PGP Encrypt Snap where decrypting its output file using a third-party PGP software adds a random suffix and TMP extension in the file name. This issue occurs only when using the PGP Encrypt Snap in a Windows-based Groundplex.

4.21snapsmrc542-StableUpgraded with the latest SnapLogic Platform release.
4.20 Patchbinary8801-Latest
  • Fixed the Decompress Snap wherein the Snap stops decompressing at 64MB without displaying any error, when decompressing using the GZIP scheme.
  • Fixed an issue in the PGP Encrypt Snap so that third-party decryption tools do not receive a .tmp file from the Snap.   
4.20 Patchbinary8791-Latest

Fixed the ZipFile Write Snap wherein the Snap fails to execute if it finds different zip file paths when processing multiple input binary data.

4.20 Patchbinary8785-Latest
  • Added the User-defined object metadata and Object tags properties in the S3 File Writer Snap and the Get Object Tags property in the S3 File Reader Snaps to allow the inclusion of user-defined metadata and object tags.
  • Fixed a regression caused by Patch binary8775 wherein the File Reader and S3 File Reader Snaps fail to read S3 files with an account that does not include GetObjectTagging permission.
4.20 Patchbinary8775-Latest

Fixed the File Writer Snap to allow the deletion of temporary Google Storage files from the /tmp directory of the Groundplex if Pipeline execution stops before completion. 

4.20 Patchbinary8741-Latest
  • Fixed the ZipFile Write Snap wherein the Snap gives a Null Pointer Exception error if no input data is received by it during execution. 
  • Fixed the Email Sender & Reader Snaps where the Snaps fail to execute due to resource exhaustion on the Snaplex.
4.20 Patchbinary8710-Latest
  • Fixed the ZipFile Write Snap where the Snap generates files with incorrect names when the Use input view label checkbox is selected.
  • Fixed the File Writer Snap where the Snap fails intermittently when there is a network disruption.
  • Fixed the File Reader Snap where the Snap generates an output view, along with the error view, if there is an error when using the Google Service account.
4.20snapsmrc535-StableUpgraded with the latest SnapLogic Platform release.
4.19 Patchbinary8369-Latest

Fixed the following issues associated with the SMB account wherein:

  • Pipelines with multiple concurrent SMB connections hang intermittently.
  • Directories are not deleted completely.
4.19snaprsmrc528-Latest
  • The Key Passphrase field is now a mandatory field for the SSH Auth account. Ensure that you provide a passphrase when adding/editing accounts. Else, you will likely lose all updates related to the account and Pipeline.
  • Raises the minimum buffer size in the S3 File Writer Snap to 6 MB.
4.18 Patchbinary8768-Latest
  • Fixed the File Reader, File Writer, and Directory Browser Snaps to resolve 0x103 (STATUS_PENDING) and 0xc000022d (STATUS_RETRY) errors for SMB file operations.
4.18 Patchbinary8046-Latest

Enhanced the Snap Pack to support AWS SDK 1.11.634 to fix the NullPointerException issue in the AWS SDK. This issue occurred in AWS-related Snaps that had HTTP or HTTPS proxy configured without a username and/or password. 

4.18 Patch MULTIPLE7884-Latest

Fixed an issue with the PostgreSQL grammar to better handle the single quote characters.

4.18 Patchbinary7860-Latest

Fixed an issue with the File Writer Snap wherein the Snap is intermittently unable to set correct permissions.

4.18 Patch

binary7851

-Latest
  • Added new field, Advanced properties, in the File Reader, File Writer, File Delete, ZipFile Read, ZipFile Write, Directory Browser, Multi File Reader, File Poller, and File Operation Snaps. Use this field to configure the SAS URI to access Azure Storage. Supported SAS types are Service SAS on container, Service SAS on blob, and Account SAS.
  • Added new Snap, SAS Generator. This Snap enables you to generate Shared Access Storage (SAS) URIs for accessing Azure Storage containers and blobs.
4.18 Patchbinary7746-Latest

Fixed an issue with the SMB file protocol wherein Binary Snaps are unable to create a native thread using an SMB file path.

4.18 PatchMULTIPLE7778-Latest

Updated the AWS SDK library version to default to the Signature Version 4 Signing process for API requests across all regions.

4.18 Patchbinary7720-Latest

Fixed an issue with the ZipFile Read Snap wherein the Snap fails to extract files from a zip file heavier than 100MB when the number of retries is greater than zero.

4.18snapsmrc523-Latest

Added a new account type, Google Service Account, which enables you to isolate workflows from individual users.

4.18snapsmrc523-Latest

Added a new account type, Google Service Account, which enables you to isolate workflows from individual users.

4.17 Patch binary7589-Latest

Fixed an issue with the File Reader Snap wherein SMB fails to provide multiple Snaps with concurrent access.

4.17 Patch binary7487-Latest

Fixed an issue with the File Writer Snap wherein the Overwrite File action for SMB files fails on subsequent executions.

4.17 PatchALL7402-Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17 Patch binary7381-Latest

Fixed an issue with SMB accounts wherein login to the server fails if password contains a plus (+) sign.

4.17 Patchbinary7366-Latest

Added support for multiple slashes as a prefix for SMB file URLs.

4.17 Patchbinary7280-Latest

Added a new field, File Delete Action, to the File Delete Snap that handles missing target files.

4.17 Patchsnapsmrc515-Latest
4.16 Patchbinary7049-Latest

Fixed an issue with the File Writer Snap wherein the Snap writes FTPS files partially. Two new global properties, ftpsDelayBeforeClosing and ftpDelayBeforeClosing, enable you to add delays to the FTP file protocol to handle the partial write. 

4.16 Patchbinary7049-Latest

Fixed an issue with the File Writer Snap wherein the Snap writes FTPS files partially. Two new global properties, ftpsDelayBeforeClosing and ftpDelayBeforeClosing, enable you to add delays to the FTP file protocol to handle the partial write. 

4.16 Patchbinary6975-Latest

Added a new property, Blob endpoint, for Binary Accounts, which enables you to specify the Azure Blob Storage endpoint that you want to use with an Azure Storage account. 

4.16snapsmrc508-Latest

Added a new property Only Output on Change in the File Poller Snap. This property helps avoid redundancy by not displaying the same matching file in every polling result unless the file is changed.

4.15 Patchbinary6744-Latest

Fixed a timeout error while writing to S3 in the S3 File Writer Snap.

4.15 Patchbinary6414-Latest

Fixed an issue wherein the hostname specified in the Directory Browser path failed to appear as a path in the output document.

4.15 Patchbinary6414-Latest

Fixed an issue wherein the hostname specified in the Directory Browser path failed to appear as a path in the output document.

4.15snapsmrc500-Latest

Added a new property, Binary Header Properties, to the CSV Formatter Snap. This property can be configured with the binary headers and their values in the incoming document.  

4.14 PatchMULTIPLE5732-Latest

Fixed an issue with S3 file reads getting aborted intermittently because of incomplete consumption of input stream.

4.14snapsmrc490-Latest

Enhanced the Basic Auth and Symmetric Crypto accounts to support pipeline parameters. Using pipeline parameters, Basic Auth now supports passing username and password, and Symmetric Crypto now supports passing secret key dynamically.

4.13 Patch

binary5372

-Latest

Updated the File Operation Snap for S3 to support files larger than 5GB by using an API for multipart upload copy.

4.13 Patch binary5315-Latest

Added a new property "Enable staging" to enable the File Reader and S3 File Reader Snaps to perform as expected even in a slow network connection to AWS S3.

4.13snapsmrc486-Latest

Added AWS Key Management Service (KMS) encryption support to AWS S3 and S3 Dynamic accounts in the Binary Snap Pack.

4.12binary5044-Latest

Fixed an issue with the S3 File Writer Snap, which corrupts while writing files if retry value is set to 1.

4.12 Patchbinary4882-Latest

Fixed issue caused in the File Operation Snap due to the rollback after the 4.12 release that impacted the S3 and FTP protocols. 

4.12 Patchbinary4840-Latest

Fixed an issue in the File Delete Snap, wherein if no account is given for the SFTP protocol, then the error did not display.

4.12 Patchbinary4797-Latest

Added a new property 'Number of retries' in the File Writer Snap to fix interoperability issues with a server software.

4.12 Patchbinary4736-Latest

Fixed the issue where File Writer Snap does not write files to Windows Serv-U FTP server, while not displaying any error message.

4.12snapsmrc480-Latest
  • Added new Snaps - File Operation Snap and S3 File Reader Snap.
  • Updated S3 File Writer Snap to provide suggestions for S3 buckets and file names (versioning support).
4.11 Patchbinary4424-Latest

Resolved an Issue with SFTP server where the pipeline stopped responding while writing to the Tumbleweed server (SFTP server). Fixed the code in a way that the SFTP server now flushes out data after each write.

4.11 Patchbinary4328-Latest

Fixed an issue with the File Delete Snap that was unable to delete the file with a size greater than 1MB.

4.11 Patchsnapsmrc465-Latest
  • Added the new Snaps, Multipart Reader and Multipart Writer.
  • Updated the S3 File Writer Snap with Maximum upload threads property to support the performance.
  • The File Reader and the ZipFile Reader Snaps now show the progress message during the pipeline runtime.
4.11binary4019-Stable

Resolved an issue with the File Writer Snap writing to an FTP Server that may prematurely close the connection; this patch ensures the write has fully completed before disconnecting.

4.10 Patchbinary3930-Latest

Directory Browser - When "Ignore empty result" is not selected, the "original" passthrough document is now returned even when the S3 directory is empty.

4.10 Patchbinary3840-Latest

S3OutputStream handles failures.

4.10snapsmrc414-Stable

No updates made. Automatic rebuild with a platform release.

4.9 Patchbinary3331-Latest

Directory Browser Snap - fixed NPE issue, "File filter" property, and "Display update time and owner for S3 subdirectories" property.

4.9 Patchbinary3183-Latest

Fixed SFTP connection leak when "Validate after write" is checked for File Write Snap.

4.9 Patchbinary3170-Latest

Addressed the following issue in Directory Browser: "Update time" being returned "unknown" for directories within S3 objects

4.9 Patchbinary3081-Latest

Added ability to sign PGP encrypted files.

4.9 Patchbinary3060-Latest

Addressed an issue in Directory Browser and fixed issue in writing the original document to output view when reading from S3.

4.9 Patchbinary3022-Latest

Addressed an issue regarding an array out of bounds exception when IAM Role is enabled.

4.9 Patchbinary3000-Latest
  • Restore the update date date-time format for using Directory Browser with S3. A new property Display update time and owner name for s3 subfolders was added that, when enabled, will calculate update times and owners on AWS S3 subfolders.
  • Added the IAM support to the AWS S3 account.
4.9Snapsmrc405-Stable

No updates made. Automatic rebuild with a platform release.

4.8 PatchSnapsmrc405-Latest

Addressed an issue with Directory Browser taking too lont to start listing files from S3 bucket and then failing with partial results due to CPU spikes.

4.8Snapsmrc398-Latest
  • Info tab added to accounts.

  • Streaming performance improvement while writing to an S3 bucket using S3 File Writer. Updated the S3 File Writer Snap with a Buffer size(MB) property.
  • The 'content-location' in the output header of Binary Snaps was updated to correctly reflect the location (for example, sldb:/// instead of sldb://). This may impact your Pipeline if you are using this information in the following Snaps: File Reader, AES Encrypt, AES Decrypt, BlowFish Encrypt, Blowfish Decrypt, Compress, Decompress, File Writer, Multi File Reader, PGP Encrypt, PGP Decrypt, TwoFish Encrypt, TwoFish Decrypt, or S3 File Writer.
4.7.0 Patchbinary2346-Latest

ZipFile Read Snap: Added support for reading 7z archive formats created using Windows machines.

4.7.0 Patchbinary2337-Latest

Added Encrypted filename property to PGP Encrypt Snap.

4.7Snapsmrc382-Latest
  • Updated the Snap Account settings with a new Account Type, Azure Data Lake.
  • Updated the Snaps- Directory Browser, File Writer, File Reader with the account Type, Azure Data Lake.
  • Updated the File Reader and ZipFile Read Snaps with the property, Prevent URL encoding.
  • Spark mode support added to S3 File Writer for AWS S3.
  • Spark mode support added to File Reader for AWS S3.
4.6.0 Patchbinary2110-Latest

File Writer: fixed an issue on Windows Snaplexes that prevented creating directories that are not present.

4.6.0 Patchbinary2009-Latest

File Writer: fixed an issue on Windows Snaplexes that prevented creating directories that are not present.

4.6.0 Patchbinary1898-Latest

File Reader and ZipFile Reader Snaps: Added a new "Prevent URL encoding" setting to allow users to disable automatic URL encoding of file paths. This allows pre-encoded URLs and file paths to be used as-is.

4.6.0 Patchbinary1851-Latest

Resolved an issue with Directory Browser Snap not freeing up connections in Windows Groundplex.

4.6.0Snapsmrc362
Stable
  • Binary Snaps that work with AWS S3 accounts can now configure their accounts with IAM Role.
  • Enhanced the File Writer Snap with an option to create a directory if the specified directory path does not exist, the newly added field, Create directory if not present.
  • Updated based on the currently supported account types.  The supported account types are: Basic Auth, AWS S3, S3 Dynamic, SSH Auth, SMB, Azure Storage, and Google Storage.
4.5.1 binary1563-Latest
  • File Reader, ZipFile Read, Multi File Reader Snaps are updated with the Execute during preview field to execute the Snap during the Save operation so that the output view can produce the preview data. For more information, see File Reader, ZipFile Read, & Multi File Reader.
  • File Delete & File Writer Snaps are updated with an option to validate file deletion & file writing after Snap execution. For more information, see File Delete & File Writer.
  • ZipFile Write Snap is updated with an option, Use input view label, to enable sequential file naming of files added to zip file. For more information, see ZipFile Write.
  • Fixed an error in File Reader Snap that exposed account credentials in an error message.
  • Fixed an error in File Writer & File Delete Snap to ensure consistent error handling for all the protocols.
4.5Snapsmrc344-Stable
  • File Reader, File Writer, S3 File Writer, ZipFile Read, Directory Browser, Multi File Reader, File Poller, File Delete, ZipFile Write, HDFS Reader and HDFS Writer updated to support IAM Roles for Amazon EC2.
  • Support for Google Storage added to File Reader, File Writer, Directory Browser, Multi File Reader, File Poller, File Delete, ZipFile Read, and ZipFile Write Snaps.
  • Resolved an issue in File Writer Snap that occurred when writing to an SFTP file with an SSH account.
  • Resolved an issue in Multi File Reader Snap that occurred when adding error views and performing binary data streaming.
  • Doc Enhancement: Example added to File Delete Snap.
4.4.1--Latest
  • A new Snap property Write empty file has been added to File Writer and S3 File Writer Snaps to allow for creation of zero byte files. 
  • Resolved an exception in File Writer when 'file name' has no value.  
  • ZipFile Read: "zip-filename" was added to the header of the output binary document.
4.--Stable
  • Resolved an issue with File Writer failing to timeout when attempting to connect to an SFTP location that was unreachable.
  • Resolved an issue with File Reader failing validation is FTP connection password had special characters.
  • Support for WASB and WASBS in Directory Browser, Multi File Reader, File Delete, File Poller, ZipFile Read, and ZipFile Write Snaps.
4.3.2--Latest
  • NEW! S3 File Writer
  • Implemented wasbs:// protocol support in Binary Snap Pack.

    In the SnapLogic 4.3.2 release, WASB (Windows Azure Storage Blob) or WASBS protocol (wasb:/// or wasbs:///) support has been added to the Binary Snaps.

    In the WASB and WASBS file URL, the top directory should be the name of the 'Azure Storage container'.

    The follow line should be added to global.properties file and the jcc restarted to have the Azure Storage support available:

    	jcc.jvm_options = -DDEFAULT_URL_PATTERN=.*.core.windows.net.*
  • Resolved an issue with Directory Browser Snap returning Invalid Path.
4.3.1---
  • Feature: Enhanced File Delete Snap to support S3 protocol.
  • Resolved an issue with smb pathname failing when directory name contained a space.
  • Resolved an issue with a pipeline  showing as successful when writing to a project to which it had no access.
  • Resolved an issue with Directory Browser not returning any data when target files were not present. The option, Ignore empty result, now allows you to determine whether or not to output an empty document of no data is passed through.
4.3.0---
  • File Reader and File Writer now support Azure Blob as a file protocol.
  • Support for specifying another Windows drive path added to Directory Browser, File Poller, Multi File Reader, File Reader, and File Writer.
  • File Delete no longer displays user credentials in error messages.
  • Resolved an issue with File Poller failing to properly determine directories versus files in an S3 path.

4.2.2

---
  • Resolved an issue with the ZipFile Read Snap failing to decompress a zip file.
  • Resolved an issue with MultiFile Reader not able to read UNC-syntax local files in Windows Groundplex.
  • Resolved an SFTP I/O error with File Read.
  • Resolved an issue in SFTP pooling when a large number of connections are opened for both pooling enabled and disabled.
  • Resolved an issue in File Poller where setting Polling timeout to a negative number below -1 caused the Snap to run forever.
  • Resolved an issue in AES Snap with 256 bit keys.
  • Resolved a file size issue in File Writer with the Dropbox FTP site.
4.2.1-
 
-
  • NEW! File Poller Snap. This Snap polls a directory looking for files matching the specified pattern.
  • PGP Decrypt now supports files that are encrypted and signed.
  • Resolved Directory Browser unable to support file protocol on Windows Groundplex
  • Resolved Multi File Reader File protocol is not working for Windows Groundplex
Summer 2015---
--
 
-
  • ZipFile Read Snap hangs when the File property is evaluated to a binary object too large to be a file URL
  • Directory Browser: Unexpected results when using SFTP protocol paths
  • SMB ClearText credentials visible for incorrect connection string
--
 
-
  • File writer Snap - Null pointer exception resolved - Better reporting on ftps errors
  • Directory Browser Snap listed wrong path for S3 sub-directories
--
 
-
  • Directory Browser: added pass-through capability
  • File Delete: resolved an error writing to network stream
  • File Writer: The output view field "fileAction" has changed to "result", web HDFS enhancements
--
 
-
  • Compress and Decompress: Resolved an issue with pipeline preview not limiting the amount of data available in preview.
  • File Writer: Improved error messages.

Multi File Reader: Resolved an issue were some files were read twice if Include subfolders was selected when using the S3 protocol.

--
-

Tooltip cleanup

--November 2014-

File Writer now lets you set file permissions.

--July/Summer 2014-

NEW! ZipFile Read and Write

--April 2014-

File Writer Snap updated to allow for appending, overwriting, ignoring or erroring out if the file already exists.

--March 2014-
  • NEW! Encrypt and Decrypt Snaps for AES
  • NEW! Encrypt and Decrypt Snaps for Blowfish
  • NEW! Encrypt and Decrypt Snaps for Twofish
  • NEW! Directory Browser
  • Execute during preview was added to the File Writer Snap.
--January 2014-

An output view was added to File Writer.

--December 2013-
  • NEW! File Delete Snap
  • NEW! PGP Decrypt and PGP Encrypt
--November 2013-
  • NEW! Compress and Decompress
  • Writer Snaps can now be enabled to write during preview.
  • Reader Snaps allow you to pass through data from the input view. The output of the reader will provide a new document element holding the original data from the input view (under original).
--July 2013-

There are now separate Snaps for reading a single file into SnapLogic and reading multiple files (File Reader and Multi File Reader).

--June 2013-

Initial release. Read/write support for popular data formats: Binary, CSV, HTML, JSON