Versions Compared

Key

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

...

In this article

...

titleGeneral Guidelines. Remove 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 1000 px or corresponding gridline 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
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to...

Prerequisites

  • Valid client ID.
  • A valid account with the required permissions.

None.

Support for Ultra Pipelines

...

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to retrieve the first non-NULL expression among a set of arguments. The Snap returns NULL if all its arguments are NULL. If you expect a query to return null values for certain functions or columns, you can use this Snap to replace the NULLs with some other value—typically in the case of certain aggregate functions that return null values instead of zero when they have no rows to evaluate.

COALESCE Arguments

Result

coalesce(NULL, 1, NULL)

1

coalesce(1, NULL, NULL)

1

coalesce(NULL, NULL, 3)

3

coalesce(NULL, NULL, NULL)

NULL

...

Prerequisites

  • A valid SnapLogic account to connect to the database in which you want to perform the COALESCE operation.

Limitations

None.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or Document

  • Min: 1

  • Max:

  • Mapper Snap
  • Copy Snap
  • ..
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.

Snap Settings

...

titleDocumenting Fields Based On Data Type/UI Element

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

...

  • <State what the 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

...

  • 1

  • ELT Insert Select

  • ELT Merge Into

  • ELT Copy

The SQL query that resolves to a document containing the list of arguments for the COALESCE operation.

Output

Document

  • Min: 1

  • Max: 1

  • ELT Select

  • ELT Filter

  • ELT Join

The modified SQL query with the COALESCE operation included.

Snap Settings

Note
  • Click the = (Expression) button in the Snap's configuration, if available, to define the corresponding field value using expression language and Pipeline parameters. 

  • Field names marked with an asterisk ( * )  in the table below are mandatory. 

Field Name

Type

Field Dependency

DescriptionSpecify a unique label for the Snap

Description

Label*

String

Specify a unique label for the Snap.

Default ValueELT Coalesce
Example

Label*

String

None.

Coalesce for AVG values

Get preview data

Checkbox

Select this checkbox to include a preview of the query's output. The Snap performs limited execution and generates a data preview during Pipeline validation.

Info

In case of ELT Pipelines, only the SQL query flows through the Snaps but not the actual source data. Hence, the preview data for a Snap is the result of executing the SQL query that the Snap has generated in the Pipeline.

The number of records displayed in the preview (upon validation) is the smaller of the following:

  • Number of records available upon execution of the SQL query generated by the Snap.

  • The value set in the Preview Data Count setting (default is 50 records).

Note

Rendering Complex Data Types in Databricks Lakehouse Platform

Based on the data types of the fields in the input schema, the Snap renders the complex data types like map and struct as object data type and array as an array data type. It renders all other incoming data types as-is except for the values in binary fields are displayed as a base64 encoded string and as string data type.

Default Value

Channel Operations

Not selected
Example

Delete Member

Number of records

String/Expression

Sampling Type is Number of records.

Enter the number of records to output.

Field set

Specify advanced parameters that you want to include in the request

Selected

Pass through

Checkbox

Select this checkbox to include the original input data in the output document along with the results of the COALESCE operation.

Default ValueNot selected
ExampleSelected

Coalesce Alias

String

Enter the column alias name for storing the results of the COALESCE operation. Leave this field blank to allow the Snap to automatically define an alias name for the column.

Default Value: None
ExampleNewCoaleas

Coalesce Arguments

Specify the list of arguments based on the input data schema for performing the COALESCE operation. Each function must be specified as a new row. Click (blue star) to add a row.

This field set consists of the following fields:

  • Field 1

  • Field 2

  • Field 3

Field 1*

Debug mode checkbox is not selected
  • Coalesce Argument

Coalesce Argument

String/Expression

Enter an argument for performing the COALESCE operation. Define only one argument in this field.

Default Value:

 <value> or None. None.

 None
Example

<value>

Field 2

Checkbox

ORDER_CNT, ORDERS_AVG_AMT

Troubleshooting

Error

Reason

Resolution

Batch execution failed

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

Verify that the Batch size 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

...

Download this Pipeline. 

Downloads

title
Note

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

Attachments
patterns*.slp, *.zip



Insert excerpt
XYZ Snap Pack
XYZ Snap Pack
nopaneltrue

...

See Also