Versions Compared

Version Old Version 1 New Version Current
Changes made by

Anand Vedam

Gouri Bhagchandani

Saved on

Key

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

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
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to delete an S3 object specified in the Bucket and Object Key fields.

  • To delete multiple S3 objects, use the S3 Browser Snap as the upstream Snap with Bucket and Object Key fields expression-enabled.

  • When the specified object does not exist, the Snap displays the '200 OK' status in the output document without any error.

...

Snap Type

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

Prerequisites

...

Valid client ID.

...

writes the status of the deleted S3 objects.

Prerequisites

None.

Support for Ultra Pipelines 

Works in Ultra Pipelines. 

...

Works in Ultra Pipelines if....

...

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

Document

  • Min: 0

  • Max: 1

Mapper

  • Binary to Document

  • Copy

  • ..

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

    • S3 Copy

    Output

    Document

    Binary

    Binary or Document

    • Min: 0

    • Max: 1

    • ..

    • ..

    The EDI transaction ID and order confirmation.

    • S3 Browser

    • Mapper

    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

    when 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

    ...

    {"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/","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}
    data
    Info

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

    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

    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.

    S3 Delete
    Example: Delete Demo object

    String

    N/A

    Specify a unique name for the Snap.

    Bucket*

    Default Value: None
    Examples: 

    String/Expression/Suggestion

    N/A

    Specify the S3 bucket name where the S3 object to be deleted 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 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.

    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.

    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.

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

    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.

    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 .

    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

    We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:

    <screenshot of Pipeline/Snap and description>

    ...

    Example

    Refer Managing-Data-in-S3.

    Downloads

    Info

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Provide Pipeline parameters as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    Snap Pack History

    Insert excerpt
    XYZ Amazon S3 Snap PackXYZ
    Amazon S3 Snap Pack

    ...

    Endpoint Doc Link 1

    ...

    Endpoint Doc Link 2

    ...

    Endpoint Doc Link 3

    ...

    SnapLogic Glossary

    ...

    nameS3 Snap Pack History
    nopaneltrue

    ...