Entity Framework 6 からSage X3 Cloud のデータに連携

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでSage X3 Cloud にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Sage X3 Cloud Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

   • URL：Sage X3 Cloud インスタンスのベース URL。
   • OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
   • OAuthClientId：OAuth アプリケーションのクライアント ID。
   • OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
   • Audience：トークンリクエストで使用する API の Audience 値。
   • XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
   • Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
   • Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

   ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

   
   
   <configuration>
      ... 
     <connectionStrings>
       <add name="SageX3CloudContext" connectionString="Offline=False;AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;" providerName="System.Data.CData.SageX3Cloud" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SageX3Cloud" type="System.Data.CData.SageX3Cloud.SageX3CloudProviderServices, System.Data.CData.SageX3Cloud.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SageX3Cloud.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSageX3CloudContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class SageX3CloudContext :DbContext {
   	public SageX3CloudContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<SageX3CloudContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSage X3 Cloud のエンティティ、例えばBPCUSTOMER にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class BPCUSTOMER {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String BPCNUM { get; set; }
   }
   public class BPCUSTOMERMap :EntityTypeConfiguration<BPCUSTOMER> {
   	public BPCUSTOMERMap() {
   		this.ToTable("BPCUSTOMER");
   		this.HasKey(BPCUSTOMER => BPCUSTOMER.Id);
   		this.Property(BPCUSTOMER => BPCUSTOMER.BPCNUM);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   
   public DbSet<BPCUSTOMER> BPCUSTOMER { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   
   SageX3CloudContext context = new SageX3CloudContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.BPCUSTOMER select line;