Versions Compared

Key

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

In this article

...

In this article:

Table of Contents
stylenone

Overview

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

Prerequisites

  • Valid client ID.

  • Valid tenant URL.

  • ...

  • ...

Limitations

Known Issues

  • Supports only reading JSON files.

  • ....

Account Settings

<Insert image here>

Appsplus panel macro confluence macro
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.

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

A registered OAuth application in the Confluent portal with appropriate permissions:

  • Client ID

  • Client secret

  • OAuth2 token endpoint

  • Scope

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

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

Field Name

Field Type

Field Dependency

Description

Default Value:

Example:

Label*

 

Default Value

ELT Database

Kafka OAuth2 Account
Example

ELT RS Account

Kafka OAuth2Account

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*

Default Value
Example

String

Debug mode checkbox is not selected.

Field 2

Default Value
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

...

 

Bootstrap servers*

Use this field to specify the initial list of Kafka broker addresses for a Kafka client to connect to during its initial bootstrap process.

Bootstrap server

 

Default Value: N/A
Example: localhost:9092

String/Expression

None

Specify the host:port pairs to establish the initial connection to the Kafka cluster.

Schema registry URL

 

Default Value: N/A
Example: http://ec2-55-334-44-58.compute-1.amazonaws.com:8000

String/Expression

None

Specify the schema registry server URL.

Advanced Kafka properties

Use this field set to specify any additional Kafka properties for connecting to the Kafka server that are not specifically provided in the Confluent Kafka Snaps. 

Key 

 

Default Value: N/A
Example: max.message.size

String/Expression

None

Specify the key for any Kafka parameters that are not specifically supported by the Snaps.

Value

 

Default Value: N/A
Example: 5 MB

String/Expression/Integer

None

Specify the value for the corresponding key that is not specifically supported by the Snaps.

Security protocol

 

Default Value: SASL_PLAINTEXT
Example: SASL_SSL

String/Expression/Suggestion

None

Select the security protocol from the dropdown list. The available options are:

  • SASL_SSL

  • SASL_PLAINTEXT

Keystore filepath

 

Default Value: N/A
Example: server.keystore.jks

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the keystore file location of the client.

Keystore file password

 

Default Value: N/A
Example: KsP@ssw0rd123!

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the keystore password to access the keystore file of the client.

SSL key password

 

Default Value: N/A
Example: SslK3yP@ssw0rd!

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the SSL key password.

Truststore filepath

 

Default Value: N/A
Example: server.truststore.jks

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the truststore file location of the client.

Truststore password

 

Default Value: N/A
Example: Value is encrypted

String/Expression

Appears when the Security protocol is SASL_SSL

Specify the password to access the truststore file, if used.

Client ID*

 

Default Value: N/A
Example: 8231b8a-jbc8-128-73ce-d021j2b279c8

String

None

Specify the client ID created during the application registration process. This ID enables the application to log in to an identity provisioning program, such as Azure Active Directory. The application ID, also known as the client ID, uniquely identifies your application. Learn more about the application configuration process in the Azure portal.

Client secret*

 

Default value: N/A
Example: value is encrypted

String

None

Specify the client secret, which your application uses to securely acquire the tokens. The client secret can be created by following the steps of the application provider.

Scope

Default Value: N/A
Example: api://e0af525c-c373-44bc-ac99-5f5a-2782268d/default

String/Expression

None

Specify the scope to provide a way to manage permissions to protected resources, such as your web API. Learn more about how to set up OAuth2 credentials in the Azure portal.

OAuth2 token endpoint*

 

Default valueN/A

Example: https://login.microsoftonline.com/2060acfg-89d9-423d-9514-eac46338ec05/oauth2/v2.0/token

String/Expression

 

None

Specify the token endpoint to get the access token.

Insert excerpt
Kafka Snap Pack
Kafka Snap Pack
nopaneltrue

Related Content

Add label