Package org.flowable.engine
Public API of the Flowable 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
s.RuntimeService
: For starting and searching ProcessInstance
s.TaskService
: Exposes operations to manage human (standalone) tasks, such as claiming, completing and assigning tasks.IdentityService
: Used for managing users, groups and the relations between them.ManagementService
: Exposes engine administration and maintenance operations,
which have no relation to the runtime exection of business processes.HistoryService
: Exposes information about ongoing and past process instances.FormService
: Access to form data and rendered forms for starting new process instances and completing tasks.-
Interface Summary Interface Description Agenda Deprecated. in 6.2.0, use theAgenda
in the common module instead.BpmnChangeTenantIdEntityTypes CandidateManager DecisionTableVariableManager DynamicBpmnConstants DynamicBpmnService Service providing access to the repository of process definitions and deployments.FlowableEngineAgenda This interface exposes methods needed to manipulate the agenda implementation.FlowableEngineAgendaFactory FormService Access to form data and rendered forms for starting new process instances and completing tasks.HistoryCleaningManager HistoryService Service exposing information about ongoing and past process instances.IdentityService Service to manageUser
s andGroup
s.InternalProcessLocalizationManager ManagementService Service for admin and maintenance operations on the process engine.ProcessEngine Provides access to all the services that expose the BPM and workflow operations.ProcessEngineLifecycleListener Interface describing a listener that gets notified when certain event occurs, related to the process-engine lifecycle it is attached to.ProcessMigrationService Service to manager process instance migrations.RepositoryService Service providing access to the repository of process definitions and deployments.RuntimeService TaskService Service which provides access toTask
and form related operations. -
Class Summary Class Description DefaultCandidateManager DefaultHistoryCleaningManager ProcessEngineConfiguration Configuration information from which a process engine can be build.ProcessEngines Helper for initializing and closing process engines in server environments. -
Exception Summary Exception Description FlowableTaskAlreadyClaimedException Deprecated. useFlowableTaskAlreadyClaimedException