Salesforce Platform Event Source Connector for Confluent Cloud¶

注釈

If you are installing the connector locally for Confluent Platform, see Salesforce Platform Event Source Connector for Confluent Platform.

Kafka Connect Salesforce Platform Event Source connector for Confluent Cloud では、Salesforce プラットフォームイベントをサブスクライブし、それを Apache Kafka® トピックに書き込む方法が提供されます。

機能¶

Salesforce Platform Event Source Connector には、以下の機能があります。

Salesforce ストリーミング API の使用: このコネクターはプラットフォームイベントに Salesforce ストリーミング API を使用します。
初期開始の設定: 新規プラットフォームイベントの消費を開始するか、過去 72 時間のすべてのイベントの消費から開始します。
サポートされるデータフォーマット: このコネクターは、Avro、JSON スキーマ、Protobuf、または JSON（スキーマレス）の出力データをサポートします。スキーマレジストリベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「環境の制限」を参照してください。
コネクターあたりのタスク数: 組織では複数のコネクターを実行できますが、コネクターあたり 1 つのタスク（"tasks.max": "1"）という制限があります。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

Confluent Cloud コネクターの制限事項も参照してください。

クイックスタート¶

このクイックスタートを使用して、Salesforce Platform Event Source Connector の利用を開始することができます。このクイックスタートでは、コネクターを選択し、Salesforce プラットフォームイベントをサブスクライブするようにコネクターを構成するための基本的な方法について説明します。

前提条件

アマゾンウェブサービス（AWS）、Microsoft Azure （Azure）、または Google Cloud Platform （GCP）上の Confluent Cloud クラスターへのアクセスを許可されていること。
Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
スキーマレジストリベースのフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「環境の制限」を参照してください。
コネクターを作成する前に、Confluent Cloud クラスター上に トピックが 1 つ以上存在している必要があります。
Salesforce アカウントには、サブスクライブするプラットフォームイベントが 1 つ以上必要です。コネクターを設定する際は、Salesforce アカウントで使用するセキュリティトークン、キー、およびシークレットを把握しておく必要があります。
ネットワークに関する考慮事項については、「ネットワークアクセス」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。

Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
- 既存のサービスアカウントのリソース ID を入力する。
- コネクター用の Confluent Cloud サービスアカウントを作成します。「サービスアカウント」のドキュメントで、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
- Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用¶

ステップ 1: Confluent Cloud クラスターを起動します。¶

インストール手順については、「Confluent Cloud を使用した Apache Kafka のクイックスタート」を参照してください。

ステップ 2: コネクターを追加します。¶

左のナビゲーションメニューの Data integration をクリックし、Connectors をクリックします。クラスター内に既にコネクターがある場合は、+ Add connector をクリックします。

ステップ 3: コネクターを選択します。¶

Salesforce Platform Event Source コネクターのアイコンをクリックします。

重要

コネクターを作成する前に、Confluent Cloud クラスター上にトピックが 1 つ以上存在している必要があります。

ステップ 4: 接続をセットアップします。¶

以下を実行して、Continue をクリックします。

注釈

すべての前提条件を満たしていることを確認してください。
アスタリスク（ * ）は必須項目であることを示しています。

コネクターの名前を入力します。
Kafka Cluster credentials で Kafka クラスターの認証情報の指定方法を選択します。サービスアカウントのリソース ID を選択するか、API キーとシークレットを入力できます（または、Cloud Console でこれらを生成します）。
Salesforce 接続 の詳細情報を追加します。Salesforce instance は必須ではありません。このプロパティを入力しない場合は、https://login.salesforce.com がデフォルトとして使用されます。コネクターは、Salesforce からの認証応答の中に指定されたエンドポイントを使用します。その他のすべてのフィールドは、Salesforce との接続に必要です。
イベントを消費する際にコネクターが使用する最初の開始点を initial starting point で指定します。72 時間以内のすべてのイベントを消費する場合は all を使用します。コネクターを起動した後に到着したイベントのみを消費する場合は latest を使用します。このプロパティのデフォルトは latest です。
Connection timeout をミリ秒で追加します。これは、Salesforce エンドポイントに接続するまでの待機時間です。デフォルトは 30000 ミリ秒（30 秒）です。
Output Kafka record value で、Kafka 出力レコード値のフォーマット（コネクターから送られるデータ）を AVRO、JSON（スキーマレス）、JSON_SR（JSON スキーマ）、または PROTOBUF から選択します。スキーマベースのメッセージフォーマット（Avro、JSON_SR（JSON スキーマ）、Protobuf など）を使用するには、有効なスキーマが Schema Registry に存在する必要があります。詳細については、「環境の制限」を参照してください。
このコネクターで使用するタスクの数を入力します。組織では複数のコネクターを実行できますが、コネクターあたり 1 つのタスク（"tasks.max": "1"）という制限があります。
Transforms and Predicates: 詳細については、Single Message Transforms（SMT）のドキュメントを参照してください。

See 構成プロパティ for all property values and descriptions.

ステップ 5: コネクターを起動します。¶

実行中の構成をプレビューして、接続の詳細情報を確認します。プロパティの構成に問題がないことが確認できたら、Launch をクリックします。

ちなみに

コネクターの出力のプレビューについては、「コネクターのデータプレビュー」を参照してください。

ステップ 6: コネクターのステータスを確認します。¶

コネクターのステータスが Provisioning から Running に変わります。ステータスが変わるまで数分かかる場合があります。

ステップ 7: Kafka トピックを確認します。¶

コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。

Confluent CLI の使用¶

以下の手順に従うと、Confluent CLI を使用してコネクターをセットアップし、実行できます。

注釈

すべての前提条件を満たしていることを確認してください。
コマンド例では Confluent CLI バージョン 2 を使用しています。詳細については、「Confluent CLI v2 への移行 <https://docs.confluent.io/confluent-cli/current/migrate.html#cli-migrate>`__」を参照してください。

重要

コネクターを作成する前に、Confluent Cloud クラスター上にトピックが 1 つ以上存在している必要があります。

ステップ 1: 使用可能なコネクターをリスト表示します。¶

以下のコマンドを入力して、使用可能なコネクターをリスト表示します。

confluent connect plugin list

ステップ 2: コネクターの必須の構成プロパティを表示します。¶

以下のコマンドを実行して、コネクターの必須プロパティを表示します。

confluent connect plugin describe <connector-catalog-name>

例:

confluent connect plugin describe SalesforcePlatformEventSource

出力例:

Following are the required configs:
connector.class: SalesforcePlatformEventSource
name
kafka.auth.mode
kafka.api.key
kafka.api.secret
kafka.topic
salesforce.username
salesforce.password
salesforce.password.token
salesforce.consumer.key
salesforce.consumer.secret
salesforce.platform.event.name
output.data.format
tasks.max

ステップ 3: コネクターの構成ファイルを作成します。¶

コネクター構成プロパティを含む JSON ファイルを作成します。以下の例は、コネクターの必須プロパティを示しています。

{
  "connector.class": "SalesforcePlatformEventSource",
  "name": "SalesforcePlatformEventSource_0",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "****************",
  "kafka.api.secret": "**********************************************",
  "kafka.topic": "TestPlatformEvent",
  "salesforce.username": "<my-username>",
  "salesforce.password": "**************",
  "salesforce.password.token": "************************",
  "salesforce.consumer.key": "******************************************",
  "salesforce.consumer.secret": "***************************************",
  "salesforce.platform.event.name": "TestEvent__e",
  "output.data.format": "JSON",
  "tasks.max": "1"
}

以下のプロパティ定義に注意してください。

"connector.class": コネクターのプラグイン名を指定します。
"name": 新しいコネクターの名前を設定します。

"kafka.auth.mode": 使用するコネクターの認証モードを指定します。オプションは SERVICE_ACCOUNT または KAFKA_API_KEY （デフォルト）です。API キーとシークレットを使用するには、構成プロパティ kafka.api.key と kafka.api.secret を構成例（前述）のように指定します。サービスアカウントを使用するには、プロパティ kafka.service.account.id=<service-account-resource-ID> に リソース ID を指定します。使用できるサービスアカウントのリソース ID のリストを表示するには、次のコマンドを使用します。
```
confluent iam service-account list
```
例:
```
confluent iam service-account list

   Id     | Resource ID |       Name        |    Description
+---------+-------------+-------------------+-------------------
   123456 | sa-l1r23m   | sa-1              | Service account 1
   789101 | sa-l4d56p   | sa-2              | Service account 2
```
"output.data.format": Kafka 出力レコード値のフォーマット（コネクターから送られるデータ）を設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット（たとえば、Avro、JSON_SR（JSON スキーマ）、および Protobuf）を使用するには、Confluent Cloud Schema Registry を構成しておく必要があります。
"tasks.max": このコネクターで使用するタスクの数を入力します。組織では複数のコネクターを実行できますが、コネクターあたり 1 つのタスク（"tasks.max": "1"）という制限があります。

Single Message Transforms: CLI を使用する SMT の追加の詳細については、Single Message Transforms（SMT）のドキュメントを参照してください。

See 構成プロパティ for all property values and descriptions.

ステップ 4: プロパティファイルを読み込み、コネクターを作成します。¶

以下のコマンドを入力して、構成を読み込み、コネクターを起動します。

confluent connect create --config <file-name>.json

例:

confluent connect create --config salesforce-platform-event-source.json

出力例:

Created connector SalesforcePlatformEventSource_0 lcc-aj3qr

ステップ 5: コネクターのステータスを確認します。¶

以下のコマンドを入力して、コネクターのステータスを確認します。

confluent connect list

出力例:

ID          |            Name                  | Status  |  Type
+-----------+----------------------------------+---------+-------+
lcc-aj3qr   | SalesforcePlatformEventSource_0  | RUNNING | source

ステップ 6: Kafka トピックを確認します。¶

コネクターが実行中になったら、メッセージが Kafka トピックに取り込まれていることを確認します。

Connect 用の Confluent Cloud API の使用に関する詳細とサンプルについては、「Confluent Cloud API for Connect」セクションを参照してください。

構成プロパティ¶

Use the following configuration properties with this connector.

How should we connect to your data?¶

name

Sets a name for your connector.

型: string
Valid Values: A string at most 64 characters long
重要度: 高

Kafka Cluster credentials¶

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.

型: string
Default: KAFKA_API_KEY
Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY
重要度: 高

kafka.api.key

型: password
重要度: 高

kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

型: string
重要度: 高

kafka.api.secret

型: password
重要度: 高

Which topic do you want to send data to?¶

kafka.topic

Identifies the topic name to write the data to.

型: string
重要度: 高

How should we connect to Salesforce?¶

salesforce.instance

The URL of the Salesforce endpoint to use. The default is https://login.salesforce.com. This directs the connector to use the endpoint specified in the authentication response.

型: string
Default: https://login.salesforce.com
重要度: 高

salesforce.username

コネクターで使用される Salesforce ユーザー名。

型: string
重要度: 高

salesforce.password

コネクターで使用される Salesforce パスワード。

型: password
重要度: 高

salesforce.password.token

ユーザー名に関連付けられた Salesforce セキュリティトークン。

型: password
重要度: 高

salesforce.consumer.key

OAuth アプリケーションのコンシューマーキー。

型: password
重要度: 高

salesforce.consumer.secret

OAuth アプリケーションのコンシューマーシークレット。

型: password
重要度: 高

salesforce.platform.event.name

The Salesforce platform event to subscribe to

型: string
重要度: 高

Connection details¶

salesforce.initial.start

Specify the initial starting point for the connector. Allowed values are

latest: only read events that arrive after the connector has started.

all: read all events including past events from the beginning of the Event Bus.

The default value is latest.

型: string
デフォルト: latest
Importance: medium

connection.timeout

The amount of time to wait in milliseconds while connecting to the Salesforce streaming endpoint.

型: long
Default: 30000
重要度: 低

request.max.retries.time.ms

In case of error when making a request to Salesforce, the connector will retry until this time (in ms) elapses. The default value is 30000 (30 seconds). Minimum value is 1 sec

型: long
デフォルト: 30000（30 秒）
Valid Values: [1000,...,250000]
重要度: 低

Output messages¶

output.data.format

Sets the output Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF

型: string
重要度: 高

Number of tasks for this connector¶

tasks.max

Type: int
Valid Values: [1,...,1]
重要度: 高

次のステップ¶

参考

フルマネージド型の Confluent Cloud コネクターが Confluent Cloud ksqlDB でどのように動作するかを示す例については、「Cloud ETL のデモ」を参照してください。この例では、Confluent CLI を使用して Confluent Cloud のリソースを管理する方法についても説明しています。