Ready to get started?

Learn more about the CData ADO.NET Provider for DocuSign or download a free trial:

Download Now

Entity Framework 6 からDocuSign Data にアクセス

この記事は、Entity Framework のcode-first アプローチを使って、DocuSign data に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。



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

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

    To connect to DocuSign, set the following connection properties:

    • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
    • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

    Authenticating to DocuSign

    DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information. <configuration> ... <connectionStrings> <add name="DocuSignContext" connectionString="Offline=False;OAuthClientId=MyClientId; OAuthClientSecret=MyClientSecret; CallbackURL=http://localhost:33333; " providerName="System.Data.CData.DocuSign" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.DocuSign" type="System.Data.CData.DocuSign.DocuSignProviderServices, System.Data.CData.DocuSign.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>

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