Versions Compared

Key

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

...


...

titleGeneral Guidelines. Remove Before Publishing.

...

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


In this article

Table of Contents
maxLevel2
absoluteUrltrue

...

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:1
  • Max:1
  • Mapper Snap
This Snap has at most one document input view.
Output

Document

  • Min:1
  • Max:1
  • Filter

This Snap has exactly one document output view.

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

...


Note

Field names marked with an asterisk ( * ) are mandatory.

...

Field Name

Data type

Description

Label*

String

Specify a unique label for the account.

Default ValueELT Database Account
ExampleELT RS Account

OpenAPI Specification

String

Enter the URL for the OpenAPI specification file.

Example: zuora_open_api_spec3.json, sldb:///zuora_open_api_spec3.json
Default value: [None]

Zuora Object

String

Required. This property sets the Zuora object name. A suggestion lists all the available object names. Enter the desired object if it is not in the suggested list.

Example: Account
Default value: [None] 

Where Clause

String

Enter WHERE clause of Zuora SELECT query without the word ‘WHERE’.

Example: name = ‘SnapLogic’
Default value: [None] 

Output Fields

String

Enter SELECT field names, one field name for each row. If empty, the Snap attempts to select all fields.

Example: id
Default value: [None]

Number of retries

Integer

Enter the maximum number of retry attempts in case of a failure in execution.

Example: 3
Default value: 0

Retry interval (seconds)

Integer

Specify the minimum number of seconds to wait before the next retry.

Example: 2
Default value: 1

...