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

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

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

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

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

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

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

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

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

   OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'

   BigCommerce 認証は標準のOAuth フローに基づいています。

   Store ID の取得

   BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. 画面にAPI Path という名前のテキストボックスが表示されます。
   5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
   6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
   7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

   パーソナルアクセストークンの取得

   加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

   1. BigCommerce アカウントにログインします。
   2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
   3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
   4. アカウント名を入力します。
   5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
   6. 「保存」をクリックします。

   BigCommerce への認証

   次に、以下を設定してデータに接続できます。
   • StoreId：API Path テキストボックスから取得したStore ID に設定。
   • OAuthAccessToken：生成したトークンに設定。
   • InitiateOAuth：OFF に設定。

   接続プロパティの詳細は、ヘルプドキュメントの"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 ブロックは空になり、アイテムを除去していることを示します。

スキーマを処理する

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