View source for Swordfish Documentation: Installing ODE

=Installing the ODE Engine=
This section contains information and instructions on ODE and BPEL in Swordfish, starting and configuring the ODE.
==About ODE and BPEL in Swordfish==
<p>The [http://ode.apache.org Apache ODE] BPEL engine supports the execution of [http://en.wikipedia.org/wiki/Business_Process_Execution_Language| BPEL] processes in Swordfish. In Swordfish, the ODE uses
[http://servicemix.apache.org/SMX4/index.html Servicemix 4] as the JBI container 
and an adapted ODE JBI integration layer that supports an [http://www.eclipse.org/eclipselink/ EclipseLink] based database integration to persist the process state.</p>
<p>For information on the general issues about the ODE JBI deployment, see [http://ode.apache.org/user-guide.html#UserGuide-InJBI ODE User Guide]. If you want to try out a tutorial on ODE, see [http://ode.apache.org/links.html ODE Tutorials].
The deployment and execution of BPEL processes in Swordfish is described in [[Swordfish_Documentation:_Executing_BPEL| Executing BPEL processes]].
</p>
<p>
Swordfish ODE is provided as an OSGI bundle which can be installed/started using OSGI
mechanisms - either using the <tt>install/start</tt> commands of the OSGI console or by listing the ODE bundle
inside the Equinox <tt>config.ini</tt> file.</p>

==Starting ODE==
To start ODE:
<ol>
<li>Create a target platform which extends the standard Swordfish target platform with all the
    bundles in the ODE.extension project which, can be found in the Swordfish [http://dev.eclipse.org/svnroot/rt/org.eclipse.swordfish/sandbox dev.eclipse.org/svnroot/rt/org.eclipse.swordfish/sandbox]
<li>Create an Eclipse OSGI Run Configuration using the ODE target platform as described above where:
<pre>  
  	Program arguments

		-os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -console -clean

	VM arguments

		-Declipse.ignoreApp=true -Dosgi.noShutdown=true
		-Djava.util.logging.config.file="your logging.properties location"
		-Dorg.osgi.service.http.port=9001
		-Dorg.eclipse.swordfish.registry.fileLocation="your_repository_location"
		-Declipse.ignoreApp=true
		-Dservicemix.base=.

	Working directory

		${workspace_loc:org.apache.ode}/work
</pre> 
   <li>Export the org.apache.ode project in [http://dev.eclipse.org/svnroot/rt/org.eclipse.swordfish/sandbox dev.eclipse.org/svnroot/rt/org.eclipse.swordfish/sandbox] 
   as an eclipse plugin
<li>Install and start the created ODE bundle using the OSGI console
</ol>

==Configuring ODE==
In the debugging phase we recommend that you increase the default global logging level in the '''logging.properties''' file, which is referred to in the '''-Djava.util.logging.config.file''' option in the run configuration.

The ODE specific logging options can found in the <tt>ode-jbi.properties</tt> file in <tt>org.apache.ode</tt> in [http://dev.eclipse.org/svnroot/rt/org.eclipse.swordfish/sandbox sandbox].

<pre>
ode-jbi.event.listeners=org.apache.ode.bpel.common.evt.DebugBpelEventListener
debugeventlistener.dumpToStdOut=on
</pre> 

The option, <tt>ode-jbi.properties</tt> also contains the definition of the database layer that is used to persist the process state.
The use of [http://www.eclipse.org/eclipselink/ EclipseLink] is hard coded in our ODE database integration layer. This was
originally developed in [http://eclipse.org/smila SMILA]. However, it is possible to change the database used, for example, 
instead of [http://db.apache.org/derby Apache Derby] you can use [http://hsqldb.org HSQLDB], or an Oracle Database for lengthy processes where reliable persistence is required. 

The JPA configuration is located in <tt>META-INF/persistence.xml</tt> in <tt>org.apache.ode</tt>. For more information, see
[http://www.jpox.org/docs/jpa/persistence_xml.html persistence_xml].

-----
[[Swordfish_Documentation |Swordfish Documentation Home]] <br/>
[[Swordfish | Swordfish Wiki Home]] <br/>