This extension facilitates a streamlined process for HR members known as Originators to formally request the employee's salary increase through group approval process.
It comprises code for a Experience Card and Page along with an associated EIP workflow designed to facilitate salary increase changes by Originators.
The Experience Card and Page enables Originators to specify the target employee and their desired salary packages, triggering the invocation of the EIP workflow.
The EIP workflow, in turn, executes the salary increase process using the information provided by the Originators through the Experience Page.
The experience card features a straightforward hyperlink leading to the Salary Increase Request Form.
The Salary Increase Request Form presents a comprehensive array of fields which Originators are required to full in order to retrieve pertinent employee information for initiating a salary increase change request.
Upon choosing the target employee, their basic information like Name, Position Title, Current Annual Salary, Compensation Type etc are displayed under the employee field like shown below
Once the employee information is prepared, we can begin by providing their salary package and the effective date for the new salary package to take effect.
Once the form is submitted, we'll be invoking the Ellucian Intelligent Processes Workflow.
The following JSON body is what we'll be submitting to EIP Workflow API ie, workflow-instances API. We have to configure the below mentioned API parameters under the variables key on EIP Start section.
Please refer the Start Parameters image under the EIP Workflow section.
{
"id": "a808968d-5245-4249-8563-a1700157ffa6",
"requestedFor": "13f2b1de-94d6-4651-99d5-4fc48dbfb21a",
"variables": {
"employeeName": {
"value": "Angel M. Ranger"
},
"positionTitle": {
"value": "Benefits Coordinator"
},
"compensationType": {
"value": "Salaried"
},
"positionCode": {
"value": "ZHRPR62001BECO"
},
"currentSalary": {
"value": "47100"
},
"proposedSalary": {
"value": "48500"
},
"effectiveDate": {
"value": "2024-10-01"
},
"personId": {
"value": "4aa78660-bd46-41b4-88e6-882d5f47a153"
},
"erpId": {
"value": "0017550"
},
"currency": {
"value": "USD"
},
"requestDate": {
"value": "2024-09-24"
}
}
}
Under the start section, we have configure all the above mentioned API variables under start parameters as follows.
This extension necessitated the utilization of both EEDM, BP APIs and couple of Spec APIs along with custom DataConnect Serverless APIs. The following is a compilation of the APIs employed in this context
Endpoint | API Type | API Version |
---|---|---|
persons | EEDM | 12.6.0 |
institution-jobs | EEDM | 12.0.0 |
institution-positions | EEDM | 12.0.0 |
employment-departments | EEDM | 12.1.0 |
person-positions-wages | Colleague Ethos Web APIs | 1.0.0 |
It is imperative to generate Dataconnect Serverless APIs for all specified APIs, excluding the workflow-instances
. Specifically, the post-person-positions-wages-salary-increase-request-colleague
API will utilize the Ethos Token
Authentication type, while all other APIs will employ the User Token
authentication method.
Kindly check the below documentation links for creating Serverless APIs and setting up authorizations permissions for the above mentioned authentication methods
For the documentation on workflow-instances
, kindly refer here.
Endpoint | API Type | Token Type | Description |
---|---|---|---|
get-persons-hr-salary-increase-request-colleague-poc | User Token | ||
get-persons-info-hr-salary-increase-request-colleague-poc | User Token | ||
post-person-positions-wages-salary-increase-request-colleague | Custom API | Ethos Token | This API updates the employee salary by calling institution-jobs API and captures the justification data to custom table |
For this extension, we have leveraged the following Path Design components to create a clean and minimal UI.
- Card
- Grid
- TextField
- Search
- Button
- Divider
- Dropdown
- Snackbar
- Skeleton
- DropdownItem
- SearchItem
- Typography
- DatePicker
- CircularProgress
- makeStyles
With Path Design System, you get to experience unparalleled cross-device compatibility, as this extension effortlessly adapts and shines with responsive design.
As the HR Salary Increase Request experience is exclusively accessible to users with the Originators role, direct utilization of authenticatedEthosFetch is not feasible, given that the majority of APIs are restricted to the experience-admin role. Consequently, we have developed all aforementioned APIs on Data Connect as serverless APIs, with the exception of the workflow-instances
API.
With the Path Design system's grids, our UI seamlessly adapts to whichever screen the user is viewing and provides a flawless user experience.
Copyright 2024 Ellucian Company L.P. and its affiliates.