Wave Financial データでアップデートグラムを使用する

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

この記事では、CData BizTalk Adapter for WaveFinancial で実行できるアップデートグラムを作成します。設計したスキーマは、インサート、アップデート、デリートのアップデートグラムを作成するためのテンプレートとして使用します。

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

［Add Adapter］ ウィザードから、アダプターをVisual Studio のBizTalk サーバープロジェクトに追加します。アダプターを使って、修正したいテーブルに関するWave Financial のメタデータをクエリします。

1. ［Solution Explorer］ の［project］ で右クリックし、［Add］ -> ［Add Generated Items］ と進みます。
2. ［resulting dialog box］ の［Add Adapter Metadata］ を選択します。
3. 表示される［Add Adapter］ ウィザードで、リストからCData BizTalk Adapter for WaveFinancial を選択します。
4. ［Port menu］ では、選択を空白のままにします。もしくは、アダプターを使用するように構成されている受信場所や送信ポートを選択します。
5. ［Next］をクリックすると、［Schema］ウィザードが表示されます。

アップデートグラム用のスキーマを作成する

以下のステップに従って、Visual Studio のBizTalk サーバープロジェクトでスキーマを作成します。

1. 未追加の場合は、Wave Financial アダプターをプロジェクトに追加します。
2. 送信ポートや受信場所で、認証資格情報やその他の接続プロパティが未構成の場合、［Add Adapter］ウィザードの［Connection String］ページから入力します。下は一般的な接続文字列です。

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

   Wave Financial は、データに接続する手段として、API トークンを指定する方法とOAuth 認証情報を使用する方法の2つを提供しています。

   API トークン

   Wave Financial API トークンを取得するには：
   1. Wave Financial アカウントにログインします。
   2. 左ペインのManage Applications に移動します。
   3. トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要がある場合があります。
   4. API トークンを生成するには、Create token をクリックします。

   OAuth

   Wave Financial はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

   ヘルプドキュメントでは、以下の3つの一般的な認証フローでのWave Financial への認証について詳しく説明しています。

   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

   カスタムOAuth アプリケーションの作成についての情報と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。

   接続プロパティの詳細は、ヘルプドキュメントの"BizTalk Configuration" チャプターを参照してください。

3. ［Schema Information］ページで、［General Options］セクションの［Send Port］をクリックします。［CommandType］メニューから［Updategram］を選択します。要請応答送信ポートのアダプターを使用している場合、［One-Way］オプションを無効にします。
4. 次の［Statement Information］ページでは、アップデートグラムの形式（Insert、Update、Delete）を選択します。 スキーマに含ませたいテーブル名とカラムを選択します。アップデートまたはデリートを行う場合、ID カラムを選択します。

   Noteアップデートグラムを作成する際、修正はスキーマに含ませたカラムに限定されます。

5. ［Next］をクリックしてスキーマの概要を確認してウィザードを終了し、スキーマを作成します。完成した.xsd ファイルがプロジェクトに追加されます。

インサート、アップデート、デリートのインスタンスメッセージを生成する

アップデートグラムスキーマの作成後、アップデートグラムを生成する.xsd ファイルを使用できます。.xsd ファイルを右クリックし、［Generate Instance］を選択します。このファイルは、アップデートグラムを手動で作成するテンプレートとして使用することもできます。以下は、インサート、アップデート、デリートそれぞれに生成されたアップデートグラムインスタンスの例です。

インサート

まず、インサートの一例です。このインスタンスでは、データの変化を指定するafter ブロックのみを扱います。

アップデート

次に、アップデートの一例です。このインスタンスでは、before ブロック（テーブルに存在するデータ）と、after ブロック（データの変化）の両方を扱います。

デリート

最後に、デリートの一例です。after ブロックは空になり、アイテムを除去していることを示します。

スキーマを処理する

Wave Financial レコードのインサート、アップデート、デリートにアップデートグラムを使用するには、こちらのチュートリアルをご覧ください。