ODBC を介してNode.js からXero WorkflowMax データをクエリ

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Node.js はブラウザ上以外でJavaScript コードを使用できるJavaScript ランタイム環境です。CData ODBC Driver for XeroWorkflowMax を使用すれば、Node.js アプリとスクリプトから、リアルタイムXero WorkflowMax データにアクセスできます。この記事ではnode-odbc のインストールと、リアルタイムXero WorkflowMax データへのアクセスが可能な、シンプルなNode.js アプリケーションを作成するために必要なツールについて説明します。

ビルトインの最適化されたデータ処理により、CData ODBC Driver は比類のないパフォーマンスで、Node.js のリアルタイムXero WorkflowMax データとやりとりできます。Node.js からXero WorkflowMax に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をXero WorkflowMax に直接プッシュし、組み込まれたSQL エンジンを利用してサポートされていない操作（主にSQL 関数とJOIN 操作）をクライアント側で処理します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Xero WorkflowMax をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにXero WorkflowMax データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

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

CData ODBC ドライバのインストールとXero WorkflowMax への接続設定

まずは、本記事右側のサイドバーからXeroWorkflowMax ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

必要な接続プロパティの値が未入力の場合には、データソース名（DSN）で入力します。組み込みのMicrosoft ODBC Data Source Administrator を使用し、DSN を構成できます。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、ヘルプドキュメントの「はじめに」を参照してください。

WorkflowMax API に接続するには、Xero からAPIKey とAccountKey を取得します。取得については、 Xero のサポートにお問い合わせ頂く必要があります。(https://www.workflowmax.com/contact-us).

API キーとAccount キーを取得したら、APIKey とAccountKey 接続プロパティの値を設定してください。 これらが設定されれば、接続の準備は完了です。

node-odbc を構築する

CData ODBC Driver を介してXero WorkflowMax に接続するには、必要なツールをインストールした後に、node-odbc を手動で構築する必要があります。

必要なツールをインストールする

以下のコマンドでは、node-odbc の構築に必要なツールをインストールします。（ツールをグローバルにインストールする-g パラメータに注意してください。）

npm i -g windows-build-tools
npm i -g node-gyp

node-odbc を構築する

必要なツールをインストールしたらNode.js アプリケーションのディレクトリを作成し、Node.js スクリプトで使用するバイナリを構築するodbc をインストールします。

mkdir nodeodbc
cd nodeodbc
npm i -g node

Node.js からXero WorkflowMax をクエリ

ODBC Driver がインストールされ、DSN が構成されて、node-odbc が構築されたら、Node.js アプリケーションからリアルタイムXero WorkflowMax データをクエリすることができるようになります。以下のサンプルコードは、特定のDSN に接続してClients テーブルをクエリします。

myscript.js

const odbc = require('odbc');

async function queryXeroWorkflowMax() {
    const connection = await odbc.connect(`DSN=CData XeroWorkflowMax Source`);
    const data = await connection.query('SELECT Id, Name FROM Clients');
    console.log(data);
}

queryXeroWorkflowMax();

アプリケーションを作成したら、node を使用してスクリプトを実行します。

node myscript.js

おわりに

CData ODBC Driver for XeroWorkflowMax の30日の無償評価版 をダウンロードすればNode.js でリアルタイムXero WorkflowMax データを使用できます。ご不明な点があれば、サポートチームにお問い合わせください。