OData SDK for PHP を使ってJira Service Management のデータを取得

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData Connect Cloud はJira Service Management のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Jira Service Management のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect Cloud はJira Service Management のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からJira Service Management のデータへのリアルタイム連携を実現します。

Connect Cloud を構成

ODataPHP SDK でJira Service Management のデータを操作するには、Connect Cloud からJira Service Management に接続し、コネクションにユーザーアクセスを提供してJira Service Management のデータのOData エンドポイントを作成する必要があります。

Jira Service Management に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect Cloud ユーザーの追加

必要であれば、Connect Cloud 経由でJira Service Management に接続するユーザーを作成します。

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect Cloud アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect Cloud からJira Service Management に接続

CData Connect Cloud では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「Jira Service Management」を選択します。
3. 必要な認証プロパティを入力し、Jira Service Management に接続します。

   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」セクションを参照してください。

   

4. Create & Test をクリックします。
5. 「Add Jira Service Management Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にJira Service Management OData エンドポイントを追加する

Jira Service Management に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. Jira Service Management 接続（例：JiraServiceDesk1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からJira Service Management のデータに接続できます。

1. まずは、ODataPHP SDK を使用してCData Connect Cloud が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\JiraServiceDeskEntities.php

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect Cloud およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect Cloud はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect Cloud の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってJira Service Management のデータにアクセスできます。以下のコードはRequests テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'JiraServiceDeskEntities.php'; try{ $svc = new CDataAPI(); $requests = new Requests(); $requests->CurrentStatus = 'Open'; $svc->AddToRequests($requests); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->requests()->Execute(); foreach($response->Result as $requests) echo $requests->RequestId."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }