SAPExecuteCommand

この API メソッドを通常のコマンドのように使用して、次に説明する各種のコマンドを実行できます。

コマンドを実行するたびに、次のいずれかの出力パラメータがシステムから返されます。

● 0 = 実行失敗

● 1 = 実行成功

PlanDataTransfer

このコマンドを使用すると、入力された計画データが再計算されます。

PlanDataSave

このコマンドを使用すると、入力された計画データが保存されます。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "PlanDataSave") このコマンドを実行すると、入力された計画データが保存されます。

PlanDataReset

このコマンドを使用すると、最後のデータ保存以降に入力された計画データがリセットされます。

PlanDataClientReset

このコマンドを使用すると、最後に正常に行われたデータの再計算以降に入力された計画データがリセットされます。

PlanDataToDisplayMode

このコマンドを使用すると、データの計画中に入力待ちモードを終了し、表示モードに切り替わります。

PlanDataToChangeMode

このコマンドを使用すると、データの計画中に入力待ちモードに切り替わります。

PauseVariableSubmit

変数の実行を一時停止するには、このコマンドをパラメータを "On" で使用します。 一時停止を解除するには、パラメータ

"Off" と共にコマンドを使用します。

PauseVariableSubmit のモードが "On" の場合、すべての Analysis 式と大部分の Analysis マクロが実行されなくなりま す。 SAPAddMessage、SAPSetVariable、PauseVariableSubmit "Off" のマクロは実行されます。

Hide/Show

ブックの Analysis UI コンポーネントを非表示または表示するには、このコマンドを使用します。 "Ribbon"、

"ContextMenu"、および "TaskPane" のタイプでこのコマンドを使用できます。

リボン全体を非表示にし ("All")、再び表示することができます ("Default")。コンテキストメニューの場合は、個々の最新表 示またはメニュー全体を非表示にし、そのメニュー全体を再び表示することができます。デザインパネルでは、Analysis およ び [コンポーネント] タブを非表示にして、完全なデザインパネルを再度表示できます。

次のコマンドがサポートされています。

● Application.Run("SAPExecuteCommand", "Hide", "Ribbon", "All")

● Application.Run("SAPExecuteCommand", "Show", "Ribbon", "Default")

● Application.Run("SAPExecuteCommand", "Hide", "ContextMenu", "Refresh_Single")

● Application.Run("SAPExecuteCommand", "Hide", "ContextMenu", "All")

● Application.Run("SAPExecuteCommand", "Show", "ContextMenu", "Default")

● Application.Run("SAPExecuteCommand", "Hide", "TaskPane", "Analysis")

● Application.Run("SAPExecuteCommand", "Hide", "TaskPane", "Components")

● Application.Run("SAPExecuteCommand", "Show", "TaskPane", "Default")

ShowPrompts

このコマンドを使用して、プロンプトダイアログを表示します。ブックまたはデータソースのプロンプトダイアログを呼び出すこと ができます。ダイアログを呼び出すには、データソースの最新表示を行う必要があります。

1 つのデータソースのプロンプトダイアログを表示します。

lResult= Application.Run("SAPExecuteCommand", "ShowPrompts", "DS_1")

このコマンドを実行すると、DS_1 のプロンプトダイアログが表示されます。これは、ブックで変数がマージされない場合にのみ 可能です。

すべてのデータソースのプロンプトダイアログを表示します。

lResult= Application.Run("SAPExecuteCommand", "ShowPrompts", "ALL") このコマンドを実行すると、ブックのすべてのデータソースのプロンプトダイアログが表示されます。

Refresh

ブックのデータの最新表示をあらかじめ行うには、このコマンドを使用します。最新表示するパラメータとして、データソースま たは計画オブジェクトを 1 つ指定できます。 パラメータが入力されていない場合、またはパラメータとして文字列 'ALL' が入力 されている場合には、すべてのデータソースと計画オブジェクトが最新表示されます。すでに最新表示されているデータソー スに対してこのコマンドを実行すると、対応するすべてのクロスタブが再描画されます。

また、データソースの一覧を最新表示することもできます。

注記

計画機能 'PF_X' にフィルタが割り当てられている場合には、エイリアスが 'PF_X' であるこのフィルタを一覧に含めること

ができます。ただし、計画機能自体は最新表示されないため、独自のコマンドで最新表示を行う必要があります。

特定のデータソースの最新表示 Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "Refresh", "DS_1") このコマンドを実行すると、DS_1 データソースのデータが最新表示されます。

すべてのデータソースの最新表示 Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "Refresh") このコマンドを実行すると、すべてのデータソースのデータが最新表示されます。

データソースの一覧を最新表示します。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "Refresh"; "DS_1;DS_2") このコマンドを実行すると、データソース DS_1 および DS_2 のデータで最新表示が行われます。

RefreshData

このコマンドを使用して、ブックに含まれるすべてのデータソースまたは定義されたデータソースの最新表示を行います。最 新表示するデータソースを指定できます。パラメータが入力されていない場合、またはパラメータとして文字列 'ALL' が入力さ れている場合には、すべてのデータソースが最新表示されます。 データソースに対してこのコマンドを実行すると、サーバに ある対応するデータが更新されて、クロスタブが再描画されます。

定義された 2 つのデータソースを最新表示します。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "RefreshData", "DS_1;DS_3") このコマンドを実行すると、サーバにあるデータソース DS_1 および DS_3 のデータが最新表示されます。

Restart

このコマンドを使用すると、ブックのすべてのデータソースまたは定義したデータソースが再起動します。技術的には、データ ソースの再起動は、現在のナビゲーション状態と選択したプロンプト値を保持しながらデータソースを削除して再挿入するのと 同じ効果があります。データソースを追加または初回最新表示するための完全なプロセスが実行されます。再起動後は、デ ータベースの新しいデータが、対応するクロスタブに含まれるようになります。データソースを再起動するには、コマンド

Refresh などを使用してデータソースの初回最新表示を実行する必要があります。パラメータが入力されていない場合、また

はパラメータとして文字列 'ALL' が入力されている場合には、すべてのデータソースが再起動されます。再起動されるデータ ソースを定義するには、データソースをセミコロン区切り一覧のパラメータとして入力できます。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "Restart", "DS_1;DS_2") このコマンドを実行すると、データソース DS_1 および DS_2 のデータが再起動されます。

AutoRefresh

1 つまたは複数のデータソースの再表示を停止するには、このコマンドをパラメータ 'Off' で使用します。再表示を再有効化す るには、このコマンドをパラメータ 'On' で使用します。データソースはいつでもオフに設定されます。この設定は、コールバッ

ク Workbook_SAP_Initialize などでも行うことができます。 すべてのパラメータは必須で、空白にはできません。

このコマンドをパラメータ 'On' で使用すると、更新待機中のすべての要求データソースのクロスタブが自動的に再表示されま す。

データソースの設定 AutoRefresh は、ブックの [最新表示を一時停止] には依存しません。ブックが一時停止されていない 場合、およびデータソースが一時停止されていない場合も、データソースに基づくクロスタブは再表示されます。データソース の AutoRefresh 値は、マクロ SAPGetProperty (SAPGetPropert y("IsAutoRefresh","DS_1") から受け取ることができま す。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "AutoRefresh", "Off", "DS_1;DS_2")

このコマンドを実行すると、データソース DS_1 および DS_2 の最上部のクロスタブは自動的に再表示されなくなります。

RegisterCallback

コールバックを登録するには、このコマンドを使用します。 SAPExecuteCommand を使用して、コールバック AfterRedisplay、BeforePlanDataSave、BeforePlanDataReset を登録できます。

UnregisterCallback

このコマンドを使用すると、上述のコールバックの登録が取り消されます。

Dim lResult As Long

lResult= Application.Run("SAPExecuteCommand", "UnregisterCallback", "AfterRedisplay") このコマンドを実行すると、AfterRedisplay コールバックの登録が取り消されます。

関連情報

コールバックの使用 [81 ページ]

Analysis UI コンポーネントの表示/非表示 [79 ページ] SAPSetVariable [76 ページ]