PHP からSharePoint Excel Services のデータに接続する方法

CData ODBC Driver for ExcelServices は、PHP アプリケーションからSharePoint Excel Services のデータへの連携を実現します。本記事では、SharePoint Excel Services のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。

CData ODBC ドライバとは？

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

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

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

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

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

SharePoint Excel Services に接続するDSN を作成します。

1. まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。ODBC データソースアドミニストレータを使用してDSN を作成および設定する方法については、ヘルプドキュメントの「はじめに」の章を参照してください。
   
   

   ワークブックへの接続

   どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。

   • Library：デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
   • Folder：このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。

   テーブルとしてのスプレッドシートデータへの接続

   CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。

   API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。

   • OData： OData API を使用すると、Excel で［挿入］->［テーブル］をクリックして作成されたExcel テーブルオブジェクト（範囲やスプレッドシートではありません）から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
   • REST： REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。

   DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

   SharePoint オンプレミスへの接続

   URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。

   SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUser と Password を設定してください。

   Note：SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

   Windows（NTLM）

   最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUser と Password を設定して接続してください。

   その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。

SharePoint Excel Services への接続の確立

odbc_connect を呼び出して、SharePoint Excel Services への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。

$conn = odbc_connect("CData ExcelServices Source","user","password");

コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:

$conn = odbc_pconnect("CData ExcelServices Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

エレメントの作成

odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。

$query = odbc_prepare($conn, "SELECT * FROM Account WHERE Industry = ?");

クエリの実行

Prepared ステートメントをodbc_execute を使って実行します。

$conn = odbc_connect("CData ExcelServices Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Account WHERE Industry = ?");
$success = odbc_execute($query, array('Floppy Disks'));
  

Non-Parameterized クエリは、odbc_exec を使います。

$conn = odbc_connect("CData ExcelServices Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Account");
  

結果の処理

odbc_fetch_array ファンクションの結果セット配列としてアクセスします。

$conn = odbc_connect("CData ExcelServices Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Account");
while($row = odbc_fetch_array($query)){
 echo $row["Name"] . "\n";
}

odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。

$conn = odbc_connect("CData ExcelServices Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Account WHERE Industry = ?");
$success = odbc_execute($query, array('Floppy Disks'));
if($success)
  odbc_result_all($query);

サンプルクエリのテスト

スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。

1. PHP の最新版のバイナリのダウンロード。

2. フォルダにファイルを入れる。

3. フォルダを開く。

4. php.ini-development をphp.ini に変更。

5. ブラウザからテストスクリプトにアクセスするためのコマンドを実行。

   php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
   

他のサンプルクエリ

サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、SharePoint Excel Services 向けに最適化したものです。

SharePoint Excel Services からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

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

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