製品をチェック

QuickBooks Data Provider の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

QuickBooks アイコン QuickBooks ADO.NET Provider 相談したい

QuickBooks への完全な読み書きアクセスにより、任意の.NET アプリケーションから検索(顧客、トランザクション、請求書、販売レシートなど)、アイテムの更新、顧客の編集などを実行できます。

Entity Framework 6 からQuickBooks データに連携

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

加藤龍彦
デジタルマーケティング

最終更新日:2022-04-04
quickbooks ロゴ

CData

ado ロゴ画像
Entity Framework ロゴ

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

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

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

    ローカルQuickBooks インスタンスへの接続には接続プロパティ入力は不要です。

    CData 製品は、リモートコネクタ経由でQuickBooks にリクエストを作成します。リモートコネクタはQuickBooks と同じマシン上で動作し、軽量の組み込みWeb サーバーを介して接続を受け入れます。サーバーはSSL/TLS をサポートし、ユーザーにリモートマシンからのセキュアな接続を可能にします。

    初めて接続するときは、CData 製品をQuickBooks で認証する必要があります。詳しくは、ヘルプドキュメントの「Using the Remote Connector」を参照してください。

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。