データ可視化ソリューション「Reveal」から Confluence に接続する方法

杉本和也
杉本和也
リードエンジニア
データ可視化ソリューション「Reveal」から Confluence データに接続する方法



CData API Server を使って、Reveal にConfluence データをフィードして、ビジュアライズを実現できます。コネクターによりリアルタイムデータ連携が可能になり、リフレッシュ操作で最新のデータを取得可能になります。この記事では、Reveal からConfluence のデータに接続しビジュアライズする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなConfluence OData サービスを作成していきましょう。

Confluence への接続

Reveal からConfluence のデータを操作するには、まずConfluence への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Confluence」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Confluence への接続設定を行っていきましょう! 接続設定
  5. 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 です。
    その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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 です。
その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。

API Server のユーザー設定

次に、API Server 経由でConfluence にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Confluence 用のAPI エンドポイントの作成

ユーザーを作成したら、Confluence のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でConfluence への接続を設定してユーザーを作成し、API Server でConfluence データのAPI を追加しました。これで、OData 形式のConfluence データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

ダッシュボードの作成

それでは実際に可視化を行っていきます。「Reveal」ではダッシュボードという単位でいくつかのグラフを配置して、構成していきます。

  1. Revealにログインし、「新規」→「ダッシュボード」をクリックします。
  2. Reveal
  3. データソースから「ODataフィード」を選択し
  4. Reveal
  5. API ServerのAPIエンドポイントURLを指定し、資格情報を入力します。 URLは「https://XXXXXXX/api.rsc/」といったように末尾が「api.rsc」で終わっているものを入力します。
  6. Reveal
  7. 資格情報は「汎用資格情報」を選択し、
  8. Reveal
  9. あらかじめ作成しておいたAPI Serverのユーザー名と認証トークンをそれぞれ指定します。
  10. Reveal
  11. 認証完了後、エンティティセットを選択する画面に移動するので、取得したい任意のエンティティセットを選択します。
  12. Reveal
  13. これでダッシュボードを作成する準備が整いました。あとは Reveal の機能を使って、Confluence・API Serverから取得したデータを可視化・分析することができます。
  14. Reveal
  15. 以下のようなグラフを作成することができました。
  16. Reveal

このように Confluence 内のデータをAPI を書くことなく Reveal 上で処理することができるようになります。

おわりに

これで、リアルタイムConfluence のデータから簡単なダッシュボードが作成できました。Confluence (および150 を超えるほかのソース)からのOData フィードの作成方法の詳細については、API Server のページにアクセスしてください。30 日間無料トライアルをダウンロードしてOData API を使用するツールでConfluence のデータをリアルタイムに活用しましょう。

はじめる準備はできましたか?

詳細はこちら、または無料トライアルにお申し込みください:

CData API Server お問い合わせ