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

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

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

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

   資格情報の取得

   SAP Fieldglass の担当者に問い合わせ、OAuthClientId、OAuthClientSecret、EnvironmentURL を入手してください。

   SAP Fieldglass への接続

   運用環境への認証を行うには、以下のように指定します。

   • APIKey：SAP Fieldglass API キー。これはオプションですが、API キーが必要であることを示すSAP Fieldglass からのエラーが発生した場合は、SAP Fieldglass 管理者に依頼するか、SAP Fieldglass Integration Tools にログインしてCreate API Application をクリックします。
   • OAuthClientId：SAP Fieldglass 担当者から取得したOAuth Client ID。
   • OAuthClientSecret：SAP Fieldglass 担当者から取得したOAuth Client Secret。
   • EnvironmentURL：SAP Fieldglass 担当者から取得したSAP Fieldglass Environment URL。
   <configuration> ... <connectionStrings> <add name="SAPFieldglassContext" connectionString="Offline=False;EnvironmentURL='https://myinstance.com';Username=myuser;Password=mypassword;APIKey=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx;" providerName="System.Data.CData.SAPFieldglass" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SAPFieldglass" type="System.Data.CData.SAPFieldglass.SAPFieldglassProviderServices, System.Data.CData.SAPFieldglass.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SAPFieldglass.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSAPFieldglassContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SAPFieldglassContext :DbContext { public SAPFieldglassContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SAPFieldglassContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSAP Fieldglass のエンティティ、例えばAuditTrails にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class AuditTrails { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class AuditTrailsMap :EntityTypeConfiguration<AuditTrails> { public AuditTrailsMap() { this.ToTable("AuditTrails"); this.HasKey(AuditTrails => AuditTrails.Id); this.Property(AuditTrails => AuditTrails.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<AuditTrails> AuditTrails { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SAPFieldglassContext context = new SAPFieldglassContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.AuditTrails select line;