ColdFusion でJira Service Management データに連携する方法

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

CData JDBC Driver for JiraServiceDesk は、ColdFusion のrapid development tools を使ってJira Service Management への接続をシームレスに統合します。この記事では、ColdFusion でJira Service Management に連携しJira Service Management テーブルをクエリする方法を説明します。

ColdFusion にJira Service Management のJDBC データソースを作成

下記の手順に従ってJira Service Management データソースを作成し、ColdFusion アプリケーションへの連携を可能にします。

1. ドライバーのJAR および.lic ファイルを、インストールディレクトリから C:\ColdFusion10\cfusion\wwwroot\WEB-INF\lib にコピーします。

   ドライバーのJAR およびlicense はインストールディレクトリの［lib］サブフォルダに配置されています。

2. ドライバーをデータソースとして追加：

   ColdFusion Administrator インターフェースで［Data & Services］ノードを展開し、［Data Sources］>［Add New Data Source］をクリックします。ダイアログが表示されたら、以下のプロパティを入力します。

   • Data Source Name：データソースの名前を入力。名前はColdFusion 変数命名規則に一致する必要があります。
   • Driver：［Other］を選択。

3. JDBC Driver のプロパティ設定:

   • JDBC URL：JDBC URL に接続プロパティを入力。JDBC のURL は以下で始まり jdbc:jiraservicedesk: 次に、セミコロン区切りでname=value ペアの接続プロパティを入力します。以下は一般的なJDBC URL です：

     jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;

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

   • Driver Class：ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
   • Driver Name：ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
   • Username：認証するユーザーネームを入力。
   • Password：認証するパスワードを入力。

［Actions］ カラムのCData Jira Service Management データソースを有効にして、接続をテストできます。ステータスがOK になったら、Jira Service Management データソースを使うことができます。

クエリを実行

下記の手順に従って、Jira Service Management の基準に合ったレコードをクエリし、結果をHTML テーブルに出力する簡単なアプリケーションを作成します。

1. 新規ColdFusion markup ファイルでクエリを定義：C:\ColdFusion10\cfusion\wwwroot directory for ColdFusion の.cfm ファイルに次のコードを入力：

   <cfquery name="JiraServiceDeskQuery" dataSource="CDataJiraServiceDesk"> SELECT * FROM Requests </cfquery>

   Note：CData JDBC Drivers は、cfqueryparam エレメントを使ってパラメータ化されたクエリもサポートします。例：

   <cfquery name="JiraServiceDeskQuery" dataSource="CDataJiraServiceDesk"> SELECT * FROM Requests WHERE CurrentStatus = <cfqueryparam>Open</cfqueryparam> </cfquery>

2. CFTable を使ってHTML にテーブルを出力：

   <cftable query = "JiraServiceDeskQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"/> <cfcol header="<b>RequestId</b>" align="Left" width=9 text="#RequestId#"></cfcol> <cfcol header="<b>ReporterName</b>" align="Left" width=12 text="#ReporterName#"></cfcol> </cftable>

3. コードを実行してグリッドを表示します。

HTML 部分を含む以下のフルコードが利用できます。