DbVisualizer でAvalara AvaTax データに連携しクエリを作成

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

CData JDBC Driver for AvalaraAvatax は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでAvalara AvaTax データへの接続を提供します。この記事では、DbVisualizer からAvalara AvaTax データに接続する方法、およびtable エディタを使ってAvalara AvaTax を編集、および保存する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. Avalara AvaTax をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにAvalara AvaTax データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてAvalara AvaTax の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

Avalara AvaTax データの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからAvalara AvaTax データに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData Avalara AvaTax Driver）。
   • URL Format をjdbc:avalaraavatax: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Avalara AvaTax XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.AvalaraAvatax.jar）を選択して「Open」をクリックします。
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.avalaraavatax.AvalaraAvataxDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:avalaraavatax: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。

     • User：ユーザー名に設定します。
     • Password：パスワードに設定します。

     サンドボックス環境を使用している場合には、オプションで次を設定してください。

     • UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。

     アカウント番号とライセンスキーを使用して認証する

     または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。

     • AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
     • LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、Avalara AvaTax JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.avalaraavatax.jar

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:avalaraavatax:User=MyUser;Password=MyPassword;
   • NOTE：Database Userid とDatabase Password は、それぞれAvalara AvaTax のUser プロパティとPassword プロパティに対応しています。
3. 「Connection」タブで「Connect」をクリックします。

Avalara AvaTax JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに