Versions Compared

Old Version 1

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 2

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

You can use this account type to connect <Snap Pack name> Azure SQL Snaps with data sources that use <Account Type Name> account.

Prerequisites

  • Valid client ID.

  • Valid tenant URL.

  • ...

  • ...

Limitations

Known Issues

  • Supports only reading JSON files.

  • ....

Account Settings

<Insert image here>

...

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

...

Azure SQL Active Directory Dynamic Account.

Dynamic Account types support Secrets Management, a SnapLogic add-on that allows you to store endpoint credentials in a third-party secrets manager. Orgs using Secrets Management provide the information necessary to retrieve the secrets in expression-enabled dynamic Account fields. During validation and execution, Pipelines obtain the credentials directly from the secrets manager. Learn more about Secrets Management.

Prerequisites

  • Valid Database.

  • Valid Azure Storage credentials.

Limitations and Known Issues

None.

Account Settings

...

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

...

  • field set.

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

...

  • field set.

Field Name

Field Type

Field Dependency

Description

Description

Label*

Default Value: N/A
Example: Azure SQL Active Directory Dynamic Account

String

Specify a unique name for the account instance.

Account properties*

Enter in the information to create a connection to the database.

Hostname*

Default Value: N/A
Example:

Label

 191.235.87.130

String/Expression

Specify the server's address to connect to.

 

Port Number*

Default Value: 1433
Example:

 ELT Database Account

 3306

String/Expression

Specify the database server's port to connect to.

 

Database name*

Default Value: N/A
Example: 

ELT RS Account

sldatabase

String

None.

Specify a unique label for the account.

Field set

Specify advanced parameters that you want to include in the request.

This field set consists of the following fields:

  • Field 1

  • Field 2

  • Field 3

Field 1

/Expression

Specify the database name to connect to.

 

Username

Default Value: N/A
Example: sladmin

String/Expression

Specify the username to connect to the database. The username is used as the default username when retrieving connections. The username must be valid in order to set up the data source.

 

Password

Default Value: N/A
Example: <Encrypted>

String/Expression

Specify the password to connect to the data source. The password is used as the default password when retrieving connections. The password must be valid in order to set up the data source.

 

Trust all certificates

Default Value: Deselected 

Checkbox

Select this checkbox to allow all SSL certificates for connecting to the database.

 

Advanced properties

Specify advanced properties for connecting to the database.

Auto commit

Default Value: Selected
 

Checkbox

Select this checkbox to commit each of the batches immediately after it is executed. If the Snap fails, only the batch being executed at that moment is rolled back.

Deselect this checkbox to commit the output only after all the batches are executed. If the Snap fails, the entire transaction is rolled back, unless the Snap finds invalid input data before it sends the insert request to the server, and routes the error documents to the Error view.

Batch size*

Default Value: 50
Example: 

String

Debug mode checkbox is not selected.

Field 2

90

Integer

Specify the number of statements to execute at a time.

Note

  • Select queries are not batched.

  • Using a large batch size could use up the JDBC placeholder limit of 2100.

Fetch size*

Default Value:

 

100
Example: 

String

None.

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.

...

...

Endpoint Doc Link 1

...

Endpoint Doc Link 2

...

300

Integer

Specify the Number of rows to fetch at a time when executing a query.

Large values could cause the server to run out of memory.

 

Max pool size*

Default value: 50
Example: 90

Integer

Specify the maximum number of connections a pool will maintain at a time.

 

Max life time*

Default value: 30

Integer

Specify the maximum lifetime of a connection in the pool. Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit. A value of 0 indicates an infinite lifetime, subject to the Idle Timeout value. An in-use connection is never retired. Connections are removed only after they are closed.

 

Idle Timeout*

Default Value: 5

Integer

Specify the maximum amount of time a connection is allowed to sit idle in the pool. A value of 0 indicates that idle connections are never removed from the pool.

 

Checkout timeout*

Default value: 10000

Integer

Specify the number of milliseconds to wait for a connection to be available when the pool is exhausted. Zero waits forever. An exception will be thrown after the wait time has expired.

If you specify 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout.

 

URL Properties

Default Value: 
Example: 

Use this field set to set additional URL properties if any.

URL property name

Default value: N/A
Example:

String

URL property name

 

URL property value

Default value: N/A
Example:

String

URL property value

...

Snap Pack History

...