You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ode.apache.org by va...@apache.org on 2012/12/31 16:25:56 UTC
svn commit: r1427148 - /ode/site/trunk/content/
Author: vanto
Date: Mon Dec 31 15:25:55 2012
New Revision: 1427148
URL: http://svn.apache.org/viewvc?rev=1427148&view=rev
Log:
formatting tweaks.
Modified:
ode/site/trunk/content/bpel-management-api-specification.mdtext
ode/site/trunk/content/creating-a-process.mdtext
ode/site/trunk/content/jbi-deployment.mdtext
ode/site/trunk/content/management-api.mdtext
ode/site/trunk/content/process-versioning.mdtext
ode/site/trunk/content/smx4-osgi-deployment.mdtext
ode/site/trunk/content/upgrading-ode.mdtext
ode/site/trunk/content/war-deployment.mdtext
Modified: ode/site/trunk/content/bpel-management-api-specification.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/bpel-management-api-specification.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/bpel-management-api-specification.mdtext (original)
+++ ode/site/trunk/content/bpel-management-api-specification.mdtext Mon Dec 31 15:25:55 2012
@@ -1,4 +1,6 @@
Title: BPEL Management API Specification
+Category: documentation
+
<a name="BPELManagementAPISpecification-BPELManagementAPISpecification"></a>
# BPEL Management API Specification
The BPEL Management API {excerpt} exposes management functions related to BPEL processes and their instances{excerpt}.
Modified: ode/site/trunk/content/creating-a-process.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/creating-a-process.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/creating-a-process.mdtext (original)
+++ ode/site/trunk/content/creating-a-process.mdtext Mon Dec 31 15:25:55 2012
@@ -1,36 +1,40 @@
Title: Creating a Process
+Category: documentation
+
+## Overview
+
[TOC]
<a name="CreatingaProcess-DeployingaProcessinOde"></a>
-### Deploying a Process in ODE
+## Deploying a Process in ODE
Each deployment is a directory with all relevant deployment artifacts. At the minimum it will contain the deployment descriptor, one or more process definitions (BPEL or .cbp), WSDL and XSDs (excluding those compiled into the .cbp). It may also contain other files, such as SVGs or XSLs. The deployment descriptor is a file named deploy.xml (see the next paragraoh for its description).
During deployment, the process engine loads all documents from the deployment descriptor. Loading documents allow it to reference processes, service and schema definitions using fully qualified names, and import based on namespaces instead of locations.
-To deploy in ODE, just copy the whole directory containing your artifacts (the directory itself, not only its content) in the path %DEPLOYMENT_ROOT%/WEB-INF/processes (in Tomcat it would be %TOMCAT_HOME%/webapps/ode/WEB-INF/processes).
+To deploy in ODE, just copy the whole directory containing your artifacts (the directory itself, not only its content) in the path `%DEPLOYMENT_ROOT%/WEB-INF/processes` (in Tomcat it would be `%TOMCAT_HOME%/webapps/ode/WEB-INF/processes`).
<a name="CreatingaProcess-DeploymentDescriptor"></a>
-### Deployment Descriptor
+## Deployment Descriptor
To deploy your process in ODE you will need to create a simple deployment descriptor with basic information. The deploy.xml file configures one or several processes to use specific services. For each process, deploy.xml must supply binding information for partner links to concrete WSDL services. Every partner link used with a <receive> activity must be matched with a <provide> element, and every partnerLink used in an <invoke> activity must be matched with an <invoke> element in *deploy.xml* (unless that partnerLink has initializePartnerRole="false").
<a name="CreatingaProcess-Formaldefinition"></a>
-### Formal definition
+## Formal definition
The XML schema describing ODE's deployment descriptor is available [here](http://svn.apache.org/viewvc/ode/trunk/bpel-schemas/src/main/xsd/dd.xsd?view=markup). The root element, deploy, contains a list of all deployed processes from the deployment directory:
<deploy>
- <process ...>*
- { other elements }
- </process>
+ <process ...>*
+ { other elements }
+ </process>
</deploy>
Each process is identified by its qualified name and specifies bindings for provided and invoked services:
<process name = QName fileName = String? bpel11wsdlFileName = String? >
- (<provide> | <invoke>)*
- { other elements }
+ (<provide> | <invoke>)*
+ { other elements }
</process>
Each process element must provide a `name` attribute with the qualified name of the process. Optionally, a `fileName` attribute can be used to specify the location of the BPEL process definition (the .bpel file). The `fileName` attribute does not need to be provided unless non-standard compilation options are used or the `bpel11wsdlFileName` attribute is used to specify a WSDL document for a BPEL 1.1 process.
@@ -38,7 +42,7 @@ Each process element must provide a `nam
Each `<process>` element must enumerate the services provided by the process and bind each service to an endpoint. This is done through `<provide>` elements which associates `partnerLink`s with `endpoint`s:
<provide partnerLink=NCName>
- <service name = QName port = NCName?>
+ <service name = QName port = NCName?>
</provide>
Note, that only one partnerLink can be bound to any specified endpoint.
@@ -46,7 +50,7 @@ Note, that only one partnerLink can be b
The port attribute can be used to select a particular endpoint from the service definition.
<a name="CreatingaProcess-Examples"></a>
-#### Examples
+## Examples
A very simple process that would only be invoked would use a deploy.xml very similar to:
@@ -82,7 +86,7 @@ A deployment including two processes inv
</invoke>
</process>
<process name="resp:MagicSessionResponder">
- <type>resp:MagicSessionResponder</type>
+ <type>resp:MagicSessionResponder</type>
<provide partnerLink="mainPartnerLink">
<service name="mws:MSResponderService" port="MSResponderPort"/>
</provide>
@@ -96,10 +100,10 @@ A deployment including two processes inv
See the complete example [here](https://svn.apache.org/repos/asf/ode/trunk/distro-axis2/src/examples/MagicSession/).
<a name="CreatingaProcess-Additionalsettings"></a>
-#### Additional settings
+## Additional settings
<a name="CreatingaProcess-Inmemoryexecution"></a>
-##### In memory execution
+### In memory execution
For performance purposes, you can define a process as being executed only in-memory. This greatly reduces the amount of generated queries and puts far less load on your database. Both persistent and non-persistent processes can cohabit in ODE.
@@ -117,7 +121,7 @@ To declare a process as in-memory just a
Be aware that in-memory executions introduces many restrictions on your process and what it can do. The instances of these processes can't be queried by using the [Management API](management-api.html). The process definition can only include one single receive activity (the one that will trigger the instance creation).
<a name="CreatingaProcess-User-definedprocessproperties"></a>
-##### User-defined process properties
+### User-defined process properties
User-defined process properties provide means to configure process models and their instances. They are either statically declared and set in the deployment descriptor `deploy.xml` or can be set using the process management API. All instances of a process model share the same set of process properties. If a process property changes, it changes for all instances.
@@ -125,9 +129,9 @@ A process property is identified by a QN
<process name="pns:HelloWorld2">
- ...
- <property xmlns:loan="urn:example" name="loan:loanThreshold">4711</property>
- ...
+ ...
+ <property xmlns:loan="urn:example" name="loan:loanThreshold">4711</property>
+ ...
</process>
@@ -141,12 +145,11 @@ For instance, instead of hard coding the
To read process properties in a BPEL process, you can use the non-standard XPath extension `bpws:process-property(propertyName)`, e.g. in a transition condition or in an assign activity:
-
...
<assign>
- <copy>
- <from xmlns:loan="urn:example">bpws:process-property(loan:loanThreshold)</from>
- <to>$threshold</to>
- </copy>
+ <copy>
+ <from xmlns:loan="urn:example">bpws:process-property(loan:loanThreshold)</from>
+ <to>$threshold</to>
+ </copy>
</assign>
...
Modified: ode/site/trunk/content/jbi-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/jbi-deployment.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/jbi-deployment.mdtext (original)
+++ ode/site/trunk/content/jbi-deployment.mdtext Mon Dec 31 15:25:55 2012
@@ -1,7 +1,8 @@
Title: JBI Deployment
+Category: documentation
## Overview
-Here's a quick overview to deploy PXE/ODE on a JBI container (e.g. [ServiceMix](http://servicemix.apache.org))
+Here's a quick overview to deploy ODE on a JBI container (e.g. [ServiceMix](http://servicemix.apache.org))
<a name="JBIDeployment-1)DownloadtheJBIdistribution"></a>
## 1) Download the JBI distribution
Modified: ode/site/trunk/content/management-api.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/management-api.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/management-api.mdtext (original)
+++ ode/site/trunk/content/management-api.mdtext Mon Dec 31 15:25:55 2012
@@ -1,10 +1,11 @@
Title: Management API
+Category: documentation
## Overview
ODE has a complete management API to check which processes are deployed, running and completed instances, variables values and more. To see which methods are available, have a look at the [ProcessManagement](http://ode.apache.org/javadoc/org/apache/ode/bpel/pmapi/ProcessManagement.html) and [InstanceManagement](http://ode.apache.org/javadoc/org/apache/ode/bpel/pmapi/InstanceManagement.html) interfaces, the javadoc is pretty comprehensive.
-
+
These two interfaces are available as web services on the Axis2-based distribution. The corresponding WSDL can be found [here](http://svn.apache.org/repos/asf/ode/trunk/axis2/src/main/wsdl/pmapi.wsdl).
-
+
To invoke these two services, any web service client should work (in a perfect interoperable world). To ease the invocation when using an Axis2 client, a helper class is bundled in ode-axis2.jar: [ServiceClientUtil](http://ode.apache.org/javadoc/axis2/org/apache/ode/axis2/service/ServiceClientUtil.html). Usage examples are also available in test classes [InstanceManagementTest](http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/InstanceManagementTest.java) and [ProcessManagementTest](http://svn.apache.org/repos/asf/ode/trunk/axis2/src/test/java/org/apache/ode/axis2/management/ProcessManagementTest.java). Here is a short example demonstrating the invocation of the _listAllProcesses_ operation:
:::java
Modified: ode/site/trunk/content/process-versioning.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/process-versioning.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/process-versioning.mdtext (original)
+++ ode/site/trunk/content/process-versioning.mdtext Mon Dec 31 15:25:55 2012
@@ -1,11 +1,10 @@
Title: Process Versioning
- * [Introduction](#ProcessVersioning-Introduction)
- * [How Versioning Works](#ProcessVersioning-HowVersioningWorks)
- * [Process Versioning in ODE](#ProcessVersioning-ProcessVersioninginOde)
- * [Remote Deployment vs. Hand-Made Deployment](#ProcessVersioning-RemoteDeploymentvs.Hand-MadeDeployment)
+Category: documentation
<a name="ProcessVersioning-Introduction"></a>
-### Introduction
+## Introduction
+
+[TOC]
Before starting on what process versioning exactly does, let's see what the world (or at least ODE) would be without versioning. It will be much more easier for you to understand the solution after fully seeing the problem.
Modified: ode/site/trunk/content/smx4-osgi-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/smx4-osgi-deployment.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/smx4-osgi-deployment.mdtext (original)
+++ ode/site/trunk/content/smx4-osgi-deployment.mdtext Mon Dec 31 15:25:55 2012
@@ -1,4 +1,6 @@
Title: SMX4 OSGi Deployment
+Category: documentation
+
<a name="SMX4OSGiDeployment-DeployApacheODEOSGibundleandexampleprocess(PingPong)"></a>
## Deploy Apache ODE OSGi bundle and example process (Ping Pong)
@@ -17,7 +19,7 @@ This will install ODE with default setti
Create `SMX4/etc/org.apache.ode.jbi.cfg` file with following contents:
- :::text
+ :::properties
ode-jbi.pidNamespace=urn:ode-jbi
ode-jbi.allowIncompleteDeployment=false
ode-jbi.messageMapper=org.apache.ode.jbi.msgmap.ServiceMixMapper
@@ -78,12 +80,12 @@ Please note that `etc/org.apache.ode.jbi
You can grab pmapi SA from here [http://markmail.org/message/ghigpzcpt2j3qnoo](http://markmail.org/message/ghigpzcpt2j3qnoo).
Then edit SMX4 `etc/config.properties` and change from:
- :::text
+ :::properties
org.osgi.framework.bootdelegation=sun.*,com.sun*,javax.transaction,javax.transaction.*
to:
- :::text
+ :::properties
org.osgi.framework.bootdelegation=sun.*,com.sun*,javax.transaction,javax.transaction.*,javax.xml.stream,javax.xml.stream.*
Modified: ode/site/trunk/content/upgrading-ode.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/upgrading-ode.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/upgrading-ode.mdtext (original)
+++ ode/site/trunk/content/upgrading-ode.mdtext Mon Dec 31 15:25:55 2012
@@ -1,4 +1,8 @@
Title: Upgrading ODE
+Category: documentation
+
+## Overview
+
<div class="alert alert-note"><h4 class="alert-heading">You shall backup</h4></div>
ODE upgrade procedures usually consist in:
@@ -12,7 +16,7 @@ ODE upgrade procedures usually consist i
## From 1.3.3 to 1.3.4
-First, apply SQLs to denormalize LARGE_DATA table from here: [https://issues.apache.org/jira/browse/ODE-694]
+First, apply SQLs to denormalize LARGE_DATA table from [here](https://issues.apache.org/jira/browse/ODE-694)
Then, please apply following updates:
@@ -41,7 +45,7 @@ None
## From 1.2 to 1.3.2
-If you're currently using ODE *1.2* and are upgrading to 1.3.2, please run the following queries.
+If you're currently using ODE 1.2 and are upgrading to 1.3.2, please run the following queries.
### For OpenJPA database schema
Modified: ode/site/trunk/content/war-deployment.mdtext
URL: http://svn.apache.org/viewvc/ode/site/trunk/content/war-deployment.mdtext?rev=1427148&r1=1427147&r2=1427148&view=diff
==============================================================================
--- ode/site/trunk/content/war-deployment.mdtext (original)
+++ ode/site/trunk/content/war-deployment.mdtext Mon Dec 31 15:25:55 2012
@@ -1,4 +1,6 @@
Title: WAR Deployment
+Category: documentation
+
<a name="WARDeployment-DeployingtheWAR"></a>
## Deploying the WAR
@@ -12,7 +14,7 @@ Get the WAR file in the distribution roo
Copy the content of the _examples_ directory in the distribution (the 3 sub-directories) to _tomcat/webapps/ode/WEB-INF/processes_, this will automatically deploy the 3 example processes. Use the sendsoap command located in the distribution _bin_ directory to send test messages. The messages to run each of the 3 examples are provided in their respective directory (testRequest.soap). For each example type something like:
:::text
- bin/sendsoap http://localhost:8080/ode/processes/helloWorld examples/HelloWorld2/testRequest.soap
+ $ bin/sendsoap http://localhost:8080/ode/processes/helloWorld examples/HelloWorld2/testRequest.soap
The *sendsoap* executable can be found in the distribution _bin_ directory. The urls should be updated according to the address defined in the WSDL file for the process service.
@@ -43,7 +45,7 @@ The ODE war should have been copied to t
2. Add a file named _ode-axis2.properties_ under _webapps/ode/WEB-INF/conf_ with the following content:
- :::text
+ :::properties
ode-axis2.db.mode=EXTERNAL
ode-axis2.db.ext.dataSource=java:comp/env/jdbc/ODEDB
@@ -51,11 +53,11 @@ The ODE war should have been copied to t
You're done!
<a name="WARDeployment-ConfiguringODEinJBosswithJNDIEXTERNALdatasource"></a>
-## Configuring ODE in JBoss with JNDI EXTERNAL datasource
+## Configuring ODE in JBoss with external JNDI datasource
Create ode/WEB-INF/conf/ode-axis2.properties with following content:
- :::text
+ :::properties
#Uncomment for using dao hibernate
#ode-axis2.dao.factory=org.apache.ode.daohib.bpel.BpelDAOConnectionFactoryImpl
ode-axis2.db.mode=EXTERNAL