KPI とダッシュボード

KPI 用語

インターシステムズの KPI では、クエリによって返される各行は、KPI の独立した系列になります。以下の図は、KPI のいくつかの系列を示しています (この章で後述する KPI テスト・ページに表示されています)。系列名は、[KPI 値] テーブルの最初の列に示されます。

(既定では) 系列名は、クエリが返した最初の列の値になります。

KPI には、プロパティも含まれ、そのそれぞれが返されるデータの列に対応します。前述の例では、KPI は 5 つのプロパティを持っています。KPI を定義する際に、これらのプロパティ名とその順序をオーバーライドできます。

KPI クエリにはパラメータを含めることができます。これらは KPI フィルタと呼ばれます。なぜなら、これらは通常 (ただし、常時ではありません)、KPI が返した値をフィルタするからです。KPI テスト・ページには、利用可能な KPI フィルタがすべて表示されます。KPI メカニズムは、任意の KPI に対して一連の KPI フィルタを自動的に提供します。

また、KPI は、カスタム・コードを実行するアクションも定義できます。KPI をダッシュボードに追加する際は、これらのアクションを実行するためのコントロールをダッシュボードに追加できます。ページングを使用するテキスト分析クエリに基づく KPI の場合、その KPI では [前のページ] および [次のページ] アクションが定義されます。

テキスト分析クエリを使用する KPI の定義

テキスト分析クエリを使用する KPI を定義するには、以下の手順を実行します。

1. 以下のクラスの 1 つを拡張するクラスを作成します。

   • %iKnow.DeepSee.GenericKPIOpens in a new tab — ほとんどのクエリには、これを使用します。次の手順でクエリを指定します。

   • %iKnow.DeepSee.SourceListFilterKPIOpens in a new tab — これを使用して、ソースに関する情報を表示します。この場合は、システムは %iKnow.Queries.SourceAPIOpens in a new tab の GetByEntities() または GetByDomain() メソッドを使用します。

2. このクラスでは、使用するテキスト分析ドメインを指定します。これを実行するには、以下のいずれかを実行します。

   • ドメインの整数 ID を指定します。これを実行するには、IKDOMAINID クラス・パラメータをオーバーライドして、テキスト分析ドメインの整数 ID に設定します。

   • ドメインを定義するキューブと NLP (自然言語処理) メジャーを指定します。これを実行するには、以下のクラス・パラメータをオーバーライドします。

     • IKCUBENAME ： キューブの論理名と同じです。

     • IKMEASURENAME ： 指定されたキューブ内の NLP メジャーのローカル名と同じです。

     この手法は、キューブの統合を使用している場合にのみ可能です。詳細は、"InterSystems Business Intelligence の上級モデリング" を参照してください。

3. また、使用したスーパークラスに応じて、以下のクラス・パラメータをオーバーライドします。

   • IKPAGESIZE — 任意のページに表示される行の数と等しくなります。既定値は 10 です。

     ダッシュボード内で、これはダッシュボード・ウィジェットでページごとに表示される行数に影響を与えます。

   • IKQUERYCLASS — (%iKnow.DeepSee.GenericKPIOpens in a new tab のサブクラスを作成する場合のみ) API の完全なパッケージおよびクラス名と等しくなります。ObjectScript API に属する API クラスの 1 つを使用します。例 ： %iKnow.Queries.EntityAPIOpens in a new tab

   • IKQUERYNAME — (%iKnow.DeepSee.GenericKPIOpens in a new tab のサブクラスを作成する場合のみ) そのクラスのメソッド名と等しくなります。

4. 以下のような XData ブロックをクラスに追加します。これにより、KPI の論理名と表示名を指定します。

   /// This XData definition defines the KPI.
   XData KPI [ XMLNamespace = "http://www.intersystems.com/deepsee/kpi" ]
   {
   <kpi name="MyKPI" displayName="My KPI">
   </kpi>
   }
   

   

   必要に応じて name および displayName の値を指定します。name にはスペースや句読点を含めることはできません。displayName の値はローカライズ可能です。displayName は省略することができ、既定では name が使用されます。

   後述のサブセクション “KPI プロパティのオーバーライド” も参照してください。

5. クラスをコンパイルします。

   オプションとして KPI テスト・ページを使用します。(現在スタジオでクラスを表示している場合は、[表示]→[ウェブページ] をクリックします。)

   KPI をテストするには、[フィルタ] セクションのドロップダウン・リストを使用します。次に [クエリ送信] をクリックします。

   これらのドロップダウン・リストには、利用可能な KPI フィルタがすべて表示されます。次のサブセクションを参照してください。

利用可能な KPI フィルタ

KPI のクエリには、パラメータを含めることができます。こうしたパラメータは KPI フィルタと呼ばれます。なぜなら、これらは通常 (ただし、常時ではありません)、KPI が返した値をフィルタするからです。テキスト分析に基づく KPI では、以下の KPI フィルタが自動的に提供されます。

• 使用しているクエリに対して意味のあるクエリ・パラメータ・サブセット (テキスト分析ドメイン ID といった一部のクエリ・パラメータは自動的に処理され、公開されません)

• このドメインのすべてのパブリック・ソース・メタデータ・フィールド

• 系列名として使用する列を指定するための NAMECOLUMN パラメータ

KPI プロパティのオーバーライド

既定では、%iKnow.DeepSee.GenericKPIOpens in a new tab に基づく任意の KPI は、クエリ結果と同じ名前を使用し、クエリ結果と同じ順序ですべての結果列を公開します。この順序や名前は変更することができ、列は非表示にすることができます。

それぞれの結果列は KPI プロパティです。ユーザがダッシュボードを作成すると、以下が表示されます。

• 既定では、ユーザが KPI に基づくピボット・テーブル・ウィジェットを追加すると、KPI で定義されているものと同じ順序と名前でプロパティが表示されます。

• KPI に基づくスコアカード・ウィジェットを追加する場合は、ユーザが表示するプロパティを選択します。選択肢のドロップダウン・リストには、KPI で定義されているものと同じ順序と名前のプロパティが含まれます。

• いずれの場合も、ユーザは KPI プロパティの順序や KPI プロパティに対して表示されるタイトルを変更できます。

KPI プロパティの順序や名前を変更したり、プロパティを非表示にするには、次のように XData ブロック内に一連の <property> 要素を追加します。

XData KPI [ XMLNamespace = "http://www.intersystems.com/deepsee/kpi" ]
{
<kpi name="MyKPI" displayName="My KPI">
    <property name="entity" displayName="Entity" />
    <property name="frequency" displayName="Frequency" />
    <property name="spread" displayName="Spread" />
</kpi>
}

<property> では、name の値は、クエリが返すフィールドの名前と正確に一致することが必要です。displayName には、ユーザに表示される名前を使用します。<property> 要素を希望の順序でリストし、表示するプロパティをすべてリストします。

例

以下に KPI の例を示します。

Class GIKNOW.TopEntitiesKPI Extends %iKnow.DeepSee.GenericKPI
{

Parameter IKDOMAINID = 1;

Parameter IKPAGESIZE As %Integer = 10;

Parameter IKQUERYCLASS = "%iKnow.Queries.EntityAPI";

Parameter IKQUERYNAME = "GetTop";

/// This XData definition defines the KPI.
XData KPI [ XMLNamespace = "http://www.intersystems.com/deepsee/kpi" ]
{
<kpi name="TopEntities" displayName="Top Entities in text analytics domain 1"  >
<property name="resultNumber" displayName="rank"/>
<property name="entity" displayName="entity"/>
<property name="entUniId" displayName="Id"/>
<property name="frequency" displayName="frequency"/>
<property name="spread" displayName="spread"/>
</kpi>
}

}

別の例は、この次のセクションの “KPI でのダッシュボードの例” を参照してください。

KPI を表示するダッシュボードの作成

KPI をユーザに利用可能にするには、KPI をダッシュボードに追加します。ユーザは、さまざまな方法でダッシュボードにアクセスできるようになります。詳細は、この章で後述される “ダッシュボードへのアクセス” を参照してください。

• ダッシュボードを作成する方法

• 系列名の変更

• プロパティの構成

• [前のページ] および [次のページ] ボタンの追加

• 最大表示長の設定

• ダッシュボードの例

ダッシュボードの作成 ： Basics

以下の手順は、KPI を表示するシンプルなダッシュボードの作成方法を簡単に説明しています。

1. 管理ポータルで、[Analytics] > [ユーザ・ポータル] をクリックしてから、[ビュー] をクリックします。

   ユーザ・ポータルが表示され、既存のパブリック・ダッシュボードとピボット・テーブルがこのネームスペースにリストされます。

2. [メニュー]→[新しいダッシュボード] をクリックします。

   新しいダッシュボードに関する基本情報の入力を求めるダイアログ・ボックスが表示されます。

3. [ダッシュボード名] に値を入力します。

4. オプションで [フォルダ] の値を指定します。

5. [ページレイアウト] では、3 番目のオプション (ワークボックスなし) をクリックします。

6. [OK] をクリックします。

   ダッシュボードの作成、保存、および表示が行われます。ダッシュボードは最初は空です。

   

7. ウィジェットを追加して KPI を表示します。そのためには、以下の操作を実行します。

   1. [メニュー]→[新規ウィジェット追加...] をクリックします。

   2. 左の領域で、項目をクリックして選択肢リストを表示します。

      ピボット・テーブル・ウィジェットまたはスコアカードのいずれかを選択します。

   3. 使用するウィジェットのタイプをクリックします。

   4. [データソース] タブで、[データソース] の横にある検索ボタン をクリックします。

   5. KPI の名前をクリックします。

   6. [OK] をクリックします。

   7. スコアカードを選択した場合は、“プロパティの構成” を参照してください。

   8. [OK] をクリックして、ウィジェットを追加します。

8. ウィジェットのサイズを変更し、もう一度 [メニュー]→[保存] をクリックします。

9. 構成オプションの詳細は、以下のサブセクションを参照してください。

結果は以下のようになります。

この章の最後のセクションに、追加情報へのリンクが示されています。

系列名の変更

KPI をピボット・テーブル・ウィジェットに表示すると、行の名前として系列名が使用されます。既定では、返り値の最初の列が系列名に使用されますが、これはこのシナリオでは役に立たないかもしれません。例えば、以下の KPI では、最初の列は結果番号です。

系列名として別の列を選択するには、以下の手順に従います。

1. ウィジェットの再構成ボタン をクリックします。

2. [コントロール] タブをクリックします。

3. テーブルの右側の追加ボタン をクリックします。このテーブルは最初は空です。

4. [タイプ] で [隠し] を選択します。

5. [アクション] で、[フィルタ] を選択します。

6. [フィルタ] で、[系列名列] を選択します。

7. [デフォルト値] で、追加ボタン をクリックします。

8. 使用する列の名前を選択します (例えば、ここで示された KPI の [entity])。

9. [OK] をクリックして、既定値を追加します。

10. [OK] をクリックして、コントロールを追加します。

11. [OK] をクリックして、ウィジェットの再構成を完了します。

これで行名が変更されました。以下はその例です。

KPI でのダッシュボードの例

SAMPLES ネームスペースでは、テキスト分析を使用する KPI を表示するダッシュボードの例が用意されています。このダッシュボードを表示するには、以下の手順に進みます。

1. 管理ポータルで、SAMPLES ネームスペースにアクセスします。

2. [Analytics] > [ユーザ・ポータル] をクリックしてから、[ビュー] をクリックします。

   ユーザ・ポータルが表示され、既存のパブリック・ダッシュボードとピボット・テーブルがこのネームスペースにリストされます。

3. [Aviation event reports] をクリックします。

   要求されたダッシュボードがシステムで表示されます。

このダッシュボードで、[イベント・レポートの上位概念] ウィジェットを探します。このウィジェットは以下のように表示されます。

このウィジェットには、Aviation.KPI.TopConcepts クラスに定義された KPI が表示されます。

ダッシュボードへのアクセス

ダッシュボードは、さまざまな方法でユーザに提供できます。

• アプリケーションによってダッシュボードへの直接リンクを提供できます。

• ダッシュボードを表示可能なユーザ・ポータルを作成できます。InterSystems ユーザ・ポータルを使用するか、または独自のポータルを作成できます。

  InterSystems ユーザ・ポータルはエンド・ユーザが直接使用することを目的としています。

関連項目

• ダッシュボードの作成に関する詳細は、"ダッシュボードの作成" を参照してください。

• アプリケーションからダッシュボードへのアクセスに関する詳細は、"InterSystems Business Intelligence の実装" の “アプリケーションからダッシュボードへのアクセス” を参照してください。

• クラスへのダッシュボード定義のパッケージ化に関する詳細は、"InterSystems Business Intelligence の実装" の “クラスへの Business Intelligence 要素のパッケージ化” を参照してください。

• InterSystems ユーザ・ポータルおよびダッシュボードの詳細は、"ダッシュボードとユーザ・ポータルの使用法" を参照してください。