BPMProcessInstancesPurge 命令

在线编辑

传统:
使用此命令可删除 Workflow Server上流程应用程序 Snapshot 的业务流程定义 (BPD) 实例数据和关联文档。

使用此命令可删除命令参数所指定的实例的 BPD 实例及其关联任务和文档。 它还会将数据记录到标准 systemout.log 文件，以跟踪哪些过滤器条件选定用于删除实例数据和关联文档。
本主题仅适用于 IBM Business Automation Workflow Advanced 配置。请记住: 不能使用此命令来删除 BPEL 流程。 使用 deleteCompletedProcessInstances.py 和 deleteCompletedTaskInstances.py 管理脚本来删除 BPEL 流程。 如需了解这些脚本的相关信息，请查看 deleteCompletedProcessInstances.py管理脚本和 deleteCompletedTaskInstances.py管理脚本
BPMProcessInstancesPurge 命令是使用 wsadmin 脚本编制客户机的 AdminTask 对象来运行的。
重要信息: 请先等待命令完成，然后再重新运行该命令。

先决条件

注: 在配置了多个安全域的环境中，使用 PALService MBean 而不是 wsadmin 命令。 请参阅 流程应用程序 LifeCycle (PAL) MBean。
必须满足以下条件：
  • 在已连接方式下（即，在不使用 wsadmin -conntype none 选项的情况下）运行命令。
  • 本主题仅适用于 IBM Business Automation Workflow Advanced 配置。要运行此命令，您必须是具有 DeAdmin 角色的用户。 在网络部署环境中，必须在包含用于处理 Workflow Server 应用程序的应用程序集群成员的节点上运行此命令。 请勿从 Deployment Manager 概要文件运行此命令。
  • 本主题仅适用于 IBM Business Automation Workflow Advanced 配置。您不能使用此命令删除 BPEL 流程。
  • 在网络部署环境中，可以从任何集群成员运行此命令。 但是，首先必须与要从中运行该命令的集群成员的 SOAP 端口建立 wsadmin 会话。

位置

从 install_root/bin 目录启动 wsadmin 脚本编制客户机。

语法

BPMProcessInstancesPurge
-instanceStatus instance_statuses
[-containerAcronym process_application_acronym]
[-containerSnapshotAcronym process_application_snapshot_acronym]
[-endedAfterLocal local_time_on_the_server]
[-endedBeforeLocal local_time_on_the_server]
[-instanceID instance_ID]
[-maximumDuration number_of_minutes]
[-outputFile file_path]
[-transactionSlice number_of_instances_to_delete_in_a_transaction]
[-force]

参数

-instanceStatus instance_status
类型为“String[]”的必需参数，用于标识要清除的流程实例的状态。
  • COMPLETED - 移除所有已完成的流程实例。
  • TERMINATED - 移除所有已终止的流程实例。
  • FAILED - 移除所有失败的流程实例。
  • DID_NOT_START - 除去处于 未启动 状态的所有流程实例。
  • SUSPENDED - 移除所有暂挂的流程实例。
  • ACTIVE - 移除所有活动流程实例。
  • ALL - 移除所有流程实例。
重要信息: 如果要删除未处于结束状态 (COMPLETED 或 TERMINATED) 的实例，那么必须指定 -force 选项。
-containerAcronym process_application_acronym
类型为 String 的可选参数，用于标识首字母缩写词，此缩写指定要清除其流程实例的流程应用程序。 例如，BillingDispute 流程应用程序可能具有首字母缩写词 BILLDISP。 如果指定 containerSnapshotAcronym 参数，那么此参数是必需的。
-containerSnapshotAcronym process_application_snapshot_acronyms
类型为 String[] 的可选参数，用于标识指定流程应用程序的 Snapshot 首字母缩写词。 Snapshot 首字母缩写词可能不同于 Snapshot 名称。
重要信息: 从最近创建的快照中删除实例时，请务必小心，因为这可能会影响 TIP 实例。
提示: 要查找 Snapshot 首字母缩写词，请运行 BPMShowProcessApplication 命令。 更多信息，请参阅 BPMShowProcessApplication 命令。
-endedAfterLocal local_time_on_the_server
类型为 String 的可选参数，用于标识服务器上的本地时间。 该字符串必须具有以下格式: yyyy-MM-ddThh:mm:ss (年，月，日， T ，小时，分钟，秒)。 仅处理在此参数指定的时间后完成或终止的实例。 如果将此参数与 endedBeforeLocal 参数配合使用，那么仅处理在此参数指定的时间段内已完成或已终止的实例。 该参数的值指示实例到达其结束状态的日期。
注: 如果指定此参数并且 instanceStatus 参数设置为 ALL，那么可能会出现意外结果，因为只有处于 COMPLETED 或 TERMINATED 状态的流程实例才能具有结束日期。 无法清除处于不同状态的流程实例，因为它们不满足时间条件。
-endedBeforeLocal local_time_on_the_server
类型为 String 的可选参数，用于标识服务器上的本地时间。 该字符串必须具有以下格式: yyyy-MM-ddThh:mm:ss (年，月，日， T ，小时，分钟，秒)。 仅处理在此参数指定的时间前完成或终止的实例。 如果将此参数与 endedAfterLocal 参数配合使用，那么仅处理在此参数指定的时间段内已完成或已终止的实例。 该参数的值指示实例到达其结束状态的日期。
注: 如果指定此参数并且 instanceStatus 参数设置为 ALL，那么可能会出现意外结果，因为只有处于 COMPLETED 或 TERMINATED 状态的流程实例才能具有结束日期。 无法清除处于不同状态的流程实例，因为它们不满足时间条件。
-instanceID 实例标识
类型为 String[] 的可选参数，用于标识要移除的实例标识的列表。 如果有多个实例标识，那么每个实例标识都必须以空格分隔（针对 Jython 格式命令）或以分号分隔（针对 JACL 格式命令）。 您也可以将此参数与 endedAfterLocal 或 endedBeforeLocal 配合使用。
-maximumDuration 分钟数
类型为 Integer 的可选参数，用于指定最大删除时间（以分钟为单位）。 如果清除所需的时间超过此参数指定的时间，那么会完成当前清除作业的当前事务片，然后停止当前清除作业。 缺省值为 0，这指示无限制。
-outputFile 文件路径
可选参数，用于提供写入流程实例清除日志条目的标准文件路径。 缺省值为 systemout.log。
-transactionSlice number_of_instances_to_delete_in_a_transaction
可选参数，用于指定每个事务中要删除的实例的数量。 缺省值为 10。 如果清除服务调整了 transactionSlice，请检查 SystemOut.log 文件中是否存在任何异常。 调整使用的值可提高清除操作的速度。
-force
如果想要删除不是处于结束状态的实例，可选参数将变为必需。 结束状态为 COMPLETED 和 TERMINATED。

使用 BPMProcessInstancesPurge 命令

在网络部署环境中，使用为运行 Workflow Server 或 Workflow Center 应用程序的应用程序集群成员配置的端口。
提示: 要确定正确的端口号，请通过单击 服务器 > 服务器类型 > WebSphere 应用程序服务器 > server_name > 通信 > 端口来查看 WebSphere 管理控制台 端口集合 页面，并找到 SOAP_CONNECTOR_ADDRESS的值。

以下部分提供使用命令的例证。

示例：删除实例和关联的任务

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.example.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMProcessInstancesPurge('[-containerAcronym PA435 -containerSnapshotAcronym V1 -instanceStatus FAILED -outputFile C:\US58626\log1.txt]')

wsadmin>AdminTask.BPMProcessInstancesPurge('[-containerAcronym PA435 -containerSnapshotAcronym [V1 V2] -instanceStatus FAILED -force -outputFile C:\US58626\log1.txt]')

示例：根据实例标识删除实例

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.example.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMProcessInstancesPurge('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -instanceStatus TERMINATED -instanceID [4 5 1001 1002]]')

示例：删除特定时间段内已完成或已终止的实例

wsadmin -conntype SOAP -port 8880 -host ProcessServer01.example.com -user admin -password admin -lang jython 

wsadmin>AdminTask.BPMProcessInstancesPurge('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 
          -instanceStatus ALL -endedAfterLocal 2015-01-01T00:00:00 -endedBeforeLocal 2015-02-31T21:37:06]')
在此情况下，虽然 -instanceStatus ALL 选择所有状态的实例，删除选择将减少为时间范围内已完成或终止的实例。

SystemOut.log 中用于确认命令已运行的样本条目

wsadmin>AdminTask.BPMProcessInstancesPurge('[-containerAcronym HSS -instanceStatus TERMINATED 
      -endedBeforeLocal 2016-11-02T21:37:06]')'The BPMProcessInstancesPurge command passed.'
SystemOut.log 条目：

[11/1/16 14:22:45:532 PDT] 000001cc CommandServic I PALAdminCommands otherProcessInstancesPurge Entering
[11/1/16 14:22:45:553 PDT] 000001cc Log           I   PAL: About to delete the process instances matching the filter criteria: 
SnapshotIDs: [Snapshot.f1659d94-2365-4903-8a90-9fa62f3ccc97, Snapshot.95fb38c2-50b4-4ba7-b3e9-24e72254233b]
Statuses: [4]
Ended before: 2016-11-02 21:37:06.0
Maximum duration: 0
Transaction slice: 10

[11/1/16 14:22:45:554 PDT] 000001cc Log           I   PAL: Number of qualifying instances before deletion: 1
[11/1/16 14:22:45:664 PDT] 000001cc Log           I   PAL: A deletion job is running. Progress: Deleted 1 instance(s).
[11/1/16 14:22:45:665 PDT] 000001cc Log           I   PAL: Every instance has been deleted. The deletion job finished.
[11/1/16 14:22:45:676 PDT] 000001cc Log           I   PAL: Successfully deleted the process instances matching the filter criteria: 
SnapshotIDs: [Snapshot.f1659d94-2365-4903-8a90-9fa62f3ccc97, Snapshot.95fb38c2-50b4-4ba7-b3e9-24e72254233b]
Statuses: [4]
Ended before: 2016-11-02 21:37:06.0
Maximum duration: 0
Transaction slice: 10

[11/1/16 14:22:45:677 PDT] 000001cc Log           I   PAL: Number of qualifying instances before deletion: 1
[11/1/16 14:22:45:689 PDT] 000001cc Log           I   PAL: Number of qualifying instances after deletion: 0
[11/1/16 14:22:45:693 PDT] 000001cc CommandServic I PALAdminCommands otherProcessInstancesPurge Exiting