HistoryService (Camunda BPM Javadocs 7.11.21-ee)

All Known Implementing Classes:

HistoryServiceImpl
```
public interface HistoryService
```
Service exposing information about ongoing and past process instances. This is different from the runtime information in the sense that this runtime information only contains the actual runtime state at any given moment and it is optimized for runtime process execution performance. The history information is optimized for easy querying and remains permanent in the persistent storage.

Author:

Christian Stettler, Tom Baeyens, Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Job`	`cleanUpHistoryAsync()` Schedules history cleanup job at batch window start time.
`Job`	`cleanUpHistoryAsync(boolean immediatelyDue)` Schedules history cleanup job at batch window start time.
`CleanableHistoricBatchReport`	`createCleanableHistoricBatchReport()` Creates a new programmatic query to create a cleanable historic batch report.
`CleanableHistoricCaseInstanceReport`	`createCleanableHistoricCaseInstanceReport()` Creates a new programmatic query to create a cleanable historic case instance report.
`CleanableHistoricDecisionInstanceReport`	`createCleanableHistoricDecisionInstanceReport()` Creates a new programmatic query to create a cleanable historic decision instance report.
`CleanableHistoricProcessInstanceReport`	`createCleanableHistoricProcessInstanceReport()` Creates a new programmatic query to create a cleanable historic process instance report.
`HistoricActivityInstanceQuery`	`createHistoricActivityInstanceQuery()` Creates a new programmatic query to search for `HistoricActivityInstance`s.
`HistoricActivityStatisticsQuery`	`createHistoricActivityStatisticsQuery(String processDefinitionId)` Query for the number of historic activity instances aggregated by activities of a single process definition.
`HistoricBatchQuery`	`createHistoricBatchQuery()` Creates a query to search for `HistoricBatch` instances.
`HistoricCaseActivityInstanceQuery`	`createHistoricCaseActivityInstanceQuery()` Creates a new programmatic query to search for `HistoricCaseActivityInstance`s.
`HistoricCaseActivityStatisticsQuery`	`createHistoricCaseActivityStatisticsQuery(String caseDefinitionId)` Query for the number of historic case activity instances aggregated by case activities of a single case definition.
`HistoricCaseInstanceQuery`	`createHistoricCaseInstanceQuery()` Creates a new programmatic query to search for `HistoricCaseInstance`s.
`HistoricDecisionInstanceQuery`	`createHistoricDecisionInstanceQuery()` Creates a new programmatic query to search for `HistoricDecisionInstance`s.
`HistoricDecisionInstanceStatisticsQuery`	`createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)` Query for the statistics of DRD evaluation.
`HistoricDetailQuery`	`createHistoricDetailQuery()` Creates a new programmatic query to search for `HistoricDetail`s.
`HistoricExternalTaskLogQuery`	`createHistoricExternalTaskLogQuery()` Creates a new programmatic query to search for `historic external task logs`.
`HistoricIdentityLinkLogQuery`	`createHistoricIdentityLinkLogQuery()` Creates a new programmatic query to search for `historic identity links`.
`HistoricIncidentQuery`	`createHistoricIncidentQuery()` Creates a new programmatic query to search for `historic incidents`.
`HistoricJobLogQuery`	`createHistoricJobLogQuery()` Creates a new programmatic query to search for `historic job logs`.
`HistoricProcessInstanceQuery`	`createHistoricProcessInstanceQuery()` Creates a new programmatic query to search for `HistoricProcessInstance`s.
`HistoricProcessInstanceReport`	`createHistoricProcessInstanceReport()` Creates a new programmatic query to create a historic process instance report.
`HistoricTaskInstanceQuery`	`createHistoricTaskInstanceQuery()` Creates a new programmatic query to search for `HistoricTaskInstance`s.
`HistoricTaskInstanceReport`	`createHistoricTaskInstanceReport()` Creates a new programmatic query to create a historic task instance report.
`HistoricVariableInstanceQuery`	`createHistoricVariableInstanceQuery()` Creates a new programmatic query to search for `HistoricVariableInstance`s.
`NativeHistoricActivityInstanceQuery`	`createNativeHistoricActivityInstanceQuery()` creates a native query to search for `HistoricActivityInstance`s via SQL
`NativeHistoricCaseActivityInstanceQuery`	`createNativeHistoricCaseActivityInstanceQuery()` creates a native query to search for `HistoricCaseActivityInstance`s via SQL
`NativeHistoricCaseInstanceQuery`	`createNativeHistoricCaseInstanceQuery()` creates a native query to search for `HistoricCaseInstance`s via SQL
`NativeHistoricDecisionInstanceQuery`	`createNativeHistoricDecisionInstanceQuery()` creates a native query to search for `HistoricDecisionInstance`s via SQL
`NativeHistoricProcessInstanceQuery`	`createNativeHistoricProcessInstanceQuery()` creates a native query to search for `HistoricProcessInstance`s via SQL
`NativeHistoricTaskInstanceQuery`	`createNativeHistoricTaskInstanceQuery()` creates a native query to search for `HistoricTaskInstance`s via SQL
`NativeHistoricVariableInstanceQuery`	`createNativeHistoricVariableInstanceQuery()` creates a native query to search for `HistoricVariableInstance`s via SQL
`UserOperationLogQuery`	`createUserOperationLogQuery()` Creates a new programmatic query to search for `UserOperationLogEntry` instances.
`void`	`deleteHistoricBatch(String id)` Deletes a historic batch instance.
`void`	`deleteHistoricCaseInstance(String caseInstanceId)` Deletes historic case instance.
`void`	`deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds)` Deletes historic case instances and all related historic data in bulk manner.
`void`	`deleteHistoricDecisionInstance(String decisionDefinitionId)` Deprecated. Note that this method name is not expressive enough, because it is also possible to delete the historic decision instance by the instance id. Therefore use `deleteHistoricDecisionInstanceByDefinitionId(java.lang.String)` instead to delete the historic decision instance by the definition id.
`void`	`deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId)` Deletes historic decision instances of a decision definition.
`void`	`deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId)` Deletes historic decision instances by its id.
`Batch`	`deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query, String deleteReason)` Deletes historic decision instances asynchronously based on query of decision instances.
`Batch`	`deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds, HistoricDecisionInstanceQuery query, String deleteReason)` Deletes historic decision instances asynchronously based on query and a list of decision instances, whereby query result and list of ids will be merged.
`Batch`	`deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds, String deleteReason)` Deletes historic decision instances asynchronously based on a list of decision instances.
`void`	`deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds)` Deletes decision instances and all related historic data in bulk manner.
`void`	`deleteHistoricProcessInstance(String processInstanceId)` Deletes historic process instance.
`void`	`deleteHistoricProcessInstanceIfExists(String processInstanceId)` Deletes historic process instance.
`void`	`deleteHistoricProcessInstances(List<String> processInstanceIds)` Deletes historic process instances.
`Batch`	`deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason)` Deletes historic process instances asynchronously based on query.
`Batch`	`deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)` Deletes historic process instances asynchronously based on query and a list of process instances.
`Batch`	`deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, String deleteReason)` Deletes historic process instances asynchronously.
`void`	`deleteHistoricProcessInstancesBulk(List<String> processInstanceIds)` Deletes historic process instances and all related historic data in bulk manner.
`void`	`deleteHistoricProcessInstancesIfExists(List<String> processInstanceIds)` Deletes historic process instances.
`void`	`deleteHistoricTaskInstance(String taskId)` Deletes historic task instance.
`void`	`deleteHistoricVariableInstance(String variableInstanceId)` Deletes a historic variable instance by its id.
`void`	`deleteHistoricVariableInstancesByProcessInstanceId(String processInstanceId)` Deletes all historic variables and historic details (variable updates, form properties) of a process instance.
`void`	`deleteUserOperationLogEntry(String entryId)` Deletes a user operation log entry.
`Job`	`findHistoryCleanupJob()` Deprecated. As of v. 7.9.0, because there can be more than one history cleanup job at once, use `findHistoryCleanupJobs()` instead.
`List<Job>`	`findHistoryCleanupJobs()` Finds history cleanup job if present.
`String`	`getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId)` Returns the full error details that occurs when the historic external task log with the given id was last executed.
`String`	`getHistoricJobLogExceptionStacktrace(String historicJobLogId)` Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed.
`SetRemovalTimeSelectModeForHistoricBatchesBuilder`	`setRemovalTimeToHistoricBatches()` Set a removal time to historic batches and all associated historic entities using a fluent builder.
`SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder`	`setRemovalTimeToHistoricDecisionInstances()` Set a removal time to historic decision instances and all associated historic entities using a fluent builder.
`SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder`	`setRemovalTimeToHistoricProcessInstances()` Set a removal time to historic process instances and all associated historic entities using a fluent builder.

- Method Detail
  - createHistoricProcessInstanceQuery
```
HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()
```
    Creates a new programmatic query to search for HistoricProcessInstances.
  - createHistoricActivityInstanceQuery
```
HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()
```
    Creates a new programmatic query to search for HistoricActivityInstances.
  - createHistoricActivityStatisticsQuery
```
HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)
```
    Query for the number of historic activity instances aggregated by activities of a single process definition.
  - createHistoricCaseActivityStatisticsQuery
```
HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(String caseDefinitionId)
```
    Query for the number of historic case activity instances aggregated by case activities of a single case definition.
  - createHistoricTaskInstanceQuery
```
HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()
```
    Creates a new programmatic query to search for HistoricTaskInstances.
  - createHistoricDetailQuery
```
HistoricDetailQuery createHistoricDetailQuery()
```
    Creates a new programmatic query to search for HistoricDetails.
    The result of the query is empty:
  - if the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION or
  - the user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION in case ProcessEngineConfiguration.enforceSpecificVariablePermission is enabled.

createHistoricVariableInstanceQuery
```
HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()
```
Creates a new programmatic query to search for HistoricVariableInstances.
The result of the query is empty:
if the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION or
the user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION in case ProcessEngineConfiguration.enforceSpecificVariablePermission is enabled.

Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)

Batch deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds, HistoricDecisionInstanceQuery query, String deleteReason)

Interface HistoryService

Method Summary

Method Detail

createHistoricProcessInstanceQuery

createHistoricActivityInstanceQuery

createHistoricActivityStatisticsQuery

createHistoricCaseActivityStatisticsQuery

createHistoricTaskInstanceQuery

createHistoricDetailQuery

createHistoricVariableInstanceQuery

createUserOperationLogQuery

createHistoricIncidentQuery

createHistoricIdentityLinkLogQuery

createHistoricCaseInstanceQuery

createHistoricCaseActivityInstanceQuery

createHistoricDecisionInstanceQuery

deleteHistoricTaskInstance

deleteHistoricProcessInstance

deleteHistoricProcessInstanceIfExists

deleteHistoricProcessInstances

deleteHistoricProcessInstancesIfExists

deleteHistoricProcessInstancesBulk

cleanUpHistoryAsync

cleanUpHistoryAsync

findHistoryCleanupJob

findHistoryCleanupJobs

deleteHistoricProcessInstancesAsync

deleteHistoricProcessInstancesAsync

deleteHistoricProcessInstancesAsync

deleteUserOperationLogEntry

deleteHistoricCaseInstance

deleteHistoricCaseInstancesBulk

deleteHistoricDecisionInstance

deleteHistoricDecisionInstancesBulk

deleteHistoricDecisionInstanceByDefinitionId

deleteHistoricDecisionInstanceByInstanceId

deleteHistoricDecisionInstancesAsync

deleteHistoricDecisionInstancesAsync

deleteHistoricDecisionInstancesAsync

deleteHistoricVariableInstance

deleteHistoricVariableInstancesByProcessInstanceId

createNativeHistoricProcessInstanceQuery

createNativeHistoricTaskInstanceQuery

createNativeHistoricActivityInstanceQuery

createNativeHistoricCaseInstanceQuery

createNativeHistoricCaseActivityInstanceQuery

createNativeHistoricDecisionInstanceQuery

createNativeHistoricVariableInstanceQuery

createHistoricJobLogQuery

getHistoricJobLogExceptionStacktrace

createHistoricProcessInstanceReport

createHistoricTaskInstanceReport

createCleanableHistoricProcessInstanceReport

createCleanableHistoricDecisionInstanceReport

createCleanableHistoricCaseInstanceReport

createCleanableHistoricBatchReport

createHistoricBatchQuery

deleteHistoricBatch

createHistoricDecisionInstanceStatisticsQuery

createHistoricExternalTaskLogQuery

getHistoricExternalTaskLogErrorDetails

setRemovalTimeToHistoricProcessInstances

setRemovalTimeToHistoricDecisionInstances

setRemovalTimeToHistoricBatches