Magic xpi からCData ODBC Driver を使ってNetSuite につないでみた

こんにちは！テクニカルディレクターの桑島です。

ノーコードでデータを連携・同期・統合するデータ連携（EAI）ツール「Magic xpi」には、ODBC でデータベースへ接続する機能が備わっているので、これを使ってNetSuite のデータ連携を行うことが可能です。 通常、NetSuite などのSaaS として提供されるアプリケーションにはWeb API でアクセスしますが、CData NetSuite ODBC Driver によって、RDB にアクセスするのと同感覚で、NetSuite のデータを扱うことができます。

CData ODBC ドライバとは？

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

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

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

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

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

Magic xpi スタジオにてプロジェクトを作成して、ODBC接続設定を行います。

1. Magic xpi スタジオを起動してメニューバーからファイル > 新規 を選択します。新規プロジェクトウィンドウが起動したらプロジェクト名を指定して新規プロジェクトを作成します。
   
2. メニューバーからプロジェクト > リソース を選択します。リソース設定ウィンドウが起動したら左下の「新規」ボタンをクリックします。
   
3. 新規リソースウィンドウにて、リソースタイプを「Database」を選択、リソース名にCDataNetSuiteを指定して「OK」ボタンをクリックします。
   

4. リソース設定ウィンドウにて、DBMSには「ODBC」、データソース名には、Microsoft ODBC データソースアドミニストレーターのシステムDSNで定義されたデータソース名（DSN）、例えば「CData NetSuite Source」などを設定します。
   Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定する方法は、CData NetSuiteのヘルプドキュメントの「はじめに」をご参照ください。

   Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

   Netsuite への接続

   NetSuite は現在、2つの異なるAPI を提供しています。

   • SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。 しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、 そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
   • SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。 加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。

   NetSuite に接続するには、以下を行う必要があります。

   1. Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
   2. 使用するAPI に適した接続オプションを設定します。（それぞれのAPI で利用可能な接続オプションが異なります。ヘルプドキュメントの「許可の設定」を参照してください。）

   Netsuite への認証

   SuiteTalk またはSuiteQL

   NetSuite は2つの形式のOAuth 認証を提供します。

   • トークンベース認証（TBA）は、基本的にOAuth 1.0 で、OAuthAccessToken とOAuthAccessTokenSecret を実行時ではなくNetSuite UI 内で作成します。 TBA は、2020.2 以降のSuiteTalk およびSuiteQL の両方で利用可能です。
   • OAuth 2.0 認証は、SuiteQL でのみ利用できます。OAuth 2.0 認証を強制するには、次のいずれかを実行します。
     • OAuthVersion を使用するAPI に明示的に設定、または
     • Schema をSuiteQL に設定

   認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。

   「検証」ボタンをクリックしてデータベースとの接続が成功することを確認して、リソース設定ウィンドウを「OK」ボタンをクリックして終了します。

NetSuite のデータをCSV ファイルへ出力するフローの作成

Magic xpi スタジオにて、データマッパーコンポーネントを使用してNetSuite のデータをCSV ファイルへ出力するフローを作成します。

1. プロジェクト内に作成されたフローを右クリックして、特性を選択します。フロー特性ウィンドウが起動したら自動起動をYesに変更して「OK」ボタンをクリックします。
   
2. トリガコンポーネントが「自動起動」に設定されたことを確認します。コンポーネント内のデータマッパーを右側のペインにドラッグ＆ドロップします。
   
3. データマッパーウィンドウが起動するので「構成」ボタンをクリックします。
   
4. 送り元/送り先管理ウィンドウが開くので、送り元のタイプをDatabase、送り先のタイプをフラットファイルに設定します。
   
5. 送り元の「特性」ボタンをクリックして、データベーススキーマ特性ウィンドウにてDB オペレーションで「Select」を選択、データベース定義で「CDataNetSuite」を選択して「ウィザード」ボタンをクリックします。
   
6. 使用可能テーブルからテーブルを選択して「追加」ボタンをクリックして選択済テーブルに追加されたことを確認して「次へ」ボタンをクリックします。
   
7. データベースウィザードにて出力したいカラムを使用可能カラムから「追加」ボタンをクリックして選択済カラムに追加されたことを確認して「次へ」ボタンをクリックします。 Where 句とOrder By 句の定義ウィンドウが表示されるので必要であれば設定して「次へ」ボタンをクリックします。
   
8. ウィザードの結果にてSQL が表示されます。誤りがなければ「終了」ボタンをクリックします。
   
9. 次に、送り先の「特性」ボタンをクリックして、フラットファイルウィンドウにてデータの送り先で「ファイル」を選択、右横のウィンドウにパス付の出力ファイル名を入力します。 下段の「新規」ボタンを、出力するカラム数分クリックして出力項目を定義します。出力項目に併せて必要に応じて型や桁数を定義してください。
   
10. 送り元/送り先管理ウィンドウに戻り「マップ」ボタンをクリックします。
11. 「マップ」ウィンドウが起動するので、送り元から送り先の項目へのドラッグ＆ドロップ操作で線でつなぎます。「OK」ボタンをクリックします。 送り元/送り先管理ウィンドウに戻り「OK」ボタンをクリックします。
    

Magic xpi スタジオからのテスト実行

Magic xpi スタジオから作成したフローを実行します。

1. メニューバーからデバッガ > 開く を選択します。チェック処理が実行され正常に終了すると、メニューバーからデバッガ > 実行 が活性化されるので選択します。
   
2. フローが実行されて正常に終了すると送り先のフラットファイルウィンドウで指定したファイルが作成されてNetSuite 内の指定したカラムのデータが出力されていることを確認できます。
   

おわりに

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。