Entity Framework 6 からSAP ByDesign のデータに連携

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

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

   SAP ByDesign に接続するには、次の接続プロパティを設定します。

   • Url: SAP ByDesign サイトのURL に設定。例：https://test.sapbydesign.com
   • User: アカウントのユーザー名に設定。
   • Password: アカウントのパスワードに設定。
   • CustomService or AnalyticsService: いずれか一方のみを指定する必要があります。データを取得するカスタムサービスがある場合はCustomService を指定します。アナリティクスサービスのレポートを取得する場合はAnalyticsService を指定します。 どちらも指定されていない場合は、'cc_home_analytics.svc' がAnalyticsService プロパティのデフォルトとして使用されます。指定するサービスがわからない場合は、Services ビューをクエリして利用可能なサービスを一覧表示できます。

   
   <configuration>
      ... <connectionStrings>
       <add name="SAPByDesignContext" connectionString="Offline=False;URL=https://my999999.sapbydesign.com;User=username;Password=password;CustomService=servicename;" providerName="System.Data.CData.SAPByDesign" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.SAPByDesign" type="System.Data.CData.SAPByDesign.SAPByDesignProviderServices, System.Data.CData.SAPByDesign.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

   
   public DbSet<[Inventory Balance]> [Inventory Balance] { set; get; }
   

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

   SAPByDesignContext context = new SAPByDesignContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.[Inventory Balance] select line;