Appsplus panel macro confluence macro

data

{"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

minLevel	1
maxLevel	2
absoluteUrl	true

Overview

You can use this Snap to list the attributes of S3 objects in a specific bucket matching the prefix. It internally lists all S3 objects with the specified bucket name and prefix, and then applies the filter if any.

AWS S3 does not define any folder object and the '/' characters are part of the S3 object key names.

...

Snap Type

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

Prerequisites

...

Valid client ID.

...

objects from S3.

Prerequisites

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	Document

Binary

Binary or

Min: 0
Max: 1

Mapper
S3 Copy

Key/value pairs used to evaluate expression properties in this Snap.

Output

Document

Min: 1
Max: 2

S3 Download
Mapper

Copy

..

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

Output

Document

Binary

Binary or Document

Min:
Max:

..
..

The EDI transaction ID and order confirmation

The output displays the following attributes:

bucket: The S3 bucket name.
objectKey: The S3 object with the prefix.
path: The path to the S3 bucket.
size: The size of the S3 object.
lastModified: The date when the S3 object was last modified.
storage-class: The Storage Class field, which indicates the archived status of the S3 object.
ownerDisplayName: The display name of the S3 owner.
ownerID: The ID of the S3 owner.

The attributes for each S3 object matching the specific Snap field values. For example, if you have the following S3 objects with the prefix "foo/" in the bucket "mrtest":

Info

foo/bar/ban
foo/bar/bash
foo/bar/baz
foo/batbat/baz
foo/boo

If the S3 Browser Snap has the following properties, then the Snap produces output documents for all the five S3 objects.

Bucket: mrtest
Prefix: foo/
Filter: **
Delimiter:

If the S3 Browser Snap has the following properties, then the Snap produces only one output document for foo/boo.

Bucket: mrtest
Prefix: foo/
Filter: **
Delimiter: /

Note
When you use the Cross Account IAM Role in the S3 account, the `ownerDisplayName` and `ownerID` fields may be empty in the output document.

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

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.

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 ( ): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.

...

Field Name

...

Field Type

...

Field Dependency

...

Description

Label*

Default Value: ELT Database Account
Example: ELT 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

...

None.

Snap Execution

...

Info

Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the fieldset.
Remove icon (): Indicates that you can remove fields from the fieldset.

Field Name

Field Type

Field Dependency

Description

Label*

Default Value: S3 Browser
Example: Browse IT Resources

String

N/A

Specify a unique name for the Snap.

Bucket*

Default Value: N/A
Examples:

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
Example of S3 Express One Zone bucket:
- snapexpress--usw2-az2--x-s3

String/Expression/Suggestion

N/A

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

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

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

<S3_bucket_name>@<region_name>

Note: If you enter an incorrect region name, but the bucket name is valid, the AWS S3 service might successfully access the bucket without errors.

You can access an S3 bucket in an S3 Virtual Private Cloud (VPC) endpoint by specifying the bucket name with the following syntax:
- <S3_bucket_name>@<VPC_S3_endpoint>
You can access an S3 Express One Zone bucket with the following syntax:
- <bucket-name>--<region>-<available-zone>--x-s3
S3 Express One Zone does not support the following bucket name pattern:
- <bucket>@<region_info>.
S3 Express One Zone does not support VPC.

Prefix

Default Value: None
Examples:

test
test/
abc/xyz/

String/Expression/Suggestion

N/A

Specify the prefix of S3 object key names.

When you specify the Bucket and Prefix field values and leave default values for the remaining fields, the Snap lists all S3 objects matching the prefix in the bucket.
You can select an object key from the suggested list and use it for the prefix. The maximum length of the suggested list is 1,000.
S3 Express One Zone only supports prefixes that end in a delimiter.

Filter (Glob)

Default Value: **
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

String/Expression

N/A

Specify the filter the Snap should use internally to list all S3 objects.

The Snap matches the specified Bucket and Prefix and then applies the filter. A glob pattern of <Prefix> + <Filter> is applied to the entire string of each S3 object key.
The definition of the glob pattern is as follows:

The * character matches zero or more characters of an S3 object name without crossing '/' boundaries.
The ** characters match 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.
The [ ] characters are a bracket expression that matches a single character of a name component out of a set of characters. For example, [abc] matches "a", "b", or "c". You may use the hyphen (-) to specify a range, so [a-z] specifies a range that matches from "a" through "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".
In a bracket expression, the *, ? and \ characters match themselves. The (-) character matches itself if it is the first character in 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

Default Value: Deselected

Checkbox

Displays Advanced Properties when you select this checkbox.

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

Maximum Object Keys

Default Value: All
Example: 2500

String/Integer/Expression