Skip to end of banner
Go to start of banner

S3 File Reader

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 39 Next »

On this Page

Snap Type:Read
Description:

This Snap reads any type of data from an S3 bucket. If a value is given in the Version ID property, it will read the specific version of an S3 file object. The suggest features can be used to view and select S3 buckets, sub-directories, files, and version IDs.

ETL Transformations & Data Flow

This Snap extracts data from S3 buckets. 

Input & Output

  • Expected input: An upstream Snap is optional and any Snap with a document output view can be connected upstream (such as Mapper, File Writer, and so on). Any document with key-value pairs to evaluate expression properties in the S3 File Reader Snap. Each input document, if any, will cause one read operation of the Snap.
  • Expected output: Any Snap with a binary input view can be connected downstream, such as CSV Parser, JSON Parser, XML Parser, and so on. Binary data read from AWS S3 specified in the File property with header information about the binary stream. The binary data and header information can be previewed at the output of the Snap. An example is: 
 Click here to expand...
Prerequisites

IAM Roles for Amazon EC2

The IAM_CREDENTIAL_FOR_S3 feature is to access S3 files from Groundplex nodes hosted in the EC2 environment without Access-key ID and Secret key in the AWS S3 account in the Snap. The IAM credential stored in the EC2 metadata provides access rights to the S3 buckets. 

 Steps 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. Click + to add a new row in the Global properties section.
  6. Enter jvm_options in Key and -DIAM_CREDENTIAL_FOR_S3=TRUE in Value.

  7. Restart the JCC (node).
  • IAM role is supported only in the Groundplex nodes hosted in the EC2 environment.
  • The IAM Role stored on the EC2 instance requires List, Read, and Write permissions.

  • S3 account validation is not supported when you enable IAM role property. 

For more information on IAM Roles, see IAM Roles for Amazon EC2.

Support and Limitations

Works in Ultra Pipelines.

The current Snap functionality supports AWS S3 Cloud Service and will be applicable for AWSGovCloud setup.

Configurations

Account & Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Binary Accounts for information on setting up accounts that work with this Snap.

Required settings for account types are as follows: 

  • AWS S3 - Access-key ID, Secret key, Security token.
  • S3 Dynamic - Access-key ID, Secret key, Security token, Server-side encryption.

Views

InputThis Snap has at most one document input view. 
OutputThis Snap has exactly one binary output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.
Troubleshooting:The section describes typical issues you may encounter while using this Snap, and instructions on how to workaround them:

Settings

Label

Required. 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.
File

Required. This property specifies the URL for the S3 file, from where the binary data is to be read. It must start with "s3:///". The suggest feature can be used to view the list of buckets, subdirectories and files. Bucket names are suggested if the property is empty or "s3:///". Once a bucket is selected, 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 "=" button pressed.

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. 

See AWS Regions and Endpoints for details.

Examples

  • s3:///mybucket@s3.eu-west-1.amazonaws.com/test.json
  • s3:///rds-sql-test-staging@s3.us-gov-east-1.amazonaws.com/test.csv
  • _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)

Default value:  s3:///

Version ID

Enter or select S3 file version ID. If the property is empty, the Snap reads the latest version. The suggest feature can be used to view the list of version IDs for the S3 file in the File property. The suggest feature is not supported if the properties in the S3 Dynamic account are parameterized. Each line in the suggested list also includes the last modified date and the file size to help select a version. When the property value is entered manually, only the version ID is needed. The Snap ignores the last modified date and size information of a version when it reads the file. If the versioning of a S3 bucket is not enabled, no version ID is suggested. The versions of the following cases will be omitted in the suggested list since their files cannot be downloaded: 

  • If a file had existed before the versioning was enabled, its version does not have any version ID assigned to it.
  • Version ID's with 'Deleted Marker' resource type are also omitted in the suggested list.

Examples:   xvcnB8gPi37l3hbOzlsRFxjVwQ.numQz

Default value:  [None]

Version ID suggestion intervalEnter the time interval for the Version ID suggestion. Enter two rows to provide a start date and an end dates. If only one row is provided, the interval will be from the date until now. If empty, all version IDs will be suggested. This property may be useful when a given S3 file has many versions. This property is used for the Version ID suggestion only, and not used during the Snap preview or execution.
Year

Enter the year as a 4-digit integer.

Example:  2017

Default value:  [None]

Month

Enter the month as an integer.

Examples:   9, 09, 12, and so on.

Default value:  [None]

Date

Enter the day of the month.

Examples:   28, 09, 12, and so on.

Default value:  [None]

Zone

Enter or select a time zone ID from the suggested list. May be empty for UTC. Please note only zone IDs in the suggested list are supported.

Examples:   US/Pacific

Default value:  [None]

Enable staging

If selected, the Snap downloads the source file into a local temporary file. When the download is completed, it streams the data from the temporary file to the output view. This property prevents the Snap from being blocked by slow downstream pipeline. The local disk should have sufficient free space as large as the expected file size. 

Default value: Not selected

Some Snaps may take a long time to process large amounts of data. This, in turn, could lead to connection timeouts, causing the pipeline to fail. Selecting this property saves the data on your local disk, enabling you to avoid such timeouts.

Number of retries

Specifies the maximum number of retry attempts that the Snap must make in case there is a network failure, and the Snap is unable to read the target file.

If the value is larger than 0, the Snap overrides the Enable staging value to true and downloads the S3 file to 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 starts to stream the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

Ensure that the local drive has sufficient free disk space to store the temporary local file.

Example:  3

Minimum value: 0

Default value: 0

  • 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.
  • Ensure that the local drive has sufficient free disk space to store the temporary local file.

Retry interval (seconds)

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

Get Object Tags

Select this check box to include object tags in the header of the output binary data. See Object Tagging for more information on object tags.

You must have the S3:GetObjectTagging permission to be able to use this feature.

Default value: Not selected

Snap execution

Page lookup error: page "Anaplan Read" not found.

If you're experiencing issues please see our Troubleshooting Guide.

Examples


Basic Use Case

The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:










The Snap is configured with the following parameters:

A preview of the output from executing this pipeline is shown below:

The exported pipeline is available in the Downloads section below.

Typical Snap Configurations

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

  • Without Expressions: Values are passed directly in the Snap.

         

  • With Expressions:
    • Using pipeline parameters: Values are passed as pipeline parameters:

                    


A few examples of how the Snap's suggestion works:


 Sample S3 File Reader Snap with bucket names suggested

 Sample S3 File Reader Snap with sub-directories and files suggested

 Sample S3 File Reader Snap with all version IDs suggested without interval

 Sample S3 File Reader Snap with Version ID suggestion interval and time zone IDs suggested

 Sample S3 File Reader Snap with version IDs suggested with interval from 11/21/2017 to 11/30/2017 (as given above)

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
You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
No files shared here yet.
  • Drag and drop to upload or browse for files
  • See Also

    Snap Pack History

     Click to view/expand


    Release Snap Pack VersionDateTypeUpdates
    February 2024436patches25711 Latest

    Fixed an SMB (server message block) connectivity issue within the Binary Snap Pack, as the incorrect name provided by the SMB client did not match the Windows cluster virtual name, affecting the SPN (service principal name) connection.

    February 2024436patches25332 Latest

    Fixed a null pointer exception in the Public Key Account for Binary Snap Pack when the Public Key field value is null. Now, the account displays a configuration exception for a null value.

    February 2024436patches25241 Latest

    Fixed an issue with the File Writer Snap, which partially writes the file for some FTPS servers by pausing for seconds before closing the output stream as specified in the global property ftpsDelayBeforeClosing.

    February 2024436patches25161 LatestFixed an issue with the File Poller Snap that displayed an exception when an unauthorized character ':' was used in the Windows Snaplex.
    February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
    November 2023435patches24525 LatestFixed an issue with the File Poller Snap that caused it to poll recursively for files in the root directory of the S3 bucket.
    November 2023435patches23780 Latest

    Fixed an issue with the Binary Snaps that failed to build a data connection when connecting to the FTP server over FTPS protocol.

    November 2023main23721 Stable

    Updated and certified against the current SnapLogic Platform release.

    August 2023434patches23502 LatestFixed an issue with the File Operation Snap (SFTP protocol) where the error message did not display during a move operation, although the existing file was available in the target path and the Error if exists checkbox was selected.
    August 2023434patches23302 Latest

    Fixed an issue that occurred when node properties were used to override default algorithm specifications for SFTP operations.

    August 2023434patches22976 LatestFixed an issue that caused account credentials to be visible in the stack trace of some failed SFTP operations.
    August 2023434patches22842 Latest

    Fixed an issue that caused NTLM authentication issues when trying to access SMB servers.

    August 2023434patches22639 Latest

    The JSON key field in the Binary Google Service Account supports JSON strings. You can upload the JSON key either from SLDB or dynamically pass the value using a pipeline parameter or access values from Secrets Manager.

    August 2023

    main22460

     


    Stable

    Updated and certified against the current SnapLogic Platform release.

    May 2023433patches22297 Latest
    • Fixed an issue with the PGP Sign Snap that caused an error when using an encryption subkey for signing.
    • Fixed an issue with the File Writer Snap where the file was unable to validate when the File action field was set to IGNORE for the WASB and WASBs protocols.
    May 2023

    433patches21913

     Latest
    • Dynamic ports are supported for the SMB file protocol.
    • Fixed an issue with the File Writer Snap that caused slow performance when writing large files and the Flush interval was set to a positive value.
    May 2023433patches21870 LatestAdded the PGP Sign Snap, which allows binary data to be signed using PGP.
    May 2023

    433patches21645

     Latest

    With the 4.33 GA release, support for some algorithms for SFTP connection negotiation is removed for improved security and because we’ve updated the library used to connect to SFTP sources. With Snap Pack version 433patches21645, you can modify the global properties. Refer to the Configuration Settings for Snaps documentation for details about how to revert to the previous settings.

    May 2023433patches21576 Latest

    Fixed the issues with the AES Encrypt and AES Decrypt Snaps, where the Snaps previously did not include the error stack trace in the error view. The Snaps now provide detailed information in case of any issues or errors.

    May 2023433patches21482 Latest
    • Fixed an issue that caused a String index out of range error with the SFTP protocol in the File Writer Snap when it attempted to create a top-level directory.

    • Enhanced the PGP Encrypt Snap with the Encryption key ID field, which allows you to specify the key ID for encrypting the data. If you do not specify an encryption key ID, the Snap uses the primary key in the public key (master key).

    Starting from version 433patches21482, the PGP Encrypt Snap will no longer support encryption with an expired key. To ensure continued support for encryption, we highly recommend extending the expiration of your PGP key.

    May 2023433patches21291 LatestFixed an issue with the Multi File Reader Snap where it failed with the error S3 object not found when the Snap found no matching file to read and the Folder/File property value did not end with a forward slash (/).
    May 2023433patches21179 Latest
    • Fixed an issue with the File Delete Snap where the Snap failed with a 404 Not Found error when trying to delete files from an Amazon S3 bucket. This issue occurred only with the Identity and Access Management (IAM) role in an Amazon AWS S3 Account.

    • Fixed an issue where Binary Snaps could not handle region information for the Amazon S3 file protocol, which resulted in an error.

    May 2023main21015 Stable

    The Key passphrase field in the Private Key Account now supports expressions, allowing dynamic evaluation using pipeline parameters when the expression button is enabled.

    February 2023

    432patches20458

     Latest

    Fixed an issue where the ZipFile Read and ZipFIle Write Snaps failed to display the input schema for the File or File name field when using an expression.

    February 2023432patches20431 Latest
    • Fixed an issue where the File Writer Snap would not retry on completing the writing of the file.

    • Added a configuration warning message when using the WASBS protocol with AzCopy, as it supports only the HTTPS protocol.
    February 2023432patches20349 Latest

    The JSCH library has been upgraded to version 0.2.7.

    February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
    November 2022431patches18977 Latest

    The PGP Decrypt Snap now allows you to skip the signature verification when you face an issue with the signature in the encrypted file.

    November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
    September 2022430patches17933 Latest
    • The File Delete Snap now passes the input document to the error view correctly.

    • The AWS S3 and S3 Dynamic accounts now support the maximum session duration of an IAM role defined in AWS.

    August Patch

    430patches17292

     Stable and Latest

    Fixed an issue with the Directory Browser Snap, which failed with a null pointer exception error when connecting to the SFTP server containing a port number.

    The Binary Snap Pack is deployed as both the latest and stable distribution. We recommend that you use this version for your Org when using the recommended Snaplex version (main-13269 - 4.30 GA).

    August 2022main17386 Stable
    • The File Operation Snap supports moving data from a local node to an Azure blob through the AZ Copy utility.

    • The Azure Storage Account includes the Request Size (MB) field to set the buffer limit before writing to Azure storage to enhance the performance.

    • The SSH Auth Account supports dynamic values for the following fields that allow you to use Pipeline parameters.

      • Username

      • Private key

      • Key passphrase

    4.29 Patch

    429patches16569

     Latest
    4.29 Patch429patches15842 Latest
    • Improved the tooltip for the File action field in the ZipFile Write Snap.
    • 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 if 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

    • No labels