Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 3.33 KB

task_execution_sample.adoc

File metadata and controls

47 lines (28 loc) · 3.33 KB
Raw

Task Execution Sample

This sample demonstrates the following:

  • How to programmatically create process actors on process start using the ProcActionsFrame

  • How to pass process variables to the process instance using the ProcActionsFrame

  • How to get and modify standard process actions created by the ProcActionsFrame (e.g. change "Start process" button caption)

  • How to start a process programmatically without the ProcActionsFrame

  • How to automatically update the processState field each time the process moves further using the ActivitiEventListener

The sample uses the Task execution - 1 process model:

TaskExecution1Model

To test the sample, use the Application - Tasks screen.

In this example, we don’t use the StandardProcForm to assign process actors. We do it with the help of the before start process predicate of the ProcActionsFrame. See the setBeforeStartProcessPredicate() method usage in the {proj_bpm_samples}/blob/master/modules/web/src/com/company/bpmsamples/web/task/TaskEdit.java[TaskEdit.java]

See the setStartProcessActionProcessVariablesSupplier() usage in the {proj_bpm_samples}/blob/master/modules/web/src/com/company/bpmsamples/web/task/TaskEdit.java[TaskEdit.java] as an example of how to pass process variables at process start using the ProcActionsFrame. The acceptanceRequired process variable will be used by one of process gateways to decide whether the task must be accepted by the initiator or the process must be completed.

The changeStartProcessBtnCaption() demonstrates that you can get and modify process actions generated by the ProcActionsFrame. In this method the standard button caption "Start process" is replaced by the custom one.

The startProcessProgrammatically() method demonstrates how to start a new process instance without the ProcActionsFrame.

link:../../../source/examples/TaskExecution1StartProgrammatically.java[role=include]

The {proj_bpm_samples}/blob/master/modules/core/src/com/company/bpmsamples/core/bpm/listeners/UpdateProcessStateListener.java[UpdateProcessStateListener.java] is an implementation of the org.activiti.engine.delegate.event.ActivitiEventListener. This listener is registered as a process-level listener. It does the following: each time a new process step is reached, the processState field of the related com.company.bpmsamples.entity.Task entity is updated with the current process step name.

That’s how process-level event listeners configuration looks in the process model.

TaskExecution1UpdateProcessStateListener

To open this window click somewhere in the modeler, click the Show advanced properties link and then go with the Event listeners property.

See the comments in the source code at GitHub for details.

The Task entity editor XML descriptor: {proj_bpm_samples}/blob/master/modules/web/src/com/company/bpmsamples/web/task/task-edit.xml[task-edit.xml]

The Task entity editor Java controller: {proj_bpm_samples}/blob/master/modules/web/src/com/company/bpmsamples/web/task/TaskEdit.java[TaskEdit.java]

Activiti event listener that updates processState: {proj_bpm_samples}/blob/master/modules/core/src/com/company/bpmsamples/core/bpm/listeners/UpdateProcessStateListener.java[UpdateProcessStateListener.java]