Versions Compared

Old Version 1

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version Current

changes.mady.by.user Kalpana Malladi

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

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.

...

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to list the tables in a database. This Snap connects to the database, reads its metadata, and outputs a document for each table found in the database. The table names display in topological order in the output so that tables with few dependencies display first in the output.  For example, if table A has a foreign key reference to table B, then table B displays first in the output before A. The ordering is intended to ease the process of replicating a group of tables from one database to another.

...

Snap Type

The AlloyDB Table List Snap is a Read Snap.

Prerequisites

None.

Support for Ultra Pipelines

...

Works in Ultra Pipelines. 

...

Works in Ultra Pipelines if....

...

Does not support Ultra Pipelines. 

Limitations

None.

Known Issues

None.

Limitations and Known Issues

None.

Behavior Change

Multiexcerpt fast include block macro
macro_uuid759f8cbd-2d0a-4556-9a70-e808d9793994
nameBehavior change for driver upgrade
templateDataeJyLjgUAARUAuQ==
pageAlloyDB Bulk Load
addpanelfalse

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or

Document

Binary

Binary or

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • ..

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

    Output

    • JSON Generator

    The schema name from where the Snap must list the tables.

    Output

    Document

    • Min: 1

    • Max:

    • ..

    • ..

    The EDI transaction ID and order confirmation

    • 1

    • JSON Parser

    • File Writer

    This Snap outputs a list of tables in a database. Documents with a "name" field containing the fully-qualified name of the table and a "type" field. To use the table name in another Snap, like a Select or Insert, you can pass it through for each Snap to another Pipeline with the Select or Insert.

    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:

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

    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}

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

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

    • Upload icon ((blue star) ): Indicates that you can upload files.

    Field

    Name

    Field Type

    Field Dependency

    Description

    Label*

    Default Value:

     ELT Database Account

    AlloyDB Table List
    Example:

     ELT RS Account

    List Tables

    String

    None.

    The

    Specify a unique name for the Snap.

    You can modify

    Modify this to be more specific, especially if you have more than one Snap of the same

    Snap

    type in your Pipeline.

    Number of records

    Schema name

    Default Value:

     

     N/A
    Example: test

    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*

    /Suggestion

    The database schema name. If it is not defined, then the suggestion for the table name will retrieve all tables names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values.

    Compute table graph

    Default Value: 

    <value> or None.

    Not selected
    Example:

     <value>

    Field 2

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

    String

    None

    Selected

    String

    Debug mode check box is not selected.

    Checkbox

    Computes the dependents among tables and returns each table with a list of tables it has foreign key references to. The ordering of outputted tables is from least dependent to most dependent. 

    Turning on this option will significantly slow down the Snap; leave it as off unless you need it.

    Snap Execution

    Default Value: Validate & Execute
    Example:

    Validate &

    Execute Only

    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

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

    Download this Pipeline. 

    Downloads

    ...

    ...

    Download and import the Pipeline into SnapLogic.

    ...

    Snap

    ...

    Provide Pipeline parameters, as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    ...

    Pack History

    Insert excerpt

    ...

    Google AlloyDB Snap Pack

    ...

    Google AlloyDB Snap Pack

    ...

    Endpoint Doc Link 1

    ...

    Endpoint Doc Link 2

    ...

    Endpoint Doc Link 3

    ...

    nameGoogle AlloyDB SPH

    ...