AMO OLAP の高度なオブジェクトのプログラミング

[アーティクル]
10/31/2023

適用対象: SQL Server Analysis Services Azure Analysis Services Fabric/Power BI Premium

このトピックでは、高度な OLAP オブジェクトの分析管理オブジェクト (AMO) プログラミングの詳細について説明します。

Action オブジェクト

アクションクラスは、キューブの特定領域の参照時に、アクティブな応答を作成するために使用します。 Action オブジェクトは AMO を使用して定義できます。ただし、このオブジェクトはデータを参照するクライアントアプリケーションから使用されます。アクションにはさまざまな種類があり、その種類に応じて作成する必要があります。アクションの種類は次のとおりです。

ドリルスルーアクション。このアクションが発生したキューブで選択されているセル内のデータを表す行セットを返します。
レポートアクション。アクションが発生するキューブの選択したセクションに関連付けられているレポートを返します。
標準アクション。このアクションは、実行されたキューブで選択されているセクションに関連付けられたアクション要素 (URL、HTML、DataSet、RowSet などの要素) を返します。

Action オブジェクトを作成するには、次の手順を実行します。

Action の派生オブジェクトを作成し、基本属性を設定します。

基本属性には、アクションの種類、対象の種類またはキューブのセクション、対象またはアクションが使用可能なキューブの特定領域、キャプション、およびキャプションが MDX 式であることなどがあります。
アクションの種類の特別な属性を設定します。

3 種類のアクションはそれぞれ属性が異なります。パラメーターについては、次のサンプルコードを参照してください。
アクションをキューブコレクションに追加してキューブを更新します。アクションは更新可能なオブジェクトではありません。

アクションのテストには別のプログラムアプリケーションが必要です。 Visual Studio でアクションをテストできます。

次のサンプルコードでは、Adventure Works Analysis Services Project サンプルから 3 つの異なるアクションをレプリケートします。次のサンプルを使用して作成したアクションは "My" から始まるため、アクションを区別することができます。

static public void CreateActions(Cube cube)  
{  
    #region Adding a drillthrough action  
    // Verify That action exists and drop it  
    if (cube.Actions.ContainsName("My Reseller Details"))  
        cube.Actions.Remove("My Drillthrough Action",true);  
  
    //Create a Drillthrough action  
    DrillThroughAction dtaction = new DrillThroughAction("My Reseller Details", "My Drillthrough Action");  
  
    //Define the Action  
    dtaction.Type = ActionType.DrillThrough;  
    dtaction.TargetType = ActionTargetType.Cells;  
    dtaction.Target = "MeasureGroupMeasures(\"Reseller Sales\")";  
    dtaction.Caption = "My Drillthrough...";  
    dtaction.CaptionIsMdx = false;  
  
    #region create drillthrough action specifics  
    //Adding Drillthrough columns  
    //Adding Measure columns to the drillthrough  
    MeasureGroup mg = cube.MeasureGroups.FindByName("Reseller Sales");  
    MeasureBinding mb1 = new MeasureBinding();  
    mb1.MeasureID = mg.Measures.FindByName( "Reseller Sales Amount").ID;  
    dtaction.Columns.Add(mb1);  
  
    MeasureBinding mb2 = new MeasureBinding();  
    mb2.MeasureID = mg.Measures.FindByName("Reseller Order Quantity").ID;  
    dtaction.Columns.Add(mb2);  
  
    MeasureBinding mb3 = new MeasureBinding();  
    mb3.MeasureID = mg.Measures.FindByName("Reseller Unit Price").ID;  
    dtaction.Columns.Add(mb3);  
  
    //Adding Dimension Columns to the drillthrough  
    CubeAttributeBinding cb1 = new CubeAttributeBinding();  
    cb1.CubeID = cube.ID;  
    cb1.CubeDimensionID = cube.Dimensions.FindByName("Reseller").ID;  
    cb1.AttributeID = "Reseller Name";  
    cb1.Type = AttributeBindingType.All;  
    dtaction.Columns.Add(cb1);  
  
    CubeAttributeBinding cb2 = new CubeAttributeBinding();  
    cb2.CubeID = cube.ID;  
    cb2.CubeDimensionID = cube.Dimensions.FindByName("Product").ID;  
    cb2.AttributeID = "Product Name";  
    cb2.Type = AttributeBindingType.All;  
    dtaction.Columns.Add(cb2);  
    #endregion  
  
    //Add the defined action to the cube  
    cube.Actions.Add(dtaction);  
    #endregion  
  
    #region Adding a Standard action  
    // Verify That action exists and drop it  
    if (cube.Actions.ContainsName("My City Map"))  
        cube.Actions.Remove("My Action", true);  
  
    //Create a Drillthrough action  
    StandardAction stdaction = new StandardAction("My City Map", "My Action");  
  
    //Define the Action  
    stdaction.Type = ActionType.Url;  
    stdaction.TargetType = ActionTargetType.AttributeMembers;  
    stdaction.Target = "[Geography].[City]";  
    stdaction.Caption = "\"My View Map for \" + [Geography].[City].CurrentMember.Member_Caption + \"...\"";  
    stdaction.CaptionIsMdx = true;  
  
    #region create standard action specifics  
    stdaction.Expression = "\"http://maps.msn.com/home.aspx?plce1=\" + " +  
        "[Geography].[City].CurrentMember.Name + \",\" + " +  
        "[Geography].[State-Province].CurrentMember.Name + \",\" + " +  
        "[Geography].[Country].CurrentMember.Name + " +  
        "\"&regn1=\" + " +  
        "Case " +  
            "When [Geography].[Country].CurrentMember Is " +  
                    "[Geography].[Country].&[Australia] " +  
                "Then \"3\" " +  
            "When [Geography].[Country].CurrentMember Is " +  
                    "[Geography].[Country].&[Canada] " +  
                "Or [Geography].[Country].CurrentMember Is " +  
                    "[Geography].[Country].&[United States] " +  
                "Then \"0\" " +  
                "Else \"1\" " +  
        "End ";  
    #endregion  
  
    //Add the defined action to the cube  
    cube.Actions.Add(stdaction);  
  
    #endregion  
  
    #region Adding a Reporting action  
    // Verify That action exists and drop it  
    if (cube.Actions.ContainsName("My Sales Reason Comparisons"))  
        cube.Actions.Remove("My Report Action", true);  
  
    //Create a Report action  
    ReportAction rsaction = new ReportAction("My Sales Reason Comparisonsp", "My Report Action");  
  
    //Define the Action  
    rsaction.Type = ActionType.Report;  
    rsaction.TargetType = ActionTargetType.AttributeMembers;  
    rsaction.Target = "[Product].[Category]";  
    rsaction.Caption = "\"My Sales Reason Comparisons for \" + [Product].[Category].CurrentMember.Member_Caption + \"...\"";  
    rsaction.CaptionIsMdx = true;  
  
    #region create Report action specifics  
    rsaction.ReportServer = "MyRSSamplesServer";  
    rsaction.Path = "ReportServer?/AdventureWorks Sample Reports/Sales Reason Comparisons";  
    rsaction.ReportParameters.Add("ProductCategory", "UrlEscapeFragment( [Product].[Category].CurrentMember.UniqueName )");  
    rsaction.ReportFormatParameters.Add("rs:Command", "Render");  
    rsaction.ReportFormatParameters.Add("rs:Renderer", "HTML5");  
    #endregion  
  
    //Add the defined action to the cube  
    cube.Actions.Add(rsaction);  
  
    #endregion  
}

KPI オブジェクト

主要業績評価指標 (KPI) はキューブ内のメジャーグループに関連付けられた、ビジネスの成功の評価に使用される計算のコレクションです。 Kpi オブジェクトは AMO で定義できます。ただし、このオブジェクトはデータを参照するクライアントアプリケーションから使用されます。

オブジェクトを作成するには、 Kpi 次の手順が必要です。

オブジェクトを Kpi 作成し、基本属性を設定します。

基本属性には、説明、表示フォルダー、関連付けられたメジャーグループ、および値があります。表示フォルダーは、エンドユーザーが KPI を見つけることができるように、クライアントアプリケーションに KPI の格納場所を指示します。関連付けられたメジャーグループは、すべての MDX 計算の参照元となるメジャーグループを示します。値は、業績評価指標の実際の値を MDX 式で表します。
KPI 指標、目標、状態、および傾向を定義します。

指標は -1 ～ 1 の範囲内で評価される MDX 式です。ただし、指標の値の範囲を定義するのはブラウザーアプリケーションです。
KPI を参照すると、-1 未満の値は -1 として扱われ、1 より大きい値は 1 として扱われます。
グラフィックイメージを定義します。

グラフィックイメージは文字列値であり、表示する正しいイメージのセットを識別するために、クライアントアプリケーション内で参照として使用されます。また、グラフィックイメージの文字列は表示関数の動作も定義します。通常、範囲は奇数個の状態 ("良い" ～ "悪い" まで) に分けられており、イメージセットのイメージが各状態に割り当てられています。

Visual Studio を使用して KPI を参照する場合、名前に応じて、インジケーター範囲は 3 つの状態または 5 つの状態に分割されます。さらに、範囲が逆になる (-1 が "良い"、1 が "悪い") 名前もあります。 Visual Studio では、範囲内の 3 つの状態は次のとおりです。
- Bad = -1 から -0.5
- OK = -0.4999 から -0.4999
- Good = 0.50 から 1
Visual Studio では、範囲内の 5 つの状態は次のとおりです。
- 悪い = -1 ～ -0.75
- Risk = -0.7499 から -0.25
- OK = -0.2499 から 0.2499
- 上げ = 0.25 から 0.7499
- 良い = 0.75 ～ 1

次の表に、イメージに関連付けられた使用法、名前、および状態の数を示します。

イメージの使用法	イメージ名	状態の数
Status	図形	3
Status	信号機	3
Status	道路標識	3
Status	ゲージ	3
Status	反転ゲージ	5
Status	温度計	3
Status	[円柱]	3
Status	顔	3
Status	変位の矢印	3
傾向	標準矢印	3
傾向	状態矢印	3
傾向	反転した状態の矢印	5
傾向	顔	3

KPI は更新可能なオブジェクトではないため、KPI をキューブコレクションに追加してキューブを更新します。

KPI のテストには別のプログラムアプリケーションが必要です。 VISUAL Studio で KPI をテストできます。

次のサンプルコードでは、Adventure Works Analysis Services Project サンプルに含まれる Adventure Works キューブの KPI を "Financial Perpective/Grow Revenue" フォルダーに作成します。

static public void CreateKPIs(Cube cube)  
{  
    Kpi kpi = cube.Kpis.Add("My Internet Revenue", "My Internet Revenue");  
    kpi.Description = "(My) Revenue achieved through direct sales via Interner";  
    kpi.DisplayFolder = "\\Financial Perspective\\Grow Revenue";  
    kpi.AssociatedMeasureGroupID = "Internet Sales";  
    kpi.Value = "[Measures].[Internet Sales Amount]";  
    #region Goal  
    kpi.Goal = "Case" +  
               "     When IsEmpty" +  
               "          (" +  
               "            ParallelPeriod" +  
               "            (" +  
               "              [Date].[Fiscal Time].[Fiscal Year]," +  
               "              1," +  
               "              [Date].[Fiscal Time].CurrentMember" +  
               "            )" +  
               "          )" +   
               "     Then [Measures].[Internet Sales Amount]" +  
               "     Else 1.10 *" +  
               "          (" +  
               "            [Measures].[Internet Sales Amount]," +  
               "            ParallelPeriod" +  
               "            (" +  
               "              [Date].[Fiscal Time].[Fiscal Year]," +  
               "              1," +  
               "              [Date].[Fiscal Time].CurrentMember" +  
               "            )" +  
               "          ) " +  
               " End";  
    #endregion  
    #region Status  
    kpi.Status = "Case" +  
                 "   When KpiValue( \"Internet Revenue\" ) / KpiGoal ( \"Internet Revenue\" ) >= .95 " +  
                 "   Then 1 " +  
                 "   When KpiValue( \"Internet Revenue\" ) / KpiGoal ( \"Internet Revenue\" ) <  .95 " +  
                 "        And  " +  
                 "        KpiValue( \"Internet Revenue\" ) / KpiGoal ( \"Internet Revenue\" ) >= .85 " +  
                 "   Then 0 " +  
                 "   Else -1 " +  
                 "End";  
    #endregion  
    #region Trend  
    kpi.Trend = "Case " +  
                "    When VBA!Abs " +  
                "         ( " +  
                "           KpiValue( \"Internet Revenue\" ) -  " +  
                "           ( " +  
                "             KpiValue ( \"Internet Revenue\" ), " +  
                "             ParallelPeriod " +  
                "             (  " +  
                "               [Date].[Fiscal Time].[Fiscal Year], " +  
                "               1, " +  
                "               [Date].[Fiscal Time].CurrentMember " +  
                "             ) " +  
                "           ) / " +  
                "           ( " +  
                "             KpiValue ( \"Internet Revenue\" ), " +  
                "             ParallelPeriod " +  
                "             (  " +  
                "               [Date].[Fiscal Time].[Fiscal Year], " +  
                "               1, " +  
                "               [Date].[Fiscal Time].CurrentMember " +  
                "             ) " +  
                "           )   " +  
                "         ) <=.02  " +  
                "    Then 0 " +  
                "    When KpiValue( \"Internet Revenue\" ) -  " +  
                "         ( " +  
                "           KpiValue ( \"Internet Revenue\" ), " +  
                "           ParallelPeriod " +  
                "           (  " +  
                "             [Date].[Fiscal Time].[Fiscal Year], " +  
                "             1, " +  
                "             [Date].[Fiscal Time].CurrentMember " +  
                "           ) " +  
                "         ) / " +  
                "         ( " +  
                "           KpiValue ( \"Internet Revenue\" ), " +  
                "           ParallelPeriod " +  
                "           (  " +  
                "             [Date].[Fiscal Time].[Fiscal Year], " +  
                "             1, " +  
                "             [Date].[Fiscal Time].CurrentMember " +  
                "           ) " +  
                "         )  >.02 " +  
                "    Then 1 " +  
                "    Else -1 " +  
                "End";  
    #endregion  
    kpi.TrendGraphic = "Standard Arrow";  
    kpi.StatusGraphic = "Cylinder";  
}.

パースペクティブオブジェクト

Perspective オブジェクトは AMO で定義できます。ただし、このオブジェクトはデータを参照するクライアントアプリケーションから使用されます。

オブジェクトを作成するには、 Perspective 次の手順が必要です。

オブジェクトを Perspective 作成し、基本属性を設定します。

基本属性には、名前、既定のメジャー、説明、および注釈があります。
エンドユーザーに表示される親キューブからすべてのオブジェクトを追加します。

キューブディメンション (属性および階層)、メジャーグループ (メジャーおよびメジャーグループ)、アクション、KPI、および計算を追加します。
パースペクティブは更新可能なオブジェクトではないため、パースペクティブをキューブコレクションに追加してキューブを更新します。

パースペクティブのテストには別のプログラムアプリケーションが必要です。

次のコードでは、指定したキューブに対して "Direct Sales" という名前のパースペクティブを作成します。

static public void CreatePerspectives(Cube cube)  
{  
    Perspective perspective = cube.Perspectives.Add("Direct Sales", "Direct Sales");  
    CubeDimension dim1 = cube.Dimensions.GetByName("Date");  
    PerspectiveDimension pdim1 = perspective.Dimensions.Add(dim1.DimensionID);  
    pdim1.Attributes.Add("Date");  
    pdim1.Attributes.Add("Calendar Year");  
    pdim1.Attributes.Add("Fiscal Year");  
    pdim1.Attributes.Add("Calendar Quarter");  
    pdim1.Attributes.Add("Fiscal Quarter");  
    pdim1.Attributes.Add("Calendar Month Number");  
    pdim1.Attributes.Add("Fiscal Month Number");  
    pdim1.Hierarchies.Add("Calendar Time");  
    pdim1.Hierarchies.Add("Fiscal Time");  
  
    CubeDimension dim2 = cube.Dimensions.GetByName("Product");  
    PerspectiveDimension pdim2 = perspective.Dimensions.Add(dim2.DimensionID);  
    pdim2.Attributes.Add("Product Name");  
    pdim2.Attributes.Add("Product Line");  
    pdim2.Attributes.Add("Model Name");  
    pdim2.Attributes.Add("List Price");  
    pdim2.Attributes.Add("Size");  
    pdim2.Attributes.Add("Weight");  
    pdim2.Hierarchies.Add("Product Model Categories");  
    pdim2.Hierarchies.Add("Product Categories");  
  
    PerspectiveMeasureGroup pmg = perspective.MeasureGroups.Add("Internet Sales");  
    pmg.Measures.Add("Internet Sales Amount");  
    pmg.Measures.Add("Internet Order Quantity");  
    pmg.Measures.Add("Internet Unit Price");  
  
    pmg = perspective.MeasureGroups.Add("Reseller Sales");  
    pmg.Measures.Add("Reseler Sales Amount");  
    pmg.Measures.Add("Reseller Order Quantity");  
    pmg.Measures.Add("Reseller Unit Price");  
  
    PerspectiveAction pact = perspective.Actions.Add("Drillthrough Action");  
  
    PerspectiveKpi pkpi = perspective.Kpis.Add("Internet Revenue");  
    Cube.Update();  
}

ProactiveCaching オブジェクト

ProactiveCaching オブジェクトは AMO で定義できます。

オブジェクトを作成するには、 ProactiveCaching 次の手順が必要です。

ProactiveCaching オブジェクトを作成します。

定義する基本属性はありません。
キャッシュの仕様を追加します。

仕様	説明
AggregationStorage	集計で使用するストレージの種類。パーティションにのみ適用されます。ディメンションでは、標準である必要があります。
SilenceInterval	MOLAP イメージ作成を開始する前にキャッシュが存在する最短時間。
Latency	最も古い通知から MOLAP イメージが破棄される時点までの時間。
SilenceOverrideInterval	初期通知の後、MOLAP イメージ作成が無条件で開始されるまでの時間。
ForceRebuildInterval	新しい MOLAP イメージが削除された後、MOLAP イメージ作成が無条件で開始されるまでの時間 (通知なし)。
OnlineMode	MOLAP イメージが使用可能になる時点。 Immediate または OnCacheComplete のいずれかを指定できます。

オブジェクトを ProactiveCaching 親コレクションに追加します。は更新可能なオブジェクトではないので ProactiveCaching 、親を更新する必要があります。

次のコードサンプルでは、 ProactiveCaching 指定したデータベースの Adventure Works キューブの Internet Sales メジャーグループからすべてのパーティションにオブジェクトを作成します。

static public void SetProactiveCachingSettings(Database db)  
{  
    ProactiveCaching pc;  
    if (db.Cubes.ContainsName("Adventure Works") && db.Cubes.FindByName("Adventure Works").MeasureGroups.ContainsName("Internet Sales"))  
    {  
        ProactiveCachingTablesBinding pctb;  
        TableNotification tn;  
  
        MeasureGroup mg = db.Cubes.FindByName("Adventure Works").MeasureGroups.FindByName("Internet Sales");  
        foreach(Partition part in mg.Partitions)  
        {  
            pc = new ProactiveCaching();  
            pc.AggregationStorage = ProactiveCachingAggregationStorage.MolapOnly;  
            pc.SilenceInterval = TimeSpan.FromSeconds(10);  
            pc.Latency = TimeSpan.FromSeconds(-1);  
            pc.SilenceOverrideInterval = TimeSpan.FromMinutes(10);  
            pc.ForceRebuildInterval = TimeSpan.FromSeconds(-1);  
            pc.Enabled = true;  
            pc.OnlineMode = ProactiveCachingOnlineMode.OnCacheComplete;  
            pctb = new ProactiveCachingTablesBinding();  
            pctb.NotificationTechnique = NotificationTechnique.Server;  
            tn = new TableNotification("[FactInternetSales]", "dbo");  
            pctb.TableNotifications.Add( tn);  
            pc.Source = pctb;  
  
            part.ProactiveCaching = pc;  
            part.Update();  
        }  
    }  
}

翻訳オブジェクト

Translation オブジェクトは AMO で定義できます。ただし、このオブジェクトはデータを参照するクライアントアプリケーションから使用されます。 Translation オブジェクトのコーディングは簡単です。オブジェクトのキャプションの翻訳は、ロケール識別子とキャプションの翻訳の組によって提供されます。すべてのキャプションで複数の翻訳を使用できます。変換は、ディメンション、属性、階層、キューブ、メジャーグループ、メジャーなど、ほとんどのオブジェクトに対して提供できます。

次のコードサンプルでは、属性 Product Name の名前をスペイン語に翻訳します。

static public void CreateTranslations(Database db)  
{  
    //Spanish Tranlations for Product Category in Product Dimension  
    Dimension dim = db.Dimensions["Product"];  
    DimensionAttribute atr = dim.Attributes["Product Name"];  
    Translation tran = atr.Translations.Add(3082);  
    tran.Caption = "Nombre Producto";  
  
    dim.Update(UpdateOptions.ExpandFull);  
  
}

次の方法で共有

AMO OLAP の高度なオブジェクトのプログラミング

Action オブジェクト

KPI オブジェクト

パースペクティブオブジェクト

ProactiveCaching オブジェクト

翻訳オブジェクト

フィードバック

その他のリソース

次の方法で共有

AMO OLAP の高度なオブジェクトのプログラミング

Action オブジェクト

KPI オブジェクト

パースペクティブ オブジェクト

ProactiveCaching オブジェクト

翻訳オブジェクト

フィードバック

その他のリソース

パースペクティブオブジェクト