各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からAvalara AvaTax のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、Avalara AvaTax に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるAvalara AvaTax 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでAvalara AvaTax にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Avalara AvaTax Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。
- User：ユーザー名に設定します。
- Password：パスワードに設定します。
サンドボックス環境を使用している場合には、オプションで次を設定してください。
- UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。
アカウント番号とライセンスキーを使用して認証する
または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。
- AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
- LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。
<configuration> ... <connectionStrings> <add name="AvalaraAvataxContext" connectionString="Offline=False;User=MyUser;Password=MyPassword;" providerName="System.Data.CData.AvalaraAvatax" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.AvalaraAvatax" type="System.Data.CData.AvalaraAvatax.AvalaraAvataxProviderServices, System.Data.CData.AvalaraAvatax.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AvalaraAvatax.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAvalaraAvataxContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class AvalaraAvataxContext :DbContext { public AvalaraAvataxContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<AvalaraAvataxContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAvalara AvaTax のエンティティ、例えばTransactions にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Transactions { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class TransactionsMap :EntityTypeConfiguration<Transactions> { public TransactionsMap() { this.ToTable("Transactions"); this.HasKey(Transactions => Transactions.Id); this.Property(Transactions => Transactions.Id); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Transactions> Transactions { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
AvalaraAvataxContext context = new AvalaraAvataxContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Transactions select line;
関連コンテンツ
