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

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

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

   Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

   以下の接続プロパティを設定します。

   • AccountName：Talkdesk アカウントの名前。
   • Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
   • OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
   • OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

   カスタム OAuth アプリケーションの作成

   1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
   2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
   3. Grant Type を Client Credentials に設定します。
   4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
   5. Create をクリックし、Client Id と Client Secret をコピーします。

   接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

   
   
   <configuration>
      ... 
     <connectionStrings>
       <add name="TalkdeskContext" connectionString="Offline=False;AccountName=myAccount;Region=US;OAuthClientId=myClientId;OAuthClientSecret=myClientSecret;" providerName="System.Data.CData.Talkdesk" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Talkdesk" type="System.Data.CData.Talkdesk.TalkdeskProviderServices, System.Data.CData.Talkdesk.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

   
   
   public DbSet<Users> Users { set; get; }
   

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

   
   TalkdeskContext context = new TalkdeskContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Users select line;