This documentation is for WSO2 Enterprise Integrator version 6.2.0 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.

All docs This doc
Skip to end of metadata
Go to start of metadata

The Business Process Management Initiative (BPMI) has developed a standard Business Process Modeling Notation (BPMN). The BPMN 2.0 specification was released to the public in January, 2011. BPMN has been integrated to EI Business Process by using the Activiti engine 5.19.0, which is a light-weight workflow and the Business Process Management (BPM) platform, targeted at business people, developers and system admins. It is open-source and distributed under the Apache license. The Activiti engine runs in any Java application, on a server, on a cluster or in the cloud. It is extremely lightweight and based on simple concepts.

Uploading BPMN artifacts

  1. Download and run EI Business Process. For instructions see the Installation Guide.
  2. Go to https://localhost:9445/carbon/ and login with credentials (default username: admin and password: admin).
  3. As highlighted in the diagram below in red, you can upload BPMN artifacts (.bar extension) by navigating through Main → Add BPMN


    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 the new version will be deployed. Since only package-level versioning is available, the new package should include all the processes defined in the old package, although you may only need to update a single process in that package. 

  4. Once you uploaded the artifact successfully you can navigate to the BPMN deployed  Processes list and view the deployed processes.

  5. When you click on the package name you will be directed to a page to undeploy the package if necessary.

  6. When you click on the Process ID you will be directed to Process Information page which contains the process details, process diagram and process definition.

  7. In-order to view the BPMN process instances created, navigate to BPMN instances from the left side navigation panel as shown in the caption below.

  8. You will be able to suspend/activate or delete instances in the Manage section.
  9. In-order to access the BPMN rest service, you can use the following url pattern: https://localhost:9445/bpmn/{serviceName} with respective authentication (default username: admin and password: admin) headers.

Now that you understand how to upload BPMN artifacts and how to view, activate, suspend and delete BPMN process instances, next you can take a look at Managing BPMN Artifacts for information on how you can use the BPMN Explorer to interact with deployed BPMN applications.

Creating a BPMN artifact project

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


 To create a BPMN artifact you should have Eclipse setup with the WSO2 EI tooling pack. For more information, see Installing Enterprise Integrator Tooling.

  1. Start Eclipse and navigate to File>New>Other
  2. Search or scroll and find the BPMN category under the WSO2 folder and click on BPMN Project
  3. Enter a project name and click Next.
  4. In the next window that appears, select any referenced projects and click Finish. You will now have a new BPMN project.

    This method only creates a BPMN project. After creating the project, you should add a BPMN diagram to it. For more information on how to add a BPMN diagram, see creating artifact files.

    Creating artifact files

    Creating a BPMN diagram

    To create a BPMN diagram, you have to create a BPMN project first. See Creating a BPMN artifact project for more information on creating a BPMN project.

    After creating a BPMN project, follow these steps to add a BPMN diagram to that project.

    1. Right-click on your BPMN project found on the left pane of your Eclipse window and select New>Other
    2. Search or scroll and find the BPMN category under the WSO2 folder and click on BPMN Diagram. Click Next.
    3. Enter or select the BPMN project you want to add the diagram to and enter a file name for your diagram. Click Next.
    4. Select a template diagram or create a new empty diagram and click Finish
    5. You will see that the BPMN diagram has been added under the project you specified and a new empty diagram will open up along with a palette. You can use the palette to create the desired diagram.  
  • No labels