重要

このページの日本語コンテンツは古くなっている可能性があります。最新の英語版コンテンツをご覧になるには、こちらをクリックしてください。

Salesforce PushTopic Source Connector for Confluent Cloud

注釈

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

Salesforce PushTopic Source Connector for Confluent Cloud では、Salesforce オブジェクト(SObject)で発生する作成、アップデート、削除、復元イベントをサブスクライブする機能が提供されます。このコネクターを使用して、これらの PushTopic イベントをキャプチャーし、そのイベントを Apache Kafka® トピックに書き込むことができます。

機能

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

  • Salesforce ストリーミング API の使用: このコネクターは PushTopics に Salesforce ストリーミング API を使用します。

  • PushTopic の作成: Salesforce PushTopic namesalesforce.push.topic.name)構成プロパティで PushTopic の名前を提供します。salesforce.push.topic.create を true に設定すると、コネクターの起動時に PushTopic が存在しない場合に、その名前の PushTopic が作成されます。

  • 少なくとも 1 回のデリバリー: コネクターによって、レコードが Kafka のトピックに少なくとも 1 回は配信されることが保証されます。コネクターを再起動した場合、Kafka のトピックに重複レコードが存在している可能性があります。これに関連する制限を以下の注意事項に示します。

    注釈

    • コネクターは、実行中に、Kafka に書き込まれた最新レコードの再生 ID を定期的に記録します。コネクターが停止してから 24 時間以内に再起動された場合は、停止した時点からの PushTopic の消費を続けるので、イベントの損失はありません。しかし、コネクターが 24 時間を超えて停止していた場合は、コネクターによる読み取りが可能になる前に、Salesforce 内で一部のイベントが破棄されます。
    • コネクターが失敗のため想定外に停止した場合は、Kafka に正常に書き込まれた最新レコードの再生 ID が記録されていない可能性があります。コネクターが再起動すると、最後に記録された再生 ID から再開されます。このため、Kafka で一部のイベントが重複する可能性があります。
  • サポートされる出力フォーマット: このコネクターは、Avro、JSON スキーマ、Protobuf、または JSON(スキーマレス)の出力データをサポートします。スキーマレジストリ ベースのフォーマット(Avro、JSON_SR(JSON スキーマ)、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。

  • タスク: このコネクターは、1 つのタスクのみの実行をサポートしています。

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

制限

以下の情報を確認してください。

クイックスタート

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

前提条件
  • アマゾンウェブサービス (AWS)、Microsoft Azure (Azure)、または Google Cloud Platform (GCP)上の Confluent Cloud クラスターへのアクセスを許可されていること。
  • Confluent CLI がインストールされ、クラスター用に構成されていること。「Confluent CLI のインストール」を参照してください。
  • スキーマレジストリ ベースのフォーマット(Avro、JSON_SR(JSON スキーマ)、Protobuf など)を使用するには、Schema Registry を有効にしておく必要があります。詳細については、「スキーマレジストリ Enabled Environments」を参照してください。
  • コネクターを作成する前に、Confluent Cloud クラスター上に トピックが 1 つ以上存在している必要があります
  • コネクターを設定する際は、Salesforce アカウントのセキュリティトークン、キー、およびシークレットを把握しておく必要があります。
  • ネットワークに関する考慮事項については、「Networking and DNS Considerations」を参照してください。静的なエグレス IP を使用する方法については、「静的なエグレス IP アドレス」を参照してください。
  • Kafka クラスターの認証情報。次のいずれかの方法で認証情報を指定できます。
    • 既存の サービスアカウント のリソース ID を入力する。
    • コネクター用の Confluent Cloud サービスアカウント を作成します。「サービスアカウント」のドキュメントで、必要な ACL エントリを確認してください。一部のコネクターには固有の ACL 要件があります。
    • Confluent Cloud の API キーとシークレットを作成する。キーとシークレットを作成するには、confluent api-key create を使用するか、コネクターのセットアップ時に Cloud Console で直接 API キーとシークレットを自動生成します。

Confluent Cloud Console の使用

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

インストール手順については、「Quick Start for Confluent Cloud」を参照してください。

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

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

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

Click the Salesforce PushTopic Source connector card.

Salesforce PushTopic Source Connector Card

重要

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

Step 4: Enter the connector details.

注釈

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

At the Add Salesforce PushTopic Source Connector screen, complete the following:

Select the topic you want to send data to from the Topics list. To create a new topic, click +Add new topic.

Step 5: Check the Kafka topic.

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

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

参考

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

../_images/topology.ja.png

Confluent CLI の使用

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

注釈

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

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

confluent connect plugin list

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

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

confluent connect plugin describe <connector-catalog-name>

例:

confluent connect plugin describe SalesforcePushTopicSource

出力例:

Following are the required configs:
connector.class: SalesforcePushTopicSource
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.object
salesforce.push.topic.name
output.data.format
tasks.max

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

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

{
  "connector.class": "SalesforcePushTopicSource",
  "name": "SalesforcePushTopicSource_0",
  "kafka.api.key": "****************",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "<my-kafka-api-key>",
  "kafka.api.secret": "<my-kafka-api-secret>",
  "salesforce.username": "<my-username>",
  "salesforce.password": "**************",
  "salesforce.password.token": "************************",
  "salesforce.consumer.key": "******************************************",
  "salesforce.consumer.secret": "***************************************",
  "salesforce.object": "<Sobject_name>",
  "salesforce.push.topic.name: "<PushTopic_name>",
  "output.data.format": "JSON",
  "tasks.max": "1"
}

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

  • "connector.class": コネクターのプラグイン名を指定します。
  • "name": 新しいコネクターの名前を設定します。
  • "kafka.auth.mode": 使用するコネクターの認証モードを指定します。オプションは SERVICE_ACCOUNT または KAFKA_API_KEY (デフォルト)です。API キーとシークレットを使用するには、構成プロパティ kafka.api.keykafka.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
    
  • "kafka.topic": Kafka トピック名を入力します。コネクターを起動する前に、トピックが 1 つ以上存在している必要があります。

  • "salesforce.<...>": Salesforce アカウントの認証および認可の詳細情報を入力します。

  • "salesforce.object": トピックを作成する SObject を入力します。

  • "salesforce.push.topic.name": サブスクライブする PushTopic の名前を入力します。入力された名前の PushTopic が存在しない場合で、プロパティ salesforce.push.topic.createtrue (デフォルト)に設定されている場合は、PushTopic が作成されます。

  • "output.data.format": Kafka 出力レコード値のフォーマット(コネクターから送られるデータ)を設定します。指定可能なエントリは、AVROJSON_SRPROTOBUF、または 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) のドキュメントを参照してください。

すべてのプロパティの値と説明については、「構成プロパティ」を参照してください。

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

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

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

例:

confluent connect create --config salesforce-pushtopic-source.json

出力例:

Created connector SalesforcePushTopicSource_0 lcc-aj3qr

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

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

confluent connect list

出力例:

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

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

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

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

構成プロパティ

このコネクターでは、以下のコネクター構成プロパティを使用します。

データへの接続方法(How should we connect to your data?)

name

コネクターの名前を設定します。

  • 型: string
  • 指定可能な値: 最大 64 文字の文字列
  • 重要度: 高

Kafka クラスターの認証情報(Kafka Cluster credentials)

kafka.auth.mode

Kafka の認証モード。KAFKA_API_KEY または SERVICE_ACCOUNT を指定できます。デフォルトは KAFKA_API_KEY モードです。

  • 型: string
  • デフォルト: KAFKA_API_KEY
  • 指定可能な値: KAFKA_API_KEY、SERVICE_ACCOUNT
  • 重要度: 高
kafka.api.key
  • 型: password
  • 重要度: 高
kafka.service.account.id

Kafka クラスターとの通信用の API キーを生成するために使用されるサービスアカウント。

  • 型: string
  • 重要度: 高
kafka.api.secret
  • 型: password
  • 重要度: 高

データの送信先トピック(Which topic do you want to send data to?)

kafka.topic

データの書き込み先トピック名を指定します。

  • 型: string
  • 重要度: 高

Salesforce への接続方法(How should we connect to Salesforce?)

salesforce.instance

使用する Salesforce エンドポイントの URL。デフォルトは 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.object

トピックを作成する Salesforce オブジェクト。

  • 型: string
  • 重要度: 高
salesforce.push.topic.name

サブスクライブ先の Salesforce PushTopic。salesforce.push.topic.create が true に設定されている場合は、この名前の PushTopic が作成されます。

  • 型: string
  • 重要度: 高
salesforce.push.topic.create

PushTopic が存在しない場合に作成するかを決定するフラグ。

  • 型: boolean
  • デフォルト: true
  • 重要度: 低
salesforce.push.topic.notify.create

Salesforce PushTopic を作成に応答させるかを決定するフラグ。この構成は、salesforce.push.topic.create が true に設定されている場合に使用されます。

  • 型: boolean
  • デフォルト: true
  • 重要度: 低
salesforce.push.topic.notify.delete

Salesforce PushTopic を削除に応答させるかを決定するフラグ。この構成は、salesforce.push.topic.create が true に設定されている場合に使用されます。

  • 型: boolean
  • デフォルト: true
  • 重要度: 低
salesforce.push.topic.notify.undelete

Salesforce PushTopic を復元に応答させるかを決定するフラグ。この構成は、salesforce.push.topic.create が true に設定されている場合に使用されます。

  • 型: boolean
  • デフォルト: true
  • 重要度: 低
salesforce.push.topic.notify.update

Salesforce PushTopic をアップデートに応答させるかを決定するフラグ。この構成は、salesforce.push.topic.create が true に設定されている場合に使用されます。

  • 型: boolean
  • デフォルト: true
  • 重要度: 低

接続の詳細(Connection details)

salesforce.initial.start

コネクターの初期開始点を指定します。使用できる値は以下のとおりです。

latest: コネクターを起動した後に到着したイベントのみを読み取ります。

all: 24 時間以内のイベントを読み取ります。

デフォルト値は latest です。

  • 型: string
  • デフォルト: latest
  • 重要度: 中
connection.timeout

Salesforce ストリーミングエンドポイントに接続する際の待機時間(ミリ秒)。

  • 型: long
  • デフォルト: 30000
  • 重要度: 低
request.max.retries.time.ms

Salesforce へのリクエストの実行中にエラーが発生した場合は、この時間(ミリ秒)が経過するまで、コネクターにより再試行されます。デフォルト値は 30000(30 秒)です。最小値は 1 秒です。

  • 型: long
  • デフォルト: 30000(30 秒)
  • 指定可能な値: [1000,...,250000]
  • 重要度: 低
salesforce.version

The version of Salesforce API to use.

  • 型: string
  • デフォルト: latest
  • 重要度: 低

出力メッセージ(Output messages)

output.data.format

Kafka 出力レコード値のフォーマットを設定します。指定可能なエントリは、AVRO、JSON_SR、PROTOBUF、または JSON です。スキーマベースのメッセージフォーマット(AVRO、JSON_SR、PROTOBUF など)を使用する場合は、Confluent Cloud Schema Registry を構成しておく必要がある点に注意してください

  • 型: string
  • 重要度: 高

このコネクターのタスク数(Number of tasks for this connector)

tasks.max
  • 型: int
  • 指定可能な値: [1,...,1]
  • 重要度: 高

次のステップ

参考

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

../_images/topology.ja.png