Versions Compared

Key

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

Appsplus panel macro confluence macrodata{"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false

**Delete Before Publishing**

  • Always use title casing for Heading formats 1 and 2.

  • Always use active voice.

  • Do not use "Please" anywhere in the document.

  • Screenshots

    • Always use the New Form UI.

    • Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide.

    • Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.

    • See Image Style Guide for details.

  • Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to list the attributes of S3 objects in a given bucket matching the prefix. The attributes provided in the output document are bucket, objectKey, path, size, lastModified and owner. It internally lists all S3 objects with a given bucket name and prefix, and then applies the filter if any. Note that AWS S3 does not define any folder object and the '/' characters are part of the S3 object key names.

Snap Type

<Snap name> Snap is a READ/WRITE/PARSE/TRANSFORM/FLOW/FORMAT-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates…

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

None.

Support for Ultra Pipelines 

Works in Ultra Pipelines

...

...

Does not support Ultra Pipelines

Limitations

None.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

DocumentBinary

Binary or Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • ..

Requires the EDI data and internal ID as a JSON document.

Output

Document

Binary

Binary or Document

  • Min: 1

  • Max: 1

  • ..

  • ..

The EDI transaction ID and order confirmation.

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.

Snap Settings

Appsplus panel macro confluence macro
data{"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

Drop-down lists/Option Buttons (radio buttons):

You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.

  • <State what the option should do in this field>. The available options are: <bullet list of LoVs>
    Specify the Salesforce API to be used. The available options are:...

  • Select the <category> that you want to use. Available options are...
    * Option 1<italicized>. <third person singular form of the verb>
    * Option 2<italicized>. <third person singular form of the verb>
    Select the API that you want to use. Available options are:
    Bulk API. Sends the Snap execution request details as a bulk API call.
    REST API. ...
    OR
    Select one of the three following modes in which the Snap executes:
    * Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.

Check boxes:

  • If selected, <Snap behavior>.
    If selected, an empty file is written when the incoming document has no data.

  • If selected, <behavior>. If not selected/Otherwise, <behavior>
    Use "If not selected" if the first sentence is long.
    If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
    If selected, an empty file is written when the incoming 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.

  • Select to <action>
    Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
    Select to execute the Pipeline during validation.

Text Fields

  • Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
    Enter the name for new account.
    Specify the account ID to use to log in to the endpoint.
    Required if IAM Role is selected.
    Do not use this field if you are using batch processing.

Numeric Text Fields

  • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
    The number of records in a batch.
    The number of seconds for which you want the Snap to wait between retries.
    The number of seconds for which the Snap waits between retries.
    Use the following special values:
    * 0: Disables batching.
    * 1: Includes all documents in a single request.

Notes in field descriptions

  • Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

    • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

    • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

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

...

Field Name

...

Field Type

...

Field Dependency

...

Description

Label*

Default ValueELT Database Account
ExampleELT RS Account

...

String

...

None.

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.

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.

This field set contains the following fields:

  • Field 1

  • Field 2

  • Field 3

...

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

...

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

Field Name

Field Type

Field Dependency

Description

Label*

Default ValueS3 Browser
ExampleS3 Browser

String

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.

Bucket

Default Value: N/A
Example:

  • mybucket

  • mybucket@eu-west-1

  • mybucket@s3.eu-west-1.amazonaws.com (an example of <S3_bucket_name>@<s3_endpoint>)

  • testBucket@bucket.vpce-028b7814794578709-vu0vvauy.s3.us-west-2.vpce.amazonaws.com (an example of <S3_bucket>@<VPC_S3_endpoint>)

String/Expression

Specify the S3 bucket name, from where S3 objects are to be listed.

A bucket name can be selected from the suggested list. Bucket names are unique globally and can be accessed without its region name in most cases. If a bucket name you use cannot be accessed without its region name, the region information can be specified as in the following syntax:

<S3_bucket_name>@<region_name>

<S3_bucket_name>@<endpoint>

<endpoint> also applies to VPC (Virtual Private Cloud) S3 endpoint.

Note that, when a wrong region name is given, if the bucket name is valid, AWS S3 service may successfully access the bucket without any error.

 

Prefix

Default Value: [None]
Examples

  • test

  • test/

  • abc/xyz/

Specify the prefix of S3 object key names. If Bucket and Prefix are given and all other properties are at default values, the Snap lists all S3 objects matching the prefix in the bucket. An object key can be selected from the suggested list and edited for the prefix. The maximum length of the suggested list is 1,000. If Prefix is expression-enabled, it can be evaluated from an input header document as well as a pipeline parameter.

Filter

Default Value: [None]
Examples

  • *.csv Matches an object name that represents a file name ending in .csv

  • * .* Matches object names containing a dot

  • {.csv, .json} Matches object names ending with .csv or .json

  • foo.? Matches object names starting with foo. and a single character extension

  • home/*/*Matches home/gus/data

  • home/**. Matches home/gus and home/gus/data

Specify the filter the Snap should use internally to list all S3 objects first matching given bucket and prefix. Filter is applied to the entire string of each S3 object key. Filter is a glob pattern which is defined as following:

  • The * character matches zero or more characters of an S3 object name without crossing '/' boundaries.

  • The ** characters matches zero or more characters crossing '/' boundaries.

  • The ? character matches exactly one character of a name component.

  • The backslash character (\) is used to escape characters that would otherwise be interpreted as special characters. The expression \\ matches a single backslash and "\{" matches a left brace for example.

  • The [ ] characters are a bracket expression that match a single character of a name component out of a set of characters. For example, [abc] matches "a", "b", or "c". The hyphen (-) may be used to specify a range so [a-z] specifies a range that matches from "a" to "z" (inclusive). These forms can be mixed so [abce-g] matches "a", "b", "c", "e", "f" or "g". If the character after the [ is a ! then it is used for negation so [!a-c] matches any character except "a", "b", or "c".

    Within a bracket expression the *, ? and \ characters match themselves. The (-) character matches itself if it is the first character within the brackets, or the first character after the ! if negating.

  • The { } characters are a group of subpatterns, where the group matches if any subpattern in the group matches. The "," character is used to separate the subpatterns. Groups cannot be nested.

  • Leading period and dot characters in names are treated as regular characters in match operations. For example, the "*" glob pattern matches file name ".login".

Show Advanced Properties

Checkbox

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

Maximum Object Keys

Appears on selecting Show Advanced Properties checkbox.

Maximum number of object keys at the output view. ‘All’ or an empty field produces all matching object key names.

Examples: 2500

Default Value: All

Ignore Empty Result

Appears on selecting Show Advanced Properties checkbox.

If selected and there is no matching S3 object key, the Snap produces no output document, and if not selected, an empty document.

Default Value: Selected

Maximum Retries*

Default Value: 3
Examples: 5

Appears on selecting Show Advanced Properties checkbox.

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

Pass Through

Default Value: Not Selected

Appears on selecting Show Advanced Properties checkbox.

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

Delimiter


Default Value: [None]
Examples: /

Appears on selecting Show Advanced Properties checkbox.

Optional delimiter that causes to produce object keys that contain the same string between the prefix and the first occurrence of the delimiter. For example, a delimiter '/' causes the Snap to produce a non-recursive object-key listing.

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.

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

...

Attachments
patterns*.slp, *.zip
sortByname

Insert excerpt
XYZ S3 Snap Pack
S3 Snap PackXYZ
nameS3 Snap Pack History
nopaneltrue

...

...