JBoss.orgCommunity Documentation

jBPM Documentation

Version 6.0.0-redhat-10


I.
1. Introduction
1.1. Introduction
1.2. Getting Involved
1.2.1. Sign up to jboss.org
1.2.2. Sign the Contributor Agreement
1.2.3. Submitting issues via JIRA
1.2.4. Fork Github
1.2.5. Writing Tests
1.2.6. Commit with Correct Conventions
1.2.7. Submit Pull Requests
1.3. Installation and Setup (Core and IDE)
1.3.1. Installing and using
1.3.2. Building from source
1.3.3. Eclipse
2. Release Notes
2.1. New and Noteworthy in KIE API 6.0.0
2.1.1. New KIE name
2.1.2. Maven aligned projects and modules and Maven Deployment
2.1.3. Configuration and convention based projects
2.1.4. KieBase Inclusion
2.1.5. KieModules, KieContainer and KIE-CI
2.1.6. KieScanner
2.1.7. Hierarchical ClassLoader
2.1.8. Legacy API Adapter
2.1.9. KIE Documentation
2.2. New and Noteworthy in jBPM 6.0.0
2.2.1. KIE api
2.2.2. jBPM Core Engine
2.2.3. jBPM Designer
2.2.4. jBPM Data Modeler
2.2.5. Form Modeler
2.2.6. jBPM Console
2.2.7. BAM / Reporting
2.2.8. Workbench
2.2.9. Remote API
2.3. New and Noteworthy in KIE Workbench 6.0.0
2.4. New and Noteworthy in Integration 6.0.0
2.4.1. CDI
2.4.2. Spring
2.4.3. Aries Blueprints
2.4.4. OSGi Ready
II. Getting Started
3. Overview
3.1. What is jBPM?
3.2. Overview
3.3. Core Engine
3.4. Process Designer
3.5. Data Modeler
3.6. Form Modeler
3.7. Process Instance and Task Management
3.8. Business Activity Monitoring
3.9. Workbench
3.10. Eclipse Developer Tools
4. Getting Started
4.1. Downloads
4.2. Getting Started
4.3. Community
4.4. Sources
4.4.1. License
4.4.2. Source code
4.4.3. Building from source
4.5. What to do if I encounter problems or have questions?
5. jBPM Installer
5.1. Prerequisites
5.2. Downloading the Installer
5.3. Demo Setup
5.4. 10-Minute Tutorial using the Workbench
5.5. 10-Minute Tutorial using Eclipse
5.6. Configuration
5.6.1. Playgrounds
5.6.2. Workbench Authentication
5.6.3. Using your own database
5.6.4. jBPM data base schema scripts (DDL scripts)
5.6.5. jBPM installer script
5.7. Frequently Asked Questions
6. Examples
6.1. Introduction
6.2. Human Resources Example
6.2.1. The KIE Project: human-resources
6.2.2. Building the Human Resources Example
6.2.3. Create a new Process Instance
6.3. Examples zip
III. jBPM Core
7. Core Engine API
7.1. Overview
7.2. KieBase
7.3. KieSession
7.3.1. ProcessRuntime
7.3.2. Event Listeners
7.3.3. Correlation Keys
7.3.4. Threads
7.4. RuntimeManager
7.4.1. Overview
7.4.2. Strategies
7.4.3. Usage
7.4.4. Configuration
7.5. Configuration
8. Processes
8.1. What is BPMN 2.0
8.2. Process
8.2.1. Creating a process
8.3. Activities
8.3.1. Script task
8.3.2. Service task
8.3.3. User task
8.3.4. Reusable sub-process
8.3.5. Business rule task
8.3.6. Embedded sub-process
8.3.7. Multi-instance sub-process
8.4. Events
8.4.1. Start event
8.4.2. End events
8.4.3. Intermediate events
8.5. Gateways
8.5.1. Diverging gateway
8.5.2. Converging gateway
8.6. Others
8.6.1. Variables
8.6.2. Scripts
8.6.3. Constraints
8.6.4. Timers
8.7. Process Fluent API
8.7.1. Example
8.8. Testing
8.8.1. Unit testing
9. Human Tasks
9.1. Introduction
9.2. Using User Tasks in our Processes
9.3. Data Mappings
9.4. Task Lifecycle
9.5. Task Service and The Process Engine
9.6. Task Service API
9.7. Interacting with the Task Service
10. Persistence and Transactions
10.1. Process Instance State
10.1.1. Runtime State
10.2. Audit Log
10.2.1. The jBPM Audit data model
10.2.2. Storing Process Events in a Database
10.2.3. Storing Process Events in a JMS queue for further processing
10.3. Transactions
10.3.1. Container managed transaction
10.4. Configuration
10.4.1. Adding dependencies
10.4.2. Manually configuring the engine to use persistence
10.4.3. Configuring the engine to use persistence using JBPMHelper - for tests only
IV. Workbench
11. Workbench
11.1. Installation
11.1.1. War installation
11.1.2. Workbench data
11.1.3. System properties
11.2. Quick Start
11.2.1. Add repository
11.2.2. Add project
11.2.3. Define Data Model
11.2.4. Define Rule
11.2.5. Build and Deploy
11.3. Configuration
11.3.1. User management
11.3.2. Roles
11.3.3. Command line config tool
11.4. Administration
11.4.1. Administration overview
11.4.2. Organizational unit
11.4.3. VFS repository
11.5. Introduction
11.5.1. Log in and log out
11.5.2. Home screen
11.5.3. Workbench concepts
11.5.4. Initial layout
11.6. Changing the layout
11.6.1. Resizing
11.6.2. Repositioning
11.7. Authoring
11.7.1. Artifact Repository
11.7.2. Asset Editor
11.7.3. Project Explorer
11.7.4. Project Editor
11.7.5. Validation
11.7.6. Data Modeller
11.7.7. Categories Editor
12. Workbench Integration
12.1. REST
12.1.1. Job calls
12.1.2. Repository calls
12.1.3. Organizational unit calls
12.1.4. Maven calls
13. Workbench High Availability
13.1.
13.1.1. VFS clustering
13.1.2. jBPM clustering
14. Designer
14.1. Designer UI Explained
14.2. Getting started with Modelling
14.3. Designer Toolbar
15. Form Modeler
15.1. Configure process and human tasks
15.2. Generate forms from task definitions
15.3. Edit forms
15.3.1. Form generated description
15.3.2. Customizing form
15.3.3. Field types
16. Runtime Management
16.1. Deployments
16.1.1. Deployment Units List
16.2. Jobs
17. Process and Task Management
17.1. Process Management
17.1.1. Process Definitions
17.2. Tasks
17.2.1. Task List
17.2.2. New Task (Ad-Hoc Task)
18. Business Activity Monitoring
18.1. Overview
18.2. Business Dashboards
18.3. Process Dashboard
19. Remote API
19.1. REST
19.1.1. Additional Information
19.1.2. Runtime calls
19.1.3. History calls
19.1.4. Task calls
19.1.5. Execute calls
19.2. JMS
19.2.1. JMS Queue setup
19.2.2. Example JMS usage
19.3. Remote Java API
19.3.1. Using the Remote Java RuntimeEngine API
V. Eclipse
20. jBPM Eclipse Plugin
20.1. jBPM Eclipse Plugin
20.1.1. Installation
20.1.2. jBPM Project Wizard
20.1.3. New BPMN2 Process Wizard
20.1.4. jBPM Runtime
20.1.5. Drools Eclipse plugin
20.2. Debugging
20.2.1. The Process Instances View
20.2.2. The Audit View
21. Eclipse BPMN 2.0 Modeler
21.1. Overview
21.2. Installation
21.3. Documentation
VI. Integration
22. Integration
22.1. Maven
22.1.1. Maven artifacts as deployment units
22.1.2. Use maven for dependency management
22.2. CDI
22.2.1. Overview
22.2.2. Configuring CDI integration
22.2.3. RuntimeManager as CDI bean
22.2.4.
22.3. OSGi
VII. Advanced Topics
23. Domain-specific Processes
23.1. Introduction
23.2. Overview
23.2.1. Work Item Definitions
23.2.2. Work Item Handlers
23.3. Example: Notifications
23.3.1. The Notification Work Item Definition
23.3.2. The NotificationWorkItemHandler
23.4. Service Repository
23.4.1. Public jBPM service repository
23.4.2. Setting up your own service repository
24. Exception Management
24.1. Overview
24.2. Introduction
24.3.
24.3.1. Technical Exceptions
24.3.2. Technical Exception Examples
24.4.
24.4.1. Business Exceptions
25. Flexible Processes
26. Concurrency and asynchronous execution
26.1. Concurrency
26.1.1. Engine execution
26.1.2. Multiple knowledge sessions and persistence
26.2. Asynchronous execution
26.2.1. Asynchronous handlers
26.2.2. jbpm executor