各製品の資料を入手。
詳細はこちら →Linux/Unix 上でPHP からNetSuite のデータに接続・連携
CData ODBC ドライバを使って、Linux/Unix マシン上でNetSuite のデータに連携可能なPHP アプリケーションを作成。PHP でのODBC ネイティブサポートを活用します。
最終更新日:2023-09-22
この記事で実現できるNetSuite 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData ODBC Driver for NetSuite をLAMP またはWAMP スタックにドロップし、NetSuite に接続されたWeb アプリケーションを構築します。本記事では、PHP のビルトインODBC 機能でNetSuite のデータに接続し、クエリを実行して、結果を出力する手順を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- NetSuite をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにNetSuite のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてNetSuite の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
UNIX/Linux マシンでCData ODBC Drivers を使用する
CData ODBC Drivers は、Ubuntu、Debian、RHEL、CentOS、Fedora など、Red Hat およびDebian ベースのさまざまなシステムでサポートされています。また、いくつかライブラリやパッケージが要求されることがありますが、それらの多くはシステムにデフォルトでインストールされています。サポートされているLinux オペレーティングシステムのバージョンと必要なライブラリの詳細については、インストール済みのもの、またはWeb 上にあるヘルプドキュメントの「はじめに」の章を参照してください。
ドライバーマネージャーをインストールする
ドライバーをインストールする前に、システムにドライバーマネージャーがあることを確認してください。この記事では、広くサポートされている無料のオープンソースODBC ドライバーマネージャーであるunixODBC を使用します。
Ubuntu のようなDebian ベースのシステムでは、APT パッケージマネージャーを使用してunixODBC をインストールできます。
$ sudo apt-get install unixODBC unixODBC-dev
Red Hat Linux ベースのシステムの場合は、yum またはdnf を使用してunixODBC をインストールできます。
$ sudo yum install unixODBC unixODBC-devel
unixODBC ドライバーマネージャーは、ドライバーの情報をodbcinst.ini ファイルから、データソースの情報をodbc.ini ファイルから読み取ります。 次のコマンドをターミナルに入力することで、システムの設定ファイルの場所を指定できます。
$ odbcinst -j
コマンドの出力は、登録されたODBC ドライバーおよびODBC データソースの設定ファイルの場所を表示します。 ユーザーデータソースにアクセスできるのは、odbc.ini ファイルがホームフォルダに格納されているユーザーアカウントだけです。システムデータソースには、すべてのユーザーがアクセスできます。 以下に、このコマンドの出力例を示します。
DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......:8
SQLLEN Size........:8
SQLSETPOSIROW Size.:8
ドライバーをインストールする
標準パッケージ形式(Debian .deb パッケージ形式または.rpm ファイル形式)でドライバーをダウンロードすることができます。ファイルをダウンロードしたら、ターミナルからドライバーをインストールできます。
ドライバーインストーラーはドライバーをunixODBC に登録し、システムDSN を作成します。これは、後にODBC 接続をサポートするツールやアプリケーションで使用できます。
Ubuntu のようなDebian ベースのシステムでは、sudo またはroot で以下のコマンドを実行します。
$ dpkg -i /path/to/package.deb
Red Hat システムまたは.rpms をサポートするその他のシステムの場合は、sudo またはroot で以下のコマンドを実行します。
$ rpm -i /path/to/package.rpm
ドライバーがインストールされたら、unixODBC ドライバーマネージャーを使用し、登録されたドライバーと定義されたデータソースを一覧表示できます。
登録されているドライバーを一覧表示する
$ odbcinst -q -d
CData ODBC Driver for NetSuite
...
定義されたデータソースを一覧表示する
$ odbcinst -q -s
CData NetSuite Source
...
CData ODBC Driver for NetSuite をunixODBC で使用するには、ドライバーがUTF-16 を使用するように設定されていることを確認します。そのために、インストール場所(通常はcdata.odbc.netsuite.ini)のlib フォルダにある、ドライバー(cdata.odbc.netsuite.ini)のINI ファイルを以下のように編集します。
cdata.odbc.netsuite.ini
...
[Driver]
DriverManagerEncoding = UTF-16
DSN を変更する
ドライバーのインストールにより、システムDSN が事前定義されます。DSN を変更するには、システムデータソースファイル(/etc/odbc.ini)を編集し、必要な接続プロパティを定義します。さらに、$HOME/.odbc.ini での変更にルートアクセスを必要としない、ユーザー固有のDSN を作成することができます。
Netsuite への接続
NetSuite は現在、2つの異なるAPI を提供しています。
- SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。 しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、 そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
- SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。 加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。
NetSuite に接続するには、以下を行う必要があります。
- Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
- 使用する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 に設定
認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。
/etc/odbc.ini または$HOME/.odbc.ini
[CData NetSuite Source]
Driver = CData ODBC Driver for NetSuite
Description = My Description
Account Id = XABC123456
Password = password
User = user
Role Id = 3
Version = 2013_1
これらの構成ファイルの使用方法については、オンラインのヘルプドキュメントを参照してください。
接続を確立する
odbc_connect またはodbc_pconnect を呼び出して、NetSuite への接続を開きます。 接続を閉じるには、odbc_close もしくはodbc_close_all を使います。
$conn = odbc_connect("CData ODBC NetSuite Source","user","password");
接続はodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いた接続は、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトで接続を共有することが可能です。スクリプト間で接続を共有することにより、システムリソースを節約し、クエリの実行を高速化できます。
$conn = odbc_pconnect("CData ODBC NetSuite Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
プリペアドステートメントを作成する
odbc_prepare を使って、プリペアドステートメントおよびパラメータライズドクエリを作成します。
$query = odbc_prepare($conn, "SELECT * FROM SalesOrder WHERE Class_Name = ?");
クエリを実行する
Prepared ステートメントをodbc_execute を使って実行します。
$conn = odbc_connect("CData ODBC NetSuite Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM SalesOrder WHERE Class_Name = ?");
$success = odbc_execute($query, array('Furniture : Office'));
Non-Parameterized クエリは、odbc_exec を使います。
$conn = odbc_connect("CData ODBC NetSuite Source","user","password");
$query = odbc_exec($conn, "SELECT Customer.FirstName AS CustomerName, SalesOrder.Total AS SalesOrderTotal FROM SalesOrder, Customer");
結果の処理
odbc_fetch_array 関数の結果セット配列としてアクセスします。
$conn = odbc_connect("CData ODBC NetSuite データ Source","user","password");
$query = odbc_exec($conn, "SELECT Customer.FirstName AS CustomerName, SalesOrder.Total AS SalesOrderTotal FROM SalesOrder, Customer");
while($row = odbc_fetch_array($query)){
echo $row["CustomerName"] . "\n";
}
odbc_result_all 関数で、結果セットをHTML テーブルとして表示します。
$conn = odbc_connect("CData ODBC NetSuite データ Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM SalesOrder WHERE Class_Name = ?");
$success = odbc_execute($query, array('Furniture : Office'));
if($success)
odbc_result_all($query);
他のサンプルクエリ
ドライバーがサポートしているSQL の詳細は、ヘルプドキュメントを参照してください。上のサンプルは、PHP community documentation for all ODBC functions をNetSuite 向けに変更したものです。
NetSuite からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。