BAM 定義 (監視モデル) の展開コマンド
BAM 管理ユーティリティの展開コマンドを使用すると、定義を適用、変更、および削除することができます。
deploy-all: BAM 定義を展開します。
update-all: BAM 定義を更新します。
remove-all: BAM 定義を削除します。
update-livedataworkbook: ライブ データ ブック内のデータベース接続情報を更新します。
regenerate-livedataworkbook: サーバー上のライブ データ ブックを再生成します。
Note
-Trace:on|off パラメーター スイッチを含めることで、任意の BM ユーティリティ コマンドでトレースを有効にすることができます。 Trace スイッチを使用すると、構成ファイルのトレース設定がオーバーライドされます。 このスイッチは、通常の BM コマンドと組み合わせて使用できます。
Note
ユーザー アカウント制御 (UAC) をサポートするシステムでは、管理者特権を使用してこのツールを実行することが必要な場合があります。
deploy-all コマンド
使用方法
bm.exe deploy-all -DefinitionFile:<def file>[ -Server:<server> ][ -Database:<database> ]
パラメーター
パラメーター | 説明 |
---|---|
DefinitionFile:<def ファイル> | 展開する定義が格納されたファイルのパスおよび名前です。 |
Server:<server> | 省略可能: 定義をデプロイするサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 サーバー名を指定しなかった場合、既定の名前 (localhost) が使用されます。 |
Database:<database> | 省略可能: 定義をデプロイするデータベースの名前。 指定しなかった場合、既定の名前 (BamPrimaryImport) が使用されます。 |
指定された BAM 定義 XML ファイルのすべてのアイテムを、指定されたサーバーおよびデータベースに展開します。 BAM 定義 XML が含まれたテキスト ファイルか、BAM Excel ブックのいずれかのファイルを使用できます。 定義ファイルに、既存のアイテムを含めることはできません。 既に展開済みのアイテムが格納されていた場合、展開は失敗し、エラーが報告されます。
BAM 定義の展開に関する考慮事項
警告サブスクリプションを展開する場合は、サブスクライバーのユーザー ID を domain\user 形式で指定する必要があります。
分散トランザクション コーディネーター (DTC) サービスは、 deploy-all コマンドが発行されたコンピューターで実行されている必要があります。
BAM 管理ユーティリティで定義を展開するとき、RTA (リアルタイム集計) ビューでサポートされるディメンション レベルは 14 レベルまでです。 それ以上のレベルを展開すると、"配置に失敗しました" というエラーが返されます。
言語設定がそれぞれ異なる複数のビューを定義し、単一言語のサーバーに対してソリューションを展開した場合、これらのビューは展開されません。 このシナリオがサポートされるのは、BAM 定義に、OLAP を必要とするスケジュール済みの集計が含まれない場合だけです。
BAM 管理ユーティリティでは、BAM 警告が有効な場合、展開できるアクティビティ ビューが 49 個に制限されます。 アクティビティ ビューの数は、各ビューに関連付けられた親アクティビティ数の総和として計算されます。 たとえば、2 つのアクティビティに基づくビューを 1 つ展開した場合、アクティビティ ビューは 2 つです。 また、一方は 2 つのアクティビティに、もう一方は単一のアクティビティに基づく 2 つのビューを展開した場合、アクティビティ ビューの数は 3 つということになります。
BAM 管理ユーティリティでは、同じ RTA およびキューブ名の組み合わせに対して複数の PivotTable レポートを定義し、それを BAM 定義に割り当てて展開することはできません。 Bm.exe によって展開作業が強制終了され、次のようなエラーが返されます。
ビューの展開...エラー: BAM の展開に失敗しました。
特定の RTA とキューブに対して定義できる PivotTable ビューは 1 つだけです。
次に示した名前は予約されています。使用すると定義の展開時にエラーが発生します。
RecordID
ActivityID
可視
IsComplete
LastModified
Note
展開中に bm.exe でエラーが発生した場合、展開は強制終了され、ビューやアクティビティに対する変更はロールバックされます。 ただし、OLAP はトランザクション配置に対応していないため、OLAP キューブに対する変更はロールバックされません。
Note
BAM 定義を作成するコンピューターと、その展開先のコンピューターは、ロケール設定が一致している必要があります。 たとえば、ロケール設定が EN のコンピューターで、英語版の Microsoft Excel を使って作成された BAM 定義を、ロケール設定が JA (日本語) のコンピューターに展開することはできません。
使用例
bm.exe deploy-all -DefinitionFile:MyDef.xml
bm.exe deploy-all -DefinitionFile:MyWorkbook.xls -Server:machine1
update-all コマンド
使用方法
bm.exe update-all -DefinitionFile:<def file>[ -Server:<server> ][ -Database:<database> ]
パラメーター
パラメーター | 説明 |
---|---|
DefinitionFile:<def ファイル> | 更新に使用する定義が格納されたファイルのパスおよび名前です。 |
Server:<server> | 省略可能: 定義の更新を展開するサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 サーバー名を指定しなかった場合、既定の名前 (localhost) が使用されます。 |
Database:<database> | 省略可能: 定義の更新をデプロイするデータベースの名前。 指定しなかった場合、既定の名前 (BamPrimaryImport) が使用されます。 |
BAM 定義 XML に基づいて特定のアイテムを更新します。 BAM 定義 XML が含まれたテキスト ファイルか、BAM Excel ブックのいずれかのファイルを使用できます。 更新時、現在の定義ファイルに記述されていないアイテムは削除されません。 アクティビティに新しいチェックポイントを追加することはできますが、展開済みのアクティビティからチェックポイントを削除することはできません。 更新中にチェックポイントの名前を変更したり、チェックポイントのプロパティを変更したりすることはできません。
アクティビティを展開した後は、アクティビティに対して実行できる操作が制限されます。 特に、アクティビティから項目を削除するには、管理者に依頼して BAM のアクティビティとビュー セット全体を展開解除し、再展開してもらう必要があります。 このとき、管理者がデータのバックアップと復元を行わないと、データが失われたり、表示できなくなったりすることがあります。
Note
このコマンドを使って、既存のビューに新しいアクティビティを追加することはできません。 ビューをアクティビティに追加するには、新しいアクティビティを含んだビューを新規作成する必要があります。 古いビューはその後で展開解除できますが、その場合、OLAP のデータ履歴は失われます。
使用例
bm.exe update-all -DefinitionFile:MyDef.xml
bm.exe update-all -DefinitionFile:MyWorkbook.xls -Server:machine1
remove-all コマンド
使用方法
remove-all DefinitionFile:<def ファイル> のbm.exe [ -Server:<server> ][ -Database:<database> ]
パラメーター
パラメーター | 説明 |
---|---|
DefinitionFile:<def ファイル> | 削除する定義が格納されたファイルのパスおよび名前です。 |
Server:<server> | 省略可能: 定義の削除元となるサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 サーバー名を指定しなかった場合、既定の名前 (localhost) が使用されます。 |
Database:<database> | 省略可能: 定義の削除元となるデータベースの名前。 指定しなかった場合、既定の名前 (BamPrimaryImport) が使用されます。 |
BAM 定義 XML ファイルに指定されている、すべてのアイテムを削除します。 BAM 定義 XML が含まれたテキスト ファイルか、BAM Excel ブックのいずれかのファイルを使用できます。 各アイテムの定義は、元の (展開時の) 定義と完全に一致している必要があります。
使用例
bm.exe remove-all -DefinitionFile:MyDef.xml
bm.exe remove-all -DefinitionFile:MyWorkbook.xls -Server:machine1
update-livedataworkbook コマンド
使用方法
bm.exe update-livedataworkbook -Name:<livedata workbook file name>[ -Server:<server> ][ -Database:<database> ]
パラメーター
パラメーター | 説明 |
---|---|
名前:<livedata ブック> | 更新する既存のライブ ブックの名前。 |
Server:<server> | 省略可能: ブックが存在するサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 サーバー名を指定しなかった場合、既定の名前 (localhost) が使用されます。 |
Database:<database> | 省略可能: ブックが存在するデータベースの名前。 指定しなかった場合、既定の名前 (BamPrimaryImport) が使用されます。 |
指定された BAM ライブ データ ブックを対象に、BAM プライマリ インポート データベースの接続情報を更新します。
Note
新しい接続文字列を構成するときには TDDS サービスを再起動して、変更がサービスから確実に認識されるようにする必要があります。 TDDS サービスの詳細については、「 BAM Event Bus Service ストアド プロシージャ」を参照してください。
使用例
bm.exe update-livedataworkbook -Name:SalesManager_Live.xls
bm.exe update-livedataworkbook -Name:SalesManager_Live.xls -Server:SalesSrv
regenerate-livedataworkbook コマンド
使用方法
bm.exe regenerate-livedataworkbook -WorkbookName:<livedata ブック ファイル名>[ -Server:<server> ][ -Database:<database> ]
パラメーター
パラメーター | 説明 |
---|---|
WorkbookName:<livedata ブック ファイル名> | 更新するブックの名前です。 |
Server:<server> | 省略可能: ブックが存在するサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 サーバー名を指定しなかった場合、既定の名前 (localhost) が使用されます。 |
Database:<database> | 省略可能: ブックが存在するデータベースの名前。 指定しなかった場合、既定の名前 (BamPrimaryImport) が使用されます。 |
BAM ライブ データ ブックを生成します。ただし、ブックは展開されません。
例
bm.exe regenerate-livedataworkbook -WorkbookName:SalesManager_Live.xls
bm.exe regenerate-livedataworkbook -WorkbookName:SM_Live.xls -Server:S1