From jbosstools-commits at lists.jboss.org Tue Nov 30 02:22:10 2010 Content-Type: multipart/mixed; boundary="===============3090626066017557110==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r27016 - trunk/bpel/docs/reference/en-US. Date: Tue, 30 Nov 2010 02:22:09 -0500 Message-ID: <201011300722.oAU7M9KU004653@svn01.web.mwc.hst.phx2.redhat.com> --===============3090626066017557110== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: Grid.Qian Date: 2010-11-30 02:22:07 -0500 (Tue, 30 Nov 2010) New Revision: 27016 Modified: trunk/bpel/docs/reference/en-US/install.xml trunk/bpel/docs/reference/en-US/master.xml trunk/bpel/docs/reference/en-US/reference.xml trunk/bpel/docs/reference/en-US/tasks.xml Log: Update BPEL User Guide https://jira.jboss.org/browse/TOOLSDOC-90 Modified: trunk/bpel/docs/reference/en-US/install.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/bpel/docs/reference/en-US/install.xml 2010-11-30 01:26:00 UTC (re= v 27015) +++ trunk/bpel/docs/reference/en-US/install.xml 2010-11-30 07:22:07 UTC (re= v 27016) @@ -3,7 +3,7 @@ Installation JBoss BPEL Tools
Installation JBoss BPEL editor - At first, you need Eclipse 3.5. You can get it from Eclipse Web Site. = + At first, you need Eclipse 3.6. You can get it from Eclipse Web Site. = The JBoss BPEL editor is included into JBoss Tools. = You have some methods to install JBoss Tools. = @@ -20,7 +20,7 @@ JBossAS (version 5.1.0.GA or higher), = available from http://www.jboss.org/jbossas. - RiftSaw (version 2.0 or higher), available= from http://www.jboss.org/rift= saw. + RiftSaw (version 2.1 or higher), available= from http://www.jboss.org/rift= saw. Ant, available from here. = @@ -53,7 +53,7 @@ Then in the = ${RiftSaw}/install folder run the com= mand: ant deploy -Ddatabase=3Dhsql -Dws.stack=3Dnative= -Dws.version=3D3.2.2.GA = - It will help you to download the web service stack, and th= en upgrade it for JBoss AS. +It will help you to download the web service stack, and then upgrade it fo= r JBoss AS. Anyway, you can do it step by step by following the guide from= JBoss RiftSaw do= cuments or the README file in ${RiftSaw= }/install Modified: trunk/bpel/docs/reference/en-US/master.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/bpel/docs/reference/en-US/master.xml 2010-11-30 01:26:00 UTC (rev= 27015) +++ trunk/bpel/docs/reference/en-US/master.xml 2010-11-30 07:22:07 UTC (rev= 27016) @@ -1,1106 +1,56 @@ - - - = - - JBoss BPEL User Guide - - - - - = - - - = - = - - DennyXud= xu(a)redhat.com - GridQian= fqian(a)redhat.com = - BobBrodt= bbrodt(a)redhat.com = - - 2009 - 2010 - JBoss by Red Hat - - - Version: 1.0.0.trunk - - - - PDF version - - - = - = - - JBoss BPEL project Overview + +JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to c= reate, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is ba= sed on Eclipse = - BPEL - project . - = - It improves the Eclipse BPEL project in the following way: - - Implements close integration with JBoss BPEL runti= me. Adds a new project type for the deployment to JBoss BPEL runtime. - Supports two ways of deployment: one way is to dep= loy a bpel project directly to JBoss BPEL runtime. The other way is to depl= oy bpel files in JBoss ESB project to JBoss BPEL runtime. - Improves the BPEL validator and increases Eclipse = BPEL editor's quality. - - = - - WS-BPEL 2.0 = - stands for Web Service Business Process Execution Language. Like EAI, B= PEL is an XML-based language, - but BPEL is more specific and targeted. A programmer uses BPEL to join = sometimes = - disparate functions into an integrated process, resulting in a seamless= use of the Internet to = - conduct business transactions ranging from simple money exchanges to co= mplex calculations and = - asset reallocation. - - -
- Key Features of JBoss BPEL project - Let's start with looking through the table of the main features = of JBoss BPEL editor project: - = - - Key Functionality for JBoss BPEL editor project - = - - - - - Feature - Benefit - - = - = - - WS-BPEL 2.0 support - JBoss BPEL project supports the newest WS= -BPEL 2.0 specifications. = - = - - Close integration with JBoss BPEL runtime= - There are two ways to deploy BPEL files t= o JBoss BPEL runtime. - The user can deploy a BPEL project as a whole and = can deploy BPEL files in - JBoss ESB project to JBoss BPEL runtime. = - = - - BPEL file editor - The user can use the editor separately to= edit a BPEL file. = - = - - BPEL file validator - The validator can give the error messages= about BPEL files to the user. = - = - = - -
= -
- - = - - Installation JBoss BPEL Tools -
- Installation JBoss BPEL editor - At first, you need Eclipse 3.6. You can get it from Eclipse Web Site. = - - The JBoss BPEL editor is included into JBoss Tools. = - You have some methods to install JBoss Tools. = - See Installing JBoss Tools for more information. - If you want to install only the JBoss BPEL editor, you can = install it from JBo= ss Tools page separately. - Please, note, that only JBoss Tools 3.1 or higher version incl= udes JBoss BPEL editor. - -
-
- Prerequisites - For installation and configuring BPEL engine into a JBossAS = environment you will need the following: - - JBossAS (version 5.1.0.GA or higher), availabl= e from http://www.jboss.org/jbo= ssas. - RiftSaw (version 2.1 or higher), available fro= m http://www.jboss.org/riftsaw<= /ulink>. - Ant, available from here. - = -
-
- Installation JBoss BPEL Runtime - - - Unpack the JBossAS installation archive into the req= uired location. - - - Unpack the RiftSaw distribution into the location al= ongside the JBossAS installation: - - - Edit the install= /deployment.properties file to update the JBossAS location setti= ngs. - - - From the install= folder, - run: ant deploy -D= database=3Dhsql - to deploy RiftSaw to JBossAS. - - - - - - Then in the = - ${RiftSaw}/install = folder run the command: - ant deploy -Ddatabase=3Dhsql -= Dws.stack=3Dnative -Dws.version=3D3.2.2.GA = - It will help you to download the web service stack, and th= en upgrade it for JBoss AS. Anyway, you can do it step by step by followin= g the guide from JBoss RiftSaw documents or the README file in ${RiftSaw}/install - - - - = -
- - = - - Tasks -
- Creating and editing a BPEL project - In the chapter we describe the necessary steps to create a n= ew BPEL project and edit the BPEL files. - You can get the source of the example from - riftsaw/samples/quickstart/hello_world. - 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 re= sponse. - First of all, you should create a BPEL project. - = - -
- Creating a BPEL project - Create the project by selecting = - New > Project... = > BPEL 2.0 > BPEL Project from the menu bar. - Then click the Next= button. = - -
- New BPEL Project - - - - - -
- On this page of the New BPEL= Project Wizard enter a project name in the Project Name - field,e.g enter HelloWorld. - = -
- New BPEL Project Wizard - - - - - -
- Click the Finish = button. - So you have created the BPEL project named HelloWorld. - Its structure is like this: -
- The BPEL Project structure - - - - - -
-
-
- Creating a BPEL process - Now you should create a BPEL process. You can create it = by selecting = - New > Others... &= gt; BPEL 2.0 > New BPEL Process File. - -
- New BPEL Process File - - - - - -
- Click the Next bu= tton. Enter the following information: - - = - Fields and values - = - <= /colspec> - - - - Field - Value - = - - = - = - - BPEL Process Name - enter a process name. For example= , HelloWorld. = - = - - Namespace - enter or select a namespace for t= he BPEL process. = - = - - Template - 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 ou= r case you should - select Synchro= nous BPEL Process. = - = - = - = - -
- = -
- New BPEL Process File Wizard - - - - - -
- = - Click the Next bu= tton. On the second page, you can custom your wsdl service details. Enter t= he following information: - - = - Fields and values - = - <= /colspec> - - - - Field - Value - = - - = - = - - Service Name - a wsdl service name for the BPEL = process. The default is, HelloWorld.= = - = - - Port Name - a wsdl port name for the BPEL pro= cess. The default is, HelloWorldPort= . = - = - - Service Address - an address of the wsdl service fo= r the BPEL process. The default is, http://loca= lhost:8080/HelloWorld. = - = - - Binding Protocol - the binding protocal that you use= in the wsdl. You can choose SOAP or HTTP. The default is, SOAP. = - = - = - -
- = -
- Create WSDL file for the BPEL Process wizardpage</t= itle> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/detail_createprocess_= 2a.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - = - <para>Click the <property moreinfo=3D"none">Next</property> bu= tton. On the third page, you can choose a folder for the process file from = the projects in your workspace. If not choose, The default folder <property= moreinfo=3D"none">HelloWorld/bpelContent</property> is selected. - Click <property moreinfo=3D"none">Finish</property>. - </para> - <note> - <para>All of your files that are used in your BPEL project= must be under the <property moreinfo=3D"none">bpelContent</property> folde= r of a BPEL project. 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 float=3D"0"> - <title>A simple BPEL Process File - - - - - -
- The next step, you can do is to edit the BPEL process fi= le and then deploy it to JBoss server. -
-
- Editing a BPEL process file - If the Properties = view and Palett= e view are not opened, you can open the views by righ= t-clicking the BPEL editor and selecting = - Show in Properties,= Show Palette in Palette view. Then = you should have the view like this: = - -
- The BPEL editor view - - - - - -
= - In the Palette vie= w, you can drag a BPEL element to the BPEL editor and= drop it in the place you want. = - In the Properties = view, 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 v= iew.The table below describes the tabs of the Properties view: = - - - = - Tabs of the Property view - = - <= /colspec> - - - - Tab - Description - = - - = - = - - Description - Shows the descriptive information= about the element,e.g. Name of the = element. = - = - - Details - Shows the detailed and important = information about the element. - It is the most important section of an ele= ment. - Most of the properties of an element are s= et in this section. = - = - - Join Behavior - Shows the Join Failure property of the element. = - = - - Documentation - Shows the documentation sub-element of an element. = - = - - Other - Every BPEL element has its own se= ctions: Correlation section, Message Exchange section, and so on. We will - introduce them while using them. = - = - = - -
- In order to see how a simple BPEL process works in actio= n, you should do some steps as below: = - - - Modify two variables of the process: - - Click on the details tab of the input = variable, - select Browse.... - Then choose string primitive from the list. -
- Edit variable in <property moreinfo=3D"= none">process</property> file - - - - - -
= - - - Select xsd as a namespace in the popup menu. - - - = - - - Add an Assign element between the receiveInput element and replyOutput element. - - - Click the Assign element in the BPEL editor in order to get the properties informati= on of it in the Properties view. = - - - - Set its name in the = Description tab as assignHelloMesg. - In the Details section of Properties view, - you should click the N= ew button to add a copy s= ub-element to the element. = - Assign "Variable to Variable"(input:string to outp= ut). At this time, an "initializer" = popup dialog appears. Click on the Yes button in the dialog. - -
- Add <property moreinfo=3D"none">Assign</pro= perty> to the process - - - - - -
= - Then you should click New once more and select Expression to Variable (assign = concat($input,' World')) to result:strin= g. -
- Add <property moreinfo=3D"none">Expression = assign</property> to the process - - - - - -
= - - -
- = -
- Adding Service to WSDL file - - The HelloWorldArtifacts.wsdl has been added a service= when you create a BPEL process file. You have a default service in this WS= DL file. But if you want to add a service by yourself, you can follow the s= teps as below: - - - Open the file "Hello= WorldArtifacts.wsdl" in the "HelloWo= rld" project by double-clicking the file. Right-click the WSDL e= ditor and select = - Add Service= . A new service should appear in the editor. Name it HelloWorldProcessService. It has the Port = - named NewPort. Select it, right-click on it and rename it to HelloWorldProcessPort in the Properties = - view. - -
- Add <property moreinfo=3D"none">Service</pr= operty> to the WSDL file - - - - - -
= - - - Right-click somewhere in the whitespace of the W= SDL editor and select = - Add Binding= . A new Binding component will appear in the editor. Name it HelloWorldSOAPBinding. Select it, in the = - General tab of the Properties view and select HelloWorld as a port type in the PortType. Then click on the = - Generate Binding Conte= nt... button to open the Binding Wi= zard. In the wizard, select SOAP = - as the Protocol. Finally, click the Finish but= ton to close the wizard. - -
- Add a <property moreinfo=3D"none">Binding</= property> to the WSDL file - - - - - -
= - - - Click the HelloWorld= ProcessPort property in the General section of the Properties vi= ew, select HelloWorldSOAPBinding in - the Binding= combobox. In the Address field inpu= t http:= //localhost:8080/bpel/processes/HelloWorld?wsdl. - -
- Add the <property moreinfo=3D"none">HelloWo= rldSOAPBinding</property> to the <property moreinfo=3D"none">HelloWorldProc= essPort</property> - - - - - -
= - = - You should also change some servic= e part configurations. - To do this,click part element in the WSDL editor, - then put the following data in the Properties view= . = - -
- Configuration of service part</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/detai= l_editprocess_5.png"></imagedata> - </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=3D"deploy"> - <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime -
- Creating a deploy.xml file - If you want to deploy a BPEL project to JBoss BPEL Runti= me, you should create a deploy.xml file. = - JBoss tools can help you to create it: - - - - Create the deploy.xml by selecting = - New > Oth= er... > BPEL 2.0 > Apache ODE Deployment Descriptor. Click the Next button. = - -
- New BPEL Deploy file - - - - - -
= - - - On the next wizard page you should enter the fol= lowing information: - BPEL Proje= ct: Click the Browse...<= /property> button to select the BPEL project in your workspace which you wa= nt to deploy to the runtime. - Please note, that you should select the bpelContent folder in your new BPEL project as= a value of BPEL Project field becau= se the deploy.xml should be created in this place. - - File name<= /property>: The default value is deploy.xml. Please, don't chang= e it. - Click on Finish button to close the wizard and a new deploy.xml file will be created= . -
- New BPEL Deploy file Wizard - - - - - -
= - - - Double-click the deploy.xml file to open it in O= DE Descriptor Deployment Editor. - In the Inbound Interfa= ces section, click the = - Associated Port column and select HelloWorldProcessPort - in the dropdown box.The Related Service and Binding Used = - columns should be automatically filled in. Save t= he deploy.xml. - -
- deploy.xml file editor - - - - - -
= - = - -
-
- Creating JBoss BPEL Server - Suppose you have installed the JBoss BPEL Runtime-RiftSaw as it was described before, now you can create a server for JBoss BP= EL runtime. - - - Open the Servers view by selecting = - Windows >= Show View > Other... > Server > Servers. - = - - - Right-click the Servers view and select = - New > Ser= ver to open the New Server Wizard: = - -
- New Server Wizard - - - - - -
= - - - Select JBoss AS 5.1 = as a server type. - - Please note, that only JBoss As 5.1 or highe= r version supports BPEL. - - - - = - Click the Next button. On the next page, you should input your JBoss As location. Then click the Next button and - you will get the page like this: = - -
- Add resource to the server - - - - - -
= - - - Select HelloWorld, then click the Add button= to add the project to the server. - Then click on the Fini= sh button. - - Start the server by right-clicking on the server= and selecting the Start item. = - = -
- The started server - - - - - -
= - If some aspects of server creation is not clear,= please, read JBoss Server Manager Reference Guide for more details. - - - You can enter the link http://localhost:8080/bpel-console/app.ht= ml to the browser to get the deployed processes. = = -
- The BPEL console - - - - - -
= - = - = - If there's anything we didn't cover or you can't figure = out, please feel free to visit our JBoss Tools Users Forum to ask questions. - There we are also waiting for your suggestions and comment= s.
-
- - - - = - - - - - JBoss Tools - BPEL - JBT - - - Reference - This chapter includes detailed reference information about all B= PEL tools wizards and editors. -
- Wizards -
- New BPEL project Wizard - This wizard helps to create new BPEL project.It is avail= able with clicking - File->New->Other->BPE= L project in the menu bar. -
- New BPEL Project Wizard - - - - - -
- It consists of only one page: - - On the page you can adjust the name of the= project and the directory where it will be created. - If "Use default" option is checked the output directory will be the workspace, - othervise the user should specify it by himself us= ing Browse button. -
- New BPEL Project Wizard - - - - - -
- - -
-
- Apache ODE Deployment Descriptor Wizard - Using this wizard user can create ODE deployment descrip= tor (deploy.xml) and place it in the temporary directory.It is available wi= th clicking - File->New->Other->Apa= che ODE Deployment Descriptor Wizard in the menu bar. -
- New BPEL Project Wizard - - - - - -
- On the page you can adjust the name of the deployment de= scriptor and - the directory where it will be created.Note,that you shoul= d use - /PROJECT_NAME/bpelContent directory as an o= utput one. - = -
-
- New BPEL Process file Wizard - Using New BPEL Process file = Wizard - user can create BPEL process file and WSDL file if it is n= ecessary. - The wizard includes several pages: - - The first page has the following options t= o set: - - New BPEL Process file Wizard. First Page Op= tions. = - - - - - = - - - Option = - Description - Default - - - - - Name - Enter the process name. - no default value - = - = - = - - Namespace - Enter the namespace url here - no default value - = - = - - Template - Select one of the provided temp= lates: = - - Asyn= chronous BPEL Process - = - generates the basis of orc= hestration logic: receive and reply activities - are included into the proc= ess;client WSDL is generated, = - service is defined in the = parentlink of the process. - The caller is notified asy= nchronously when the process completes. - - Empt= y BPEL Process - list of services participating in this BPEL pr= ocess together - with the one of messages u= sed within the process is empty.There are no any orchestration logic. - Sync= hronous BPEL Process - = - similar to Asynchronous BP= EL Process template except the fact that here - the caller is notified syn= chronously when the process completes. - - Asynchronous BPEL Process - - - Abstract Process - Specifies the created process a= s an abstract one -partially - specified processes that are not i= ntended to be executed. - unchecked - - - -
= -
- New BPEL Process file Wizard - - - - - -
- = - - = - The second page has the following options = to set: - - New BPEL Process file Wizard. Second Page O= ptions. = - - - - - = - - - Option = - Description - Default - - - - - Service Name - Enter a wsdl service name for t= he BPEL process. - The process name - = - = - - Port Name - Enter a wsdl port name for the = BPEL process. - The process name + 'Port' - = - - - Service Address - Enter an address of the wsdl se= rvice for the BPEL process. - http://localhost:8080/ + proces= s name - - - - Binding Protocol - Choose the binding protocal tha= t you use in the wsdl: SOAP or HTTP - SOAP - = - - -
= -
- New BPEL Process file Wizard - - - - - -
- = - - = - = - = - On the third page the user should select t= he BPEL project = - and folder where the process file will be created: -
- New BPEL Process file Wizard - - - - - -
- - - - Process files that are used in the BPEL project must= be under the bpelContent folder. On= ly in this case = - these files can be deployed to JBoss server. - - -
-
-
- Editors -
- Business Process Editor - Business Process Editor is intended to facilitate the pr= ocess of changing and = - adding new logic to BPEL process file.You can open .bpel = - in this editor by right click the file in the project expl= orer and selecting = - Open With...->Business Proc= ess Editor - -
- Business Process Editor - - - - - -
- The editor consists of two tabs:Design tab and Source= tab. -
- Design tab - Design tab is the main part of Business Process Editor.It= consists of 3 parts: - - Visual Pane: -
- Visual Pane of Business Process Editor</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/reference/bpel= _ref_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The Visual Pane graphically displays the order in= which the activities are executed.</para> - </listitem> - <listitem><para>Palette:</para> - <figure float=3D"0"> - <title>Palette of Business Process Editor - - - - - -
- The Palette represents different elements of the BPEL activities - organized into functional categories. - Using it the user can easily add new elements to th= e sequence activity. - To do this,he should just click the required elemen= t and then drug - and drop it to the place on the Visual Pane where i= t should be added. - - Behavior Components View: -
- Behavior Components View of Business Process = Editor - - - - - -
- Execution behavior components are grouped into th= e - Behavior Components View. - The view is also fully syncronized with Properties = view where you can customize all - the properties of the component. -
- Process Structure View of Business Process E= ditor - - - - - -
= - To add an element to some component group click p= lus( - - - - ) icon, - for its deleting you should click the element and - use its Delete option in the popup menu. = - - = - - = - = -
-
- Source tab - Source tab can be used for editing BPEL process file= directly. - The validation of file structure is also available. - -
- Validation error in Source tab - - - - - -
- If the user wants to disable/unable validation he ca= n do it by following - Window->Preferences->= ;Validation. -
- Validation configuration - - - - - -
= -
-
-
- ODE Deployment Descriptor Editor - To deploy your process in Ode you need to create a - simple deployment descriptor with basic information and - ODE Deployment Descriptor Editor= facilitates the process of descriptor configuration. - You can see how the descriptor file,opened in the editor loo= ks like on the picture below: - -
- ODE Deployment Descriptor Editor - - - - - -
= - The table below describes the configuration options of the - ODE Deployment Descriptor Editor: - - ODE Deployment Descriptor Editor.Options. = - - - - - = - - - Section = - Options - Description - - - - - = - General - = - This process is - Select one of the provided options: = - - - activated = - - - - deactivated - - - retired = - - - - = - = - Run this process in memory - for performance purposes, - you can define the process as being = - executed only in-memory. - - = - - Inbound Interfaces(Services) - Associated Port - Click Associated Port and the dropdown li= st with all available port names will appear. - Select the one you need ,other fields will b= e filled automatically. - This action configure the services - provided by the process and = - bind each service to an endpoint - - = - = - = - - Outbound Interfaces(Invokes) - Associated Port - Click Associated Port and the dropdown li= st with all available port names will appear. - Select the one you need, other fields will b= e filled automatically. - This action configure the services - invoked by the process - - - Process-level Monitoring Events - - - None - - - - All - - - - - Selected: - - - Instance life cycle<= /para> - Activity life cycle<= /para> - Data handling= - Scope handling - Correlation - = - - = - - - - Using ODE's deployment descriptor, it's a= lso = - possible to make events generation to = - filtrate which ones get created. - All option just duplicates the default beha= viour, - when nothing is specified in the deployment.= - - - Scope-level Monitoring Events - Scope - This section makes it possible to - define filtering for each scope of your proc= ess. - - - - -
-
- = -
- = - = - - - - = - - - Summary - 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 a= nd configure BPEL process and = - deployment descriptor files. = - If you have questions or suggestions concerned both the documentat= ion and tools behavior, - you are welcome to JBoss Tools Users forum. - Please, use Jira to report bugs and requests on documentation. - = -
- Other relevant resources on the topic - All JBoss Developer Studio/JBoss Tools release documentation= you can find at - http://docs.jboss.o= rg/tools in the corresponding release directory. - = - The latest documentation builds are available at http://download.jbos= s.org/jbosstools/nightly-docs. - -
- - - +[ + + + + + + +]> + + + JBoss BPEL User Guide + + + + + + + + + + + + Denny + Xu + dxu(a)redhat.com + + + Grid + Qian + fqian(a)redhat.com + + + Bob + Brodt + bbrodt(a)redhat.com + + + 2009 + 2010 + JBoss by Red Hat + + Version: 1.0.0.trunk + + + <para> + <ulink url=3D"http://download.jboss.org/jbosstools/nightly-docs= /en/bpel_ref_guide/pdf/BPEL_Reference_Guide.pdf">PDF version</ulink> + </para> + </abstract> + </bookinfo> + <toc/> +&overview;&install;&tasks;<!-- &detail; + &deploy;-->&reference;&summary;</book> \ No newline at end of file Modified: trunk/bpel/docs/reference/en-US/reference.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/bpel/docs/reference/en-US/reference.xml 2010-11-30 01:26:00 UTC (= rev 27015) +++ trunk/bpel/docs/reference/en-US/reference.xml 2010-11-30 07:22:07 UTC (= rev 27016) @@ -1,386 +1,433 @@ -<?xml version=3D"1.0" encoding=3D"UTF-8"?> -<chapter id=3D"reference"> - <?dbhtml filename=3D"reference.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>BPEL</keyword> - <keyword>JBT</keyword> - </keywordset> - </chapterinfo> - <title>Reference - This chapter includes detailed reference information about all B= PEL tools wizards and editors. -
- Wizards -
- New BPEL project Wizard - This wizard helps to create new BPEL project.It is avail= able with clicking - File->New->Other->BPEL project in the= menu bar. -
- New BPEL Project Wizard - - - - - -
- It consists of only one page: - - On the page you can adjust the name of the= project and the directory where it will be created. - If "Use default" option is = checked the output directory will be the workspace, - othervise the user should specify it by himself us= ing Browse button. -
- New BPEL Project Wizard - - - - - -
- - -
-
- Apache ODE Deployment Descriptor Wizard - Using this wizard user can create ODE deployment descrip= tor (deploy.xml) and place it in the temporary directory.It is available wi= th clicking - File->New->Other->Apache ODE Deployment Descript= or Wizard in the menu bar. -
- New BPEL Project Wizard - - - - - -
- On the page you can adjust the name of the deployment de= scriptor and - the directory where it will be created.Note,that you shoul= d use - /PROJECT_NAME/bpelContent directory as an o= utput one. - = -
-
- New BPEL Process file Wizard - Using New BPEL Process file Wizard - user can create BPEL process file and WSDL file if it is n= ecessary. - The wizard includes several pages: - - The first page has the following options t= o set: - - New BPEL Process file Wizard. First Page Op= tions. = - - - - - = - - - Option = - Description - Default - - - - - Name - Enter the process name. - no default value - = - = - = - - Namespace - Enter the namespace url here - no default value - = - = - - Template - Select one of the provided temp= lates: = - - Asyn= chronous BPEL Process - = - generates the basis of orc= hestration logic: receive and reply activities - are included into the proc= ess;client WSDL is generated, = - service is defined in the = parentlink of the process. - The caller is notified asy= nchronously when the process completes. - - Empt= y BPEL Process - list of services participating in this BPEL pr= ocess together - with the one of messages u= sed within the process is empty.There are no any orchestration logic. - Sync= hronous BPEL Process - = - similar to Asynchronous BP= EL Process template except the fact that here - the caller is notified syn= chronously when the process completes. - - Asynchronous BPEL Process - - - Abstract Process - Specifies the created process a= s an abstract one -partially - specified processes that are not i= ntended to be executed. - unchecked - - - -
= -
- New BPEL Process file Wizard - - - - - -
- = - - On the second page the user should select = the BPEL project = - and folder where the process file will be created: -
- New BPEL Process file Wizard - - - - - -
- - - - Process files that are used in the BPEL project must= be under the bpelContent folder. Only in this case = - these files can be deployed to JBoss server. - - -
-
-
- Editors -
- Business Process Editor - Business Process Editor is intended to facilitate the pr= ocess of changing and = - adding new logic to BPEL process file.You can open .bpel = - in this editor by right click the file in the project expl= orer and selecting = - Open With...->Business Process Editor - -
- Business Process Editor - - - - - -
- The editor consists of two tabs:Design tab and Source tab. -
- Design tab - Design tab is the main part of Business Process Editor.It= consists of 3 parts: - - Visual Pane: -
- Visual Pane of Business Process Editor</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/reference/bpel= _ref_6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The Visual Pane graphically displays the order in= which the activities are executed.</para> - </listitem> - <listitem><para>Palette:</para> - <figure> - <title>Palette of Business Process Editor - - - - - -
- The Palette represents diff= erent elements of the BPEL activities - organized into functional categories. - Using it the user can easily add new elements to th= e sequence activity. - To do this,he should just click the required elemen= t and then drug - and drop it to the place on the Visual Pane where i= t should be added. - - Behavior Components View: -
- Behavior Components View of Business Process = Editor - - - - - -
- Execution behavior components are grouped into th= e - Behavior Components View. - The view is also fully syncronized with Properties = view where you can customize all - the properties of the component. -
- Process Structure View of Business Process E= ditor - - - - - -
= - To add an element to some component group click p= lus( - - - - ) icon, - for its deleting you should click the element and - use its Delete option in the p= opup menu. = - - = - - = - = -
-
- Source tab - Source tab can be used for editing BPEL process file= directly. - The validation of file structure is also available. - -
- Validation error in Source tab - - - - - -
- If the user wants to disable/unable validation he ca= n do it by following - Window->Preferences->Validation.<= /para> -
- Validation configuration - - - - - -
= -
-
-
- ODE Deployment Descriptor Editor - To deploy your process in Ode you need to create a - simple deployment descriptor with basic information and - ODE Deployment Descriptor Editor facili= tates the process of descriptor configuration. - You can see how the descriptor file,opened in the editor loo= ks like on the picture below: - -
- ODE Deployment Descriptor Editor - - - - - -
= - The table below describes the configuration options of the - ODE Deployment Descriptor Editor: - - ODE Deployment Descriptor Editor.Options. = - - - - - = - - - Section = - Options - Description - - - - - = - General - = - This process is - Select one of the provided options: = - - - activated = - - - - deactivated - - - retired = - - - - = - = - Run this process in memory - for performance purposes, - you can define the process as being = - executed only in-memory. - - = - - Inbound Interfaces(Services) - Associated Port - Click Associated Port and the dropdown li= st with all available port names will appear. - Select the one you need ,other fields will b= e filled automatically. - This action configure the services - provided by the process and = - bind each service to an endpoint - - = - = - = - - Outbound Interfaces(Invokes) - Associated Port - Click Associated Port and the dropdown li= st with all available port names will appear. - Select the one you need, other fields will b= e filled automatically. - This action configure the services - invoked by the process - - - Process-level Monitoring Events - - - None - - - - All - - - - - Selected: - - - Instance life cycle<= /para> - Activity life cycle<= /para> - Data handling= - Scope handling - Correlation - = - - = - - - - Using ODE's deployment descriptor, it's a= lso = - possible to make events generation to = - filtrate which ones get created. - All option just duplicates the default beha= viour, - when nothing is specified in the deployment.= - - - Scope-level Monitoring Events - Scope - This section makes it possible to - define filtering for each scope of your proc= ess. - - - - -
-
- = -
- = - = - - + + + + + + JBoss Tools + BPEL + JBT + + + Reference + This chapter includes detailed reference information about all B= PEL tools wizards and editors. +
+ Wizards +
+ New BPEL project Wizard + This wizard helps to create new BPEL project.It is avail= able with clicking + File->New->Other->BPEL project in the= menu bar. +
+ New BPEL Project Wizard + + + + + +
+ It consists of only one page: + + On the page you can adjust the name of the= project and the directory where it will be created. + If "Use default" option is = checked the output directory will be the workspace, + othervise the user should specify it by himself us= ing Browse button. +
+ New BPEL Project Wizard + + + + + +
+ + +
+
+ Apache ODE Deployment Descriptor Wizard + Using this wizard user can create ODE deployment descrip= tor (deploy.xml) and place it in the temporary directory.It is available wi= th clicking + File->New->Other->Apache ODE Deployment Descript= or Wizard in the menu bar. +
+ New BPEL Project Wizard + + + + + +
+ On the page you can adjust the name of the deployment de= scriptor and + the directory where it will be created.Note,that you shoul= d use + /PROJECT_NAME/bpelContent directory as an o= utput one. + = +
+
+ New BPEL Process file Wizard + Using New BPEL Process file Wizard + user can create BPEL process file and WSDL file if it is n= ecessary. + The wizard includes several pages: + + The first page has the following options t= o set: + + New BPEL Process file Wizard. First Page Op= tions. = + + + + + = + + + Option = + Description + Default + + + + + Name + Enter the process name. + no default value + = + = + = + + Namespace + Enter the namespace url here + no default value + = + = + + Template + Select one of the provided temp= lates: = + + Asyn= chronous BPEL Process - = + generates the basis of orc= hestration logic: receive and reply activities + are included into the proc= ess;client WSDL is generated, = + service is defined in the = parentlink of the process. + The caller is notified asy= nchronously when the process completes. + + Empt= y BPEL Process - list of services participating in this BPEL pr= ocess together + with the one of messages u= sed within the process is empty.There are no any orchestration logic. + Sync= hronous BPEL Process - = + similar to Asynchronous BP= EL Process template except the fact that here + the caller is notified syn= chronously when the process completes. + + Asynchronous BPEL Process + + + Abstract Process + Specifies the created process a= s an abstract one -partially + specified processes that are not i= ntended to be executed. + unchecked + + + +
= +
+ New BPEL Process file Wizard + + + + + +
+ = + + The second page has the following options = to set: + + New BPEL Process file Wizard. Second Page O= ptions. = + + + + + + + Option + Description + Default + + + + + Service Name + Enter a wsdl service name for t= he BPEL process. + The process name + = = + Port Name + + The process name + 'Port' + = + + Service Address + Enter an address of the wsdl se= rvice for the BPEL process. + http://localhost:8080/ + proces= s name + + + + Binding Protocol + Choose the binding protocal tha= t you use in the wsdl: SOAP or HTTP + SOAP + = + + +
= + + New BPEL Process file Wizard + + + + + + + = + On the third page the user should select t= he BPEL project and folder where the process file will be created: +
+ New BPEL Process file Wizard + + + + + +
+ + + + Process files that are used in the BPEL project must= be under the bpelContent folder. Only in this case = + these files can be deployed to JBoss server. + + +
+
+
+ Editors +
+ Business Process Editor + Business Process Editor is intended to facilitate the pr= ocess of changing and = + adding new logic to BPEL process file.You can open .bpel = + in this editor by right click the file in the project expl= orer and selecting = + Open With...->Business Process Editor + +
+ Business Process Editor + + + + + +
+ The editor consists of two tabs:Design tab and Source tab. +
+ Design tab + Design tab is the main part of Business Process Editor.It= consists of 3 parts: + + Visual Pane: +
+ Visual Pane of Business Process Editor</titl= e> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/reference/bpel= _ref_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Visual Pane graphically displays the order in= which the activities are executed.</para> + </listitem> + <listitem><para>Palette:</para> + <figure> + <title>Palette of Business Process Editor + + + + + +
+ The Palette represents diff= erent elements of the BPEL activities + organized into functional categories. + Using it the user can easily add new elements to th= e sequence activity. + To do this,he should just click the required elemen= t and then drug + and drop it to the place on the Visual Pane where i= t should be added. + + Behavior Components View: +
+ Behavior Components View of Business Process = Editor + + + + + +
+ Execution behavior components are grouped into th= e + Behavior Components View. + The view is also fully syncronized with Properties = view where you can customize all + the properties of the component. +
+ Process Structure View of Business Process E= ditor + + + + + +
= + To add an element to some component group click p= lus( + + + + ) icon, + for its deleting you should click the element and + use its Delete option in the p= opup menu. = + + = + + = + = +
+
+ Source tab + Source tab can be used for editing BPEL process file= directly. + The validation of file structure is also available. + +
+ Validation error in Source tab + + + + + +
+ If the user wants to disable/unable validation he ca= n do it by following + Window->Preferences->Validation.<= /para> +
+ Validation configuration + + + + + +
= +
+
+
+ ODE Deployment Descriptor Editor + To deploy your process in Ode you need to create a + simple deployment descriptor with basic information and + ODE Deployment Descriptor Editor facili= tates the process of descriptor configuration. + You can see how the descriptor file,opened in the editor loo= ks like on the picture below: + +
+ ODE Deployment Descriptor Editor + + + + + +
= + The table below describes the configuration options of the + ODE Deployment Descriptor Editor: + + ODE Deployment Descriptor Editor.Options. = + + + + + = + + + Section = + Options + Description + + + + + = + General + = + This process is + Select one of the provided options: = + + + activated = + + + + deactivated + + + retired = + + + + = + = + Run this process in memory + for performance purposes, + you can define the process as being = + executed only in-memory. + + = + + Inbound Interfaces(Services) + Associated Port + Click Associated Port and the dropdown li= st with all available port names will appear. + Select the one you need ,other fields will b= e filled automatically. + This action configure the services + provided by the process and = + bind each service to an endpoint + + = + = + = + + Outbound Interfaces(Invokes) + Associated Port + Click Associated Port and the dropdown li= st with all available port names will appear. + Select the one you need, other fields will b= e filled automatically. + This action configure the services + invoked by the process + + + Process-level Monitoring Events + + + None + + + + All + + + + + Selected: + + + Instance life cycle<= /para> + Activity life cycle<= /para> + Data handling= + Scope handling + Correlation + = + + = + + + + Using ODE's deployment descriptor, it's a= lso = + possible to make events generation to = + filtrate which ones get created. + All option just duplicates the default beha= viour, + when nothing is specified in the deployment.= + + + Scope-level Monitoring Events + Scope + This section makes it possible to + define filtering for each scope of your proc= ess. + + + + +
+
+ = +
+ = + = + + Modified: trunk/bpel/docs/reference/en-US/tasks.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/bpel/docs/reference/en-US/tasks.xml 2010-11-30 01:26:00 UTC (rev = 27015) +++ trunk/bpel/docs/reference/en-US/tasks.xml 2010-11-30 07:22:07 UTC (rev = 27016) @@ -1,444 +1,488 @@ - - - Tasks -
- Creating and editing a BPEL project - In the chapter we describe the necessary steps to create a n= ew BPEL project and edit the BPEL files. - You can get the source of the example from - riftsaw/samples/quickstart/hello_world. - 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 re= sponse. - First of all, you should create a BPEL project. - = - -
- Creating a BPEL project - Create the project by selecting = - New > Project... > BPEL 2.0 > BPEL Pro= ject from the menu bar. - Then click the Next button. = - -
- New BPEL Project - - - - - -
- On this page of the New BPEL Project Wizard enter a project name in the Project Name - field,e.g enter HelloWorld. - = -
- New BPEL Project Wizard - - - - - -
- Click the Finish button. - So you have created the BPEL project named Hello= World. - Its structure is like this: -
- The BPEL Project structure - - - - - -
-
-
- Creating a BPEL process - Now you should create a BPEL process. You can create it = by selecting = - New > Others... > BPEL 2.0 > New BPEL = Process File. - -
- New BPEL Process File - - - - - -
- Click the Next button. Enter the fo= llowing information: - - = - Fields and values - = - - - - - Field - Value - = - - = - = - - BPEL Process Name - enter a process name. For example= , HelloWorld. = - = - - Namespace - enter or select a namespace for t= he BPEL process. = - = - - Template - 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 ou= r case you should - select Synchronous BPEL Process<= /property>. = - = - = - = - -
- = -
- New BPEL Process File Wizard - - - - - -
- Click the Next button. On the secon= d page make sure that the folder HelloWorld/bpelContent is selected. - Click Finish. - - - All of your files that are used in your BPEL project= must be under the bpelContent folder. Only in this ca= se = - these files can be deployed to JBoss server. - - - = - Up to now, you have got a simple BPEL process as on the = screen below. -
- A simple BPEL Process File - - - - - -
- The next step, you can do is to edit the BPEL process fi= le and then deploy it to JBoss server. -
-
- Editing a BPEL process file - If the Properties view and Palette view are not= opened, you can open the views by right-clicking the BPEL editor and selec= ting = - Show in Properties, Show Pa= lette in Palette view. Then you should have the view like this: = - -
- The BPEL editor view - - - - - -
= - In the Palette view, you can drag a BPEL element to the BPEL editor and drop it in the pl= ace you want. = - In the Properties view, you can get the information about every element of the BPEL proce= ss. - In the BPEL editor select any element you want,and then - the element's properties will be shown in the Properties v= iew.The table below describes the tabs of the Properties view: = - - - = - Tabs of the Property view - = - - - - - Tab - Description - = - - = - = - - Description - Shows the descriptive information= about the element,e.g. Name of the element. = - = - - Details - Shows the detailed and important = information about the element. - It is the most important section of an ele= ment. - Most of the properties of an element are s= et in this section. = - = - - Join Behavior - Shows the Join Failure<= /property> property of the element. = - = - - Documentation - Shows the documentation= sub-element of an element. = - = - - Other - Every BPEL element has its own se= ctions: Correlation section, Message Exchange section, and so on. We will - introduce them while using them. = - = - = - -
- In order to see how a simple BPEL process works in actio= n, you should do some steps as below: = - - - Modify two variables of the process: - - Click on the details tab of the input = variable, - select Browse.... - Then choose string primitive = from the list. -
- Edit variable in <property>process</pro= perty> file - - - - - -
= - - - Select xsd as a namespa= ce in the popup menu. - - - = - - - Add an Assign element betwe= en the receiveInput element and replyOutput<= /property> element. - - - Click the Assign element in= the BPEL editor in order to get the properties information of it in the Pr= operties view. = - - - - Set its name in the Description tab as assignHelloMesg. - In the Details section of P= roperties view, - you should click the New butt= on to add a copy sub-element to the element. = - Assign "Variable to Variable"(input:string to outp= ut). At this time, an "initializer" popup dialog appea= rs. Click on the Yes button in the dialog. - -
- Add <property>Assign</property> to the proc= ess - - - - - -
= - Then you should click New o= nce more and select Expression to Variable - (assign concat($input,' World')) to <= property>result:string. -
- Add <property>Expression assign</property> = to the process - - - - - -
= - - -
- = -
- Adding Service to WSDL file - - - = - - Open the file "HelloWorldArtifacts.wsd= l" in the "HelloWorld" project by double-cl= icking the file. Right-click the WSDL editor and select = - Add Service. A new service sh= ould appear in the editor. Name it HelloWorldProcessService. It has the Port = - named NewPort. Select it, rig= ht-click on it and rename it to HelloWorldProcessPort = in the Properties = - view. - -
- Add <property>Service</property> to the WSD= L file - - - - - -
= - - - Right-click somewhere in the whitespace of the W= SDL editor and select = - Add Binding. A new Binding co= mponent will appear in the editor. Name it HelloWorldSOAPBinding<= /property>. Select it, in the = - General tab of the Properties view and select HelloWorld as a port type in the PortType. Then click on the = - Generate Binding Content... b= utton to open the Binding Wizard. In the wizard, sele= ct SOAP = - as the Protocol. Finally, cli= ck the Finish button to close the wizard. - -
- Add a <property>Binding</property> to the W= SDL file - - - - - -
= - - - Click the HelloWorldProcessPort property in the General section of the Properties view, select HelloWorldSOAPBinding in - the Binding combobox. In the = Address field input http://localhost:8080/bpel/processes/Hell= oWorld?wsdl. - -
- Add the <property>HelloWorldSOAPBinding</pr= operty> to the <property>HelloWorldProcessPort</property> - - - - - -
= - = - You should also change some servic= e part configurations. - To do this,click part element in the WSDL editor, - then put the following data in the Properties view= . = - -
- Configuration of service part</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/detai= l_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=3D"deploy"> - <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime -
- Creating a bpel-deploy.xml file - If you want to deploy a BPEL project to JBoss BPEL Runti= me, you should create a bpel-deploy.xml file. = - JBoss tools can help you to create it: - - - - Create the bpel-deploy.xml by selecting = - New > Other... > BPEL 2.0 > Ap= ache ODE Deployment Descriptor. Click the N= ext button. = - -
- New BPEL Deploy file - - - - - -
= - - - On the next wizard page you should enter the fol= lowing information: - BPEL Project: Click the Browse... button to select the BPEL= project in your workspace which you want to deploy to the runtime. - Please note, that you should select the = bpelContent folder in your new BPEL project as a value of BPEL Project field because the bpel-deploy.xml should be cre= ated in this place. - - File name: The default value is bpel-deploy.xml. Please, don't change it. - Click on Finish button to c= lose the wizard and a new bpel-deploy.xml file will be created. -
- New BPEL Deploy file Wizard - - - - - -
= - - - Double-click the bpel-deploy.xml file to open it= in ODE Descriptor Deployment Editor. - In the Inbound Interfaces sec= tion, click the = - Associated Port column and se= lect HelloWorldProcessPort - in the dropdown box.The Related Service<= /property> and Binding Used = - columns should be automatically filled in. Save t= he bpel-deploy.xml. - -
- bpel-deploy.xml file editor - - - - - -
= - = - -
-
- Creating JBoss BPEL Server - Suppose you have installed the JBoss BPEL Runt= ime-RiftSaw as it was described before, now you can create a server for JBoss BPEL runtime. - - - Open the Servers view by se= lecting = - Windows > Show View > Other...= > Server > Servers. - = - - - Right-click the Servers view and select = - New > Server to open the New Server Wizard: = - -
- New Server Wizard - - - - - -
= - - - Select JBoss AS 5.1 as a se= rver type. - - Please note, that only JBoss As 5.1 or highe= r version supports BPEL. - - - - = - Click the Next button. On t= he next page, you should input your JBoss As= location. Then click the Next button and - you will get the page like this: = - -
- Add resource to the server - - - - - -
= - - - Select HelloWorld, then cli= ck the Add button to add the project to the server. - Then click on the Finish butt= on. - - Start the server by right-clicking on the server= and selecting the Start item. = - = -
- The started server - - - - - -
= - If some aspects of server creation is not clear,= please, read JBoss Server Manager Reference Guide for more details. - - - You can enter the link http://localhost:8080/bpel/processes.html to the browser to get the deployed processes. = -
- The BPEL console - - - - - -
= - = - = - If there's anything we didn't cover or you can't figure = out, please feel free to visit our JBoss Tools Users Forum to ask questions. - There we are also waiting for your suggestions and comment= s. = -
-
- + + + Tasks +
+ Creating and editing a BPEL project + In the chapter we describe the necessary steps to create a n= ew BPEL project and edit the BPEL files. + You can get the source of the example from + riftsaw/samples/quickstart/hello_world. + 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 re= sponse. + First of all, you should create a BPEL project. + = + +
+ Creating a BPEL project + Create the project by selecting = + New > Project... > BPEL 2.0 > BPEL Pro= ject from the menu bar. + Then click the Next button. = + +
+ New BPEL Project + + + + + +
+ On this page of the New BPEL Project Wizard enter a project name in the Project Name + field,e.g enter HelloWorld. + = +
+ New BPEL Project Wizard + + + + + +
+ Click the Finish button. + So you have created the BPEL project named Hello= World. + Its structure is like this: +
+ The BPEL Project structure + + + + + +
+
+
+ Creating a BPEL process + Now you should create a BPEL process. You can create it = by selecting = + New > Others... > BPEL 2.0 > New BPEL = Process File. + +
+ New BPEL Process File + + + + + +
+ Click the Next button. Enter the fo= llowing information: + + = + Fields and values + = + + + + + Field + Value + = + + = + = + + BPEL Process Name + enter a process name. For example= , HelloWorld. = + = + + Namespace + enter or select a namespace for t= he BPEL process. = + = + + Template + 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 ou= r case you should + select Synchronous BPEL Process<= /property>. = + = + = + = + +
+ = +
+ New BPEL Process File Wizard + + + + + +
+ Click the Next button. On the second page, you can custom your wsdl service detai= ls. Enter the following information: + + = + Fields and values + = + <= /colspec> + + + + Field + Value + = + + = + = + + Service Name + a wsdl service name for the BPEL = process. The default is, HelloWorld.= = + = + + Port Name + a wsdl port name for the BPEL pro= cess. The default is, HelloWorldPort= . = + = + + Service Address + an address of the wsdl service fo= r the BPEL process. The default is, http://loca= lhost:8080/HelloWorld. = + = + + Binding Protocol + the binding protocal that you use= in the wsdl. You can choose SOAP or HTTP. The default is, SOAP. = + = + = + +
+ = +
+ Create WSDL file for the BPEL Process wizardpage</t= itle> + <mediaobject > + <imageobject> + <imagedata fileref=3D"images/detail_createprocess_= 2a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + = + <para>Click the <property moreinfo=3D"none">Next</property> bu= tton. On the third page, you can choose a folder for the process file from = the projects in your workspace. If not choose, The default folder <property= moreinfo=3D"none">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 of a BPEL projec= t. 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 + + + + + +
+ The next step, you can do is to edit the BPEL process fi= le and then deploy it to JBoss server. +
+
+ Editing a BPEL process file + If the Properties view and Palette view are not= opened, you can open the views by right-clicking the BPEL editor and selec= ting = + Show in Properties, Show Pa= lette in Palette view. Then you should have the view like this: = + +
+ The BPEL editor view + + + + + +
= + In the Palette view, you can drag a BPEL element to the BPEL editor and drop it in the pl= ace you want. = + In the Properties view, you can get the information about every element of the BPEL proce= ss. + In the BPEL editor select any element you want,and then + the element's properties will be shown in the Properties v= iew.The table below describes the tabs of the Properties view: = + + + = + Tabs of the Property view + = + + + + + Tab + Description + = + + = + = + + Description + Shows the descriptive information= about the element,e.g. Name of the element. = + = + + Details + Shows the detailed and important = information about the element. + It is the most important section of an ele= ment. + Most of the properties of an element are s= et in this section. = + = + + Join Behavior + Shows the Join Failure<= /property> property of the element. = + = + + Documentation + Shows the documentation= sub-element of an element. = + = + + Other + Every BPEL element has its own se= ctions: Correlation section, Message Exchange section, and so on. We will + introduce them while using them. = + = + = + +
+ In order to see how a simple BPEL process works in actio= n, you should do some steps as below: = + + + Modify two variables of the process: + + Click on the details tab of the input = variable, + select Browse.... + Then choose string primitive = from the list. +
+ Edit variable in <property>process</pro= perty> file + + + + + +
= + + + Select xsd as a namespa= ce in the popup menu. + + + = + + + Add an Assign element betwe= en the receiveInput element and replyOutput<= /property> element. + + + Click the Assign element in= the BPEL editor in order to get the properties information of it in the Pr= operties view. = + + + + Set its name in the Description tab as assignHelloMesg. + In the Details section of P= roperties view, + you should click the New butt= on to add a copy sub-element to the element. = + Assign "Variable to Variable"(input:string to outp= ut). At this time, an "initializer" popup dialog appea= rs. Click on the Yes button in the dialog. + +
+ Add <property>Assign</property> to the proc= ess + + + + + +
= + Then you should click New o= nce more and select Expression to Variable + (assign concat($input,' World')) to <= property>result:string. +
+ Add <property>Expression assign</property> = to the process + + + + + +
= + + +
+ = +
+ Adding Service to WSDL file + + The HelloWorldArtifacts.wsdl has been added a service= when you create a BPEL process file. You have a default service in this WS= DL file. But if you want to add a service by yourself, you can follow the s= teps as below: + + = + + Open the file "HelloWorldArtifacts.wsd= l" in the "HelloWorld" project by double-cl= icking the file. Right-click the WSDL editor and select = + Add Service. A new service sh= ould appear in the editor. Name it HelloWorldProcessService. It has the Port = + named NewPort. Select it, rig= ht-click on it and rename it to HelloWorldProcessPort = in the Properties = + view. + +
+ Add <property>Service</property> to the WSD= L file + + + + + +
= + + + Right-click somewhere in the whitespace of the W= SDL editor and select = + Add Binding. A new Binding co= mponent will appear in the editor. Name it HelloWorldSOAPBinding<= /property>. Select it, in the = + General tab of the Properties view and select HelloWorld as a port type in the PortType. Then click on the = + Generate Binding Content... b= utton to open the Binding Wizard. In the wizard, sele= ct SOAP = + as the Protocol. Finally, cli= ck the Finish button to close the wizard. + +
+ Add a <property>Binding</property> to the W= SDL file + + + + + +
= + + + Click the HelloWorldProcessPort property in the General section of the Properties view, select HelloWorldSOAPBinding in + the Binding combobox. In the = Address field input http://localhost:8080/bpel/processes/Hell= oWorld?wsdl. + +
+ Add the <property>HelloWorldSOAPBinding</pr= operty> to the <property>HelloWorldProcessPort</property> + + + + + +
= + = + You should also change some servic= e part configurations. + To do this,click part element in the WSDL editor, + then put the following data in the Properties view= . = + +
+ Configuration of service part</titl= e> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/detai= l_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=3D"deploy"> + <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime +
+ Creating a deploy.xml file + If you want to deploy a BPEL project to JBoss BPEL Runti= me, you should create a bpel-deploy.xml file. = + JBoss tools can help you to create it: + + + + Create the deploy.xml by selecting = + New > Other... > BPEL 2.0 > Ap= ache ODE Deployment Descriptor. Click the N= ext button. = + +
+ New BPEL Deploy file + + + + + +
= + + + On the next wizard page you should enter the fol= lowing information: + BPEL Project: Click the Browse... button to select the BPEL= project in your workspace which you want to deploy to the runtime. + Please note, that you should select the = bpelContent folder in your new BPEL project as a value of BPEL Project field because the deploy.xml should be created = in this place. + + File name: The default value is deploy.xml. Please, don't change it. + Click on Finish button to c= lose the wizard and a new deploy.xml file will be created. +
+ New BPEL Deploy file Wizard + + + + + +
= + + + Double-click the deploy.xml file to open it in O= DE Descriptor Deployment Editor. + In the Inbound Interfaces sec= tion, click the = + Associated Port column and se= lect HelloWorldProcessPort + in the dropdown box.The Related Service<= /property> and Binding Used = + columns should be automatically filled in. Save t= he deploy.xml. + +
+ deploy.xml file editor + + + + + +
= + = + +
+
+ Creating JBoss BPEL Server + Suppose you have installed the JBoss BPEL Runt= ime-RiftSaw as it was described before, now you can create a server for JBoss BPEL runtime. + + + Open the Servers view by se= lecting = + Windows > Show View > Other...= > Server > Servers. + = + + + Right-click the Servers view and select = + New > Server to open the New Server Wizard: = + +
+ New Server Wizard + + + + + +
= + + + Select JBoss AS 5.1 as a se= rver type. + + Please note, that only JBoss As 5.1 or highe= r version supports BPEL. + + + + = + Click the Next button. On t= he next page, you should input your JBoss As= location. Then click the Next button and + you will get the page like this: = + +
+ Add resource to the server + + + + + +
= + + + Select HelloWorld, then cli= ck the Add button to add the project to the server. + Then click on the Finish butt= on. + + Start the server by right-clicking on the server= and selecting the Start item. = + = +
+ The started server + + + + + +
= + If some aspects of server creation is not clear,= please, read JBoss Server Manager Reference Guide for more details. + + + You can enter the link http://localhost:8080/bpel-console/app.ht= ml to the browser to get the deployed processes. = = +
+ The BPEL console + + + + + +
= + = + = + If there's anything we didn't cover or you can't figure = out, please feel free to visit our JBoss Tools Users Forum to ask questions. + There we are also waiting for your suggestions and comment= s. = +
+
+ --===============3090626066017557110==--