JBoss.orgCommunity Documentation

jBPM User Guide

by The jBPM team

Version 5.2.0.Final

1. Overview
1.1. What is jBPM?
1.2. Overview
1.3. Core Engine
1.4. Eclipse Editor
1.5. Web-based Designer
1.6. jBPM Console
1.7. Documentation
2. Getting Started
2.1. Downloads
2.2. Getting started
2.3. Community
2.4. Sources
2.4.1. License
2.4.2. Source code
2.4.3. Building from source
3. Installer
3.1. Prerequisites
3.2. Download the installer
3.3. Demo setup
3.4. 10-Minute Tutorial: Using the Eclipse tooling
3.5. 10-Minute Tutorial: Using the jBPM Console
3.6. 10-Minute Tutorial: Using Guvnor repository and Designer
3.7. What to do if I encounter problems or have questions?
3.8. Frequently asked questions
4. Core Engine: API
4.1. The jBPM API
4.1.1. Knowledge Base
4.1.2. Session
4.1.3. Events
4.2. Knowledge-based API
5. Core Engine: Basics
5.1. Creating a process
5.1.1. Using the graphical BPMN2 Editor
5.1.2. Defining processes using XML
5.1.3. Defining Processes Using the Process API
5.2. Details of different process constructs: Overview
5.3. Details: Process properties
5.4. Details: Events
5.4.1. Start event
5.4.2. End events
5.4.3. Intermediate events
5.5. Details: Activities
5.5.1. Script task
5.5.2. Service task
5.5.3. User task
5.5.4. Reusable sub-process
5.5.5. Business rule task
5.5.6. Embedded sub-process
5.5.7. Multi-instance sub-process
5.6. Details: Gateways
5.6.1. Diverging gateway
5.6.2. Converging gateway
5.7. Using a process in your application
5.8. Other features
5.8.1. Data
5.8.2. Constraints
5.8.3. Action scripts
5.8.4. Events
5.8.5. Timers
5.8.6. Updating processes
5.8.7. Multi-threading
6. Core Engine: BPMN 2.0
6.1. Business Process Model and Notation (BPMN) 2.0 specification
6.2. Examples
6.3. Supported elements / attributes
7. Core Engine: Persistence and transactions
7.1. Runtime State
7.1.1. Binary Persistence
7.1.2. Safe Points
7.1.3. Configuring Persistence
7.1.4. Transactions
7.2. Process Definitions
7.3. History Log
7.3.1. Storing Process Events in a Database
8. Core Engine: Examples
8.1. jBPM Examples
8.2. Examples
8.3. Unit tests
9. Eclipse BPMN 2.0 Plugin
9.1. Installation
9.2. Creating your BPMN 2.0 processes
9.3. Filtering elements and attributes
10. Designer
10.1. Installation
10.2. Source code
10.3. Designer UI Explained
10.4. Support for Domain-specific service nodes
10.5. Configuring Designer
10.5.1. Changing the default configuration in Designer
10.5.2. Changing the default configuration in Guvnor
10.6. Generation of process and task forms
10.7. View processes as PDF and PNG
10.8. Viewing process BPMN2 source
10.9. Embedding designer in your own application
10.10. Migrating existing jBPM 3.2 based processes to BPMN2
10.11. Visual Process Validation
10.12. Integration with the jBPM Service Repository
10.13. Generating code to share the process image, PDF, and embedded process editor
10.14. Importing existing BPMN2 processes
10.15. Viewing Process Information
10.16. Requirements
11. Console
11.1. Installation
11.1.1. Authorization
11.1.2. User and group management
11.1.3. Registering your own service handlers
11.2. Running the process management console
11.2.1. Managing process instances
11.2.2. Human task lists
11.2.3. Reporting
11.3. Adding new process / task forms
11.4. REST interface
12. Human Tasks
12.1. Human tasks inside processes
12.1.1. User and group assignment
12.1.2. Data mapping
12.1.3. Swimlanes
12.1.4. Examples
12.2. Human task service
12.2.1. Task life cycle
12.2.2. Linking the human task service to the jBPM engine
12.2.3. Interacting with the human task service
12.2.4. User and group assignment
12.2.5. Starting the human task service
12.3. Human task clients
12.3.1. Eclipse demo task client
12.3.2. Web-based task client in jBPM Console
13. Domain-specific processes
13.1. Introduction
13.2. Example: Notifications
13.2.1. Creating the work definition
13.2.2. Registering the work definition
13.2.3. Using your new work item in your processes
13.2.4. Executing service nodes
14. Testing and debugging
14.1. Unit testing
14.1.1. Helper methods to create your session
14.1.2. Assertions
14.1.3. Testing integration with external services
14.1.4. Configuring persistence
14.2. Debugging
14.2.1. The Process Instances View
14.2.2. The Human Task View
14.2.3. The Audit View
15. Process Repository
16. Business Activity Monitoring
16.1. Reporting
16.2. Direct Intervention
17. Flexible Processes
18. Integration with Maven, OSGi, Spring, etc.
18.1. Maven
18.2. OSGi
18.3. Spring
Index