历史是一个组件,它可以捕获发生在进程执行中的信息并永久的保存,与运行时数据不同的是,当流程实例运行完成之后它还会存在于数据库中。
有5个历史实体对象:
HistoricProcessInstance
s 包含当前和已经结束的流程实例信息。HistoricVariableInstance
s 包含最新的流程变量或任务变量。HistoricActivityInstance
s 包含一个活动(流程上的节点)的执行信息 。HistoricTaskInstance
s 包含关于当前和过去的(已完成或已删除)任务实例信息。HistoricDetail
s 包含历史流程实例、活动实例、任务实例的各种信息。
在API中, 提供了对这5种实体的查询方法。类HistoryService 提供了以下几种方法
一、createHistoricProcessInstanceQuery()
获取流程定义ID是'XXX'、已经结束、花费时间最长(持续时间最长)的10个
HistoricProcessInstances
historyService.createHistoricProcessInstanceQuery() .finished() .processDefinitionId("XXX") .orderByProcessInstanceDuration().desc() .listPage(0, 10);
二、createHistoricVariableInstanceQuery()
在ID为'xxx'、已经结束的流程实例中查询所有
HistoricVariableInstances,并按变量名排序
historyService.createHistoricVariableInstanceQuery() .processInstanceId("XXX") .orderByVariableName.desc() .list();
三、createHistoricActivityInstanceQuery()
获取所有已经结束的流程定义ID为’XXX'并且类型是'serviceTask'中的最后一个
HistoricActivityInstance
historyService.createHistoricActivityInstanceQuery() .activityType("serviceTask") .processDefinitionId("XXX") .finished() .orderByHistoricActivityInstanceEndTime().desc() .listPage(0, 1);
四、createHistoricDetailQuery()
下个例子, 获取所有id为123的流程实例中产量的可变更新信息。这个查询只会返回
HistoricVariableUpdate
s. 注意一些变量名可能包含多个 HistoricVariableUpdate
实体, 每次流程运行时会更新变量。 你可以用 orderByTime
(变量被更新的时间) 或者 orderByVariableRevision
(运行更新时变量的版本)来排序查询.
historyService.createHistoricDetailQuery() .variableUpdates() .processInstanceId("123") .orderByVariableName().asc() .list()
这个例子获取所有流程实例ID为123的流程中,提交任务或者启动流程时的 。 这个查询只会返回 HistoricFormProperties
s 。
historyService.createHistoricDetailQuery() .formProperties() .processInstanceId("123") .orderByVariableName().asc() .list()
最后这个例子获取所有在执行ID为123的任务时的变量更新。 返回全部在任务中设置的变量(任务局部变量) HistoricVariableUpdates
, 不是流程实例变量。
historyService.createHistoricDetailQuery() .variableUpdates() .taskId("123") .orderByVariableName().asc() .list()
任务局部变量可以用 TaskService
设置或者使用 DelegateTask
, 在TaskListener
里设置:
taskService.setVariableLocal("123", "myVariable", "Variable value");
public void notify(DelegateTask delegateTask) { delegateTask.setVariableLocal("myVariable", "Variable value"); }
五、createHistoricTaskInstanceQuery()
获取所有任务中10个花费时间最长(持续时间最长)并已经结束的
HistoricTaskInstance
s 。
historyService.createHistoricTaskInstanceQuery() .finished() .orderByHistoricTaskInstanceDuration().desc() .listPage(0, 10);
获取删除原因包含"无效",最后分配给用户"kermit"的 HistoricTaskInstance
s。
historyService.createHistoricTaskInstanceQuery() .finished() .taskDeleteReasonLike("%invalid%") .taskAssignee("kermit") .listPage(0, 10);
历史配置
级别可以在配置文件 activiti.cfg.xml 或者在 spring-context中配置:
...
历史信息级别可以配置成以下几种:
none
: 忽略所有历史存档。这是流程执行时性能最好的状态,但没有任何历史信息可用。activity
: 保存所有流程实例信息和活动实例信息。 在流程实例结束时, 最后一个流程实例中的最新的变量值将赋值给历史变量。 不会保存过程中的详细信息。audit
: 这个是默认值. 它保存所有流程实例信息, 活动信息, 保证所有的变量和提交的表单属性保持同步 这样所有用户交互信息都是可追溯的,可以用来审计。full
: 这个是最高级别的历史信息存档,同样也是最慢的。 这个级别存储发生在审核以及所有其它细节的信息, 主要是更新流程变量。