Input 

Document

• Min: 1

• Max: ∞

Downstream Snap is optional. Any Snap with a document input view can be connected downstream.

The Snap does not require input data. Input documents may be used to evaluate any JavaScript expression in the File property. It may contain value(s) to evaluate the JavaScript expression in the File property.

Output

Binary

• Min: 0

• Max: 1

• File Writer

• Binary Router

• JSON Parser

Binary data read from the source specified in the File property with header information about the binary stream.

Each file extracted from the provided zip file is written as binary object to this output view. The header of the binary object has details about the file extracted like content-location, content-type, content-length, last-modified, and zip-filename.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

• Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

sldb

no account

s3

AWS S3

ftp

Basic Auth

sftp

Basic Auth, SSH Auth 

ftps

Basic Auth

hdfs

no account

http

no account

https

no account

smb

SMB

wasb

Azure Storage

wasbs

Azure Storage

gs

Google Storage

Basic Auth

Username, Password

AWS S3

Access-key ID, Secret key

SSH Auth

Username, Private key, Key Passphrase

SMB

Domain, Username, Password

Azure Storage

Account name, Primary access key

Google Storage

Approval prompt, Application scope, Auto-refresh token
(Read-only properties are Access token, Refresh token, Access token expiration, OAuth2 Endpoint, OAuth2 token and Access type.)

Field Name

Field Type

Description

Label* 

Default Value: ZipFile Write
Example: ZipFile Write

String

Specify a unique name for the Snap.

File name*

Default Value: N/A
Example: contact.zip

String/Expression

Specifies the URL of the file where the output binary data is written. The supported file protocols are:

• sldb:

• http:

• sftp:

• ftp:

• ftps:

• s3:

• hdfs:

• webdhfs:

• smb:

• wasb:

• wasbs:

• gs:

This Snap supports S3 Virtual Private Cloud (VPC) endpoint. For example, s3://my-bucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com
This property works similar to the File name property of the File Writer Snap. For additional information refer the Settings section of the File Writer Snap.

When using expressions to build a file name, ensure that the resulting file name does not contain characters that are not supported by the target platform. For example, a file name that contains the special character ":" is not supported in SMB.

File action*

Default value: Overwrite
Example: Ignore

String/Expression

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

• Overwrite: If Overwrite is selected, the Snap attempts to write the file without checking for the file's existence for  better performance and the "fileAction" field will be "overwritten" in the output view data.

• Ignore: The Snap does not overwrite the existing file and will do nothing but write the status and file name to its output view.

• Error:  If Error is selected, the error displays in the Pipeline Run Log. If an error view is defined, the error will be written there as well.

Base directory

Default Value: N/A
Example: testFolder

String

The root directory for all the files added to .zip file.

Use input view label

Default Value: Deselected  

Checkbox

If true, the input view label is used for all names of the files added to the zip file. Otherwise, the input view ID is used instead, when input binary stream does not have its content-location in its header. When this option is selected, if there are more than one binary input streams in an input view, for the second input stream and after, the file names will be the input view label appended with '_n'. If the label is in the format of 'name.ext', '_n' will be append to the 'name', e.g. name_2.ext for the second input stream.

Number of retries

Default Value: 0
Example: 3

Integer/Expression

Specifies the maximum number of retry attempts when the Snap fails to write. If the value is larger than 0, the Snap first stores the input data in a temporary zip file before writing to the target file.

Minimum value: 0

Retry interval (seconds)

Default Value: 1
Example: 3

Integer/Expression

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

Minimum value: 1

AWS Canned ACL

Default Value: 1
Example: PublicRead

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

Watch the video for more information about AWS Canned ACL.

Learn more about AWS Canned ACLs.

Advanced properties

Use this field set to define additional properties for the Snap.

SAS URI

Dropdown

The URI of the Shared Access Storage (SAS) to be accessed. Supported SAS types are:

• Service SAS on container

• Service SAS on blob

• Account SAS

Values

String/Expression

Provide a value for the SAS URI.

Dropdown list