活动管理命令
你可借助 BAM 管理实用程序的活动管理命令来处理已部署的活动。
get-activities：获取已部署活动的列表。
remove-activity：删除活动。
get-activitywindow：获取活动的持续时间。
set-activitywindow：设置活动的活动持续时间。
get-index：获取索引列表。
create-index：创建新索引。
delete-index：删除索引。
get-archive：获取存档活动的行为。
set-archive：设置存档活动的行为。
注意
可以通过包括 -Trace：on|off 参数开关在任何 BAM 实用工具命令上启用跟踪。 使用 Trace 开关将重写配置文件中的跟踪设置。 该开关可与所有标准 BAM 命令一起使用。
注意
在支持用户帐户控制 (UAC) 的系统上，可能需要具有管理权限才能运行该工具。
get-activities 命令
使用情况
bm.exe get-activities [ -View：<view name> ][ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| Name：<activity name> | 要删除的活动的名称。 |
| Server：<server> | 可选：要从中获取活动列表的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用默认名称 localhost。 |
| Database：<database> | 可选：要从中获取活动列表的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
列出在执行此命令的计算机上部署的活动。
示例
bm.exe get-activities -View:SalesManagerView
bm.exe get-activities -Server:MyServer -Database:MyPrimaryImport
remove-activity 命令
使用情况
bm.exe remove-activity -Name：<activity name>[ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| Name：<activity name> | 要删除的活动的名称。 |
| Server：<server> | 可选：要从中删除活动的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用默认名称 localhost。 |
| Database：<database> | 可选：要从中删除活动的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
从 BAM 主导入数据库中删除指定的活动。 如果该活动具有相关视图，则此命令将失败并报告错误。 使用 remove-view 命令删除所有相关视图后，即可再次执行 remove-activity 命令。
示例
bm.exe remove-activity -Name:PurchaseOrder
bm.exe remove-activity -Name:PO -Server:MyServer -Database:MyPrimaryImport
get-activitywindow 命令
使用情况
bm.exe get-activitywindow -Activity：<activity name>[ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| Activity：<activity name> | .activity 的名称。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用默认名称 localhost。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
显示指定活动的持续时间。 该命令返回持续时间的长度和度量单位。
示例
bm.exe get-activitywindow -Activity:PurchaseOrder
bm.exe get-activitywindow -Activity:PO -Server:Ship -Database:ShipDatabase
set-activitywindow 命令
使用情况
bm.exe set-activitywindow -Activity：<activity name> -TimeLength：<integer number> -TimeUnit：Month|Day|小时|Minute[ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| Activity：<activity name> | 活动的名称。 |
| TimeLength：<integer number> | 活动的持续时间。 |
| TimeUnit:Month|Day|Hour|Minute | 持续时间的度量单位。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用默认名称 localhost。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
设置指定活动的持续时间。
示例
bm.exe set-activitywindow -Activity:PurchaseOrder -TimeLength:6 -TimeUnit:Day
bm.exe set-activitywindow -Activity:PurchaseOrder -TimeLength:1 -TimeUnit:Month
get-index 命令
使用情况
bm.exe get-index -Activity：<activity name>[ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| Activity：<activity name> | 活动的名称。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用 localhost 的默认名称。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
列出已为指定活动创建的所有索引。
示例
bm.exe get-index -Activity:PurchaseOrder
bm.exe get-index -Activity:PurchaseOrder -Server:Ship -Database:ShipDatabase
create-index 命令
使用情况
bm.exe create-index -IndexName：<index name> -Activity：<activity name> -Checkpoint：<checkpoint1>[，<checkpoint2>...][ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| IndexName：<index name> | 新索引的名称。 |
| Activity：<activity name> | 创建索引的活动的名称。 |
| Checkpoint：<checkpoint1>[，<checkpoint2>...] | 以逗号分隔的索引检查点列表。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用 localhost 的默认名称。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
使用指定检查点为指定的活动创建索引。
示例
bm.exe create-index -IndexName:Idx1 -Activity:PO -Checkpoint:State,City
bm.exe create-index -IndexName:Idx2 -Activity:PO -Checkpoint:Amount -Server:S1
delete-index 命令
使用情况
bm.exe delete-index -IndexName：<index name> -Activity：<activity name>[ -Server：<server> ][ -Database：<database> ]
参数
| 参数 | 说明 |
|---|---|
| IndexName：<index name> | 要删除的索引的名称。 |
| Activity：<activity name> | 删除索引的活动的名称。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用 localhost 的默认名称。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
从指定活动中删除具有给定名称的指定索引。
示例
bm.exe delete-index -IndexName:Idx1 -Activity:PO
bm.exe delete-index -IndexName:Idx2 -Activity:PO -Server:S1 -Database:BamPI1
get-archive 命令
使用情况
bm.exe get-archive -Activity：<activity> [-Server：<server>] [-Database：<database>]
参数
| 参数 | 说明 |
|---|---|
| Activity：<activity name> | 要显示其行为的活动的名称。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用 localhost 的默认名称。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
获取指定活动的存档程序包的行为，无论存档程序包是存档还是清除活动数据。
示例
bm.exe get-archive -Activity:PurchaseOrder
set-archive 命令
使用情况
bm.exe set-archive -Activity：<activity> -ShouldArchive：True [-Server：<server>] [-Database：<database>]
参数
| 参数 | 说明 |
|---|---|
| Activity：<activity name> | 要显示其行为的活动的名称。 |
| ShouldArchive： True | 如果设置为 True，则将活动移至存档数据库。 如果设置为 False，则清除活动。 |
| Server：<server> | 可选：活动所在的服务器的名称。 服务器必须与运行 bm.exe 的计算机位于同一域中。 如果未指定服务器名称，bm.exe 将使用 localhost 的默认名称。 |
| Database：<database> | 可选：活动所在的数据库的名称。 如果未指定该名称，则 bm.exe 将使用默认名称 BamPrimaryImport。 |
设置指定活动的存档程序包的行为，以便将活动数据移至存档数据库。 默认情况下，会为部署的新活动设置此行为。
示例
若要清除 BAM 活动数据，请执行以下操作：
bm.exe set-archive -Activity:PurchaseOrder -ShouldArchive:False
若要将 BAM 活动数据移至 BAMArchive 数据库，请执行以下操作：
bm.exe set-archive -Activity:PurchaseOrder -ShouldArchive:True