Entity Framework 6 からDynamics 365 のデータに連携

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

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

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

   Dynamics 365 接続プロパティの取得・設定方法

   Microsoft Dynamics 365 への接続

   Microsoft Dynamics 365 ドライバーは、以下のMicrosoft Dynamics 365 エディションへの接続をサポートしています。

   • CustomerService
   • FieldService
   • FinOpsOnline （デフォルト）
   • FinOpsOnPremise
   • HumanResources
   • Marketing
   • ProjectOperations
   • Sales

   Notes：

   • Supply Chain Management はFinance and Operations と同一です。これらのいずれかに接続するには、Edition をFinOpsOnline またはFinOpsOnPremise のいずれかに設定します。
   • Microsoft Dynamics 365 Business Central については、個別のMicrosoft Dynamics 365 Business Central ドライバーを使用してください。
   接続するには、次のパラメータを設定します。
   • OrganizationUrl：お使いのMicrosoft Dynamics 365 組織のURL。例えば、https://orgcb42e1d0.crm.dynamics.com。
   • Edition：上記のエディション一覧に示すとおり。

   Microsoft Dynamics 365 への認証

   Microsoft Dynamics 365 は、Azure AD、Azure サービスプリンシパル、Azure マネージドID（MSI）を経由する認証をサポートします。これらはすべてOAuth 規格に基づきます。 認証方法の詳細は、ヘルプドキュメントを参照してください。

   <configuration> ... <connectionStrings> <add name="Dynamics365Context" connectionString="Offline=False;OrganizationUrl=https://myaccount.operations.dynamics.com/;Edition=Sales;" providerName="System.Data.CData.Dynamics365" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Dynamics365" type="System.Data.CData.Dynamics365.Dynamics365ProviderServices, System.Data.CData.Dynamics365.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Dynamics365.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はDynamics365Context です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class Dynamics365Context :DbContext { public Dynamics365Context() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<Dynamics365Context>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているDynamics 365 のエンティティ、例えばGoalHeadings にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class GoalHeadings { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String GoalHeadingId { get; set; } } public class GoalHeadingsMap :EntityTypeConfiguration<GoalHeadings> { public GoalHeadingsMap() { this.ToTable("GoalHeadings"); this.HasKey(GoalHeadings => GoalHeadings.Id); this.Property(GoalHeadings => GoalHeadings.GoalHeadingId); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<GoalHeadings> GoalHeadings { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： Dynamics365Context context = new Dynamics365Context(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.GoalHeadings select line;