Flowable5-历史

历史

历史是捕获流程执行过程中发生的事件并永久保存的组件. 与运行时数据不同, 历史数据在流程实例完成后也将保留在数据库中.

有6个历史实体:

HistoricProcessInstance包含有关当前和过去的流程实例的信息。
HistoricVariableInstance包含过程变量或任务变量的最新值。
HistoricActivityInstance包含有关活动（进程中的节点）的单个执行的信息。
HistoricTaskInstance包含有关当前和过去（已完成和已删除）任务实例的信息。
HistoricIdentityLink包含关于任务和流程实例上当前和过去身份链接的信息。
HistoricDetail包含与历史流程实例，活动实例或任务实例相关的各种信息。

查询历史

在API中，可以查询所有6个历史实体。该HistoryService公开的方法createHistoricProcessInstanceQuery(), createHistoricVariableInstanceQuery(), createHistoricActivityInstanceQuery(), getHistoricIdentityLinksForTask(), getHistoricIdentityLinksForProcessInstance(), createHistoricDetailQuery()和createHistoricTaskInstanceQuery().

HistoricProcessInstanceQuery

获取流程定义ID是'XXX'、已经结束、花费时间最长（持续时间最长）的10个HistoricProcessInstances

historyService.createHistoricProcessInstanceQuery()
  .finished()
  .processDefinitionId("XXX")
  .orderByProcessInstanceDuration().desc()
  .listPage(0, 10);

HistoricVariableInstanceQuery

在ID为'xxx'、已经结束的流程实例中查询所有HistoricVariableInstances, 并按变量名排序.

historyService.createHistoricVariableInstanceQuery()
  .processInstanceId("XXX")
  .orderByVariableName.desc()
  .list();

HistoricActivityInstanceQuery

获取所有已经结束的流程定义ID为’XXX'并且类型是'serviceTask'中的最后一个 HistoricActivityInstance.
historyService.createHistoricActivityInstanceQuery() .activityType("serviceTask") .processDefinitionId("XXX") .finished() .orderByHistoricActivityInstanceEndTime().desc() .listPage(0, 1);

HistoricDetailQuery

下个例子, 获取所有id为123的流程实例中产量的可变更新信息。这个查询只会返回 HistoricVariableUpdates. 注意一些变量名可能包含多个 HistoricVariableUpdate 实体, 每次流程运行时会更新变量。你可以用 orderByTime (变量被更新的时间) 或者 orderByVariableRevision (运行更新时变量的版本)来排序查询.

historyService.createHistoricDetailQuery()
  .variableUpdates()
  .processInstanceId("123")
  .orderByVariableName().asc()
  .list()

这个例子获取所有流程实例ID为123的流程中，提交任务或者启动流程时的表单属性.这个查询只会返回 HistoricFormProperties

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");
}

HistoricTaskInstanceQuery

获取所有任务中10个花费时间最长（持续时间最长）并已经结束的 HistoricTaskInstances.

historyService.createHistoricTaskInstanceQuery()
  .finished()
  .orderByHistoricTaskInstanceDuration().desc()
  .listPage(0, 10);

获取删除原因包含"无效"，最后分配给用户"kermit"的 HistoricTaskInstances.

historyService.createHistoricTaskInstanceQuery()
  .finished()
  .taskDeleteReasonLike("%invalid%")
  .taskAssignee("kermit")
  .listPage(0, 10);

历史配置

历史级别可以用编写代码的方法配置, 用枚举类型org.activiti.engine.impl.history.HistoryLevel (或者在5.11之前定义在ProcessEngineConfiguration中的常量 HISTORY_*):

ProcessEngine processEngine = ProcessEngineConfiguration
  .createProcessEngineConfigurationFromResourceDefault()
  .setHistory(HistoryLevel.AUDIT.getKey())
  .buildProcessEngine();

该级别也可以在flowable.cfg.xml或spring-context中配置：

...

以下历史级别可以配置：
none: 忽略所有历史存档。这是流程执行时性能最好的状态，但没有任何历史信息可用。

activity: 保存所有流程实例信息和活动实例信息。在流程实例结束时, 最后一个流程实例中的最新的变量值将赋值给历史变量。不会保存过程中的详细信息。

audit: 这个是默认值. 它保存所有流程实例信息, 活动信息, 保证所有的变量和提交的表单属性保持同步这样所有用户交互信息都是可追溯的，可以用来审计。

full: 这个是最高级别的历史信息存档，同样也是最慢的。这个级别存储发生在审核以及所有其它细节的信息, 主要是更新流程变量。