Lab 3: Leverage Anypoint MQ to broadcast Order Fulfillment updates via Notification API

Configure a publish and subscribe messaging pattern using Anypoints cloud messaging service: Anypoint MQ.

Extend the Order Fulfillment API flow to publish a single Send Notification message to AnyPoint MQ.

Leverage Exchange 2.0 to reuse Gmail/Twitter and Slack Connectors for creation of two Notification subscribers.

Use DataWeave to manage data transformations across Notification API calls.

Run and test the Mule app containing the Process API from Anypoint Studio.

Let’s go ahead and open sign-in to Anypoint Platform, selecting MQ

Next let’s create the necessary Queue Destinations that will support our publish and subscribe notification pattern.

Select Sandbox environment

Click the button in the right upper hand corner, then Select Queue

Let’s give our first Queue the ID <username>-order-user-notification-queue

Accept the default values for all other fields, choose Create Queue

Create a second Queue, giving it the ID <username>-order-slack-notification-queue

Accept the default values for all other fields, choose Create Queue

Next we need to configure an AnypointMQ Exchange to enable the sending and receiving of messages to our recently defined Queues.

Click the button in the right upper hand corner, then Select Exchange

Let’s give our exchange the ID <username>-order-exchange, followed by selecting each of the two Queues we created in the last step.

Choose Save Changes

The final Anypoint MQ configuration is to create a Client App. By configuring a Client App, we can securely register an application with the Anypoint MQ host.

Select the Client Apps link in the left side nav bar, followed by the + in the upper right hand corner of the page.

Give the application a name, let’s call it <username>-order-notifications

Choose Save Changes and wait a few seconds for the screen to refresh, showing the newly created client application registration. Once the application is registered successfully, it will be displayed with a Client ID as well as a Client Secret.

Please take note of the ID and Secret, as they will be used in future steps within this lab.

Go to the folder src/test/resources and press right button.

Select New → Folder

Complete with the name examples in the Folder name

On src/test/resources/examples create a new File called publish-message-example.json

Copy and paste the following text:

{
	"order_id":"1",
	"customer_data":{
		"id": "b4285d5f-69c1-40fc-97b3-d112a6366b68",
  		"email": "test_email123@example.com",
	  	"name": "Mike Prowl",
	  	"phone": "1-(951)768-8479",
	  	"shippingAddress": {
	    	"address1": null,
	    	"city": "Houston",
	    	"country": "USA",
	    	"postalCode": "77045",
	    	"state": "Texas"
	  	},
	  	"billingAddress": {
	    	"address1": null,
	    	"city": "Riverside",
	    	"country": "USA",
	    	"postalCode": "92513",
	    	"state": "California"
  		}
	},
	"products":[
		{
			"id": 3,
			"productName": "Hoodie",
			"quantity": 1
		},
		{
			"id": 5,
			"productName": "Mug",
			"quantity": 2
		}
	]
}

Save and Close the example file.

Now, add the Anypoint MQ Component to the palette.

Go to the palette and press Search in Exchange

In the search box enter Anypoint

Select the Anypoint MQ Connector

Press the Add> button.

Press Finish

Remove the last Transform Message component.

In the Anypoint MQ Palette, Drag and Drop the Publish icon after the Scatter Gather component.

Click on the Publish Icon

Configure the Anypoint MQ client by creating a new Connector Configuration.

Press OK

Under the General section

Click

Click Define metadata link

Press Add button to create a new data type.

Complete with the name publish_message_example and press create type

Select JSON in the type drop down list

Select example from the drop down and write examples/publish-message-example.json as the path.

Press Select

Save the project

Select publish-message-example from the User Defined window.

Press Select when finished.

Replace the actual transformation with this one:

%dw 2.0
output application/json
---
{
	order_id: vars.order_id as Number,
	customer_data: {
		id: payload."1".payload.id,
		email: payload."1".payload.email,
		name: payload."1".payload.name,
		phone: payload."1".payload.phone,
		shippingAddress: {
			address1: payload."1".payload.shippingAddress.text,
			city: payload."1".payload.shippingAddress.city,
			country: payload."1".payload.shippingAddress.country,
			postalCode: payload."1".payload.shippingAddress.postalCode,
			state: payload."1".payload.shippingAddress.state
		},
		billingAddress: {
			address1: payload."1".payload.billingAddress.text,
			city: payload."1".payload.billingAddress.city,
			country: payload."1".payload.billingAddress.country,
			postalCode: payload."1".payload.billingAddress.postalCode,
			state: payload."1".payload.billingAddress.state
		}
	},
	products: payload."0".payload.products map ( orderLineItem , indexOfOrderLineItem ) -> {
		id: orderLineItem.id as Number,
		productName: orderLineItem.productName as String,
		quantity: orderLineItem.quantity as Number
	}
}

Save the project

Go to Advanced.

In the Output section, set the following values:

Add a Transform component after the publish component.

Complete the transform with the following dataweave script:

%dw 2.0
output application/json
---
{
	order_id: vars.order_id as Number,
	username: payload."1".payload.name
}

Create a new Mule Configuration file to encapsulate our Notification flows.

Name the new configuration file notification_subscribers.xml

Drag a Subscriber Anypoint MQ component on the blank canvas to begin the construction of our first flow aimed at the Gmail/Twitter channel

Rename the Flow name to notification-user-listener

Rename the component to Twitter Notificaton Subscriber .

Reuse the Anypoint MQ Connector Configuration object.

Configure the Destination to in the Queue field under General section <username>-order-user-notification-queue.

Press the save button.

Go to the Metadata tab

Press Add metadata button

Select Output: Payload and press the edit button

Select metadata publish_message_example and press Select

Go to Search in Exchange and search for Notification API

Drag and Drop Create id by id resource.

Double-click on the connector to display its properties. You should see the component properties for you to configure in the Mule Properties View.

Click on icon to create a new configuration as shown:

Complete the Request Configuration

Click OK

In the General section, set the following parameters:

Press and add the below DataWeave logic into the code editor:

%dw 2.0
output application/java
var customer=payload.customer_data.name default ""
var order_id=payload.order_id default 0
---
{
	body: "Thank you " ++ customer ++ ", your order (#" ++ order_id ++ ") has been received.",
	subject: "Order " ++ order_id
}

Finally add a Logger component. This will output an intuitive log entry indicating that the Notification was sent.

In the Message put the following string: Notification to Twitter successfully Sent

Save your flow configuration.

Drag another Subscriber Anypoint MQ component onto the canvas. This will create a new flow.

Rename the name of the flow to notification-slack-listener

Rename the component to Slack Notificaton Subscriber .

Reuse the Anypoint MQ Connector Configuration object.

Configure the Destination to <username>-order-slack-notification-queue.

Your configuration should resemble something similar to the below image:

Go to the Metadata tab

Press Add metadata button

Select Output: Payload and press the edit button

Select metadata publish_message_example and press Select

Add the component Create slack from the Notification API connector

Reuse the Connector configuration already created.

In the General section, set the following parameters:

Press and add the below DataWeave logic into the code editor:

%dw 2.0
output application/json
---
{
	userId: payload.customer_data.id,
	productList: payload.products map ( product , indexOfProduct ) -> {
		qty: product.quantity,
		name: product.productName
	}
}

Finally add a Logger component. This will output an intuitive log entry indicating that the Notification was sent.

In the Message put the following string: Notification to Slack Successfully Sent

Save your flow configuration.

Start the application as done in the previous Lab. (Right-click the application, RUN AS > Mule Application

Once the API Console View opens in Anypoint Studio, click on the POST button on the /orders_fulfillment resource.

Complete the Accept field with application/json.

View the request body then click on the SEND button below.

Once the request is served, you should see a 200 response code and the JSON response of our API.

Review GMail, Twitter and/or Slack channels with the Instructor to view the broadcasted Notification message.

Using Anypoint Studio, implemented the Order Fulfillment Stub to complete the Process API layer.

Configured the Scatter-Gather flow control and RAML Consumer objects to orchestrate Order and Customer System APIs.

Using DataWeave, managed System and API responses to produce desired result set.

Tested the Process API implementation that traverses the System API layer using live API calls from RAML Consumers.