Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
In this tutorial,
Panel
Panel

In this tutorial, you will use a BPMN process defined in the Business Process profile of WSO2 EI to manage the process of canceling a doctor's appointment. The appointment cancellation process should be designed according to the following requirement:

  • The patient should be allowed to cancel the appointment (unconditionally) if the appointment date is at least two days away.
  • The patient should not be allowed to cancel the appointment if the appointment date is less than two days away.
  • If the appointment date falls on the second day from the current date, the patient can request for appointment cancellation, which should be manually approved by an administrator.
  • The patient should receive email notifications informing if the appointment cancellation is accepted or rejected.

...

trueGo to the product page of WSO2 Enterprise Integrator, select Other Installation Options, and download the Binary distribution. Extract the ZIP file of the binary. This will be your <EI_HOME> directory.
  • Select and download the relevant WSO2 Integration Studio ZIP file based 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.

  • Tip

    Before you begin,

    1. Install Oracle Java SE Development Kit (JDK) version 1.8.* and set the JAVA_HOME environment variable.
    2. Download the product installer from here, and run the installer.
    Insert excerpt
    Installing the ProductInstalling the Productnopanel
    Info
  • You need to try out the Using the Gmail Connector tutorial before trying out this tutorial as the Gmail connector that is used in this tutorial is configured using your client ID and secret.
  • Download the MSF4J service from here and copy the JAR file to <EI_HOME>/wso2/msf4j/deployment/microservices folder. The back-end service is now deployed in the MSF4J profile of WSO2 EI.
  • Create STMP an email account to send out emails to users that want to cancel an appointment using WSO2 Business Process Server (e.g., no-reply@foo.com).
  • ...

    1. Open WSO2 Integration Studio.
    2. Go to BP Project → BPMN.
    3. Create a new project named AppointmentCancellation.
    4. Click Finish.
    5. Right click the project in the navigator and go to New → Other and select BPMN diagram.
    6. Select the AppointmentCancellation/src/main/resources/diagrams directory as the parent folder, and enter AppointmentCancellation.bpmn for the File name.
    7. Click Next, select the option to create an empty diagram as shown below, and click Finish.
    8. 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 palette.
      2. Select the Properties tab, click Form, click New, update the following and click OK.

        IdpatientName
        NameName of the Patient
        Typestring
        RequiredTrue

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

        IdNameTypeRequired
        appointmentNoAppointment NumberlongTrue
        doctorName of the DoctorstringTrue
        reasonReason for cancellationstringTrue
        emailEmail AddressstringTrue

      4. Add a REST Task from the WSO2 Tasks palette.

        Select the Properties tab, click General and give the Name as Get Appointment, then click Main config and update the following:

        Service URLhttp://localhost:9090/healthcare/appointments/validity/${appointmentNo}
        HTTP methodGET
        Output Variable MappingsnoOfDays:$.status


      5. Add an Exclusive Gateway from the Gateway palette.
      6. Add a User Task from the Task palette 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 add the following.

        IdNameTypeReadableWritableRequired
        approveCancellationDo You Approve the
        Appointment Cancellation Request?
        enumTrueTrueTrue

        Click New next to Form values and add the following:

        IdName
        approveApprove
        rejectReject

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

        IdNameTypeVariableReadableWritableRequired
        AppNoAppointment NumberlongappointmentNoTrueFalseTrue
        cancellationReasonReason For The CancellationstringreasonTrueFalseTrue
        doctorNameName of the DoctorstringdoctorTrueFalseTrue

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

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

        Service URLhttp://localhost:9090/healthcare/appointments/validity/${appointmentNo}
        HTTP methodDELETE
        Output Variable namestatus

      12. Add a MailTask from the Task palette 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}
        FromEnter a valid SMTP email address.
        SubjectAppointment cancellation rejected
        HtmlAppointment 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.


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

        To${email}
        FromEnter a valid SMTP email address.
        SubjectAppointment cancellation successful
        HtmlAppointment 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.
    9. 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.
    10. Anchor
      reject
      reject
      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.
    11. 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.
    12. 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.
    13. Click the arrow leading to the Appointment Control Task, open the General tab that is under properties and note the Id.
      Example:
    14. Click the first exclusive gateway, open the General tab that is under properties, and select the ID you noted in the above steps as the value for Default flow.

    15. Save all the changes you have made.
    16. Click Window -> Show View -> Other in the top menu of WSO2 Integration Studio.
    17. Type Package Explorer in the search bar, select it and click Open.
    18. 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:

    ...

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

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

    2. Start the Business Process profile in WSO2 EI by executing one of the following commands:

      Panel
      borderColor#542989
      bgColor#ffffff
      borderWidth1
      Localtabgroup
      Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.4.0 Business Process. This will open a terminal and start the business process profile.
      Localtab
      titleOn MacOS/Linux/CentOS

      Open a terminal and execute the following command:

      Code Block
      wso2ei-6.4.0-business-process
      Localtab
      titleOn Windows
      Code Block
      sh wso2server.sh
      Localtab
      titleOn Windows
      Code Block
      wso2server.bat
    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 WSO2 Integration Studio instance as shown below. 

    Anchor
    start_MB
    start_MB
    Starting the Message Broker profile

    Let's start the Message Broker profile's start the Message Broker profile:

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

    2. Start the Business Process profile in WSO2 EI by executing one of the following commands:

      Panel
      borderColor#542989
      bgColor#ffffff
      borderWidth1
      Localtabgroup
      Localtab
      titleOn MacOS/Linux/CentOS

    ...

    Open a terminal and execute the following command:

    Code Block
    wso2ei-6.4.0-broker

    ...

    titleOn Windows

    ...

    1. Code Block
      sh wso2server.sh
      Localtab
      titleOn Windows
      Code Block
      wso2server.bat

    Anchor
    start_integration
    start_integration
    Deploying the ESB artifacts in the ESB profile

    ...

    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: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.

      Panel
      borderColor#542989
      bgColor#ffffff
      borderWidth1
      Localtabgroup
      Localtab
      titleOn MacOS/Linux/CentOS

    ...

    1. Code Block

    ...

    1. sh carbon.sh
      Localtab
      titleOn Windows

    ...

    1. Code Block
      carbon.bat

    The system is now ready to receive appointment reservation requests.

    ...