OData を介してTIBCO Spotfire でCircleCI のデータをビジュアライズ

古川えりか
古川えりか
コンテンツスペシャリスト
CircleCI のデータをTIBCO Spotfire のダッシュボードに統合。



OData は、クラウドベース、モバイル、およびその他のオンラインアプリケーション間のリアルタイム通信を可能にする主要なプロトコルです。CData API Server は、CircleCI のADO.NET Provider for API と組み合わせると、CircleCI のデータ（またはその他の240+ のADO.NET Providers データ）をTIBCO Spotfire などのOData コンシューマに提供します。この記事では、API Server とSpotfire のOData の組み込みサポートを使用して、CircleCI のデータにリアルタイムでアクセスする方法を説明します。

API Server の設定

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

CircleCI への接続

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

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「CircleCI」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、CircleCI への接続設定を行っていきましょう！ 接続設定

  5. API キー認証の設定

    CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。

    以下の接続プロパティを設定して接続を確立してください：

    • AuthScheme：APIKey に設定します。
    • APIKey：CircleCI のパーソナル API トークンに設定します。

    接続文字列の例：

    Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

API キー認証の設定

CircleCI は、API リクエストの認証にパーソナル API トークンを使用します。パーソナル API トークンを生成するには、CircleCI アカウントにログインし、User Settings > Personal API Tokens に移動して、Create New Token をクリックします。トークンの値は一度しか表示されないため、すぐにコピーしてください。

以下の接続プロパティを設定して接続を確立してください：

  • AuthScheme：APIKey に設定します。
  • APIKey：CircleCI のパーソナル API トークンに設定します。

接続文字列の例：

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

API Server のユーザー設定

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

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

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

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

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

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

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

外部CircleCI のデータでデータビジュアライゼーションを作成する

  1. Spotfire を開き、「Add Data Tables」->「OData」をクリックします。
  2. 「OData Connection」ダイアログで、以下の情報を入力します。
    • Service URL：API Server のOData エンドポイントを入力します。例： 
      http://localhost:8032/api.rsc
    • Authentication Method：Username とPassword を選択します。
    • Username：API Server ユーザーのユーザー名を入力します。管理コンソールの「Security」タブでAPI ユーザーを作成できます。
    • Password：API Server でユーザーの認証トークンを入力します。
    Required connection settings to connect to the API Server.
  3. ダッシュボードに追加するテーブルとカラムを選択します。この例ではArtifacts を使います。 API Server API Entities.(Salesforce is shown.)
  4. リアルタイムデータを使いたい場合は、「Keep Data Table External」オプションをクリックします。このオプションは、データの変更をリアルタイムでダッシュボードに反映します。

    データをメモリにロードしてローカルで処理したい場合は、「Import Data Table」オプションをクリックします。このオプションは、オフラインでの使用、またはネットワーク接続が遅くダッシュボードとのやり取りが遅延する場合に適しています。

  5. テーブルを追加すると「Recommended Visualizations」ウィザードが表示されます。テーブルを選択すると、Spotfire はカラムのデータ型を使ってnumber、time、category カラムを検出します。この例ではNumbers セクションで を、Categories セクションで を使用しています。Recommended visualizations for the imported data table.(Salesforce is shown.)

［Recommended Visualizations］ウィザードでいくつかビジュアライズを作成したら、ダッシュボードにその他の修正を加えることができ、例えばフィルタを適用できます。「Filter」ボタンをクリックすると、各クエリで使用可能なフィルタが「Filters」ペインに表示されます。

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

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

CData API Server

この記事の内容

関連記事