Freshdesk のデータで Updategram を使用する

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Updategram を使用してFreshdesk のデータの挿入、更新、削除を行うことができます。このガイドでは、CData BizTalk Adapter for Freshdesk を使用して Updategram スキーマとインスタンスを生成する方法を説明します。

この記事では、CData BizTalk Adapter for Freshdesk で実行できる Updategram を作成します。スキーマを設計し、それをテンプレートとして挿入、更新、削除の Updategram を生成します。

Freshdesk 用アダプターをプロジェクトに追加する

Add Adapter ウィザードを使用して、Visual Studio の BizTalk Server プロジェクトにアダプターを追加します。アダプターを使用して、変更したいテーブルに関するメタデータを Freshdesk に問い合わせます。

  1. Solution Explorer でプロジェクトを右クリックし、Add -> Add Generated Items をクリックします。
  2. 表示されるダイアログボックスで Add Adapter Metadata を選択します。
  3. 表示される Add Adapter Wizard で、リストビューから CData BizTalk Adapter for Freshdesk を選択します。
  4. Port メニューでは、選択を空白のままにします。または、アダプターを使用するよう構成された Receive Location か Send Port を選択します。
  5. Next をクリックすると、Schema Wizard が表示されます。

Updategram 用のスキーマを生成する

以下の手順で、Visual Studio の BizTalk Server プロジェクトでスキーマを作成します。

  1. まだ行っていない場合は、Freshdesk アダプターをプロジェクトに追加します。
  2. Add Adapter ウィザードの Connection String ページで、Send Port または Receive Location で構成されていない場合は、認証情報やその他の接続プロパティを入力します。一般的な接続文字列は以下のとおりです： 
    Domain=MyDomain;APIKey=myAPIKey;

    FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

    • Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
    • APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

    必要な接続プロパティの詳細については、ヘルプドキュメントの "BizTalk Configuration" の章を参照してください。

  3. Schema Information ページで、General Options セクションの Send Port をクリックします。CommandType メニューから Updategram を選択します。Solicit-Response Send Port でアダプターを使用している場合は、One-Way オプションを無効にします。

  4. 次のページ（Statement Information）で、Updategram のタイプ（Insert、Update、Delete）を選択します。テーブル名とスキーマに含めるカラムを選択します。Update または Delete を行う場合は、Id カラムが必要です。

    注：Updategram を作成する際、スキーマに含めたカラムのみを変更できます。

  5. Next をクリックしてスキーマのサマリーを表示し、ウィザードを終了してスキーマを作成します。生成された .xsd ファイルがプロジェクトに追加されます。

Insert、Update、Delete のインスタンスメッセージを生成する

Updategram スキーマを作成したら、.xsd ファイルを使用して Updategram を生成できます。Solution Explorer で .xsd ファイルを右クリックし、Generate Instance を選択します。このファイルをテンプレートとして、手動で Updategram を作成することもできます。以下は、Insert、Update、Delete 用に生成された Updategram インスタンスの例です：

Insert

INSERT の例を以下に示します。このインスタンスでは、データがどのように変更されるかを指定する after ブロックのみがあります。 


<ns0:parameters xmlns:ns0="http://www.cdata.com/jp/FreshDeskProvider">
  <ns0:sync>
    <ns0:before></ns0:before>
    <ns0:after>
      <ns0:Tickets Id="Id_0" Name="Name_1" />
    </ns0:after>
  </ns0:sync>
</ns0:parameters>

Update

UPDATE の例を以下に示します。このインスタンスでは、before ブロック（テーブルの現在のデータ）と after ブロック（データがどのように変更されるか）の両方があります。 


<ns0:parameters xmlns:ns0="http://www.cdata.com/jp/FreshDeskProvider">
  <ns0:sync>
    <ns0:before>
      <ns0:Tickets Id=001d000000YBRseAAH></ns0:Tickets>
    </ns0:before>
    <ns0:after>
      <ns0:Tickets Id="Id_0" Name="Name_1" ></ns0:Tickets>
    </ns0:after>
  </ns0:sync>
</ns0:parameters>

Delete

DELETE の例を以下に示します。after ブロックは空になり、アイテムが削除されることを示します。 


<ns0:parameters xmlns:ns0="http://www.cdata.com/jp/FreshDeskProvider">
  <ns0:sync>
    <ns0:before>
      <ns0:Tickets Id=001d000000YBRseAAH></ns0:Tickets>
    </ns0:before>
    <ns0:after></ns0:after>
  </ns0:sync>
</ns0:parameters>

スキーマの処理

Updategram を使用して Freshdesk レコードの挿入、更新、削除を行う方法については、チュートリアルを参照してください。

はじめる準備はできましたか？

詳細：

Freshdesk 連携ソリューション

この記事の内容

関連記事