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

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

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

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

   Cvent への認証を行う前に、ワークスペースとOAuth アプリケーションを作成する必要があります。

   ワークスペースの作成

   ワークスペースを作成するには：

   1. Cvent にサインインし、App Switcher（ページ右上の青いボタン） -> Admin に移動します。
   2. Admin メニューから、Integrations -> REST API に移動します。
   3. Developer Management の新しいタブが立ち上がります。新しいタブでManage API Access をクリックします。
   4. Workspace を作成し、名前を付けます。開発者にアクセスさせたいスコープを選択します。スコープは、開発者がアクセスできるデータドメインを制御します。
      • All を選択すると、開発者は任意のスコープ、およびREST API にこれから追加されるスコープを選択できます。
      • Custom を選択すると、開発者がOAuth アプリで選択できるスコープを、選択したスコープに制限できます。本製品によって公開されるすべてのテーブルにアクセスするには、次のスコープを設定する必要があります。

        event/attendees:read	event/attendees:write	event/contacts:read
        event/contacts:write	event/custom-fields:read	event/custom-fields:write
        event/events:read	event/events:write	event/sessions:delete
        event/sessions:read	event/sessions:write	event/speakers:delete
        event/speakers:read	event/speakers:write	budget/budget-items:read
        budget/budget-items:write	exhibitor/exhibitors:read	exhibitor/exhibitors:write
        survey/surveys:read	survey/surveys:write

   OAuth アプリケーションの作成

   Workspace を設定して招待すると、開発者はサインアップしてカスタムOAuth アプリを作成できます。手順については、ヘルプドキュメントのカスタムOAuth アプリケーションの作成を参照してください。

   Cvent への接続

   OAuth アプリケーションを作成したら、次の接続プロパティを設定してCvent に接続します。

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