Versions Compared

Version Old Version 8 New Version 9
Changes made by

Cindy Hall (Unlicensed)

Cindy Hall (Unlicensed)

Saved on

Key

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

In this article

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • S3 Upload

  • JSON Formatter

An upstream Snap is optional. Any document with key-value pairs to evaluate expression properties. Each input document, if any, results in changing the storage class of an S3 object.

Output

Document

  • Min: 1

  • Max: 1

  • Mapper

  • S3 Restore

  • S3 Download

S3 Archive Snap output in JSON formatImage RemovedS3 Archive Snap output in JSON formatImage Added

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:

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

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining 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.

...

Info

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

  • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

  • Upload icon ((blue star) ): Indicates that you can upload files. //is this missing by designwhy was this removed?

Field Name

Field Type

Field Dependency

Description

Label*

 

Default Value: S3 Archive
Example: Project  Project Archive

String

String

N/A

 

Specify a unique name for the Snap.

 

Label*

 

Default Value: S3 Archive
Example: Project Archive

Bucket*

 

Default Value: None
Example:

String/Expression/SuggestionN/

A 

Specify the S3 bucket name where the S3 object to be archived is located.

Note

Do not add S3:/// before bucket name, because the Snap can fail.

  • Bucket names are unique globally and can be accessed without its region name in most cases. If you cannot access a bucket name without its region name, you can specify the region information in the following syntax

    • <S3_bucket_name>@<region_name>

  • You can also access the S3 bucket in an S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name in the following syntax:

    • <S3_bucket_name>@<VPC_S3_endpoint>

Note: When you enter an incorrect region name, but if the bucket name is valid, the AWS S3 service may successfully access the bucket without any error.

 

Bucket*

 

Default Value: None
Example:

  • mybucket

  • mybucket@eu-west-1

    • Example of S3 Bucket in S3 region:

    mybucket@s3

    .

    eu-west-1.amazonaws.com

    Example of S3 VPC endpoint:

  • my-bucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com

    • testBucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com

    Object Key*

     

    Default Value: None
    Examples: 

    • test.csv

    • abc/test.json

    • abc/xyz/test.xml

    String/Expression/Suggestion

    N/A

    Specify the S3 object key name, which may include one or more forward-slash ('/') characters.

    The forward-slash character is part of the S3 object key name and there is no folder object defined in AWS S3. The maximum length of the suggested list is 1,000.

     

    Object Key*

     

    Default Value: None
    Examples: 

    • test.csv

    • abc/test.json

    • abc/xyz/test.xml

    Change Storage Class

    Composite

    N/A

    Change Storage Class

    From

    Default Value: None
    Examples: 

    • Standard

    String/Expression/Suggestion

    N/A

    This field is for information only and not used when the Snap is previewed or executed. The current storage class of the selected S3 object can selected from the suggestion.

    From

    Default Value: None
    Examples: 

    • Standard

    To

    Default Value: None
    Examples: 

    • GlacierInstantRetrieval

    • GlacierFlexibleRetrieval

    • DeepArchive

    String/Expression/Suggestion

    N/A

    Enter or select the target storage class name from the suggested list.

    Supported storage classes are:

    • Standard

    • GlacierInstantRetrieval

    • GlacierFlexibleRetrieval

    • DeepArchive

    • IntelligentTiering

    • StandardInfrequentAccess

    • OneZoneInfrequentAccess

    • ReducedRedundancy

    To

    Default Value: None
    Examples: 

    • GlacierInstantRetrieval

    • GlacierFlexibleRetrieval

    • DeepArchive

    Show Advanced Properties

     

    Default Value: Deselected
    Example: Selected

    Checkbox

    N/A

    Select this checkbox to display the advanced properties.
    Deselect this checkbox to hide the properties.

    Show Advanced Properties

     

    Default Value: Deselected
    Example: Selected

    Thread Pool Size

     

    Default Value: 10
    Example: 20

    Integer/Expression

    Appears when you select Show Advanced Properties checkbox.

    Specify the maximum number of threads to be used to archive multiple S3 objects in parallel with Bucket and Object Key properties expression-enabled.

    If the Thread Pool Size property is expression-enabled, it can be evaluated with a Pipeline parameter, but not with an input document. Therefore, the value of this property remains constant throughout the Pipeline execution.

    Thread Pool Size

     

    Default Value: 10
    Example: 20

    Maximum Retries*

     

    Default Value: 3
    Example: 2

    Integer/Expression

    Appears when you select Show Advanced Properties checkbox.

    Specify the maximum number of retry attempts to perform in case of a temporary network loss.

     

    Maximum Retries*

     

    Default Value: 3
    Example: 2

    Pass Through

     

    Default Value: Deselected
    Example: Selected

    Checkbox

    Appears when you select Show Advanced Properties checkbox.

    Select this checkbox to pass the input document to the output view as a value to the 'original' key .

    Pass Through

     

    Default Value: Deselected
    Example: Selected

    Snap Execution

    Default Value: 
    Example: Validate & Execute

    Dropdown list

    N/A

    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.

    Snap Execution

    Default Value: 
    Example: Validate & Execute

    Number of records

    Default Value: 
    Example:

    String/Expression

    Sampling Type is Number of records.

    Enter the number of records to output.

    Field set Name

    Specify advanced parameters that you want to include in the request.

    Field 1*

    Default Value: <value> or None.
    Example: <value>

    String

    Debug mode check box is not selected.


    Field 2

    Default Value: <value> or None.
    Example: <value>

    String

    None.

    Snap Execution

    Default Value: 
    Example: Validate & Execute

    Dropdown list

    N/A

    Select one of the following three modes in which the Snap executes:

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

    Troubleshooting

    Error

    Reason

    Resolution

    Account validation failed.

    The Pipeline ended before the batch could complete execution due to a connection error.

    Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    Examples

    Excluding Fields from the Input Data Stream

    ...