WCF アプリケーションで NetSuite のデータ の OData サービスを公開

CData ADO.NET Provider for NetSuite を使用すると、Windows Communication Foundation（WCF）フレームワークを活用してサービス指向アプリケーションを素早く開発し、NetSuite のデータを OData コンシューマーに提供できます。この記事では、接続用の Entity Data Model を作成し、WCF Data Service を構成して OData サービスを公開する方法を解説します。公開したフィードは、Power Pivot や CData ADO.NET Provider for OData を使用するアプリケーションなど、さまざまな OData クライアントから利用できます。

はじめに

---

OData サービスの作成

以下の手順で、OData 経由でNetSuite のデータへの接続を提供する WCF サービスアプリケーションを作成します。

1. Visual Studio を開き、新しいプロジェクトを作成します。WCF Service Application テンプレートを選択します。
2. 自動生成された IService.cs と Service1.svc を削除します。
3. Entity Framework 6 をインストールします：

   Visual Studio のパッケージマネージャーコンソールを使用して、最新バージョンの Entity Framework をインストールします。以下のコマンドを実行すると、Entity Framework が自動的にダウンロード・インストールされます。

   Install-Package EntityFramework

4. Entity Framework プロバイダーを登録します：
   1. App.config または Web.config ファイルの "providers" セクションに、以下のプロバイダーエントリを追加します。Entity Framework のインストールが成功していれば、このセクションはすでに存在しているはずです。

      <configuration>
      ...
      <entityFramework>
        <providers>
          ...
          <provider invariantName="System.Data.CData.NetSuite" type="System.Data.CData.NetSuite.NetSuiteProviderServices, System.Data.CData.NetSuite.Entities.EF6" />
        </providers>
      </entityFramework>
      </configuration>

   2. インストールディレクトリの lib/4.0 にある System.Data.CData.NetSuite.Entities.dll への参照を追加します。
   3. プロジェクトをビルドして、EF6 のセットアップを完了します。
5. Project -> Add New Item -> ADO.NET Entity Data Model をクリックします。
6. 表示される Entity Data Model ウィザードで、'EF Designer from Database' オプションを選択します。
7. Choose Your Connection ダイアログが表示されたら、New Connection をクリックします。

8. Connection properties ダイアログで、CData NetSuite Data Source を選択し、必要な認証情報を入力します。

   一般的な接続文字列は以下のとおりです：

   AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

   NetSuiteへの接続

   NetSuite では、2種類のAPI でデータにアクセスできます。どちらのAPI を使用するかは、Schema 接続プロパティで以下のいずれかを選択して指定してください。

   • SuiteTalk は、NetSuite との通信に使用されるSOAP ベースの従来から提供されているサービスです。幅広いエンティティをサポートし、INSERT / UPDATE / DELETE の操作も対応しています。ただし、SuiteQL API と比べるとデータの取得速度が劣ります。また、サーバーサイドでのJOIN に対応していないため、これらの処理はCData 製品がクライアントサイドで実行します。
   • SuiteQL は、より新しいAPI です。JOIN、GROUP BY、集計、カラムフィルタリングをサーバーサイドで処理できるため、SuiteTalk よりもはるかに高速にデータを取得できます。ただし、NetSuite データへのアクセスは読み取り専用となります。

   データの取得のみが目的でしたらSuiteQL をお勧めします。データの取得と変更の両方が必要な場合は、SuiteTalk をお選びください。

   NetSuite への認証

   CData 製品では、以下の認証方式がご利用いただけます。

   • トークンベース認証（TBA）はOAuth1.0に似た仕組みです。2020.2以降のSuiteTalk とSuiteQL の両方で利用できます。
   • OAuth 2.0 認証（OAuth 2.0 認可コードグラントフロー）は、SuiteQL でのみご利用いただけます。
   • OAuth JWT 認証は、OAuth2.0 クライアント認証フローの一つで、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。

   トークンベース認証（OAuth1.0）

   トークンベース認証（TBA）は、基本的にOAuth 1.0 の仕組みです。この認証方式はSuiteTalk とSuiteQL の両方でサポートされています。管理者権限をお持ちの方がNetSuite UI 内でOAuthClientId、OAuthClientSecret、OAuthAccessToken、OAuthAccessTokenSecret を直接作成することで設定できます。 NetSuite UI でのトークン作成手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。

   アクセストークンを作成したら、以下の接続プロパティを設定して接続してみましょう。

   • AuthScheme = Token
   • AccountId = 接続先のアカウント
   • OAuthClientId = アプリケーション作成時に表示されるコンシューマーキー
   • OAuthClientSecret = アプリケーション作成時に表示されるコンシューマーシークレット
   • OAuthAccessToken = アクセストークン作成時のトークンID
   • OAuthAccessTokenSecret = アクセストークン作成時のトークンシークレット

   その他の認証方法については、ヘルプドキュメントの「はじめに」をご確認ください。

   
9. OData クライアントからアクセスさせたい NetSuite のテーブルとビューを選択します。
10. Project -> Add New Item -> WCF Data Service をクリックします。

11. データソースクラスを指定し、新しい WCF Data Service へのアクセスを構成します。以下の例では、エンティティの Access Rule が All に設定されています。これは、すべてのユーザーがデータの読み取りと変更を行えることを意味します。

      
    using System;
    using System.Collections.Generic;
    using System.Data.Services;
    using System.Data.Services.Common;
    using System.Linq;
    using System.ServiceModel.Web;
    using System.Web;
    
    namespace NetSuiteService{
      public class NetSuiteDataService : DataService<NetSuiteEntities> {
        public static void InitializeService(DataServiceConfiguration config) {
          config.SetEntitySetAccessRule("*", EntitySetRights.All);
          config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V3;
        }
      }
    }
    	

12. プロジェクトを実行します。これで、OData 対応アプリケーションから Salesforce データにアクセスし、変更を反映できるようになります。ブラウザでフィードにアクセスできます。フィードは次のように表示されます：

Power Pivot から OData サービスを利用する

これで、任意の OData クライアント（例：Excel Power Pivot）からサービスを利用できます。

1. Excel を開き、Power Pivot Window ボタンをクリックします。
2. 新しいポップアップが表示されます。From Data Feeds オプションを選択します。
3. 表示される Table Import Wizard で、OData URL を入力します（例：http://localhost:12449/NetSuiteDataService.svc/）。
4. OData サービスへの接続後、ウィンドウ下部の Next ボタンをクリックします。
5. ウィザードの次のウィンドウに、利用可能なテーブルの一覧が表示されます。インポートするテーブルを選択し、Finish をクリックします。
6. Close をクリックして、Power Pivot にデータをインポートします。