The following scenario simulates a simple leave approval business process, in which an employee fills a form and submits the leave request to the manager and the manager approves or rejects it.
Before you begin,
- Install Oracle Java SE Development Kit (JDK) version 1.8.* and set the JAVA_HOME environment variable.
- 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.
Let's get started! This tutorial includes the following sections:
If you did not try the Configuring the Start Event to Submit Data tutorial yet, follow the steps below to import its artifacts as you will be extending on that.
- Download the pre-packaged project and extract it to a preferred location. This contains the artifacts of the Configuring the Start Event to Submit Data tutorial.
- Open the WSO2 EI Tooling environment.
- Click File, and click Import.
- Expand the WSO2 category, select Existing WSO2 Projects into workspace and click Next.
- Click Browse, select the file you extracted and upload it.
- In the Package Explorer, double click on the name of the BPMN diagram to view the BPMN artifacts you imported.
Creating new artifacts
The next step of the process is where the respective manager checks the leave application form and approves/rejects it. For this part of the process, add a User Task as it will be a task performed by a user.
- Right click on the connection arrow, which connects the Start Event and the End Event and click Delete.
- Drag and drop a User Task to the diagram.
- Hover your mouse pointer over the Start Event, and click on the arrow icon (i.e., the Create Connection option) and connect the Start Event to the User Task.
- Hover your mouse pointer over the User Task, and click on the arrow icon (i.e., the Create Connection option) and connect the User Task to the End Event.
- Click on the User Task, and change the value of the Name field to
Review leave requestin the General section of the Properties tab.
Click on the User Task, click New in the Form section of the Properties tab and add the following field.
id Name Type Readable Writable Required Form Values vacationApproved Do you approve this vacation request?
For fields of type “enum” you can add form values that act as different options. You can provide two options as Approve and Reject for this field.
true true true
Name: Approve Id: false Name: Reject
To add an assignee to the User Task, enter the value as
managerfor the Assignee field in the Main Config section of the Properties tab (of the User Task).
This assumes that a single person (e.g., HR Manager) is responsible for approving or rejecting leave. If you want to allow a group of people (e.g., anyone in the HR Department) to approve/reject leave, you can enter the group role name (e.g.,
hrDepartment) as the value of the Candidate group field in the Main Config section of the Properties tab (of the User Task).
Press Ctrl+S to save all the artifacts, which you created in WSO2 EI Tooling.
The model is now complete as the necessary logic has been applied.
Deploying the artifacts
- For instructions on creating the deployable artifacts, see Creating the deployable archive.
- For instructions on deploying them, see Deploying BPMN artifacts.
Creating the user
- Log in to the Management Console of the Business Process profile.
- Click Configure → Users and Roles → Add → Add New User.
Enter the below details to create a user called
managerand click Next.
Enter both the User Name and the Password as
In the next screen, assign the user to the
adminrole and click Finish.
You view the new user you created as shown below.
Testing the output
Follow the steps below to test the output.
Start the Business Process profile of WSO2 EI.
- 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 Leave Approval Process.
Initiate the process by filling the form and click Start.
You view the following message.
- Log out and log in again using
Click TASKS and then click MY TASKS. You view the Claimable Task, which was created by the process you started.
Click on the Task, select Approve from the drop down list and click Complete Task.
You view the Task being removed from the MY TASKS list.
Click TASKS in the top menu, and then click COMPLETED TASKS. You view the Task you just completed being added to the COMPLETED TASKS list.
Similarly, you can repeat the steps from step 5 onwards to reject a leave request accordingly.