ColdFusion でBacklog のデータに連携する方法

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

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

ColdFusion にBacklog のJDBC データソースを作成

下記の手順に従ってBacklog のデータソースを作成し、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:backlog: 次に、セミコロン区切りでname=value ペアの接続プロパティを入力します。以下は一般的なJDBC URL です：

     jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;

     Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

     API キー認証

     ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

     1. Backlog の個人設定ページを開きます。
     2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
     3. ApiKey にAPI キーを指定します。
     4. URL はBacklog のテナントURL から取得できます。

     OAuth 認証

     ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。
   • Driver Class：ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.backlog.BacklogDriver
   • Driver Name：ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
   • Username：認証するユーザーネームを入力。
   • Password：認証するパスワードを入力。

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

クエリを実行

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

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

   <cfquery name="BacklogQuery" dataSource="CDataBacklog"> SELECT * FROM Issues </cfquery>

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

   <cfquery name="BacklogQuery" dataSource="CDataBacklog"> SELECT * FROM Issues WHERE Id = <cfqueryparam>1</cfqueryparam> </cfquery>

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

   <cftable query = "BacklogQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"/> <cfcol header="<b>Id</b>" align="Left" width=2 text="#Id#"></cfcol> <cfcol header="<b>ProjectID</b>" align="Left" width=9 text="#ProjectID#"></cfcol> </cftable>

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

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