Versions Compared

Old Version 48

changes.mady.by.user Cindy Hall

Saved on

compared with

New Version 49

changes.mady.by.user Cindy Hall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

Limitations

None.

Known Issues

...

Multiexcerpt include macro
nameBinary Snaps algorithm negotiation fail
templateData[]
pageDirectory Browser
addpanelfalse

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

Upstream Snap is optional. Any Snap with a document output view can be connected upstream.

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: 1

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

...

Field Name

Field Type

Description


Label*

Default Value: ZipFile Read
Example: ZipFile Read

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.

File*


Default value: [None] 
Example: contact.zip


String/Expression

Specify the URL for the zip file source. It should start with a file protocol. The supported file protocols are:

  • http

  • https

  • s3

  • sftp

  • ftp

  • ftps

  • sldb

  • smb

  • wasb

  • wasbs

  • gs

This Snap supports S3 Virtual Private Cloud (VPC) endpoint.

Note

  • Ensure the file name, folder name, or the file path does not contain '?' character because it is not fully supported and when present, the Snap might fail.

  • The FTPS file protocol works only in explicit mode. The implicit mode is not supported.

Multiexcerpt include macro
nameAcceptable File Paths
pageFile Writer

Multiexcerpt include macro
nameLint Warning
pageFile Writer

Prevent URL encoding


Default Value: Not selected


Checkbox

Excerpt

Select this checkbox to prevent the Snap from automatically encoding the URL file path (including the query string if it exists) and use the file path value as-is.  

Deselect this checkbox to encode the URLs. The following are some of the common characters that are automatically encoded by the Snap:

Character name Character  URL Encoded value
backslash      \ %5C
Pound #    %23
space       
 %20 
 percent    %     %25 
Left-angle<%3C
Right-angle>%3E
Left-angle[%5B
Right-square]%5D
Right-curly{%7B
Right-curly}%7D


And these are some of the characters that are not automatically encoded by the Snap:

Character name Character  URL Encoded value

semi-colon    

 ;   

 %3B

question mark     

?

 %3F

forward slash      

/

 %2F

colon       

 : 

  %3A 

ampersand      

 &  

%26

equals   

 =  

%3D

plus        

+  

%2B

dollar   

 $    

 %24

comma  

   ,     

%2C


  

Number of retries


Default Value: 0
Example:  3


Integer/Expression

Specify 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 first downloads the target file to a temporary zip 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 unzip the data and stream the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.

Info

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

Minimum value: 0

Retry interval (seconds)


Default Value: 1
Example: 3

Integer/Expression

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

Minimum value: 1

Advanced properties

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

SAS URI

Dropdown

Multiexcerpt include macro
nameSASURI_Description
pageFile Reader

Note

If you specify the SAS URI value in the Snap settings, then the settings provided in the account (if any account is attached) are ignored.

Values

String/Expression

Provide a value for the SAS URI.

Snap Execution

Dropdown list

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

...