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

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

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

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

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

     jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

     API Token を取得する方法

     API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

     Confluence Cloud Account への接続

     Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

     • User: Confluence サーバーに認証するユーザー名。
     • APIToken: 認証するユーザーに紐付けられたAPI Token。
     • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

     Confluence Server Instance への接続

     Server instance への接続には以下を設定します:

     • User: Confluence Instance に接続するユーザー名。
     • Password: Confluence Instance に接続するユーザーのパスワード。
     • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net
   • Driver Class：ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.confluence.ConfluenceDriver
   • Driver Name：ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
   • Username：認証するユーザーネームを入力。
   • Password：認証するパスワードを入力。

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

クエリを実行

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

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

   <cfquery name="ConfluenceQuery" dataSource="CDataConfluence"> SELECT * FROM Pages </cfquery>

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

   <cfquery name="ConfluenceQuery" dataSource="CDataConfluence"> SELECT * FROM Pages WHERE Id = <cfqueryparam>10000</cfqueryparam> </cfquery>

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

   <cftable query = "ConfluenceQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"/> <cfcol header="<b>Key</b>" align="Left" width=3 text="#Key#"></cfcol> <cfcol header="<b>Name</b>" align="Left" width=4 text="#Name#"></cfcol> </cftable>

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

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