Package org.flowable.engine

Public API of the Flowable engine.

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 Deployments.
RuntimeService: For starting and searching ProcessInstances.
TaskService: Exposes operations to manage human (standalone) org.flowable.engine.task.Tasks, such as claiming, completing and assigning tasks.
IdentityService: Used for managing Users, identity.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.

See: Description

Interface Summary

Interface	Description
Agenda	Deprecated in 6.2.0, use the Agenda in the common module instead.
CandidateManager
DynamicBpmnConstants
DynamicBpmnService	Service providing access to the repository of process definitions and deployments.
ExecutionQueryInterceptor
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.
HistoricProcessInstanceQueryInterceptor
HistoryService	Service exposing information about ongoing and past process instances.
IdentityService	Service to manage Users and Groups.
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.
ProcessInstanceQueryInterceptor
RepositoryService	Service providing access to the repository of process definitions and deployments.
RuntimeService
TaskService	Service which provides access to Task and form related operations.

Class Summary

Class	Description
DefaultCandidateManager
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 use FlowableTaskAlreadyClaimedException

Package org.flowable.engine Description

Public API of the Flowable engine.

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 Deployments.
RuntimeService: For starting and searching ProcessInstances.
TaskService: Exposes operations to manage human (standalone) org.flowable.engine.task.Tasks, such as claiming, completing and assigning tasks.
IdentityService: Used for managing Users, identity.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.