jBPM Documentation The JBoss jBPM team [http://www.jbpm.org/community/team.html] jBPM Documentation by Version 6.2.0.Final ........................................................................................................................................ xi I. Getting Started ............................................................................................................... 1 1. Overview .............................................................................................................. 2 1.1. What is jBPM? ........................................................................................... 2 1.2. Overview .................................................................................................... 4 1.3. Core Engine ............................................................................................... 5 1.4. Process Designer ....................................................................................... 6 1.5. Data Modeler .............................................................................................. 6 1.6. Form Modeler ............................................................................................. 7 1.7. Process Instance and Task Management ..................................................... 8 1.8. Business Activity Monitoring ........................................................................ 8 1.9. Workbench ............................................................................................... 10 1.10. Eclipse Developer Tools .......................................................................... 10 2. Getting Started .................................................................................................. 12 2.1. Downloads ................................................................................................ 12 2.2. Getting Started ......................................................................................... 12 2.3. Community ............................................................................................... 12 2.4. Sources .................................................................................................... 13 2.4.1. License .......................................................................................... 13 2.4.2. Source code .................................................................................. 13 2.4.3. Building from source ....................................................................... 14 2.5. Getting Involved ........................................................................................ 14 2.5.1. Sign up to jboss.org ....................................................................... 14 2.5.2. Sign the Contributor Agreement ...................................................... 15 2.5.3. Submitting issues via JIRA ............................................................. 15 2.5.4. Fork GitHub ................................................................................... 16 2.5.5. Writing Tests .................................................................................. 16 2.5.6. Commit with Correct Conventions .................................................... 18 2.5.7. Submit Pull Requests ..................................................................... 19 2.6. What to do if I encounter problems or have questions? ................................ 21 3. jBPM Installer .................................................................................................... 22 3.1. Prerequisites ............................................................................................. 22 3.2. Downloading the Installer .......................................................................... 22 3.3. Demo Setup ............................................................................................. 22 3.4. 10-Minute Tutorial using the Workbench ..................................................... 25 3.5. 10-Minute Tutorial using Eclipse ................................................................ 27 3.6. Configuration ............................................................................................ 28 3.6.1. Playgrounds ................................................................................... 28 3.6.2. Workbench Authentication .............................................................. 29 3.6.3. Using your own database ............................................................... 30 3.6.4. jBPM database schema scripts (DDL scripts) ................................... 36 3.6.5. jBPM installer script ........................................................................ 36 3.7. Frequently Asked Questions ...................................................................... 38 4. Examples ........................................................................................................... 39 iii jBPM Documentation 4.1. Introduction ............................................................................................... 39 4.2. Human Resources Example ...................................................................... 39 4.2.1. The KIE Project: human-resources .................................................. 41 4.2.2. Building the Human Resources Example ......................................... 42 4.2.3. Create a new Process Instance ....................................................... 44 4.3. Examples zip ............................................................................................ 45 II. jBPM Core .................................................................................................................. 46 5. Core Engine API ................................................................................................ 47 5.1. Overview .................................................................................................. 47 5.2. KieBase .................................................................................................... 48 5.3. KieSession ............................................................................................... 49 5.3.1. ProcessRuntime ............................................................................. 49 5.3.2. Event Listeners .............................................................................. 51 5.3.3. Correlation Keys ............................................................................ 53 5.3.4. Threads ......................................................................................... 54 5.4. RuntimeManager ....................................................................................... 55 5.4.1. Overview ....................................................................................... 55 5.4.2. Strategies ...................................................................................... 57 5.4.3. Usage ............................................................................................ 59 5.4.4. Configuration .................................................................................. 60 5.5. Services ................................................................................................... 68 5.5.1. Deployment Service ....................................................................... 69 5.5.2. Definition Service ........................................................................... 70 5.5.3. Process Service ............................................................................. 71 5.5.4. Runtime Data Service ..................................................................... 72 5.5.5. User Task Service .......................................................................... 75 5.5.6. Working with deployments .............................................................. 76 5.6. Configuration ............................................................................................ 79 6. Processes .......................................................................................................... 82 6.1. What is BPMN 2.0 .................................................................................... 82 6.2. Process .................................................................................................... 87 6.2.1. Creating a process ......................................................................... 87 6.3. Activities ................................................................................................... 92 6.3.1. Script task ..................................................................................... 92 6.3.2. Service task ................................................................................... 94 6.3.3. User task ....................................................................................... 95 6.3.4. Reusable sub-process .................................................................... 97 6.3.5. Business rule task .......................................................................... 98 6.3.6. Embedded sub-process .................................................................. 99 6.3.7. Multi-instance sub-process ............................................................ 100 6.4. Events .................................................................................................... 101 6.4.1. Start event ................................................................................... 101 6.4.2. End events .................................................................................