10:27 a.m.
Author: ochikvina
Date: 2010-05-25 11:27:33 -0400 (Tue, 25 May 2010)
New Revision: 22310
Added:
trunk/bpel/docs/reference/en-US/images/bpel_task_1.png
trunk/bpel/docs/reference/en-US/images/bpel_task_2.png
trunk/bpel/docs/reference/en-US/images/bpel_task_3.png
trunk/bpel/docs/reference/en-US/modules/summary.xml
trunk/bpel/docs/reference/en-US/modules/tasks.xml
Log:
<html><head><meta name="qrichtext" content="1"
/></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/browse/TOOLSDOC-48 - Updated BPEL guide.Corrected all
found incorrect places. </p>
</body></html>
Added: trunk/bpel/docs/reference/en-US/images/bpel_task_1.png
===================================================================
(Binary files differ)
Property changes on: trunk/bpel/docs/reference/en-US/images/bpel_task_1.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/bpel/docs/reference/en-US/images/bpel_task_2.png
===================================================================
(Binary files differ)
Property changes on: trunk/bpel/docs/reference/en-US/images/bpel_task_2.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/bpel/docs/reference/en-US/images/bpel_task_3.png
===================================================================
(Binary files differ)
Property changes on: trunk/bpel/docs/reference/en-US/images/bpel_task_3.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/bpel/docs/reference/en-US/modules/summary.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/modules/summary.xml (rev 0)
+++ trunk/bpel/docs/reference/en-US/modules/summary.xml 2010-05-25 15:27:33 UTC (rev
22310)
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter>
+ <?dbhtml filename="summary.html"?>
+ <title>Summary</title>
+ <para>In conclusion, with this document you know all the capabilities of BPEL
Tools
+ and could easily start with them.
+ The chapters above walked you through the steps on how to create and configure
BPEL process and
+ deployment descriptor files.
+ If you have questions or suggestions concerned both the documentation and tools
behavior,
+ you are welcome to JBoss Tools Users forum.
+ Please, use Jira to report bugs and requests on documentation.</para>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can
find at
+ <ulink
url="http://docs.jboss.org/tools">http://docs.jboss.org/tool...
in the corresponding release directory.
+ </para>
+ <para>The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs">http...;.
</para>
+
+ </section>
+</chapter>
Added: trunk/bpel/docs/reference/en-US/modules/tasks.xml
===================================================================
--- trunk/bpel/docs/reference/en-US/modules/tasks.xml (rev 0)
+++ trunk/bpel/docs/reference/en-US/modules/tasks.xml 2010-05-25 15:27:33 UTC (rev 22310)
@@ -0,0 +1,444 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="tasks">
+ <title>Tasks</title>
+ <section id="detail">
+ <title>Creating and editing a BPEL project</title>
+ <para>In the chapter we describe the necessary steps to create a new BPEL
project and edit the BPEL files.
+ You can get the source of the example from <property>
+ riftsaw/samples/quickstart/hello_world</property>.
+ Here and further in the guide we will create
+ a simple echo example, used to respond to a sent message with a
+ modified version of the request message being returned in a response.
+ First of all, you should create a BPEL project.
+
+ </para>
+ <section id="createproject">
+ <title>Creating a BPEL project</title>
+ <para>Create the project by selecting
+ <emphasis><property>New > Project... > BPEL 2.0 >
BPEL Project</property></emphasis> from the menu bar.
+ Then click the <property>Next</property> button.
+ </para>
+ <figure>
+ <title>New BPEL Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createproject_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this page of the <property>New BPEL Project
Wizard</property> enter a project name in the <property>Project
Name</property>
+ field,e.g enter
<property>HelloWorld</property>.</para>
+
+ <figure>
+ <title>New BPEL Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createproject_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property>Finish</property> button.
+ So you have created the BPEL project named
<property>HelloWorld</property>.
+ Its structure is like this: </para>
+ <figure>
+ <title>The BPEL Project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createproject_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="createprocess">
+ <title>Creating a BPEL process</title>
+ <para>Now you should create a BPEL process. You can create it by
selecting
+ <emphasis><property>New > Others... > BPEL 2.0 > New
BPEL Process File</property></emphasis>.
+ </para>
+ <figure>
+ <title>New BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createprocess_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property>Next</property> button. Enter the
following information:</para>
+ <table>
+
+ <title>Fields and values</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left"
colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Value</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>BPEL Process
Name</para></entry>
+ <entry><para>enter a process name. For example,
<property>HelloWorld</property>.</para></entry>
+ </row>
+ <row>
+
<entry><para>Namespace</para></entry>
+ <entry><para>enter or select a namespace for the
BPEL process.</para></entry>
+ </row>
+ <row>
+ <entry><para>Template</para></entry>
+ <entry><para>Select the necessary template for
the BPEL process.
+ When you select the template, you will see the
information
+ about the template below on the page.In our case you
should
+ select <property>Synchronous BPEL
Process</property>.</para></entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <figure>
+ <title>New BPEL Process File Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createprocess_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property>Next</property> button. On the
second page make sure that the folder
<property>HelloWorld/bpelContent</property> is selected.
+ Click <property>Finish</property>.
+ </para>
+ <note>
+ <para>All of your files that are used in your BPEL project must be
under the <property>bpelContent</property> folder. Only in this case
+ these files can be deployed to JBoss server.
+ </para>
+ </note>
+
+ <para>Up to now, you have got a simple BPEL process as on the screen
below.</para>
+ <figure>
+ <title>A simple BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_createprocess_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The next step, you can do is to edit the BPEL process file and
then deploy it to JBoss server. </para>
+ </section>
+ <section id="editprocess">
+ <title>Editing a BPEL process file</title>
+ <para>If the <emphasis><property>Properties
view</property></emphasis> and <emphasis><property>Palette
view</property></emphasis> are not opened, you can open the views by
right-clicking the BPEL editor and selecting
+ <property>Show in Properties</property>, <property>Show
Palette in Palette view</property>. Then you should have the view like this:
+ </para>
+ <figure>
+ <title>The BPEL editor view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_editprocess_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <emphasis><property>Palette
view</property></emphasis>, you can drag a BPEL element to the BPEL editor and
drop it in the place you want.</para>
+ <para>In the <emphasis><property>Properties
view</property></emphasis>, you can get the information about every element of
the BPEL process.
+ In the BPEL editor select any element you want,and then
+ the element's properties will be shown in the Properties view.The
table below describes the tabs of the Properties view:
+ </para>
+ <table>
+
+ <title>Tabs of the Property view</title>
+ <tgroup cols="2">
+ <colspec colnum="1" align="left"
colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <thead>
+ <row>
+ <entry>Tab</entry>
+ <entry>Description</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+
<entry><para>Description</para></entry>
+ <entry><para>Shows the descriptive information
about the element,e.g. <property>Name</property> of the
element.</para></entry>
+ </row>
+ <row>
+ <entry><para>Details</para></entry>
+ <entry><para>Shows the detailed and important
information about the element.
+ It is the most important section of an element.
+ Most of the properties of an element are set in this
section.</para></entry>
+ </row>
+ <row>
+ <entry><para>Join
Behavior</para></entry>
+ <entry><para>Shows the <property>Join
Failure</property> property of the element.</para></entry>
+ </row>
+ <row>
+
<entry><para>Documentation</para></entry>
+ <entry><para>Shows the
<property>documentation</property> sub-element of an
element.</para></entry>
+ </row>
+ <row>
+ <entry><para>Other</para></entry>
+ <entry><para>Every BPEL element has its own
sections: Correlation section, Message Exchange section, and so on. We will
+ introduce them while using
them.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>In order to see how a simple BPEL process works in action, you
should do some steps as below: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Modify two variables of the process:</para>
+ <itemizedlist>
+ <listitem><para>Click on the details tab of the input
variable,
+ select <property>Browse...</property>.
+ Then choose <property>string</property> primitive
from the list.</para>
+ <figure>
+ <title>Edit variable in
<property>process</property> file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/bpel_task_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property>xsd</property> as a
namespace in the popup menu.</para>
+ </listitem>
+ </itemizedlist>
+
+ </listitem>
+ <listitem>
+ <para>Add an <property>Assign</property> element
between the <property>receiveInput</property> element and
<property>replyOutput</property> element.</para>
+ </listitem>
+ <listitem>
+ <para>Click the <property>Assign</property> element
in the BPEL editor in order to get the properties information of it in the Properties
view.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Set its name in the
<property>Description</property> tab as
<property>assignHelloMesg</property>.</para>
+ <para>In the <property>Details</property> section
of Properties view,
+ you should click the <property>New</property> button
to add a <property>copy</property> sub-element to the element.
+ Assign "Variable to Variable"(input:string to output).
At this time, an "<property>initializer</property>" popup dialog
appears. Click on the <property>Yes</property> button in the dialog.
+ </para>
+ <figure>
+ <title>Add <property>Assign</property> to the
process</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/bpel_task_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Then you should click
<property>New</property> once more and select Expression to Variable
+ (assign <code>concat($input,' World'))</code>
to <property>result:string</property>. </para>
+ <figure>
+ <title>Add <property>Expression
assign</property> to the process</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/bpel_task_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="wsdl">
+ <title>Adding Service to WSDL file</title>
+ <para></para>
+ <itemizedlist>
+
+ <listitem>
+ <para>Open the file
"<property>HelloWorldArtifacts.wsdl</property>" in the
"<property>HelloWorld</property>" project by double-clicking the
file. Right-click the WSDL editor and select
+ <property>Add Service</property>. A new service
should appear in the editor. Name it
<property>HelloWorldProcessService</property>. It has the Port
+ named <property>NewPort</property>. Select it,
right-click on it and rename it to <property>HelloWorldProcessPort</property>
in the Properties
+ view.
+ </para>
+ <figure>
+ <title>Add <property>Service</property> to the
WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_editprocess_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Right-click somewhere in the whitespace of the WSDL
editor and select
+ <property>Add Binding</property>. A new Binding
component will appear in the editor. Name it
<property>HelloWorldSOAPBinding</property>. Select it, in the
+ General tab of the Properties view and select
<property>HelloWorld</property> as a port type in the
<property>PortType</property>. Then click on the
+ <property>Generate Binding Content...</property>
button to open the <property>Binding Wizard</property>. In the wizard, select
<property>SOAP </property>
+ as the <property>Protocol</property>. Finally, click
the <property>Finish</property> button to close the wizard.
+ </para>
+ <figure>
+ <title>Add a <property>Binding</property> to
the WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_editprocess_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Click the
<property>HelloWorldProcessPort</property> property in the General section of
the Properties view, select <property>HelloWorldSOAPBinding</property> in
+ the <property>Binding</property> combobox. In the
<property>Address</property> field input <ulink
url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>.
+ </para>
+ <figure>
+ <title>Add the
<property>HelloWorldSOAPBinding</property> to the
<property>HelloWorldProcessPort</property></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_editprocess_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem><para>You should also change some service
part configurations.
+ To do this,click part element in the WSDL editor,
+ then put the following data in the Properties view.
+ </para>
+ <figure>
+ <title>Configuration of service part</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/detail_editprocess_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now you have finished creating a simple BPEL process.As a next
step, you can deploy the BPEL project to JBoss BPEL Runtime.</para>
+
+ </section>
+
+ </section>
+ <section id="deploy">
+ <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title>
+ <section id="createdeploy">
+ <title>Creating a bpel-deploy.xml file</title>
+ <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you
should create a bpel-deploy.xml file.
+ JBoss tools can help you to create it:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Create the bpel-deploy.xml by selecting
+ <emphasis><property>New > Other... > BPEL 2.0
> Apache ODE Deployment Descriptor</property></emphasis>. Click the
<property>Next</property> button.
+ </para>
+ <figure>
+ <title>New BPEL Deploy file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>On the next wizard page you should enter the following
information:</para>
+ <para><emphasis><property>BPEL
Project</property></emphasis>: Click the
<property>Browse...</property> button to select the BPEL project in your
workspace which you want to deploy to the runtime.
+ Please note, that you should select the
<property>bpelContent</property> folder in your new BPEL project as a value of
<property>BPEL Project</property> field because the bpel-deploy.xml should be
created in this place.
+ </para>
+ <para><emphasis><property>File
name</property></emphasis>: The default value is bpel-deploy.xml. Please,
don't change it.</para>
+ <para>Click on <property>Finish</property> button
to close the wizard and a new bpel-deploy.xml file will be created.</para>
+ <figure>
+ <title>New BPEL Deploy file Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Double-click the bpel-deploy.xml file to open it in ODE
Descriptor Deployment Editor.
+ In the <property>Inbound Interfaces</property>
section, click the
+ <property>Associated Port</property> column and
select <property>HelloWorldProcessPort</property>
+ in the dropdown box.The <property>Related
Service</property> and <property>Binding Used</property>
+ columns should be automatically filled in. Save the
<emphasis><property>bpel-deploy.xml</property></emphasis>.
+ </para>
+ <figure>
+ <title>bpel-deploy.xml file editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="createruntime">
+ <title>Creating JBoss BPEL Server</title>
+ <para>Suppose you have installed the <property>JBoss BPEL
Runtime-RiftSaw</property> as it was described <link
linkend="installRuntime">before</link>, now you can create a server for
JBoss BPEL runtime.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Open the <property>Servers</property> view by
selecting
+ <emphasis><property>Windows > Show View >
Other... > Server > Servers</property></emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Right-click the Servers view and select
+ <emphasis><property>New >
Server</property></emphasis> to open the New Server Wizard:
+ </para>
+ <figure>
+ <title>New Server Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property>JBoss AS 5.1 </property>as a
server type. </para>
+ <note>
+ <para>Please note, that only JBoss As 5.1 or higher version
supports BPEL.</para>
+ </note>
+ </listitem>
+ <listitem>
+
+ <para>Click the <property>Next</property> button.
On the next page, you should input your <emphasis><property>JBoss
As</property></emphasis> location. Then click the
<property>Next</property> button and
+ you will get the page like this:
+ </para>
+ <figure>
+ <title>Add resource to the server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property>HelloWorld</property>, then
click the <property>Add </property> button to add the project to the server.
+ Then click on the <property>Finish</property>
button.
+ </para>
+ <para>Start the server by right-clicking on the server and
selecting the <property>Start</property> item. </para>
+
+ <figure>
+ <title>The started server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If some aspects of server creation is not clear, please,
read <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_si...
Server Manager Reference Guide</ulink> for more details.</para>
+ </listitem>
+ <listitem>
+ <para>You can enter the link <ulink
url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink>
to the browser to get the deployed processes.</para>
+ <figure>
+ <title>The BPEL console</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/deploy_createdeploy_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para>If there's anything we didn't cover or you can't
figure out, please feel free to visit our <ulink
+
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
+ >JBoss Tools Users Forum</ulink> to ask questions.
+ There we are also waiting for your suggestions and comments.</para>
+ </section>
+ </section>
+</chapter>