This documentation is for WSO2 Business Process Server version 3.5.0. View documentation for the latest release.
Skip to end of metadata
Go to start of metadata

Business process deployment capability is provided by the following feature in the WSO2 feature repository:

Name : WSO2 Carbon - BPEL Application Deployer Feature
Identifier :

If process management capability is not included in your product by default, you can add it by installing the above feature using the instructions given in section, Feature Management. Follow the instructions below to deploy a business process.

  1. Log on to the product's management console and select "Processes -> Add" under the "Main" menu.
  2. The "New BPEL Package" window opens. Provide the file and click "Upload."
  3. If the deployment is successful, a dialog box  appears as follows.
  4. The "Deployed Processes" page opens with the newly-added process listed. For example,
    • Package Name:   The name of the package containing at least the deployment descriptor and one or more process definitions (BPEL), WSDL and XSDs.
    • Process ID:
    • Version: If a package with an existing name is uploaded, the processes in the package will be versioned. All old processes in the package will be retired and new version deployed. Since there is only package-level versioning available, the new package should include all the processes defined in the old package, even though you may only need to update a single process in that package.
    • Status: Status of the process. Can be either "Active" or "Retired".
    • Deployed Date: Date and time of the package deployment.
    • Manage: A newly-created process has status as "Active", which can be retired by clicking on the "Retire" link. Once a process is retired, a new instance of it cannot be created.
  5. Click the "Process ID" to access its information dashboard. For example,

    It typically contains the following sections:

Process Details

Instance Summary

When a process is triggered by a user through the TryIt tool for example, an instance of that process is created in the BPS. Each process can have numerous instances. They are summarized graphically with statuses in summary as follows:

For more information on process instances, refer to section Process Instances.

Quality of Service Configuration

For instructions on configuring QoS, refer to:

WSDL Details

<To be added>


The "Try this service" link directs you to a new window where the operations available the BPEL service is displayed. Using this window, you can check whether the service provides the desired output. The URL for invoking the TryIt tool can also be appended by concatenating the endpoint URL of your service with the following string: 

  • ?tryit : Ajax client for simple, generic interactions with the service.    

The TryIt link will be enabled in your service dashboard only if "org.wso2.carbon.tryit" feature of the WSO2 feature repository is installed in your Carbon instance. For instructions on triggering the TryIt tool, refer to Testing WSDLs .

WSDL 1.1 and WSDL 2.0

Click on the links to the WSDL 1.1 and the WSDL 2.0 to open the page with XML configuration. The URLs for the WSDL files of the service can also be appended by concatenating the endpoint URL of the service with the following strings:

  • ?wsdl2 : WSDL 2.0 description of the service
  • ?wsdl : WSDL 1.1 description of the service

The WSDLs describe the operations the service exposes, the structure of the XML that is sent and received by each operation, and how to communicate with the service to retrieve the XML content. By default, six different types of endpoints are deployed. Each of these endpoint types are represented by the WSDL 2.0 <endpoint> elements of the service, and by the <binding> elements which these endpoints refer to. The default six types of endpoints are as follows:

  • SOAP 1.2 over HTTP
  • SOAP 1.1 over HTTP
  • Plain old XML/REST over HTTP
  • SOAP 1.2 over HTTPS
  • SOAP 1.1 over HTTPS
  • Plain old XML/REST over HTTPS

Process Definition

BPEL code for the process. For example,

Process Visualization 

Graphical workflow of the process. For example,

  1. Once the process is deployed in the BPS, it will be exposed as a BPEL service. Click "Services -> List" menu under the "Main" menu.
  2. The "Deployed Services" window opens with the newly-deployed service listed. For example,

From here, the BPEL service can be managed just like any other Web service. For instructions, refer to section Managing Services .


Instead of using the management console, you can deploy a BPEL process manually by copying the zipped file to the $PRODUCT_HOME/repository/deployment/server/bpel directory. For instructions on preparing the process zip file, refer to section Preparing for Process Deployment .

Undeploy a BPEL process

There are two ways to undeploy a BPEL package.

  1. From the Management Console user interface. 
    1. Login to the Business Process Server.
    2. In the Main menu of the Management Console, click List under Processes in the Manage section.
    3. In the Process List page, select a package to undeploy.
    4. The Package Dashboard page appears. Click on the Undeploy link.
  2. By deleting the BPEL ZIP file from the file system. 
    1. Delete the BPEL package from BPS_HOME/repository/deployment/server/bpel directory.
  • No labels