Uses of Package
org.camunda.bpm.engine.history
Package
Description
Public API of the Camunda Platform engine.
Typical usage of the API starts by the creation of a
Through the services obtained from such a
Typical usage of the API starts by the creation of a
ProcessEngineConfiguration
(typically based on a configuration file), from which a ProcessEngine
can be obtained.Through the services obtained from such a
ProcessEngine
, BPM and workflow operation
can be executed:RepositoryService
:
Manages Deployment
sRuntimeService
:
For starting and searching ProcessInstance
sTaskService
:
Exposes operations to manage human (standalone) Task
s,
such as claiming, completing and assigning tasksIdentityService
:
Used for managing User
s,
Group
s and the relations between themManagementService
:
Exposes engine admin and maintenance operations,
which have no relation to the runtime execution of business processesHistoryService
:
Exposes information about ongoing and past process instances.FormService
:
Access to form data and rendered forms for starting new process instances and completing tasks.Classes related to the
HistoryService
.API implementation classes, which shouldn't directly be used by end-users.
Classes related to the
ManagementService
.Classes related to the querying entities in the engine.
Classes related to the
RuntimeService
.-
ClassDescriptionDefines a report query for cleanable batches.Defines a report query for cleanable case instances.Defines a report query for finished decision instances.Defines a report query for cleanable process instances.Programmatic querying for
HistoricActivityInstance
s.Programmatic querying forHistoricCaseActivityInstance
s.Allows programmatic querying ofHistoricCaseInstance
s.Allows programmatic querying ofHistoricDecisionInstance
s.Programmatic querying forHistoricDetail
s.Allows programmatic querying ofHistoricProcessInstance
s.Defines a report query forHistoricProcessInstance
s.Allows programmatic querying forHistoricTaskInstance
s.Programmatic querying forHistoricVariableInstance
s.Allows querying ofHistoricActivityInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricCaseActivityInstance
s via native (SQL) queriesAllows querying ofHistoricCaseInstance
s via native (SQL) queriesAllows querying ofHistoricDecisionInstance
s via native (SQL) queries.Allows querying ofHistoricTaskInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricTaskInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricVariableInstanceQuery
s via native (SQL) queriesFluent builder to select the mode to set the removal time for historic batches.Fluent builder to select the mode to set the removal time for historic decision instances.Fluent builder to select the mode to set the removal time for historic process instances.Programmatic querying forUserOperationLogEntry
instances. -
-
ClassDescriptionDefines a report query for cleanable batches.Defines a report query for cleanable case instances.Defines a report query for finished decision instances.Defines a report query for cleanable process instances.Programmatic querying for
HistoricActivityInstance
s.Programmatic querying forHistoricCaseActivityInstance
s.Allows programmatic querying ofHistoricCaseInstance
s.Represents one input variable of a decision evaluation.Allows programmatic querying ofHistoricDecisionInstance
s.Represents one output variable of a decision evaluation.Base class for all kinds of information that is related to either aHistoricProcessInstance
or aHistoricActivityInstance
.Programmatic querying forHistoricDetail
s.Allows programmatic querying ofHistoricProcessInstance
s.Defines a report query forHistoricProcessInstance
s.Allows programmatic querying forHistoricTaskInstance
s.Programmatic querying forHistoricVariableInstance
s.Allows querying ofHistoricVariableInstanceQuery
s via native (SQL) queriesThis interface defines basic methods for resulting reports.Fluent builder to set the removal time to historic batches and all associated historic entities.Fluent builder to set the removal time to historic decision instances and all associated historic entities.Fluent builder to set the removal time to historic process instances and all associated historic entities.Programmatic querying forUserOperationLogEntry
instances. -
ClassDescriptionDefines a report query for cleanable batches.This interface defines the result of Cleanable historic batch report.Defines a report query for cleanable case instances.This interface defines the result of Historic finished case instance report.Defines a report query for finished decision instances.This interface defines the result of Cleanable historic decision instance report.Defines a report query for cleanable process instances.This interface defines the result of Cleanable historic process instance report.Represents a report result about duration of completed instances for a given period.Represents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Programmatic querying for
HistoricActivityInstance
s.Represents one execution of a case activity which is stored permanent for statistics, audit and other business intelligence purposes.Programmatic querying forHistoricCaseActivityInstance
s.A single execution of a case definition that is stored permanently.Allows programmatic querying ofHistoricCaseInstance
s.Represents one evaluation of a decision.Allows programmatic querying ofHistoricDecisionInstance
s.Base class for all kinds of information that is related to either aHistoricProcessInstance
or aHistoricActivityInstance
.Programmatic querying forHistoricDetail
s.TheHistoricExternalTaskLog
is used to have a log containing information abouttask
execution.An historic identity link stores the association of a task with a certain identity.Represents a historicincident
that is stored permanently.TheHistoricJobLog
is used to have a log containing information aboutjob
execution.A single execution of a whole process definition that is stored permanently.Allows programmatic querying ofHistoricProcessInstance
s.Defines a report query forHistoricProcessInstance
s.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.Allows programmatic querying forHistoricTaskInstance
s.A single process variable containing the last value when its process instance has finished.Programmatic querying forHistoricVariableInstance
s.Update of a process variable.Allows querying ofHistoricActivityInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricCaseActivityInstance
s via native (SQL) queriesAllows querying ofHistoricCaseInstance
s via native (SQL) queriesAllows querying ofHistoricDecisionInstance
s via native (SQL) queries.Allows querying ofHistoricTaskInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricTaskInstanceQuery
s via native (SQL) queriesAllows querying ofHistoricVariableInstanceQuery
s via native (SQL) queriesFluent builder to select the mode to set the removal time for historic batches.Fluent builder to select the mode to set the removal time for historic decision instances.Fluent builder to select the mode to set the removal time for historic process instances.Log entry about an operation performed by a user.Programmatic querying forUserOperationLogEntry
instances. -
ClassDescriptionA single execution of a case definition that is stored permanently.Represents one evaluation of a decision.A single execution of a whole process definition that is stored permanently.Log entry about an operation performed by a user.
-
ClassDescriptionA single execution of a case definition that is stored permanently.Represents one evaluation of a decision.A single execution of a whole process definition that is stored permanently.Log entry about an operation performed by a user.
-
ClassDescriptionA single execution of a case definition that is stored permanently.Represents one evaluation of a decision.A single execution of a whole process definition that is stored permanently.Log entry about an operation performed by a user.
-
ClassDescriptionRepresents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.A single execution of a whole process definition that is stored permanently.Allows programmatic querying of
HistoricProcessInstance
s. -
-
-
-
ClassDescriptionRepresents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Represents one evaluation of a decision.A single execution of a whole process definition that is stored permanently.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.Update of a process variable.Log entry about an operation performed by a user.
-
ClassDescriptionRepresents one evaluation of a decision.Allows programmatic querying of
HistoricDecisionInstance
s. -
ClassDescriptionAllows programmatic querying of
HistoricDecisionInstance
s.Allows programmatic querying ofHistoricProcessInstance
s.Fluent builder to select the mode to set the removal time for historic batches.Fluent builder to select the mode to set the removal time for historic decision instances.Fluent builder to select the mode to set the removal time for historic process instances.Fluent builder to set the removal time to historic batches and all associated historic entities.Fluent builder to set the removal time to historic decision instances and all associated historic entities.Fluent builder to set the removal time to historic process instances and all associated historic entities. -
ClassDescriptionThis interface defines the result of Cleanable historic decision instance report.Represents one input variable of a decision evaluation.Represents one evaluation of a decision.Represents one output variable of a decision evaluation.The
HistoricExternalTaskLog
is used to have a log containing information abouttask
execution.Log entry about an operation performed by a user. -
ClassDescriptionRepresents one input variable of a decision evaluation.Represents one output variable of a decision evaluation.
-
-
ClassDescriptionRepresents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.
-
ClassDescriptionRepresents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Represents one evaluation of a decision.A single execution of a whole process definition that is stored permanently.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.Update of a process variable.Log entry about an operation performed by a user.
-
ClassDescriptionThis interface defines the result of Cleanable historic batch report.This interface defines the result of Historic finished case instance report.This interface defines the result of Cleanable historic decision instance report.This interface defines the result of Cleanable historic process instance report.Represents a report result about duration of completed instances for a given period.Represents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Represents one execution of a case activity which is stored permanent for statistics, audit and other business intelligence purposes.A single execution of a case definition that is stored permanently.Base class for all kinds of information that is related to either a
HistoricProcessInstance
or aHistoricActivityInstance
.TheHistoricExternalTaskLog
is used to have a log containing information abouttask
execution.Historic form fieldsDeprecated.An historic identity link stores the association of a task with a certain identity.Represents a historicincident
that is stored permanently.TheHistoricJobLog
is used to have a log containing information aboutjob
execution.A single execution of a whole process definition that is stored permanently.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.A single process variable containing the last value when its process instance has finished.Update of a process variable.This interface defines basic methods for resulting reports.Log entry about an operation performed by a user. -
ClassDescriptionAn historic identity link stores the association of a task with a certain identity.
-
-
-
ClassDescriptionRepresents a report result about duration of completed instances for a given period.
-
-
-
ClassDescriptionDefines a report query for cleanable case instances.This interface defines the result of Historic finished case instance report.Defines a report query for finished decision instances.This interface defines the result of Cleanable historic decision instance report.Defines a report query for cleanable process instances.This interface defines the result of Cleanable historic process instance report.Represents a report result about duration of completed instances for a given period.Represents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Programmatic querying for
HistoricActivityInstance
s.Represents one execution of a case activity which is stored permanent for statistics, audit and other business intelligence purposes.Programmatic querying forHistoricCaseActivityInstance
s.A single execution of a case definition that is stored permanently.Allows programmatic querying ofHistoricCaseInstance
s.Represents one input variable of a decision evaluation.Represents one evaluation of a decision.Allows programmatic querying ofHistoricDecisionInstance
s.Represents one output variable of a decision evaluation.Base class for all kinds of information that is related to either aHistoricProcessInstance
or aHistoricActivityInstance
.Programmatic querying forHistoricDetail
s.TheHistoricExternalTaskLog
is used to have a log containing information abouttask
execution.Historic form fieldsAn historic identity link stores the association of a task with a certain identity.Represents a historicincident
that is stored permanently.TheHistoricJobLog
is used to have a log containing information aboutjob
execution.A single execution of a whole process definition that is stored permanently.Allows programmatic querying ofHistoricProcessInstance
s.Defines a report query forHistoricProcessInstance
s.Represents a historic task instance (waiting, finished or deleted) that is stored permanent for statistics, audit and other business intelligence purposes.Allows programmatic querying forHistoricTaskInstance
s.A single process variable containing the last value when its process instance has finished.Programmatic querying forHistoricVariableInstance
s.Update of a process variable.This interface defines basic methods for resulting reports.Log entry about an operation performed by a user.Programmatic querying forUserOperationLogEntry
instances. -
ClassDescriptionDefines a report query for cleanable batches.This interface defines the result of Cleanable historic batch report.
-
ClassDescriptionRepresents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.Update of a process variable.
-
ClassDescriptionThis interface defines basic methods for resulting reports.
-
ClassDescriptionBase class for all kinds of information that is related to either a
HistoricProcessInstance
or aHistoricActivityInstance
.Programmatic querying forHistoricDetail
s.A single process variable containing the last value when its process instance has finished.Programmatic querying forHistoricVariableInstance
s. -
-
ClassDescriptionProgrammatic querying for
HistoricActivityInstance
s.Programmatic querying forHistoricCaseActivityInstance
s.Allows programmatic querying ofHistoricProcessInstance
s.Programmatic querying forHistoricVariableInstance
s. -
-
ClassDescriptionRepresents one execution of an activity and it's stored permanent for statistics, audit and other business intelligence purposes.
-
ClassDescriptionA single execution of a whole process definition that is stored permanently.