Deploy, Undeploy and Manage a BPEL Process

Deploying a BPEL process

Follow the instructions below to deploy a business process.

1. Log in to the product's management console, click Main, and select Add -> BPEL-> under the Processes menu.
   

2. In the New BPEL Package window, browse and select the BPEL Package ZIP file and click Upload.

   You can find sample BPEL package ZIP files in the <EI/HOME>/samples/business-process/bpel directory. Also, instead of using the Management Console, you can deploy a BPEL process manually by creating the <EI_HOME>/repository/deployment/server/bpel directory, and copying the ZIP file to it. For instructions on preparing the process ZIP file, see Preparing for Process Deployment.

    
   If the deployment is successful, a dialog box appears as follows.
   
   You view the deployed BPEL process listed under the Deployed Processes as shown below.
   

   • 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: A unique ID to identify the deployed BPEL process.
   • 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.
3. Click the Process ID to access its information dashboard. For example,
   
   It typically contains the following sections:
   

Process Details

You view the following information about the process under Process Details:

• Process ID: A unique ID to identify the deployed BPEL process.
• 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.
  
• Package Name:  The name of the package containing at least the deployment descriptor and one or more process definitions (BPEL), WSDL and XSDs.
• Deployment Information: You view the following information about the deployment in the Deployment Descriptor.
  
  

Instance Summary

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

WSDL Details

Partner Links

Partner links are created for other partner processes that are called by the BPEL process you deploy. For more information on partner links, see BPEL 2.0 Specification.

TryIt

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, see Try It .

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,

Undeploying a BPEL process

There are two ways to undeploy a BPEL package.

1. From the Management Console user interface:
   
   1. Log in to the product's management console, click Main, and select List -> BPEL-> under the Processes menu.
   2. Click the Package Name you want to undeploy.
      
   3. 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 <EI_HOME>/wso2/business-process/repository/deployment/server/bpel directory.

For more information on BPEL, see HelloWorld Sample.

Creating a BPEL artifact project

You will find a BPEL editor packaged along with the WSO2 EI tooling. This BPEL editor can be used to create a BPEL artifact easily.

1. Start Eclipse and navigate to File>New>Other. 
2. Search or scroll and find the BPEL category under the WSO2 folder and click on BPEL Workflow. 
   
3. Select Create new BPEL Workflow on the dialog box that appears and click Next. 
   
4. Enter a project name, process name, process namespace and specify the template (asynchronous process or synchronous process). Click Next. 
   
5. Provide the maven information for the package and click Finish. You will now have a BPEL project according to the details you specified.