This project has retired. For details please refer to its Attic page.
Apache ODE – User Guide

User Guide

Getting Started

First of all, getting familiar with the WS-BPEL 2.0 standard is a very good idea. To use ODE, you will need to write processes using the BPEL language. There are several examples in our distributions that you can use to get started, but a decent understanding of the spec is assumed.

Then, you can optionally check out ODE Schema page in order to install schema for your database. Please note that schemas from distribution sometimes contain errors, because of poor quality of ORM schema generators.

ODE can be deployed in three different environments:

  • As a simple Web Service in Axis 2, ODE is bundled in a WAR than can be deployed in any application server and is invoked using plain SOAP/HTTP.
  • As a JBI service assembly, ODE is bundled in a ZIP that can be deployed in any JBI container and is invoked using the NMR.
  • SMX4 OSGi bundle


  1. WAR Deployment
  2. Upgrading ODE

Using ODE

  1. Creating a Process
  2. Process Versioning
  3. Management API
  4. Instance Replayer
  5. ODE Execution Events
  6. Endpoint References
  7. WSDL 1.1 HTTP Binding Support
  8. WSDL 1.1 Extensions for REST
  9. BPEL Extensions
  10. Instance Data Cleanup
  11. Direct Process-to-Process Communication
  12. Stateful Exchange Protocol
  13. Activity Failure and Recovery
  14. XQuery Extensions
  15. Custom XPath functions
  16. Atomic Scopes Extension for BPEL

How To

  1. ODE JBI and Axis2 properties overview
  2. Controlling ODE's Memory Footprint
  3. Endpoint Configuration
  4. HTTP Authentication
  5. Using a JNDI DataSource under ServiceMix JBI
  6. Writing BPEL Test Cases
  7. WS-Security in ODE
  8. Use Assign to build messages

End of Life

  1. JBI Deployment (EOL from ODE 1.3.7)
  2. SMX4 OSGi Deployment (EOL from ODE 1.3.7)