製品をチェック

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

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

製品の詳細

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

Wave Financial データに連携する.NET アプリケーションを素早く、簡単に開発できる便利なドライバー。

Entity Framework 6 からWave Financial データに連携

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

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

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

CData

ado ロゴ画像
Entity Framework ロゴ

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

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

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

    Wave Financial 接続プロパティの取得・設定方法

    Wave Financial は、データに接続する手段として、API トークンを指定する方法とOAuth 認証情報を使用する方法の2つを提供しています。

    API トークン

    Wave Financial API トークンを取得するには:

    1. Wave Financial アカウントにログインします。
    2. 左ペインのManage Applications に移動します。
    3. トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要がある場合があります。
    4. API トークンを生成するには、Create token をクリックします。

    OAuth

    Wave Financial はOAuth 認証のみサポートします。すべてのOAuth フローで、この認証を有効にするにはAuthSchemeOAuth に設定する必要があります。

    ヘルプドキュメントでは、以下の3つの一般的な認証フローでのWave Financial への認証について詳しく説明しています。

    • デスクトップ:ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
    • Web:共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
    • ヘッドレスサーバー:他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

    カスタムOAuth アプリケーションの作成についての情報と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。

    <configuration> ... <connectionStrings> <add name="WaveFinancialContext" connectionString="Offline=False;" providerName="System.Data.CData.WaveFinancial" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.WaveFinancial" type="System.Data.CData.WaveFinancial.WaveFinancialProviderServices, System.Data.CData.WaveFinancial.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>

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

関連コンテンツ

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

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