Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

How to Work With the ServiceNow Connector in MuleSoft

DZone's Guide to

How to Work With the ServiceNow Connector in MuleSoft

Learn how to install and use the new connector for MuleSoft's Anypoint Studio and the ServiceNow enterprise cloud computing platform.

· Integration Zone
Free Resource

Modernize your application architectures with microservices and APIs with best practices from this free virtual summit series. Brought to you in partnership with CA Technologies.

ServiceNow and MuleSoft are working together to extend service management across the enterprise by fully integrating business processes such as ITSM, HR, legal, finance, procurement, operations, marketing, and facilities.
Image title
ServiceNow is a cloud computing platform that helps enterprises to move faster. With ServiceNow, enterprises can replace unstructured work patterns followed in the past with intelligent workflows in the future.

You get thousands of requests from customers, IT incidents, and HR cases on a day-to-day basis. They move on their own paths, moving to and fro between humans, machines, and different branches. They follow very unstructured and undocumented paths.

With ServiceNow Cloud platform, all employees and customers can make requests on a single cloud platform. Every branch or team working on these issues can prioritize, find the root cause of the issue, get real-time insight, and drive it towards real action to get results. It improves the service levels. ServiceNow is the faster way to get work done at lightspeed.

MuleSoft customers also use ServiceNow in various use cases. A customer uses ServiceNow to create and manage IT incidents. Some of the ServiceNow customers use ServiceNow for asset procurement, change management, access requests, incident management, and managing HR processes.

In this post, I’d like to walk you through a simple demo app to show you how to create an incident using ServiceNow connector in case you lose the access to VPN.

Before you start with the demo app, please make sure you have the ServiceNow Connector downloaded from the Exchange.

ServiceNow Connector on Exchange

After you install the ServiceNow Connector, create a new project in the Studio and name it serviceNowdemo. Please drag and drop the connectors as shown in the below flow:

Image title

Once you have all the pallets, configure the connector. To configure the ServiceNow Connector, you need to have an account with ServiceNow. You can create a developer's account with ServiceNow on developers.servicenow.com. It's free. Once your account is created, you can go to the "Manage > Instance" option to see the instance allocated to you from ServiceNow.

Image title

You will need the username, password, URL, and ServiceNow version of this instance to configure ServiceNow Connector. Keep these details handy to configure on your ServiceNow connector. You can see the below snapshot for my configurations:Image title

HTTP Listener is the first component of my Mule flow. For HTTP Listener, I am using port 8091 and the path as "/createIncident."  

For the Transform Message component, Mule will sense the data for the configuration you will select on the ServiceNow connector and populate the output for the columns of the table. Mule uses Data Sense when we use Transform Message anywhere in the flow. For this demo, I have selected the Incident table and Insert operation in ServiceNow Connector as shown in the below snapshot:

Image title

Transform Message will be auto-populated with all of the fields of the Incident table. This is really wonderful:

Image title

We will use DataWeave to map some of these fields in Transform Message. For this demo, I am using the below DataWeave code:

%dw 1.0
%output application/xml
%namespace ns0 http://www.service-now.com/incident
---
{
  ns0#insert: {
    comments: "This is very urgent. Please resolve it quickly",
    short_description: "Cannot Access the VPN",
    state: "New"
  }
}

This is just for this demo. You can add more fields based on your experience with ServiceNow. You have to go through some of the documentation of ServiceNow to understand the purpose of the other fields in the table. If you want to use the connector to manage the HR operations or procurement, you have to select a different table and operation and configure the Transform Message component accordingly. 

In my second Transform Message component, I am providing the payload with an output as application/JSON:Image title

%dw 1.0
%output application/json
---
payload

This transformation is done to log the payload for tracking purposes in this demo. You can use the payload returned from ServiceNow to send the incident details to the users. 

As we have configured all components, our app is ready to be deployed and tested. Just run it and deploy it on your Mule Runtime env. 

Now, your app is ready to create an Incident through ServiceNow. If you open your browser and hit http://localhost:8091/createIncident, you will see the following page.

You will also get a similar response on the browser :

Image title

This will create an Incident in ServiceNow portal under the Incidents page. 

You need to browse through your ServiceNow instance https://dev37944.service-now.com/ (this is my ServiceNow instance). Please go to your ServiceNow instance to access the incidents.

Image title

Click on "incident" and Select "ALL" options on the incident page. It will show all incidents created on this instance. You have to filter based on your incident number. 

Image title

You can see that the incident has been successfully created. You can click on the incident number and check the details are same as provided in your Mule app. Image title

Image title

We have provided these details in the Transform Message component while writing the DataWeave. 

We can see all details related to the creation of the incident have flown from Mule to ServiceNow.

This was a very basic use case of ServiceNow Connector. For new users, try the above example to get started, and for others, please share with us how you are planning to use ServiceNow with the Anypoint Connector! Also, explore the Anypoint Exchange to see other resources you can leverage today.

The Integration Zone is proudly sponsored by CA Technologies. Learn from expert microservices and API presentations at the Modernizing Application Architectures Virtual Summit Series.

Topics:
mulesoft studio ,mule ,connectors ,integration

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}