This documentation is for WSO2 Enterprise Integrator version 6.3.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

Store and forward messaging is used for serving traffic to back-end services that can accept request messages only at a given rate. This is also used for guaranteed delivery to ensure that request received never gets lost since they are stored in the message store and also available for future reference. 

In this tutorial, instead of sending the request directly to the back-end service, you store the request message in the Message Broker profile of WSO2 EI. You then use a Message Processor to retrieve the message from the store and then deliver the message to the back-end service.

See the following topics for a description of the concepts that you need to know when creating ESB artifacts:

Before you begin,

  1. Download the product installer from here, and run the installer.
    Let's call the installation location of your product the <EI_HOME> directory.

    Note that if you used the product installer to install your product, the <EI_HOME> is located in a place specific to your OS as shown below:

    OSHome directory
    Mac OS/Library/WSO2/EnterpriseIntegrator/6.3.0
    WindowsC:\Program Files\WSO2\EnterpriseIntegrator\6.3.0\
  2. Select and download the relevant EI tooling 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.

    Getting an error message? See the troubleshooting tips given under Installing Enterprise Integrator Tooling.

  3. If you did not try the Exposing Several Services as a Single Service tutorial yet, open the WSO2 EI Tooling environment, click File, and then click Import. Next, select Existing WSO2 Projects into workspace under the WSO2 category, click Next and upload the pre-packaged project. This contains the configurations of the Exposing Several Services as a Single Service tutorial so that you do not have to repeat those steps.
  4. 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.

Let's get started!

Setting up the message broker profile

The message broker profile (which is an instance of WSO2 Message Broker) is shipped with the WSO2 EI product distribution. You need to enable the following configurations to be able to store messages in the broker profile.

Open the <EI_HOME>/conf/ file and add the following line after the queue.MyQueue = example.MyQueue line:


Creating the Message Store

Now, let's create a message store artifact in EI Tooling. 

  1. Right click on SampleServices in the Project Explorer and navigate to New->Message Store.
  2. Select Create a new message-store artifact and fill in the information in the following table and click Finish.

    Message Store NamePaymentRequestMessageStore
    Message Store TypeSelect WSO2 MB Message Store
    Queue Connection Factory

    amqp://admin:[email protected]/carbon?brokerlist='tcp://localhost:5675'

    Change the port to 5675.

    JNDI Queue NamePaymentRequestJMSMessageStore

    create new message store

    Click Finish.

Let's look at how we update the REST API with the Store mediator.

Creating the Deployable Artifacts

Let's now update the REST API so that the messages sent to SettlePaymentEP is forwarded to the message store we created above. 

  1. Drag and add a Store Mediator from the mediators palette just after the PayloadFactory mediator.
  2. With the Store mediator selected, access the Property tab and fill in the information as in the following table:

    Available Message StoreSelect PaymentRequestMessageStore
    Message StoreDouble click to populate the value PaymentRequestMessageStore
    DescriptionPayment Store

    Let's use a PayloadFactory mediator to send a customized response message to the client. 

  3. Delete the Call mediator by right clicking on the mediator and selecting Delete from Model. Replace this with a PayloadFactory mediator from the Mediators palette to configure the response to be sent to the client. With the PayloadFactory mediator selected, access the Property tab and fill in the information in the following table to define a customized message to be returned to the client.

    Media TypeSelect json
    Payload FormatSelect Inline
    Payload{"message":" Payment request successfully submitted. Payment confirmation will be sent via email ."}

    To avoid getting an error message, first select Media Type before selecting Payload.

    You should now have a completed configuration that looks like this:

Creating the Response Sequence

Let's create a Sequence that uses the message in the message store to send the request to SettlePaymentEP.

  1. Right click the SampleServices project in the Project Explorer and navigate to New -> Sequence. Select Create New Sequence and provide the name PaymentRequestProcessingSequence.

    Click Finish.
  2. Drag and drop a Call mediator from the Mediators palette and add SettlePaymentEP from Defined Endpoints palette to the empty box adjoining the Call mediator. This sends the request message from the store to SettlePaymentEP.

  3.  Drag and drop a Log mediator from the Mediators palette to log the response from SettlePaymentEP. Access the Property tab and fill in the following information:

    Log CategorySelect INFO
    Log LevelSelect FULL
  4. Add a Drop mediator from the Mediators palette.  You should now have a completed sequence configuration that looks like this:

    the response sequence

  5. Save the updated REST API configuration.

Creating the Message Processor

Let's create a Message Sampling Processor to dispatch the request message from the message store to the PaymentRequestProcessingSequence.

You can also use the Scheduled Message Forwarding Processor here and define the endpoint within the processor. The Message Sampling Processor is used because you need to perform mediation on the request message in the next tutorial.

Right-click the SampleServices project in the Project Explorer and navigate to  New -> Message Processor. Select create a new message-processor artifact and fill in the details as in the following table:

Message Processor TypeSelect Message Sampling Processor

This processor takes the message from the store and puts it into a sequence.

Message Processor NamePaymentRequestProcessorThe name of the scheduled message forwarding processor.
Message StoreSelect PaymentRequestMessageStoreThe message store from which the scheduled message forwarding processor consumes messages.
Processor StateActivateWhether the processor needs to be activated or deactivated.

Follow the steps given below:

  1. Click Browse.
  2. Click the workspace link.
  3. Click Carbon Application Sequences > SampleServices.
  4. Select PaymentRequestProcessingSequence and click OK.
The name of the sequence the message from the store needs to be sent to.

Click Finish.

We have now finished creating all the required artifacts.

Packaging the artifacts

Since you created a message store, sequence and a message processor,  these will need to be packaged into our existing CApp.

Package the C-App names SampleServicesCompositeApplication project with the artifacts created. Ensure the following artifact check boxes are selected in the Composite Application Project POM Editor.

  • SampleServices
    • HealthcareAPI
    • ClemencyEP
    • GrandOakEP
    • PineValleyEP
    • ChannelingFeeEP
    • SettlePaymentEP
    • PaymentRequestMessageStore
    • PaymentRequestProcessingSequence
    • PaymentRequestProcessor
  • SampleServicesRegistry

Starting the Message Broker runtime

Start the message broker profile as follows:

Open a terminal and execute the following command:

Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.3.0 Broker. This will open a terminal and start the Message Broker profile.

The message broker profile is now ready to receive messages from the ESB profile.

Starting the MSF4J profile

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

Open a terminal and execute the following command:


Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.3.0 MSF4J. This will open a terminal and start the MSF4J profile.

The Healthcare service is now active and you can start sending requests to the service.

Starting the ESB runtime and deploying the artifacts

On the Servers tab, expand the WSO2 Carbon server, right-click SampleServicesCompositeApplication, and choose Redeploy. The Console window will indicate that the CApp has been deployed successfully. If you do not have a server added in Eclipse, refer this tutorial. You can also deploy the artifacts to the ESB profile of WSO2 EI using a Composite Application Archive (CAR) file.

Sending requests to the ESB

  1. Create a JSON file names request.json with the following request payload.

    "name": "John Doe",
    "dob": "1940-03-19",
    "ssn": "234-23-525",
    "address": "California",
    "phone": "8770586755",
    "email": "[email protected]",
    "doctor": "thomas collins",
    "hospital": "grand oak community hospital",
    "cardNo": "7844481124110331"
  2. Open a command line terminal and execute the following command from the location where request.json file you created is saved:

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

    This is from the URI-Template defined when creating the API resource QueryDoctorAPI.


    You will see the response as follows:

    {"message":"Payment request successfully submitted. Payment confirmation will be sent via email."}
  3. Now check the ESB server Console in Eclipse and you will see that the response from SettlePaymentEP is logged as follows:

    [2017-04-30 14:33:48,578] [EI-Core]  INFO - LogMediator message = Routing to grand oak community hospital
    [2017-04-30 14:33:48,598] [EI-Core]  INFO - TimeoutHandler This engine will expire all callbacks after GLOBAL_TIMEOUT: 120 seconds, irrespective of the timeout action, after the specified or optional timeout
    [2017-04-30 14:33:53,464] [EI-Core]  INFO - LogMediator To:, WSAction: , SOAPAction: , MessageID: urn:uuid:a2cf1fd2-7a89-44b6-9571-990bbdfbd289, Direction: request, Payload: {"appointmentNo":1,"doctorName":"thomas collins","patient":"John Doe","actualFee":7000.0,"discount":20,"discounted":5600.0,"paymentID":"a77038e9-3e42-46f7-ac97-11e1b3a50018","status":"Settled"}

You have now explored how the ESB profile of WSO2 EI can be used to implement store and forward messaging using Message Stores, Message Processors, and the Store mediator.

  • No labels