BPMN SOAP tasks allow you to invoke SOAP endpoints within your BPMN processes. You can achieve this by adding a SOAP Task and handling the SOAP invocation part in a process implementation. This tutorial simulates the scenario of invoking the echo SOAP service, which is shipped with WSO2 EI by default.
Before you begin,
- Install Oracle Java SE Development Kit (JDK) version 1.8.* and set the
- Download the product installer from here, and run the installer.
Let's call the installation location of your product the <EI_HOME> directory. This is located in a place specific to your OS as shown below:
OS Home directory Mac OS
Select and download the relevant Enterprise Integrator tooling ZIP file depending on your operating system from here, and then extract the ZIP file. The path to this folder will be referred to as
<EI_TOOLING>throughout this tutorial.
Creating the BPMN artifacts
Follow the steps below to create the BPMN artifacts including the SOAP Task.
- Create a new BPMN project named SoapTaskBPMN. For instructions, see Creating a BPMN Project.
- Create a BPMN Diagram named SoapTask.bpmn. For instructions, see Creating the BPMN Diagram.
- Click anywhere on the canvas, go to the Properties tab, and fill in the following details:
SOAP Task Process
To implement the order approval process, drag and drop a Start Event element, a SOAP Task element, a User Task element and an End Event element to the canvas.
You view the Create connection option when you hover the mouse pointer on an artifact. Click on the arrow, drag it and drop it on the artifact to which you want to connect it.
Configuring the SOAP Task
- Select the Properties tab of the REST Task, click General and enter the Name as Echo Request.
In the Properties tab of the SOAP Task, click Main config and update the following:
Soap version soap11 Output Variable name response Soap action
urn:echoIntMore information on the properties of the SOAP Task
After adding the SOAP Task to your BPMN Diagram, you can configure the below Properties appropriately, as explained below.
Field Name String Value Required/Optional Service URL URL of the target endpoint
You can give this instead of the Service Reference (EPR).
Service Reference (EPR)
Registry resource path of the endpoint reference.
You can give this instead of the Service URL.
Input Payload Request payload Optional SOAP Headers SOAP header block, which is attached to the SOAP header when creating the SOAP request Optional SOAP version Soap version to be used when creating the SOAP request (i.e., SOAP11 or SOAP12) Required HTTP Connection Control options for the current connection. ('keep-alive' is the the default value.) Optional HTTP Transfer Encoding The form of encoding, which is used to safely transfer the entity to the user Optional Output Variable name Name of the variable to save the response Required Transport headers
Header values in the format
Configuring the User Task
- Select the Properties tab of the User Task, click General and enter the Name as Echo Response.
- Click Properties, click Main config and give
adminas the Assignee.
In the Properties tab click Form, click New and add the following.
Id Name Type Variable Readable Writable Required response Echo Response string response True False True
You view the field added to the Form of the User Task as shown below.
Press Ctrl+S to save all your artifacts.
Deploying the artifacts
- For instructions on creating the deployable artifacts, see Creating the deployable archive.
- For instructions on deploying them, see Deploying BPMN artifacts.
Testing the output
If you have not started the business profile previously, you need to start it.
- Log in to the BPMN-explorer at https://localhost:9445/bpmn-explorer using
adminfor both the username and password.
- Click PROCESSES in the top menu, and click the Start option of the REST Task Process.
This creates a Claimable Task.
- Click TASKS in the top menu, and then click Claimable Tasks.
Click on the new Claimable Task.
You view the response of the Echo Service.
- Click Complete Task, to approve the appointment.
- Click TASKS → COMPLETED TASKS to view the completed task.