Xero データをSQL Server に同期（キャッシュ）する方法

詳細情報をご希望ですか？

無償トライアル:

製品の詳細情報へ:

Xero ODBC ドライバーは、ODBC 接続をサポートする任意のアプリケーションからリアルタイムなXero 会計ソフトウェアデータに直接接続できるパワフルなツールです。標準のODBC ドライバーインタフェースを使用して、データベースのようにXero データにアクセスし、Xero の顧客、トランザクション、請求書、販売レシートなどの読み、書き、更新を実行できます。

キャッシュ機能を使って、Xero の任意のエンドポイントをSQL Server にキャッシュ同期

Xero データをDB にコピーするニーズは多いです。例えば、データのバックアップのため、データをDB にデータレイク的に格納して他のアプリケーションやBI、ETL ツールから連携利用するなどです。
ただし、JSON やXML 形式であったりスキーマレスなデータなどを、DB に格納できるようにスキーマ定義をしながらデータを同期することは大きな手間です。しかも、SaaS やNoSQL などのデータはスキーマレスであったり、スキーマが頻繁に変更されます。
CData Driver 技術では、Xero データをテーブルにモデル化し、スキーマを付与してDB にへの格納を容易にします。本記事では、CACHE コマンドだけで、SQL Server にXero データの同期を取る方法を説明します。

※製品について詳しい情報をご希望の方は以下からお進みください。

Xero にほかのBI、ETL、開発ツールから接続したい：Xero データ連携ガイドおよびチュートリアルのリストへ
Xero Drivers について詳細を知りたい：ドライバー詳細情報ページへ
ほかのデータソースに連携したい：CData Drivers 一覧へ
ドライバーの30日の無償トライアル版を使いたい：トライアル版ダウンロードページへ
製品の利用やライセンスについて相談したい：sales@cdata.co.jp までメールにてご相談ください。

同期先となるデータベースの準備

この例では、SQL Server を使います。難しい手順は不要で、SQL Server に任意の名前の新しい同期DB を作成しておくだけです。

ODBC Driver for Xero のインストールとXero への接続

ODBC 接続プロパティの指定がまだの場合は、DSN （データソース名）で接続設定を行います。 Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。 ODBC ドライバーのインストール完了時にODBC DSN 設定画面が立ち上がります。 Microsoft ODBC データソースアドミニストレーターを開いて設定を行うことも可能です。必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

To connect, set the Schema connection property in addition to any authentication values. Xero offers authentication for private applications, public applications, and partner applications. You will need to set the XeroAppAuthentication property to PUBLIC, PRIVATE, or PARTNER, depending on the type of application configured. To connect from a private application, you will additionally need to set the OAuthAccessToken, OAuthClientId, OAuthClientSecret, CertificateStoreType, CertificateStore, and CertificateStorePassword.

To connect from a public or partner application, you can use the embedded OAuthClientId, OAuthClientSecret, and CallbackURL, or you can register an app to obtain your own OAuth values.

See the "Getting Started" chapter of the help documentation for a guide to authenticating to Xero.

通常のDSN 設定に加え、キャッシュ関連項目の設定が必要です：
Cache Connection:以下をセミコロン区切りで入力
Cache Provider:SQL Server ではSystem.Data.SqlClient


Server=server name;Database=database name;User ID=your id;Password=password;

Visual Studio からキャッシュを実行

Visual Studio のサーバーエクスプローラーから「データ接続」を右クリックして「接続の追加」を選択します。
データソース選択画面で「Microsoft ODBC データソース」を選択します。

サーバーエクスプローラーには、「ODBC.Xero.CData」というコネクションができています。展開するとXero データがテーブルよびビューとしてモデル化されて表示されます。これらのオブジェクトは通常のSQL で操作することができます。

キャッシュクエリの実行

以下のキャッシュコマンドを作成し、実行します。実行時にクエリテキストエラーが出ても気にせず続行してください。


CACHE SELECT * FROM "Target Table"

キャッシュ結果をSQL Server で確認

データベースの下にkintone の選択したアプリが同期されています。キレイにDB 向けにスキーマも付いてます。普通にSQL でアプリケーション内で使ってください。