インターセプター管理コマンド
新しい BAM インターセプター機能をサポートするために、4 つの新しいコマンドが BAM 管理ユーティリティに追加されました。
これらのコマンドは、インターセプターの展開、取得、および削除をサポートします。 構成されているインターセプターを一覧表示するためのコマンドも提供されています。
deploy-interceptor: インターセプター構成をデプロイします。
get-interceptorlist: インターセプトがデプロイされるアクティビティの一覧を取得します。
get-interceptor: インターセプターの構成を取得します。
remove-interceptor: インターセプター構成を削除します。
Note
-Trace:on|off パラメーター スイッチを含めることで、任意の BM ユーティリティ コマンドでトレースを有効にすることができます。 Trace スイッチを使用すると、構成ファイルのトレース設定がオーバーライドされます。 このスイッチは、通常の BM コマンドと組み合わせて使用できます。
Note
ユーザー アカウント制御 (UAC) をサポートするシステムでは、管理者特権を使用してこのツールを実行することが必要な場合があります。
deploy-interceptor コマンド
使用方法
bm.exe deploy-interceptor -FileName:<Configuration XML Filename> [-Force:True ] [-Server:<server>] [-Database:<database>]
パラメーター
| パラメーター | 説明 |
|---|---|
| FileName:<Configuration XML Filename> | インターセプター構成を含んでいる XML ファイルの名前です。 |
| Force:True | 省略可能: イベント ソース名の競合が検出されたときに、インターセプター構成のデプロイを強制します。 |
| Server:<server> | 省略可能: インターセプターをデプロイするサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 |
| Database:<database> | 省略可能: インターセプターを構成する BAM プライマリ インポート データベースの名前。 |
このコマンドは、指定されたサーバーおよびデータベースにインターセプター構成を展開します。 展開時に、BAM 管理ユーティリティによって次の検証が実行されます。
XSD 検証: インターセプター構成は、共通インターセプター構成スキーマに対して検証されます。
アクティビティが存在する (プライマリ インポート データベースに展開されている) こと、およびチェックポイントが有効である (存在し、データ型が一致している) ことの検証。
イベント ソース名で競合が検出された場合は、競合について説明する警告がスローされます。 競合が発生した場合、 –Force:True パラメーター フラグを使用しない限り、デプロイは失敗します。
Note
–Force:True パラメーターは、同じ名前のイベント ソースを参照するインターセプター構成を削除する可能性があります。 –Force:True パラメーターを使用する前に、get-interceptor コマンドを使用して既存のインターセプター構成のバックアップを作成する必要があります。
使用例
bm.exe deploy-interceptor -FileName:myInceptor.xml
bm.exe deploy-interceptor -FileName:myInceptor.xml -Force:True
get-interceptorlist コマンド
使用方法
bm.exe get-interceptorlist [-Server:<server>] [-Database:<database>]
パラメーター
| パラメーター | 説明 |
|---|---|
| Server:<server> | 省略可能: デプロイされたインターセプターの一覧を返すサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 |
| Database:<database> | 省略可能: 展開されたインターセプターの取得元となる BAM プライマリ インポート データベースの名前。 |
このコマンドは、インターセプターが有効になっているアクティビティおよびそれらに関連付けられたイベント ソースの一覧を返します。
例
bm.exe get-interceptorlist
get-interceptor コマンド
使用方法
bm.exe get-interceptor [-Server:<server>] [-Database:<database>] -FileName: <Configuration XML Filename> [ -Activity: <Activity Name>] [-EventSource: <Event Source Name>]
パラメーター
| パラメーター | 説明 |
|---|---|
| Server:<server> | 省略可能: デプロイされたインターセプターを取得するサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 |
| Database:<database> | 省略可能: 配置されたインターセプターの取得元となる BAM プライマリ インポート データベースの名前。 |
| FileName:<Configuration XML Filename> | インターセプター構成を書き込む XML ファイルの名前です。 |
| Activity:<Activity Name> | 省略可能: 構成されたインターセプターを返すアクティビティを指定します。 EventSource パラメーターと組み合わせて使用して、返す構成をさらに指定できます。 |
| EventSource:<イベント ソース名> | 省略可能: 構成されたインターセプターを返すイベント ソースを指定します。 Activity パラメーターと組み合わせて使用して、返す構成をさらに指定できます。 |
アクティビティ名とイベント ソース名を指定しない場合は、すべてのイベント ソースとアクティビティに対するインターセプター構成を含む有効な構成ファイルが返されます。
アクティビティ名のみを指定すると、そのアクティビティに関連するすべてのイベント ソースで使用される有効なインターセプター構成ファイルが返されます。
イベント ソース名のみを指定すると、すべてのアクティビティにわたってそのイベント ソースで使用される有効なインターセプター構成ファイルが返されます。
アクティビティ名とイベント ソース名の両方を指定すると、そのアクティビティに関連する指定したイベント ソースの有効なインターセプター構成ファイルが返されます。
使用例
bm.exe get-interceptor
bm.exe get-interceptor -Activity:ShippingPO
remove-interceptor コマンド
使用方法
bm.exe remove-interceptor [-Server:<server>] [-Database:<database>] [ -Activity: <Activity Name>][-EventSource: <Event Source Name>]
パラメーター
| パラメーター | 説明 |
|---|---|
| Server:<server> | 省略可能: インターセプターが構成されているサーバーの名前。 このサーバーは、bm.exe を実行するコンピューターと同じドメインに存在している必要があります。 |
| Database:<database> | 省略可能: インターセプターが構成されているデータベースの名前。 |
| アクティビティ: <アクティビティ名> | 省略可能: 指定したインターセプターを削除するアクティビティを指定します。 EventSource パラメーターと組み合わせて使用して、返す構成をさらに指定できます。 |
| EventSource: <イベント ソース名> | 省略可能: 指定したインターセプターを削除するイベント ソースを指定します。 Activity パラメーターと組み合わせて使用して、返す構成をさらに指定できます。 |
アクティビティ名のみを指定すると、そのアクティビティに関連するすべてのイベント ソースで使用されるインターセプターが削除されます。
イベント ソース名のみを指定すると、すべてのアクティビティについてそのイベント ソース部分のみが削除されます。
例
bm.exe remove-interceptor