Managing a business process

Let's get started!

Creating the appointment cancellation process using BPMN

1. In WSO2 EI Tooling, open the Developer Studio dashboard by clicking the Developer Studio menu and choosing Open Dashboard, and select BPMN Project .
   
2. Create a new project named AppointmentCancellation.
   
3. Click Finish and click Yes in the Create an Activiti Project window.
   
4. In Developer Studio Dashboard, select BPMN Diagram. 
5. Select theAppointmentCancellation/src/main/resources/diagrams directory as the parent folder, and enter AppointmentCancellation.bpmn for the File name.
   
6. Click Next, select the option to create an empty diagram as shown below, and click Finish.
   
7. Let's start drawing the BPMN process diagram for the appointment cancellation process. The AppointmentCancellation canvas. The Palette on the right side of the AppointmentCancellation canvas contains all the activity symbols that will be used for drawing the process as shown below.
   
   Let's get started. You can easily drag and drop the activities from the Palette the canvas, and then update the properties and configurations of each activity as explained below.
   1. Add a StartEvent from the Start Event pallete.
      

   2. Select the Properties tab, click Form, click New, update the following and click OK.

      Id	patientName
      Name	Name of the Patient
      Type	string
      Required	True

      

   3. Repeat clicking New and adding the following to add the other form properties one by one.

      Id	Name	Type	Required
      appointmentNo	Appointment Number	long	True
      doctor	Name of the Doctor	string	True
      reason	Reason for cancellation	string	True
      email	Email Address	string	True

      

   4. Add a REST Task from the WSO2 Tasks pallete.
      
      Select the Properties tab, click General and give the Name as Get Appointment, then click Main config and update the following:


      Service URL	http://localhost:9090/healthcare/appointments/validity/${appointmentNo}
      HTTP method	Get
      Output Variable Mappings	noOfDays:$.status

      
      

   5. Add an Exclusive Gateway from the Gateway pallete.
      
   6. Add a User Task from the Task pallete and name it Appointment Control Task.
      
   7. Click Properties, click Main config  and give admin as the Assignee.
       
      

   8. In the Properties tab click Form, click New and update the following.
      
      

      To add the two Form values, click New and give the Id and Name and click OK as shown in the example below.

      

   9. Repeat clicking New and adding the following to add the other form proeprties one by one.

      Id	Name	Type	Variable	Readable	Writable	Required
      AppNo	Appointment Number	long	appointmentNo	True	False	True
      cancellationReason	Reason For The Cancellation	string	reason	True	False	True
      doctorName	Name of the Doctor	string	doctor	True	False	True

      

   10. Add another Exclusive Gateway from the  Gateway  pallete.
       
   11. Add a REST Task from the  WSO2 Tasks  pallete.
       
       

       Select the Properties tab and click Main config and update the following:


       Service URL	http://localhost:9090/healthcare/appointments/validity/${appointmentNo}
       HTTP method	DELETE
       Output Variable name	status

       

   12. Add a MailTask from the Task pallete below the second Parallel Gateway and name it Reject cancellation Task.
       
       Select the Properties tab and click Main config and update the following:

       To	${email}
       From	wso2eidemo@gmail.com
       Subject	Appointment cancellation rejected
       Html	Appointment cancellation request with Appointment Number ${appointmentNo} has been rejected. Thank you. Administration Department

       
       

   13. Add another MailTask above the second Parallel Gateway and name it Approve Cancellation Task.
       

       To	${email}
       From	wso2eidemo@gmail.com
       Subject	Appointment cancellation successful
       Html	Appointment cancellation request with Appointment Number ${appointmentNo} has been approved. Thank you. Administration Department

       
       

   14. Link each activity by hovering over the element, selecting the arrow sign and dragging it to the connecting element as shown below.
       
8. Click on the arrow leading from the first Exclusive Gateway to the Approve Cancellation Task, and in the Main config section of the Properties tab add the ${noOfDays >2} condition.
   
9. Click on the arrow leading from the first Exclusive Gateway to the Reject Cancellation Task, and in the Main config section of the Properties tab add the ${noOfDays<2} condition.
   
10. Click on the arrow leading from the second Exclusive Gateway to the Rest Task, and in the Main config section of the Properties tab add the  ${approveCancellation == 'approve'}  condition.
    
11. Click on the arrow leading from the second Exclusive Gateway to the Reject Cancellation Task, and in the Main config section of the Properties tab add the  ${approveCancellation == 'reject'}  condition.
    
12. Click Window -> Show View → Other in the top menu of Tooling.
    
13. Type Package Explorer in the search bar, select it and click OK.
    
14. In the Package Explorer, right-click the AppointmentCancellation project and select Create deployment artifacts. 
    
    This will create a AppointmentCancellation.bar file in the deployment folder:
    

Deploying the BPMN process in the Business Process profile

You can now deploy the .bar file of the BPMN process using the management console of the business process profile in WSO2 EI.

1. Open a terminal and navigate to the <EI_HOME>/wso2/business-process/bin  directory.
2. Start the Business Process profile in WSO2 EI by executing one of the following commands:
   • On Linux/Mac OS:  sh wso2server.sh

   • On Windows:  wso2server.bat --run

3. Open the management console from https://localhost:9445/carbon/.
4. Log in using admin as the username and password.
5. Go to Main -> Manage -> Add ->BPMN and upload the AppointmentCancellation.bar file by browsing in the workspace directory of your Tooling instance as shown below. 
   

Starting the Message Broker profile

Let's start the Message Broker profile:

1. Open a new command line terminal and navigate to the <EI_HOME>/wso2/broker/bin directory.
2. Execute one of the following commands.
   • On Linux/Mac OS:  sh wso2server.sh
   • On Windows:  wso2server.bat

Deploying the ESB artifacts in the ESB profile

# register some connection factories
# connectionfactory.[jndiname] = [ConnectionURL]
connectionfactory.QueueConnectionFactory = amqp://admin:admin@clientID/carbon?brokerlist='tcp://localhost:5675'
connectionfactory.TopicConnectionFactory = amqp://admin:admin@clientID/carbon?brokerlist='tcp://localhost:5675'
# register some queues in JNDI using the form
# queue.[jndiName] = [physicalName]
queue.MyQueue = example.MyQueue
queue.PaymentRequestJMSMessageStore=PaymentRequestJMSMessageStore

Now, let's start the ESB profile in WSO2 EI and upload the ESB artifacts:

1. Open a terminal and navigate to the <EI_HOME>/bin directory.
2. Execute one of the following scripts to start the ESB profile of WSO2 EI.
   • On Windows: integrator.bat --run
   • On Linux/Mac OS: sh integrator.sh
3. In your Web browser, navigate to the WSO2 EI management console using the following URL: https://localhost:9443/carbon/
4. Log into the management console using the following credentials:
   • Username: admin
   • Password: admin

5. Deploy the SampleServicesCompositeApplication_1.0.0.car as follows:

   1. On the Main tab of the management console, go to Manage -> Carbon Applications and click Add. 

   2. Click Choose File, select the SampleServicesCompositeApplication_1.0.0.car file that you downloaded, and click Upload. 

Starting the back-end service

To be able to send requests to the back-end service (which is an MSF4J service deployed in the MSF4J profile of WSO2 EI), you need to first start the MSF4J runtime:

1. Open a terminal and navigate to the <EI_HOME>/wso2/msf4j/bin directory.

2. Start the runtime by executing the MSF4J startup script as shown below.

   sh carbon.sh

The system is now ready to receive appointment reservation requests.

Sending requests to the ESB

To demonstrate how the BPMN process for appointment cancellation works, let's send three separate requests to the ESB profile of WSO2 EI. These requests will create three separate doctor's appointments on three separate dates. You will receive confirmation emails for all of the appointments.

1. First, create JSON files with three separate request payloads as shown below. Note the following when you create the request payloads.

   Set the "appointment_date" as follows:

   • In request1.json, leave a gap less than 2 days between the current date as the "appointment_date".

   • In request2.json, leave a 2-day gap between the current date and the "appointment_date".
   • In request3.json, leave at least a 3-day gap between the current date and the "appointment_date".

   Make sure you provide a valid email address so that you can test the email being sent to the patient. 

   For example, if today's date is 20th March 2018, the values of the appointment_date property in the requests should be as follows:

   • In the request1.json file: "2018-03-21"
   • In the request2.json file: "2018-03-23"
   • In the request3.json file: "2018-03-24" or any date after that.
     
2. Open a command line terminal and navigate to the location where you have stored the above request payloads.
3.  Execute the following command, which will send the request1.json payload as a request.
   

   curl -v -X POST --data @request1.json http://localhost:8280/healthcare/categories/surgery/reserve --header "Content-Type:application/json"

   You will see the response as follows:

   {"message":"Payment request successfully submitted. Payment confirmation will be sent via email."}

   An email will be sent to the provided patient email address with the following details:

   Subject: Payment Status
    
   Message: 
   {
   "Appointment Number": 1,
   "Doctor":"thomas collins",
   "patient":"John Doe",
   "actualFee":"7000.0",
   "discount":"0",
   "discounted":"7000.0",
   "status":"Settled",
   "cancellation link" : "https://localhost:9445/bpmn-explorer/"
   }

4. Execute the following commands to send appointment reservation requests using the request2.json and request3.json payloads respectively.
   • curl -v -X POST --data @request2.json  http://localhost:8280/healthcare/categories/surgery/reserve  --header "Content-Type:application/json"
   • curl -v -X POST --data @request3.json  http://localhost:8280/healthcare/categories/surgery/reserve  --header "Content-Type:application/json"
5. You will receive separate emails confirming the above appointments.

Canceling appointments using the BPMN explorer

Let's now look at how to cancel the doctor's appointments. If you successfully, completed the previous steps, you will now have three emails confirming three appointments. The cancellation link is provided in each mail. 

1. Click the cancellation link in one of the mails, which will take you to the BPMN explorer. 
   
2. Log in to the BPMN explorer using admin as the username and password.
3. Click Processes and see that an appointment cancellation process is listed as shown below.
   
4. Click Start to begin the cancellation process and the Start Process form will open as shown below.
   
   We will first cancel the appointment that was confirmed from the request1.json payload. That is, the appointment date should be less than two days from the current date. 
   1. Enter the appointment details in the above form and click Start. Be mindful of the following values:
      
      • Appointment Number: This should be the number you received in the appointment confirmation email.
      • Email Address: A notification email will be sent to this address after the cancellation process is completed. Be sure to enter a valid email address in this field.
   2. You will now receive an email rejecting the cancellation of your appointment because your appointment date is only two days from the current date.
   
   Now let's cancel the appointment that was confirmed from the request2.json payload. That is, the appointment date should be exactly two days from the current date.
   1. Click PROCESSES in the menu bar and start the AppointmentCancellation process again. The Start Process form will open again.
   2. Enter the appointment details of the second appointment that was emailed to you and click Start. Be sure to enter the correct appointment number and email address.
   3. Since the appointment falls exactly two days from the current date, the appointment cancellation will neither be approved or rejected automatically.
   4. Click TASKS on the menu bar and see that a manual task has been created for the appointment cancellation. 
      
   5. You can now assume the role of an administrator in the hospital service and determine if the appointment cancellation should be approved or rejected. 
   6. Let's approve the request: Select Approve and click Complete Task in the appointment control task shown above.
   7. You will receive an email confirming that the appointment cancellation is approved.
   
   Now let's cancel the appointment that was confirmed from request3.json. That is, the date of appointment should be more than two days away from the current date.
   
   1. Click PROCESSES in the menu bar and start the AppointmentCancellation process again. The Start Process form will open again.
   2. Enter the appointment details of the third appointment that was emailed to you and click Start. Be sure to enter the correct appointment number and email address.
   3. Since the appointment is more than two days from the current date, the appointment cancellation will neither be approved automatically. 
   4. You will receive an email confirming that the appointment cancellation is approved.