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

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

API Server の設定

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

Nuclia への接続

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

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

5. API キー認証の設定

   Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

   1. https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
   2. Knowledge Box の設定に移動します
   3. Service Accounts セクションに移動します
   4. 新しいサービスアカウントを作成するか、既存の API キーをコピーします

   API キーを取得したら、以下の接続プロパティを設定します：

   • AuthScheme：APIKey に設定します。
   • APIKey：Nuclia サービスアカウントの API キーに設定します。
   • KbId：Knowledge Box の UUID に設定します。
   • Zone：Nuclia のデプロイゾーンに設定します（例：aws-us-east-2-1）。

   接続文字列の例

   Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
   

   Nuclia への接続

   認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。

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

API キー認証の設定

Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます：

1. https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
2. Knowledge Box の設定に移動します
3. Service Accounts セクションに移動します
4. 新しいサービスアカウントを作成するか、既存の API キーをコピーします

API キーを取得したら、以下の接続プロパティを設定します：

• AuthScheme：APIKey に設定します。
• APIKey：Nuclia サービスアカウントの API キーに設定します。
• KbId：Knowledge Box の UUID に設定します。
• Zone：Nuclia のデプロイゾーンに設定します（例：aws-us-east-2-1）。

接続文字列の例

Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;

Nuclia への接続

認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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 でユーザーの認証トークンを入力します。
   
3. ダッシュボードに追加するテーブルとカラムを選択します。この例ではKnowledgeBox を使います。
4. リアルタイムデータを使いたい場合は、「Keep Data Table External」オプションをクリックします。このオプションは、データの変更をリアルタイムでダッシュボードに反映します。

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

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

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