BPEL Guide
The BPEL Quick Start guide explains how to set up and start the WSO2 BPS, model a BPEL process, deploy and test it using the WSO2 BPS management console. The guide has the following sections.
Setting up and starting BPS
WSO2 BPS setup is very simple. While more details of the installation can be found in the Installation Guide, this guide provides a basic summary to get you started fast.
- Ensure that the following are installed in your environment.
- JDK 7 or 8.
- JAVA_HOME environment variable is set to
<JDK_HOME>
. For example,JAVA_HOME=c:\Program Files\java\jdk1.7.0_71
.
- Download the BPS binary distribution from http://wso2.com/products/business-process-server/.
- Extract the zip file to a folder which will be referred to as
<PRODUCT_HOME>
throughout the rest of this guide. - Open a command prompt (or a shell in Linux) and go to the
<PRODUCT_HOME>\bin
directory. - Start the BPS server by executing wso2server.sh (or wso2server.bat in Windows).
- The operation log keeps running until the server starts, which usually takes several seconds. Wait until the server fully boots up and displays a message similar to "WSO2 Carbon started in n seconds."
Modelling a BPEL process
- Download and setup the WSO2 Business Process Server tooling plug-in with Eclipse.
- Open Eclipse and select File > New > Other.
- From the window that appears, select Composite Application Project and click Next.
- Provide a suitable name for the project. For the purpose of this example, name it as "WS_NumberAdderCarbon". Click Finish once done.
The composite application project is created and you can see it on Project Explorer pane on the left of your Developer Studio screen. - Right-click on the project which is on the Project Explorer pane and choose New > BPEL WorkFlow. If it does not appear there, click Other and search for BPEL WorkFlow on the search bar.
- On the Create New BPEL WorkFlow wizard, select Create New BPEL workflow and click Next to continue.
- Provide suitable names, a namespace and select the matching template for your BPEL process and project. More information on the different templates can be found here.
For this example, the following values can be used:- Project Name : BPELNumberAdder
- Process Name : AdderProcess
- Namespace : http://NumberAdder.com
- Template : Synchronous BPEL Process
Click Finish to close the wizard.The Project Explorer window and the AdderProcess.bpel file will look like the following.
This point onwards you have to design your BPEL process by adding business logic to the BPEL process. In this guide we will be designing a simple process to add two integers.
- Open
AdderProcessArtifacts.wsdl
file in BPELNumberAdder Project and click on the blue arrow next to Adder Process Request. It will open another tab calledInlineSchemaofAdderProcessArtifacts.wsdl.
- Rename the default variable named as "input" as x and change the type from "string" to int.
- Add another element by right-clicking on AdderProcessRequestType>Add an element. Name it y and set the type as int. Now it should look like the follwing image.
Now lets design the simple business logic. Open the
AdderProcess.bpel
file. You need to add business logic in the place of where FIX_ME-Add_Business_Logic_HereTo delete, right-click on the element and choose delete.
Add an Assign activity in between
receiveInput
andcallbackClient
activities. To add Assign activity drag it from the Action section of the Action Palette.Another way to add activity element to the editor is right-click on element and use add-before option.
- Click on the Assign element and then click on Details tab in the Properties window.
- Click on New which will lead you to the following view in the Properties window.
- We will use an Xpath expression to compute the addition of two variables and assign the result to the output variable. To do that select Expression from the From drop down list and select Variable from the To drop down list.
Include the following expression in the box below "Edit the associated Xpath Expression".
$input.payload/tns:x + $input.payload/tns:y
- While you configure the variables, the a message will appear asking to initialize the variables. Click Yes. It will automatically generate an XML string for variable initialization. The Properties window of Assign activity should look like the following once you have completed the steps.
- Now you need to define inbound and out bound interfaces. Open the
deploy.xml
file which is in the BPEL project. Choose AdderProcessPort as the Inbound Address Port from the given list. The rest of the parameters will be automatically filled in once you select it. You do not need to specify ports outbound interfaces as we do not have external invocations in this particular business process. - Include the BPEL process as a dependency of the Composite Application (WS_NumberAdderCarbon). To include it, open
pom.xml
of Composite application project and select the BPELNumberAdder checkbox as a dependency.
Deploying and testing the BPEL process
After modelling the BPEL process, it can be deployed in the WSO2 BPS.
- In Developer Studio, right-click on the Servers window and select New>Server. If it is not visible, select Window>Show View>Servers.
- The New Server window appears. From the list, expand the WSO2 folder and select WSO2 Carbon 4.4 based server as shown below. Carbon 4.4 based server is selected here since BPS 3.5.0 is based on Carbon 4.0.2. If needed, specify the Server name here. In this example, we specify it as WSO2 BPS. Click Next.
- Set the CARBON_HOME by clicking the Browse button and selecting
WSO2 Business Process Server_Home
directory. Click Finish once done or Next if more settings of the server need to be configured such as the 'service port', 'web console port' etc. - Once done, WSO2 BPS is added to Servers List as shown below.
- The next step is to deploy the composite application in WSO2 BPS. Go to WSO2 BPS Server>Add and Remove and select the WS_NumberAdderCarbon project. The server will be automatically started.
- If the server does not get started automatically, right-click on the server and select Start. In the console window, note the server process's log.
- The WSO2 BPS login page will open automatically in the default web browser. Login using admin as username and admin as password.
Select Processes >BPEL>List from the Main menu. The Deployed Processes window opens with the AdderProcess deployed.
The "Process ID" is generated in the format
{"Process NameSpace"} ProcessName-VersionNo
.Click the Process ID.
- The Process Information window appears with the details of the process. Click on the Try It link.
- A browser window opens to enter the required input parameters. Enter the values and press Send to calculate the result.
Alternatively, you can use the SOAP UI tool to test a business process. The SOAP UI application shows the request/response soap messages and is particularly helpful in error handling.