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

ColdFusion の標準的なデータアクセスコードでConfluence にデータ連携。

加藤龍彦
デジタルマーケティング

最終更新日:2021-02-06

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



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]を選択。
    Adding a JDBC data source to ColdFusion. (Salesforce is shown.)
  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;

      Confluence 接続プロパティの取得・設定方法

      任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

      Confluence への認証

      Confluence は、次の認証メソッドをサポートしています:API トークン、Basic 認証、OAuth 2.0、SSO。

      API トークン - Confluence Cloud アカウント

      トークンの取得

      アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

      トークンを使用する認証

      Cloud アカウントへの認証を行うには、以下を入力します。

      • AuthScheme:APIToken に設定。
      • User:Confluence サーバーに認証する際に使用されるユーザー。
      • APIToken:現在認証されているユーザーに紐づくAPI トークン。
      • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

      Basic 認証 - Confluence Server インスタンス

      Server インスタンスへの認証を行うには、以下のように指定します。

      • AuthSchemeBasic に設定。
      • User:Confluence インスタンスに認証する際に使用されるユーザー。
      • Password:Confluence サーバーに認証する際に使われるパスワード。
      • Url:Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。
      その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

    • Driver Class:ドライバーのクラスを入力。ドライバークラスは、以下のとおりです。cdata.jdbc.confluence.ConfluenceDriver
    • Driver Name:ユーザー定義のドライバー名を入力。ドライバー名はColdFusion Administrator コンソールでデータソースを認識するために使われます。
    • Username:認証するユーザーネームを入力。
    • Password:認証するパスワードを入力。
Required connection properties specified in the JDBC URL. (Salesforce is shown.)

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

Test the connection in the Actions column. (Salesforce is shown.)

クエリを実行

下記の手順に従って、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. コードを実行してグリッドを表示します。

    Query results in an HTML table. (Salesforce is shown.)

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

<html> <head><title>Hello World</title></head> <body> <cfoutput>#ucase("hello world")#</cfoutput> <cfquery name="ConfluenceQuery" dataSource="CDataConfluence"> SELECT * FROM Pages </cfquery> <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> </body> </html>

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。