| Package | Description |
|---|---|
| org.camunda.bpm.engine |
Public API of the camunda BPM 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 DeploymentsRuntimeService:
For starting and searching ProcessInstancesTaskService:
Exposes operations to manage human (standalone) Tasks,
such as claiming, completing and assigning tasksIdentityService:
Used for managing Users,
Groups 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. |
| org.camunda.bpm.engine.impl |
API implementation classes, which shouldn't directly be used by end-users.
|
| org.camunda.bpm.engine.rest.dto.runtime.modification | |
| org.camunda.bpm.engine.runtime |
Classes related to the
RuntimeService. |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstantiationBuilder |
RuntimeService.createProcessInstanceById(String processDefinitionId)
Starts a process instance at any set of activities in the process with the given id.
|
ProcessInstantiationBuilder |
RuntimeService.createProcessInstanceByKey(String processDefinitionKey)
Starts a process instance at any set of activities in the process with the latest version
of the given key.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ProcessInstantiationBuilderImpl
Simply wraps a modification builder because their API is equivalent.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CancellationInstructionDto.applyTo(ProcessInstantiationBuilder builder,
ProcessEngine engine,
com.fasterxml.jackson.databind.ObjectMapper mapper) |
abstract void |
ProcessInstanceModificationInstructionDto.applyTo(ProcessInstantiationBuilder builder,
ProcessEngine engine,
com.fasterxml.jackson.databind.ObjectMapper mapper) |
void |
StartBeforeInstructionDto.applyTo(ProcessInstantiationBuilder builder,
ProcessEngine engine,
com.fasterxml.jackson.databind.ObjectMapper mapper) |
void |
StartAfterInstructionDto.applyTo(ProcessInstantiationBuilder builder,
ProcessEngine engine,
com.fasterxml.jackson.databind.ObjectMapper mapper) |
void |
StartTransitionInstructionDto.applyTo(ProcessInstantiationBuilder builder,
ProcessEngine engine,
com.fasterxml.jackson.databind.ObjectMapper mapper) |
| Modifier and Type | Method and Description |
|---|---|
ProcessInstantiationBuilder |
ProcessInstantiationBuilder.businessKey(String businessKey)
Set the business key for the process instance
|
ProcessInstantiationBuilder |
ProcessInstantiationBuilder.caseInstanceId(String caseInstanceId)
Associate a case instance with the process instance
|
Copyright © 2018. All rights reserved.