KPI クラスおよびプラグイン・クラスのリファレンス情報
ここには、Business Intelligence KPI クラスおよびプラグイン・クラスのリファレンス情報が記載されています。
変更を加えた後は、KPI クラスをリコンパイルする必要があります。
基本要件
KPI を定義するには、以下の要件に合致したクラスを作成します。
-
%DeepSee.KPIOpens in a new tab を拡張する必要があります。
-
KPI という名前の XData ブロックを格納している必要があります。
-
この XData ブロックに対して、以下のように XMLNamespace が指定されている必要があります。
XMLNamespace = "http://www.intersystems.com/kpi"
-
XData ブロック内のルート要素が <KPI> であり、この要素がこのページに記載された要件に従っている必要があります。
-
クラスには、複数のクラス・パラメータを定義できます。"クラス・パラメータの指定" を参照してください。
プラグインの要件は、以下の例外を除いて、同じです。
-
クラスは、%DeepSee.KPIOpens in a new tab ではなく、%DeepSee.KPIPlugInOpens in a new tab を拡張する必要があります。
-
クラスには PLUGINTYPE クラス・パラメータを定義できます。"プラグインの定義" を参照してください。
KPI またはプラグインの共通属性
KPI またはプラグインの要素の多くに、以下の属性が存在します。わかりやすくするため、ここにこれらをリストします。
属性 | 目的 |
---|---|
name | 要素の論理名。 |
displayName | (オプション) ユーザ・インタフェースで使用されるこの要素のローカライズ名。この属性を指定しない場合は、代わりに name 属性で指定した値が使用されます。詳細は、"ローカライズの実行" を参照してください。 |
description | (オプション) この要素の説明。 |
disabled | (オプション) コンパイラがこの要素を使用するかどうかを制御します。この属性が "true" の場合、コンパイラはこの属性を無視します。既定では、この属性は "false" です。 |
<kpi>
<kpi> 要素は、KPI クラスまたはプラグイン・クラスにおける XData ブロックのルート要素です。この要素には以下の項目があります。
属性または要素 | 目的 |
---|---|
name、displayName、description、disabled | このページで前述の "KPI の共通属性" を参照してください。 |
caption | 使用されていません。 |
sourceType、mdx、sql | "ハードコードされたクエリを使用した KPI の定義" を参照してください。 |
rangeLower、rangeUpper、thresholdLower、thresholdUpper | "速度計の範囲としきい値の指定" を参照してください。 |
actionClass | (オプション) この KPI 内で定義されたアクションに加えてこの KPI で使用可能なアクションを定義する関連 KPI クラスを指定します。別の KPI の完全なパッケージとクラス名を指定します。 |
<property> | (オプション) ゼロ個以上の <property> 要素を含めることができます。このそれぞれが、KPI で使用するクエリの列に対応します。<property> 要素の指定がないと、クエリ結果を表示できません。 |
<action> | (オプション) ゼロ個以上の <action> 要素を含めることができます。このそれぞれを、この KPI を基にしたスコアカードの作成時に使用できます。 |
<filter> | (オプション) ゼロ個以上の <filter> 要素を含めることができます。このそれぞれを、この KPI を基にしたスコアカードの作成時に使用できます。 |
<property>
<kpi> 内の <property> 要素には以下の属性があります。
属性 | 目的 |
---|---|
name、displayName、description、disabled |
このページで前述の "KPI の共通属性" を参照してください。KPI プロパティの name または displayName は、このプロパティを表示するメータ・ウィジェットの既定のキャプションとして使用されることに注意してください。その用途に適した名前を指定すると便利です。 |
columnNo | このプロパティのデータを格納するクエリ内の列の番号。最初のデータ列は 1 です。 |
format | (オプション) この KPI がピボット・テーブル・ウィジェットで表示される場合のこのプロパティの既定の数値形式。例えば、format="##.###" のようになります。 |
style | (オプション) この KPI がピボット・テーブル・ウィジェットで表示される際に、このプロパティを表示するセルに適用される CSSOpens in a new tab スタイル。例えば、style="color:red" のようになります。 |
headerStyle | (オプション) この KPI がピボット・テーブル・ウィジェットで表示される際に、対応するヘッダ・セルに適用される CSS スタイル。例えば、style="color:red;font-style:italic" のようになります。 |
defaultValue | 使用されていません。 |
KPI テスト・ページでは、format、style、および headerStyle の各属性は無視されます。これらの属性は、ピボット・テーブル・ウィジェットにのみ作用します。
<filter>
<kpi> 内の <filter> 要素には以下の属性があります。
属性 | 目的 |
---|---|
name、displayName、description、disabled | このページで前述の "KPI の共通属性" を参照してください。 |
filterProperty | このフィルタで制御される <property> 要素の論理名。このオプションは、プログラムを使用してフィルタ値を取得する際に使用されます。 |
defaultValue | (オプション) このフィルタの既定値。スコアカードに KPI を組み込む際にもフィルタの既定値を指定できることに注意してください。その既定値は、<filter> 要素の defaultValue 属性より優先されます。 |
sql、valueList、displayList | "KPI フィルタの定義" を参照してください。 |
searchType | (オプション) このフィルタをウィジェットに表示する際に使用するコントロールの種類を指定します。既定のコントロールは、ドロップダウン・リストです。代わりにカレンダーを表示するには、この属性を "day" と指定します。 |
dependsOn | (オプション) このフィルタが依存する別のフィルタの名前を指定します。例えば、KPI に State および City という名前のフィルタがある場合、City フィルタの定義に dependsOn="State" と指定できます。 |
<action>
<kpi> 内の <action> 要素には以下の属性があります。
属性 | 目的 |
---|---|
name、displayName、description、disabled |
このページで前述の "KPI の共通属性" を参照してください。 name 属性は、applyFilter、setFilter、refresh、showListing、viewDashboard、navigate、newWindow、rowCount、rowSort、colCount、colSort のいずれにもすることができません (大文字と小文字の区別はありません)。 |
<action> 要素は、アクション自体を定義するものではありません。アクションは、クラスの %OnDashboardAction() コールバック・メソッド内で定義します。"カスタム・アクションの定義" を参照してください。
KPI またはプラグインに定義されているアクションをダッシュボード・デザイナーに通知し、選択して使用できるようにするには、<action> 要素が必要です。