Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%KPI

KPI またはプラグインから値を返します。この関数は、インターシステムズによる MDX への拡張機能です。

返りタイプ

この関数は、数値を返します。

構文および詳細

%KPI(kpiName,propName,series)

または、以下のようになります。

%KPI(kpiName,propName,series,parmName1,parmValue1,parmName2,parmValue2)

以下は、この指定の説明です。

  • kpiName は、KPI またはプラグインの名前です。

  • propName は、KPI またはプラグインの <property> 要素の引用符付きの名前です。

  • series は、KPI またはプラグインの系列 (行) のオプションの番号または引用符付きの名前です。既定値は 1 です。

  • parmName1parmName2 (以降同様) は、KPI またはプラグインのパラメータのオプションの引用符付きの名前です (多くの場合、これらはフィルタです)。このパラメータ名は大文字と小文字を区別しますので、注意してください。

    フィルタをリストする順序は、KPI には影響しません。

    16 個までのパラメータとその値を指定できます。

  • parmValue1parmValue2 (以降同様) は、名前付きフィルタの対応値です。

%KPI は指定されたすべてのパラメータ値を使用して、指定された series の指定された propName の値を返します。KPI およびプラグインの場合、正規化とローカライズが行われたプロパティ名が値のキャプションになります。

MDX ベースの KPI およびプラグインの場合、特殊な %CONTEXT パラメータを使用して、クエリのコンテンツを考慮させることができます。このパラメータを使用しない場合、クエリのコンテンツは無視されます。その値に対して、以下のフラグの組み合わせを指定します。

  • "rows" は、現在のピボット行のコンテキストを使用する必要があることを指定します。

  • "columns" は、現在のピボット列のコンテキストを使用する必要があることを指定します。

  • "filters" は、現在のピボットのフィルタのコンテキストを使用する必要があることを指定します。

  • "all" は、上記をすべて使用する必要があることを指定します (既定)。

パイプ文字 (|) は、"rows|columns" のように、フラグを組み合わせるために使用します。値 "all""rows|columns|filters" と同じことを指定します。(%MDX 関数もこのパラメータを使用します。使用例は、%MDX を参照してください。)

Important:

%CONTEXT パラメータを使用する場合は、引用符で囲むことに注意してください。また、最後のパラメータとして使用しない限り、このパラメータには値を指定する必要があります。例えば、以下は有効です。

%KPI("%DeepSee.Median","MEDIAN",1,"%measure","Amount Sold","%CONTEXT")

以下も有効です。

%KPI("%DeepSee.Median","MEDIAN",1,"%CONTEXT","all","%measure","Amount Sold")

しかし、以下は正しくないため、目的どおりには解釈されません。

%KPI("%DeepSee.Median","MEDIAN",1,"%CONTEXT","%measure","Amount Sold")

KPI (プラグイン以外) は既定で同期的に実行されますが、非同期的に実行するよう定義することができます。

以下の例では、DemoMDX KPI の先頭行の PatCount プロパティの値を取得します。

SELECT %KPI("demomdx","PatCount") ON 0 FROM patients
 
                             Patient Count
                                       115

以下の例では、%DeepSee.Plugin.Median サンプル・プラグインを使用する計算メジャーを定義します。

WITH MEMBER [MEASURES].[Median Amount Sold] AS 
'%KPI("%DeepSee.Median","MEDIAN",1,"%measure","Amount Sold","%CONTEXT")' 
SELECT NON EMPTY {[Measures].[Amount Sold],[MEASURES].[MEDIAN AMOUNT SOLD]} ON 0,
NON EMPTY [Product].[P1].[Product Name].Members ON 1 
FROM [HoleFoods]

                         Amount Sold   Median Amount Sold
 1 Bagels (dozen)               38.96                 2.95
 2 Bundt Cake                1,632.01                19.95
 3 Calamari (frozen            566.90                22.95
 4 Cheerios (box)              600.11                 3.95
 5 Donuts (dozen)              429.36                 2.95
 6 Free-range Donut          1,310.64                12.95
 7 Fruit Loops (box            772.83                 4.95
 8 Lifesavers (roll            248.96                 1.15
 9 Onion ring                  377.25                 4.95
10 Onion ring                   28.57                 5.95
11 Penne (box)                 176.72                 1.95
12 Pineapple Rings             512.00                 8.95
13 Pretzels (bag)               88.12                 3.95
14 Swiss Cheese (sl            445.10                 5.95
15 Tortellini (froz          1,000.89                 6.95
16 Unsalted Pretzel            316.70                 4.25
17 Ziti (box)                  979.43                 4.81

使用可能なプラグイン・クラス

DeepSee には、%KPI 関数と併用できる複数のプラグインがあります。

%DeepSee.Distinct

指定されたレベルの個別値の数を取得します。

このプラグインは、プロパティ DISTINCT を提供します。このプラグインには、以下のパラメータを使用できます。

パラメータ
%cube キューブの論理名。
%level カウントする個別値を持つレベルまたはリレーションシップの MDX 識別子。例 : [DocD].[H1].[Doctor][RelatedCubes/Doctors].[DocD]

このプラグインは、クラス %DeepSee.PlugIn.DistinctOpens in a new tab で定義されています。

%DeepSee.Median

セルで使用される最下位レベルのすべてのレコード間で、指定されたメジャーの中央値を取得します。

このプラグインは、プロパティ MEDIAN を提供します。このプラグインには、以下のパラメータを使用できます。

パラメータ
%cube キューブの論理名。
%measure 使用する値を持つメジャーの MDX 識別子。例 : [MEASURES].[Measure Name]

このプラグインは、クラス %DeepSee.PlugIn.MedianOpens in a new tab で定義されています。

%DeepSee.Percentile

最下位レベルのすべてのレコード間で、指定されたメジャーのパーセンタイル値を取得します。

このプラグインは、プロパティ PERCENTILE を提供します。このプラグインには、以下のパラメータを使用できます。

パラメータ
%cube キューブの論理名。
%measure 使用する値を持つメジャーの MDX 識別子。例 : [MEASURES].[Measure Name]
%percentile 評価するパーセンタイル。既定値は 50 です (プラグインは、50 番目のパーセンタイルを算出します)。

このプラグインは、クラス %DeepSee.PlugIn.PercentileOpens in a new tab で定義されています。

これらのプラグイン・クラスは PLUGINTYPE"Aggregate" と定義されているため、アナライザまたはウィジェットでプラグインを直接使用することはできません。

関連項目

FeedbackOpens in a new tab