Entity Framework 6 からBullhorn CRM データに連携

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

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

   Begin by providing your Bullhorn CRM account credentials in the following:

   • DataCenterCode: Set this to the data center code which responds to your data center. Refer to the list of data-center-specific Bullhorn API URLs: https://bullhorn.github.io/Data-Center-URLs/

   If you are uncertain about your data center code, codes like CLS2, CLS21, etc. are cluster IDs that are contained in a user's browser URL (address bar) once they are logged in.

   Example: https://cls21.bullhornstaffing.com/BullhornSTAFFING/MainFrame.jsp?#no-ba... indicates that the logged in user is on CLS21.

   Authenticating with OAuth

   Bullhorn CRM uses the OAuth 2.0 authentication standard. To authenticate using OAuth, create and configure a custom OAuth app. See the Help documentation for more information.

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