CData Zendesk BizTalk Adapter に一方向送信ポートを構成

Biztalk Adapter を一方向送信ポートと兼用することにより、BizTalk でアップデートグラムとデータ操作SQL を実行できます。

加藤龍彦
デジタルマーケティング

最終更新日:2021-07-17

この記事で実現できるZendesk 連携のシナリオ

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

ここでは、CData BizTalk Adapter for Zendesk を使用して静的な一方向送信ポートを作成、構成、テストする手順を説明します。静的な一方向送信ポートを使用することで、アップデートグラム、SQL コマンド、ストアドプロシージャを実行できます。送信ポートは、 返答データを持たない Zendesk のデータ変更の操作に役立ちます。通常、これはDELETE またはUPDATE のSQL コマンドか、アップデートグラムですが、場合によっては、ストアドプロシージャになります。

SELECT コマンドの実行や、作成したレコードId の取得のような、応答するアクションをトリガーする場合は、要請応答送信ポートを使用します。

一方向送信ポートを作成し実行する

静的な一方向送信ポートを作成し、Zendesk アダプタをトランスポートタイプとして使用するように構成します。

  1. 未実行の場合、BizTalk 管理コンソールでBizTalk アプリケーションを開きます。
  2. BizTalk アプリのノードで、[Send Ports]を右クリックし、[New]->[Static One-Way Send Port]を選択します。送信ポートプロパティのダイアログが表示されます。
  3. [Name]メニューで、送信ポートの名前を入力します。
  4. [Type]メニューで、CData.Zendesk を選択します。
  5. [Send Pipeline]メニューで、デフォルトオプションの[PassThruTransmit]を選択します。
The send port properties dialog.(Salesforce is shown.)

アダプタを構成する

[Transport Properties]ダイアログで、アダプタが実行するコマンドを定義します。

  1. 送信ポートのプロパティで、[Configure]ボタンをクリックします。CData.Zendesk トランスポートプロパティのダイアログが表示されます。
  2. [CommandType]プロパティで、実行したいコマンドタイプを選択します。
  3. SQL コマンドを実行したい場合は、[SQL Command]のボックスにコマンドを入力してください。
プロパティとその機能についての説明は、ヘルプドキュメントの[Adapter Configuration]を参照してください。 The Adapter Transport  Properties dialog.(Salesforce is shown.)

Zendesk への接続を構成する

Connection String Options ダイアログで、Zendesk への接続に必要な資格情報とその他のプロパティを設定します。

  1. 送信ポートのプロパティダイアログで[Configure]をクリックすると、アダプタのプロパティダイアログが表示されます。
  2. [Connection String]プロパティのボタンをクリックします。
  3. [Connection String]プロパティのボックスをクリックします。[Connection String Options]ダイアログが表示されます。
  4. 接続プロパティを入力します。下は一般的な接続文字列です。

    URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

    Zendesk 接続プロパティの取得・設定方法

    Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL(Zendesk Support URL)を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

    また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

    Zendesk への認証

    Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証(レガシー)です。

    API トークン認証

    API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthSchemeAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

    1. Token アクセスを有効にします。
    2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。
    最後に、APIToken をアクティブなAPI トークンに設定します。

    その他の認証方法についてはヘルプドキュメントを参照してください。

  5. [Test Connection]をクリックして値を確認し、接続を確認します。
プロパティとその機能の説明については、ヘルプドキュメントの[Connection String Options]チャプターを参照してください。 Credentials and other connection properties used to connect to the data source.(Salesforce is shown.)

接続に成功し、アダプターが実行するコマンドを定義することで、送信ポートを使用できるようになります。アプリケーションで一方向送信ポートを使用する例については、次のセクションを参照してください。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、送信ポートを使用してコマンドを実行します。

この例ではフィルターを利用して、アップデートグラムを含むメッセージを受信場所から送信ポートに移動します。フィルターについてのより詳しい説明は次のセクションを参照してください。

フィルターを作成し、アプリケーションを介してBizTalk メッセージをルーティングする

送信ポートを必要なメッセージに関連付けるには、その送信ポートのプロパティの[Filters]セクションでフィルタールールを作成します。条件に一致するメッセージは、送信ポートにルーティングされます。受信場所でのフィルタリングに関しては、次の例を参照してください。

例:一方向送信ポートでアップデートグラムを実行する

このセクションでは、一方向送信ポートをアプリケーションで使用する方法について説明します。アプリケーションはファイルに含まれているアップデートグラムコマンドを読み取り、コマンドを実行します。

  1. 一方向受信場所はアップデートグラムを含むXML ドキュメントをピックアップします。
  2. 受信場所は、コマンドの結果を含むBizTalk メッセージを作成します。
  3. 一方向送信ポートは、受信場所のURI をフィルタリングします。ドキュメントは一方向送信ポートにルーティングされます。
  4. 送信ポートは、アップデートグラムコマンドを実行します。

前の例と同様に次のステップでは、ファイルからアップデートグラムを読み取るための受信場所を設定し、送信ポートを使用してコマンドを実行する方法を説明します。

  1. 静的な一方向の受信場所を作成、構成します。転送タイプのファイルを使用します。「CData BizTalk Adapter for Zendesk の受信場所を作成、構成する」と同じ手順に従います。
  2. 静的な一方向送信ポートを作成します。
  3. 送信ポートのプロパティで、[Filters]をクリックします。
  4. 空のプロパティで、次の値を設定します。
    プロパティ
    メニューから BTS.InboundTransportLocation を選択します。
    新しく作成された一方向受信場所のURI を入力します。
A filter that routes updategrams from a one-way receive location to a one-way send port that is configured for the adapter.

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。