Employee Onboarding Process API - Implementation Template
home
This template provides a foundation for designing of employee onboarding business process.
This template is a REST API implemented using APIkit and RAML definition. The API uses JSON as exchange format. Included are example requests and responses and incorporates the Employee System APIs, for storing Employees in multiple target systems.
Below are the endpoints that are implemented.
- POST /employees
This endpoint will start generation of the Employee onboarding process. The generation is done asynchronously using queue for requests. The process aggregates the ids of each system API response using a lookup process API. The lookup process API RAML you can find in main/resources/api/ directory. The lookup process API implementation of that RAML is client specific and should use persistent storage to preserve a mapping data. Responses are got from three source instances(Workday, Netsuite and Salesforce) using API Led Connectivity System APIs.
- GET /employees/{id}
This endpoint returns Employee ids aggregation identified by unique ID. If the process does not exist or has not been finished yet, the request ends up with "Resource not found" message.
- GET /queue/elements/{id}
This endpoint returns the status of the queued Employee onboarding process identified by unique ID. There are three states:
- In progress - status code 200 is returned, process has not finished yet
- Generated - status code 303 and the user is directly redirected to the Employee by id resource.
- Not found - status code 404, there is not Employee with specified ID
Look at the included self-descriptive RAML definition and the corresponding flows to learn more about the flows.
License Agreement
Note that using this template is subject to the conditions of this License Agreement.
Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.
Run it!
Simple steps to get API Led Connectivity Process API for Employees running.
Running on premise
In this section we detail the way you should run this template on your computer.
Where to Download Mule Studio and Mule ESB
First thing to know if you are a newcomer to Mule is where to get the tools.
Importing a template into Studio
Mule Studio offers several ways to import a project into the workspace, for instance:
- Anypoint Studio Project from File System
- Packaged mule application (.jar)
You can find a detailed description on how to do so in this Documentation Page.
Running on Studio
Once you have imported the template into Anypoint Studio you need to follow these steps to run it:
- Locate the properties file
mule.dev.properties, in src/main/resources - Complete all the properties required as per the examples in the section Properties to be configured
- Once that is done, right click on your template project folder
- Hover your mouse over
"Run as" - Click on
"Mule Application"
Running on Mule ESB stand alone
Complete all properties in one of the property files, for example in [mule.prod.properties] (../master/src/main/resources/mule.prod.properties) and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod.
Running on CloudHub
While creating your application on CloudHub (Or you can do it later as a next step), you need to go to Deployment > Advanced to set all environment variables detailed in Properties to be configured as well as the mule.env.
Deploying your template on CloudHub
Mule Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link
Properties to be configured (With examples)
In order to use this Mule template you need to configure properties (Credentials, configurations, etc.) either in properties file or in CloudHub as Environment Variables. Detail list with examples:
Application configuration
Common Configuration
- http.port
8081
APIs Configuration
- api.domain
your-destination-api.cloudhub.io:80 - api.basePath
/api - system.api.employee.nets.domain
your-destination-nets-system-api.cloudhub.io - system.api.employee.nets.http.port
9091 - system.api.employee.nets.basePath
/api1 - system.api.employee.nets.protocol
HTTPS - system.api.employee.wday.domain
your-destination-wday-system-api.cloudhub.io - system.api.employee.wday.http.port
9092 - system.api.employee.wday.basePath
/api2 - system.api.employee.wday.protocol
HTTPS - system.api.user.sfdc.domain
your-destination-sfdc-system-api.cloudhub.io - system.api.user.sfdc.http.port
9093 - system.api.user.sfdc.basePath
/api3 - system.api.user.sfdc.protocol
HTTPS - system.api.user.sfdc.profileId
1abda9823bbaaaaaa - process.api.employee.lookup.domain
your-lookup-process-api.cloudhub.io - process.api.employee.lookup.http.port
9094 - process.api.employee.lookup.basePath
/api4 - process.api.employee.lookup.protocol
HTTP
Customize It!
This brief guide intends to give an overview idea 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 will be organized by describing all the XML that conform the template.
Of course more files will be found such as Test Classes and Mule Application Files, but to keep it simple we will focus on the XMLs.
Here is a list of the main XML files you can find in this application:
global.xml
Configuration for Connectors and Properties Place Holders are also set in this file. Even though you can change the configuration here, all parameters that can be modified here are in properties file, and this is the recommended place to do it so. Of course if you want to do core changes to the logic you will need to modify this file.
In the visual editor they can be found on the Global Element.
process-api.xml
This file contains the routing logic of the API and the global exception strategies
implementation.xml
A functional aspect of this template implemented in this XML is to create Employees in parallel invoking multiple CRUD system APIs. You can customize and extend the logic of this template in this XML to more specifically meet your needs.