Workday and ServiceNow Employee Aggregation

Aggregates employees from Workday and users from ServiceNow into a CSV file. This basic pattern can be modified to collect from more or different sources and to produce formats other than CSV.

This application is triggered by an HTTP call that can be used manually or programmatically. Employees and users are sorted such that the employees only in Workday appear first, followed by users only in ServiceNow, and lastly by employees and users found in both systems. The custom sort or merge logic can be easily modified to present the data as needed. This template also serves as a great base for building APIs using the Anypoint Platform.

Aggregation templates can be easily extended to return a multitude of data in mobile friendly form to power your mobile initiatives by providing easily consumable data structures from otherwise complex backend systems.

License Agreement

This template is subject to the conditions of the MuleSoft License Agreement. Review the terms of the license before downloading and using this template. You can use this template for free with the Mule Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.

Use Case

I want to aggregate workers from Workday and users from ServiceNow Instances and compare them to see which workers (users) can only be found in one of the two and which workers(users) are in both instances.

This template generates the result in the format of a CSV report sent by email.

This template serves as a foundation for extracting data from two systems, aggregating data, comparing values of fields for the objects, and generating a report on the differences.

As implemented, it gets workers from one instance of Workday and users from one instance of ServiceNow, compares by the email address of the workers (users), and generates a CSV file which shows workers in A (Workday), users in B (ServiceNow), and workers (users) in A and B. The report is then emailed to the configured email address.

Considerations

To make this template run, there are certain preconditions that must be considered. All of them deal with the preparations in both, that must be made for the template to run smoothly. Failing to do so can lead to unexpected behavior of the template.

ServiceNow Considerations

Here's what you need to know to get this template to work with ServiceNow.

As a Data Destination

There are no considerations with using ServiceNow as a data destination.

Workday Considerations

As a Data Source

There are no considerations with using Workday as a data origin.

Run it!

Simple steps to get this template running.

Running On Premises

Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable to use it. To follow the example, use mule.env=prod.

After this, to trigger the use case you just need to browse to the local http endpoint with the port you configured in your file. If this is, for instance, 9090 then you should browse to: http://localhost:9090/generatereport and this creates a CSV report and sends it to the email you set.

Where to Download Anypoint Studio and the Mule Runtime

If you are new to Mule, download this software:

• Download Anypoint Studio
• Download Mule runtime

Note: Anypoint Studio requires JDK 8.

Importing a Template into Studio

In Studio, click the Exchange X icon in the upper left of the taskbar, log in with your Anypoint Platform credentials, search for the template, and click Open.

Running on Studio

After you import your template into Anypoint Studio, follow these steps to run it:

1. Locate the properties file mule.dev.properties, in src/main/resources.
2. Complete all the properties required per the examples in the "Properties to Configure" section.
3. Right click the template project folder.
4. Hover your mouse over Run as.
5. Click Mule Application (configure).
6. Inside the dialog, select Environment and set the variable mule.env to the value dev.
7. Click Run.

Running on Mule Standalone

Update the properties in one of the property files, for example in mule.prod.properties, and run your app with a corresponding environment variable. In this example, use mule.env=prod.

Running on CloudHub

When creating your application in CloudHub, go to Runtime Manager > Manage Application > Properties to set the environment variables listed in "Properties to Configure" as well as the mule.env value.

Once your app is all set and started, if you choose as domain name wday2snowworkeraggregation to trigger the use case you just need to browse to http://wday2snowworkeraggregation.cloudhub.io/generatereport and the report is sent to the emails configured.

Deploying a Template in CloudHub

In Studio, right click your project name in Package Explorer and select Anypoint Platform > Deploy on CloudHub.

Properties to Configure

To use this template, configure properties such as credentials, configurations, etc.) in the properties file or in CloudHub from Runtime Manager > Manage Application > Properties. The sections that follow list example values.

Application Configuration

Application Configuration

• http.port 9090
• page.size 200

WorkDay Connector configuration

• wday.username joan
• wday.tenant acme_pt1
• wday.password joanPass123
• wday.hostname your_impl-cc.workday.com

ServiceNow Connector Configuration

• snow.user mule.snow
• snow.password secret
• snow.endpoint https://dev147.service-now.com

SMTP Services Configuration

• smtp.host smtp.gmail.com
• smtp.port 587
• smtp.user exampleuser@gmail.com
• smtp.password ExamplePassword456

Email Details

• mail.from exampleuser@gmail.com
• mail.to woody.guthrie@gmail.com
• mail.subject Worker aggregation Report
• mail.body Worker aggregation report
• attachment.name WorkerReport.csv

API Calls

There are no special considerations regarding API calls.

Customize It!

This brief guide provides a high level understanding of how this template is built and how you can change it according to your needs. As Mule applications are based on XML files, this page describes the XML files used with this template. More files are available such as test classes and Mule application files, but to keep it simple, we focus on these XML files:

• config.xml
• businessLogic.xml
• endpoints.xml
• errorHandling.xml

config.xml

This file provides the configuration for connectors and configuration properties. Only change this file to make core changes to the connector processing logic. Otherwise, all parameters that can be modified should instead be in a properties file, which is the recommended place to make changes.

businessLogic.xml

The functional aspect of this template is implemented in this XML file, directed by a flow responsible for aggregating data, comparing records, and finally formatting the output, in this case being a report.

Uses the Scatter-Gather component to query the data in different systems. After that the aggregation is implemented in DataWeave 2 script using Transform component. Aggregated results are sorted by source of existence:

1.Workers only in Workday
2.Users only in ServiceNow
3.Workers and Users in both Workday and ServiceNow

These are transformed to CSV format. The final report in CSV format is sent to email that you configured in mule.*.properties file.

endpoints.xml

This is the file where you will find the inbound side of your integration app. This Template has an HTTP Connector as the way to trigger the use case.

Trigger Flow

HTTP Listener Connector - Start Report Generation

• ${http.port} is a property to be defined either in a property file or in CloudHub environment variables.
• The path configured by default is generatereport and you are free to change for the one you prefer.
• The host name for all endpoints in your CloudHub configuration should be defined as localhost. CloudHub will then route requests from your application domain URL to the endpoint.

errorHandling.xml

This file handles how your integration reacts depending on the different exceptions. This file provides error handling that is referenced by the main flow in the business logic.