Quick Start Guide
com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_links' is unknown.

Quick Start Guide

WSO2 Enterprise Integrator (WSO2 EI) is a comprehensive solution that allows you to seamlessly integrate applications, services, data, and business processes to support modern enterprise integration requirements. 

For this quick start guide, let's consider a basic Health Care System where WSO2 EI is used as the integration software. In this guide, an external party (a patient) wants to make a doctor's reservation at a given hospital.

Routing requests based on message content

This is a 5-minute guide to give you a quick overview of how WSO2 EI mediates and routes messages from a front-end service (client) to a back-end service.

Before you begin,

  1. Go to the WSO2 Integration product page, click Download → Previous Releases. You can now download WSO2 EI 6.5.0 version.

  2. Download and start the back-end service that will process appointment requests:

    1. Download the back-end service and copy it to the <EI_HOME>/wso2/msf4j/deployment/microservices directory.
      The back-end service is now deployed in the MSF4J profile, which will run microservices for your integration flows. 

    2. Start the MSF4J profile:

  3. If you are on a Windows OS, install cURL. For more information, see the cURL Releases and Downloads.

Let's get started!

Configuring WSO2 EI

  1. Start the ESB profile:

    The WSO2 EI product consists of many profiles. The ESB profile is used to manage short-running and stateless integration. For more information, see the WSO2 EI Overview.

  2. Open the ESB profile Management Console using https://localhost:9443/carbon, and log in using admin as the username and the password.

    The Management Console provides a UI to configure WSO2 EI. WSO2 Carbon is the core platform on which WSO2 middleware products are built. 

  3. Download the SampleServicesCompositeApplication_1.0.0.car file from GitHub.

     Click here to find out what is inside the car file you downloaded.
    This file is a Carbon Application Archive (CAR file) containing the integration artifacts you will use in this tutorial, including:
    • An API resource, which acts as the endpoint that accepts incoming requests from a client, routes them to the back-end service for processing, receives a response from the service, and sends the response back to the client.
    • A Switch Mediator to route messages based on the message content to the relevant HTTP Endpoint defined in the ESB.
    • A Log Mediator to log the message that the switch mediator is routing the message to the correct endpoint.
    • A Send Mediator to send the appointment request to the correct hospital endpoint.

    If you want to try out this same guide by configuring the artifacts, try out the Routing Requests Based on Message Content tutorial.

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

    3. Refresh the page to see the Carbon application you just added in the Carbon Applications List screen.

Sending requests to WSO2 EI

We are now ready to request a doctor's appointment at Grand Oak Community Hospital.  

  1. Create a JSON file named request.json with the following payload to specify the details the back-end service needs to make the appointment: patient information, doctor name, hospital name, and appointment date. 

    {
      "patient": {
        "name": "John Doe",
        "dob": "1940-03-19",
        "ssn": "234-23-525",
        "address": "California",
        "phone": "8770586755",
        "email": "johndoe@gmail.com"
      },
      "doctor": "thomas collins",
      "hospital": "grand oak community hospital",
      "appointment_date": "2025-04-02"
    }

    If you want to request a different hospital, you can specify one of the following hospital names instead.

    • clemency medical center

    • pine valley community hospital

  2. Open a terminal, navigate to the directory where you have saved the request.json file, and execute the following cURL command.

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

    This command sends the JSON payload you created in the previous step to the API resource http://localhost:8280/healthcare/categories/surgery/reserve, which was included in the CAR file you uploaded. The API resource contains the logic for routing appointment requests to the back-end service you deployed in the microservices directory. 

    You get the following response:

    > POST /healthcare/categories/surgery/reserve HTTP/1.1
    
    > Host: localhost:8280
    > User-Agent: curl/7.54.0
    > Accept: */*
    > Content-Type:application/json
    > Content-Length: 285
    > 
    * upload completely sent off: 285 out of 285 bytes
    < HTTP/1.1 200 OK
    < Content-Type: application/json
    < Date: Tue, 21 May 2019 09:14:45 GMT
    < Transfer-Encoding: chunked
    < 
    * Connection #0 to host localhost left intact
    
    {"appointmentNumber":1,"doctor":{"name":"thomas collins","hospital":"grand oak community hospital","category":"surgery","availability":"9.00 a.m - 11.00 a.m","fee":7000.0},"patient":{"name":"John Doe","dob":"1940-03-19","ssn":"234-23-525","address":"California","phone":"8770586755","email":"johndoe@gmail.com"},"fee":7000.0,"confirmed":false,"appointmentDate":"2025-04-02"}
  3. Now check the terminal window and you see the following message: INFO - LogMediator message = Routing to grand oak community hospital

Congratulations, you have successfully completed this guide!
In this tutorial, you have seen how you can create a request payload and send it to an endpoint in WSO2 EI, which routes the message to a back-end service and then sends a response back to the client. 

What's next?

Exposing a datasource as a service

Guaranteeing message delivery

Defining a BPMN process

com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_links2' is unknown.