各製品の資料を入手。
詳細はこちら →PHP からJira Service Management のデータに接続する方法
CData ODBC Driver を使って、PHP アプリケーションからJira Service Management にデータ連携。PHP でのODBC ネイティブサポートを活用します。
最終更新日:2023-09-26
この記事で実現できるJira Service Management 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData ODBC Driver for JiraServiceDesk は、PHP アプリケーションからJira Service Management のデータへの連携を実現します。本記事では、Jira Service Management のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- Jira Service Management をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにJira Service Management のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてJira Service Management の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとJira Service Management への接続設定
まずは、本記事右側のサイドバーからJiraServiceDesk ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
Jira Service Management に接続するDSN を作成します。
- まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。ODBC データソースアドミニストレータを使用してDSN を作成および設定する方法については、ヘルプドキュメントの「はじめに」の章を参照してください。
Jira Service Management 接続プロパティの取得・設定方法
任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。
- URL(例:https://yoursitename.atlassian.net)
カスタムフィールドへのアクセス
デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。
Jira Service Management への認証
ベーシック認証
ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。
- AuthScheme:Basic に設定。
- User:認証ユーザーのユーザー名に設定。
- Password:認証ユーザーのパスワードに設定。
API トークン
Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。
データに接続するには以下を設定します。
- AuthScheme:APIToken に設定。
- User:認証ユーザーのユーザー名に設定。
- APIToken:作成したAPI トークンに設定。
ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。
OAuth 2.0
Jira Service Management のOAuth 2.0 サポート(3LO)を活用して、ログインクレデンシャルなしでデータに接続することもできます。この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。
Jira Service Management への接続の確立
odbc_connect を呼び出して、Jira Service Management への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。
$conn = odbc_connect("CData JiraServiceDesk Source","user","password");
コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:
$conn = odbc_pconnect("CData JiraServiceDesk Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
エレメントの作成
odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。
$query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?");
クエリの実行
Prepared ステートメントをodbc_execute を使って実行します。
$conn = odbc_connect("CData JiraServiceDesk Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?");
$success = odbc_execute($query, array('Open'));
Non-Parameterized クエリは、odbc_exec を使います。
$conn = odbc_connect("CData JiraServiceDesk Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Requests");
結果の処理
odbc_fetch_array ファンクションの結果セット配列としてアクセスします。
$conn = odbc_connect("CData JiraServiceDesk Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM Requests");
while($row = odbc_fetch_array($query)){
echo $row["RequestId"] . "\n";
}
odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。
$conn = odbc_connect("CData JiraServiceDesk Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Requests WHERE CurrentStatus = ?");
$success = odbc_execute($query, array('Open'));
if($success)
odbc_result_all($query);
サンプルクエリのテスト
スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。
PHP の最新版のバイナリのダウンロード。
フォルダにファイルを入れる。
フォルダを開く。
php.ini-development をphp.ini に変更。
ブラウザからテストスクリプトにアクセスするためのコマンドを実行。
php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
他のサンプルクエリ
サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、Jira Service Management 向けに最適化したものです。
Jira Service Management からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。