カスタム・アクションの定義

コンテキスト情報

DeepSee は、2 つの異なるメカニズムによって、アクションでコンテキスト情報を利用できるようにします。ユーザがカスタム・アクションを起動すると、DeepSee はコンテキスト情報を pContext 変数に書き込みます。この変数は、サーバ上のカスタム・コードで使用できます。カスタム・アクションが URL を開くとき、その URL に $$$VALUELIST および $$$CURRVALUE トークンが含まれていれば、DeepSee はそれらのトークンを置換します。以下の図は、これらのメカニズムを示しています。

アクションの宣言

アクションを宣言するには、KPI クラスで以下のタスクのどちらかか両方を実行します。

• <kpi> 要素内に、アクションごとに <action> 要素を 1 つずつ含めます。

  この要素では、この KPI クラス内で使用可能なアクションの名前を指定します。ユーザ・インタフェースでは、この情報を使用して、ユーザが使用できるアクションの一覧が作成されます。以下はその例です。

  <kpi xmlns="http://www.intersystems.com/deepsee/kpi"
   name="Holefoods Actions">
  
  <action name="ActionA"/>
  <action name="ActionB"/>
  <action name="ActionC"/>
  </kpi>
  

  

  <action> の詳細は、"DeepSee 上級モデリング・ガイド" の付録 “KPI クラスおよびプラグイン・クラスのリファレンス情報” を参照してください。

• KPI クラスの %OnGetActionList() コールバック・メソッドをオーバーライドします。このメソッドには、以下のシグニチャがあります。

  ClassMethod %OnGetActionList(ByRef pActions As %List, pDataSourceName As %String = "") As %Status
  

  

  pActions は以下のノードの配列です。

  ノード	値
  pActions	アクションの数
  pActions(n)	n 番目のアクションに関する詳細。これは、以下の項目で構成される $LISTBUILD リストです。 論理アクション名に等しい文字列 対応する表示名に等しい文字列

  pDataSourceName は、将来使用するためのものです。

  以下はその例です。

  ClassMethod %OnGetActionList(ByRef pActions As %List, pDataSourceName As %String = "") As %Status
  {
      set newaction=$LB("New Action","New Action Display Name")
      set pActions($I(pFilters))=newaction
      quit $$$OK
  }
  

  

アクションの動作の定義

アクションの動作を定義するには、KPI クラスの %OnDashboardAction() コールバック・メソッドをオーバーライドします。このメソッドには、以下のシグニチャがあります。

classmethod %OnDashboardAction(pAction As %String, pContext As %ZEN.proxyObject) as %Status

DeepSee は、ユーザがダッシュボードでアクションを呼び出したときに、このコールバックを実行します。pAction は、アクションの論理名です。pContext は、現在選択されているスコアカード行に関する情報を含むオブジェクトであり、メソッドがダッシュボードにコマンドを返す方法を提供します。以降のセクションで詳細を説明します。

簡単な例を以下に示します。

ClassMethod %OnDashboardAction(pAction As %String, pContext As %ZEN.proxyObject) As %Status
{
 Set sc = $$$OK
 Try {
      If (pAction = "Action 1") {
              //this part defines Action 1
              //perform server-side actions
          }
         Elseif (pAction="Action 2")
         {
                //this part defines Action 2
                //perform other server-side actions
                 }
        }
        Catch(ex) {
                Set sc = ex.AsStatus()
        }
 Quit sc
}

このメソッドでは、Action 1 と Action 2 の 2 つのアクションを定義します。

シナリオ : ピボット・テーブルをデータ・ソースとして使用するピボット・テーブル・ウィジェット

このシナリオでは、%OnDashboardAction() メソッド内で pContext 変数は以下のプロパティを持ちます。

シナリオ : リストをデータ・ソースとして使用するピボット・テーブル・ウィジェット

このシナリオでは、%OnDashboardAction() メソッド内で pContext 変数は以下のプロパティを持ちます。

シナリオ : KPI をデータ・ソースとして使用するピボット・テーブル・ウィジェット

このシナリオでは、%OnDashboardAction() メソッド内で pContext 変数は以下のプロパティを持ちます。

シナリオ : KPI をデータ・ソースとして使用するスコアカード

このシナリオでは、%OnDashboardAction() メソッド内で pContext 変数は以下のプロパティを持ちます。

使用可能なコマンド

pContext.command 内では、以下のコマンドを使用できます。

alert

alert:message

メッセージがダイアログ・ボックスに表示されます。message は表示されるメッセージです。

以下はその例です。

 Set pContext.command = "alert:hello world!"

applyFilter

applyFilter:target:filterSpec

引数の詳細は、“applyFilter と setFilter の詳細” を参照してください。

このコマンドは、指定されたフィルタを設定し、ブラウザ・ウィンドウを更新します。

例えば、以下のように、ピボット・テーブルにフィルタを適用します。

 Set pContext.command = "applyFilter:samplepivot:[DateOfSale].[Actual].[YearSold]:&[2008]"

navigate

navigate:url

url は、表示する URL です。

このコマンドは、指定された URL を同じブラウザ・ウィンドウ内で開きます。

以下はその例です。

 Set pContext.command = "navigate:http://www.google.com"

newWindow

newWindow:url

url は、表示する URL です。

このコマンドは、指定された URL を新しいブラウザ・ウィンドウ内で開きます。

以下はその例です。

 Set pContext.command = "newWindow:http://www.google.com"

popup

popup:zenpopupurl

zenpopupurl は、Zen ポップアップ・ウィンドウの相対 URL です。

このコマンドにより、指定された Zen ポップアップ・ウィンドウが表示されます。以下はその例です。

 Set pContext.command = "popup:%ZEN.Dialog.fileSelect.cls"

refresh

refresh:widgetname

widgetname は更新するウィジェットのオプションの名前です。この引数を省略すると、コマンドはユーザがアクションを起動したウィジェットを更新します。

このコマンドは、ブラウザ・ウィンドウの更新に、フィルタの現在の設定を使用します。

以下はその例です。

 // Refresh the widget that fired this action and another named samplepivot.
 Set pContext.command = "refresh;refresh:samplepivot"

この例では複数のコマンドがセミコロンで区切られています。

setFilter

setFilter:target:filterSpec

引数の詳細は、“applyFilter と setFilter の詳細” を参照してください。

このコマンドは、指定されたフィルタを設定しますが、ブラウザ・ウィンドウは更新しません。

applyFilter と setFilter の詳細

applyFilter および setFilter コマンドはそれぞれ以下のとおりです。

applyFilter:target:filterSpec

および、

setFilter:target:filterSpec

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

• target は、フィルタ処理するウィジェットです。アスタリスク (*) を使用すると、すべてのウィジェットにフィルタを適用できます。

• filterSpec では、指定のターゲットに適用するフィルタ値を指定します。これは、以下の形式にする必要があります。

  filter_name:filter_values
  

  

  引数は、以下のようにターゲット・ウィジェットの詳細によって異なります。

  シナリオ	filter_name	filter_values
  ターゲット・ウィジェットでピボット・テーブルを表示する	[dimension].[hierarchy].[level]	“設定の構成” の章の “指定可能なフィルタの既定値” を参照してください。
  ターゲット・ウィジェットで KPI を表示する	その KPI に定義されているフィルタ名	このフィルタに使用できる値のいずれか (KPI で定義されているものと同じ)

  メモ ：

  • 複数のフィルタ仕様を使用できます。そのためには、チルダ (~) でそれぞれを区切ります。以下はその例です。

    FILTER:filterspec1~filterspec2
    

    

  • MDX クエリを使用する KPI やピボット・テーブルの場合、フィルタ名とフィルタ値では大文字と小文字は区別されません。

  • このフィルタが作用するウィジェットは、同じフィルタを使用するフィルタ・コントロール (非表示の場合もあります) で構成されているウィジェットのみです。例えば、ウィジェットに Cities フィルタ・コントロールが含まれていて、その他のフィルタ・コントロールが含まれていないとします。アクションが市町村に対するフィルタ処理の場合、そのウィジェットは更新されます。アクションが郵便番号に対するフィルタ処理の場合、そのウィジェットは更新されません。