Skip to content

Commit 00ae57e

Browse files
Ellynnnsonglim327
authored andcommitted
refactor: update hrms documentation
1 parent c26f4fc commit 00ae57e

File tree

409 files changed

+1803
-1339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

409 files changed

+1803
-1339
lines changed

docs/integration/hrms/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"label": "HRMS",
3-
"position": 7,
2+
"label": "SQL HRMS",
3+
"position": 1,
44
"link": {
55
"type": "generated-index",
66
"description": "Human Resource Management System (HRMS) related topics"

docs/integration/hrms/autostart.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_position: 3
3+
title: Auto Start
4+
description: A guide to enable Auto Start (Android only)
5+
---
6+
7+
:::info
8+
This setting only available on **Android** devices that supports Auto Start
9+
:::
10+
11+
**Step:** Search **'SQL HRMS'** | Allow Auto Start
12+
13+
![autostart](../../../static/img/integration/hrms/autostart/autostart.png)
14+
15+
:::info
16+
Encouraged to enable **Autostart** for SQL HRMS to ensure E TMS and Announcement features work accordingly
17+
:::

docs/integration/hrms/e-claim.md

Lines changed: 0 additions & 174 deletions
This file was deleted.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "E Claim",
3+
"position": 7,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "A guide on E Claim features"
7+
}
8+
}
Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
sidebar_position: 2
3+
title: App Usage
4+
description: An E Claim features in SQL HRMS app guide
5+
---
6+
7+
## Dashboard
8+
9+
![dashboard](../../../../static/img/integration/hrms/e-claim/dashboard.png)
10+
11+
- **Claim Status Count Summary**:
12+
- User's total approved, pending and rejected claims in the current year
13+
- User can tap on each status to view claims with the respective status
14+
- **Claim Amount Summary**: User's total amount of pending and approved claims submitted in the current year
15+
- **Claim Balance Summary**: User’s pending and approved claims on each expenses types by month and by year
16+
17+
## Claim Submission
18+
**Step 1:**
19+
20+
**Default Claim:** Select expense type, claim date, amount and description
21+
22+
**E-Invoice Claim:** Select attachment that includes a **VALID** E-Invoice QR code
23+
- User can view the MTD limit, YTD limit and claim balance for each selected expenses type
24+
- For E-Invoice Claim, post date, ref 1 and ref 2 will be filled in based on the E-Invoice and are not editable
25+
- User need to allow Camera and Photos (only for iOS device) permission in order to continue the service (refer [Android Permission](../permission.md#android-2) and [iOS Permission](../permission.md#ios-2))
26+
27+
**Step 2:** Submit
28+
29+
![claim-submission](../../../../static/img/integration/hrms/e-claim/claim-submission.png)
30+
31+
#### Claim Submission Warning Dialog Box
32+
The app will help to do the following checkings after user click on the ***'Submit' button***:
33+
34+
1. **Exceed MTD Limit:** Prompts if total submitted amount (including previous submission) exceed the monthly limit of the expenses type
35+
36+
![exceed-mtd-limit](../../../../static/img/integration/hrms/e-claim/exceed-mtd-limit.png)
37+
38+
2. **Exceed YTD Limit:** Prompts if total submitted amount (including previous submission) exceed the yearly limit of the expenses type
39+
40+
![exceed-ytd-limit](../../../../static/img/integration/hrms/e-claim/exceed-ytd-limit.png)
41+
42+
:::info
43+
User can choose to change the claim details by submitting a new claim (***'Reapply' button***) or proceed with the current claim submission (***'Proceed' button***) if exceed monthly limit, but **NOT ALLOWED** to proceed the submission if exceed yearly limit
44+
:::
45+
46+
#### Claim Submission Sucessful
47+
The app will prompt this dialog message upon successful submission
48+
49+
1. Successful Dialog Box
50+
51+
![claim-successful-emp](../../../../static/img/integration/hrms/e-claim/claim-successful-emp.png)
52+
53+
2. App Notification (Manager side)clai
54+
55+
![claim-successful-app-noti](../../../../static/img/integration/hrms/e-claim/claim-successful-app-noti.png)
56+
57+
3. Email Notification (Manager side)
58+
59+
![claim-successful-email-noti](../../../../static/img/integration/hrms/e-claim/claim-successful-email-noti.png)
60+
61+
## Claim Status
62+
User can view all his claim transactions once enter this page
63+
64+
![claim-status](../../../../static/img/integration/hrms/e-claim/claim-status.png)
65+
66+
- User can apply filter and sorting order to view different claim transaction listing:
67+
- Filtering options:
68+
- Expenses type
69+
- Date range
70+
- Claim status
71+
- Sorting options:
72+
- Date
73+
- Expenses type
74+
- Claim Status
75+
- Type of claim status:
76+
77+
| **Icon** | **Claim Status** | **Remark** |
78+
| :------- | :--------------- | :--------- |
79+
| ![pending-approval-icon](../../../../static/img/integration/hrms/e-claim/pending-approval-icon.png) | Pending Approval | Status after normal employee applied a claim submission |
80+
| ![approved-icon](../../../../static/img/integration/hrms/e-claim/approved-icon.png) | Approved | Approved by manager from app and not synced to payroll system |
81+
| ![approved-sync-icon](../../../../static/img/integration/hrms/e-claim/approved-sync-icon.png) | Approved (Sync) | Synced and approved on payroll system |
82+
| ![rejected-icon](../../../../static/img/integration/hrms/e-claim/rejected-icon.png) | Rejected | Rejected from app / payroll system |
83+
| ![cancelled-icon](../../../../static/img/integration/hrms/e-claim/cancelled-icon.png) | Cancelled | Cancelled by user from app |
84+
85+
## Claim Transaction Detail
86+
87+
![claim-detail](../../../../static/img/integration/hrms/e-claim/claim-detail.png)
88+
89+
- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
90+
- ***'View Change Log' button***: View change log of the claim
91+
92+
## Team Claim (Manager only)
93+
Manager can view all claim transactions of his team once enter this page
94+
95+
![team-claim](../../../../static/img/integration/hrms/e-claim/team-claim.png)
96+
97+
- Manager can apply filter and sorting order to view different claim transaction listing:
98+
- Filtering options:
99+
- Expenses type
100+
- Date range
101+
- Claim Status
102+
- Branch
103+
- Department
104+
- Sorting options:
105+
- Date
106+
- Expenses type
107+
- Claim Status
108+
109+
### Claim Approval
110+
111+
![claim-approval](../../../../static/img/integration/hrms/e-claim/claim-approval.png)
112+
113+
- Managers can apply different actions on his team’s claim transaction based on the claim status
114+
| **Claim Status** | **Allowed Actions** |
115+
| :--------------- | :------------------ |
116+
| Pending Approval | Approve, Reject |
117+
| Approved | Undo Approved, Reject |
118+
| Approved (Sync) | - |
119+
| Rejected | Approve, Undo Rejected |
120+
| Cancelled | - |
121+
122+
- ***'View Change Log' button***: View change log of the claim
123+
124+
#### Claim Approval Warning Dialog Box
125+
The following checkings will be carried out when manager approving a claim:
126+
127+
1. **MTD Claim Over Limit:**
128+
- The app will prompt this dialog box if total approval amount (including previous claim transaction) already exceed the monthly limit of the expenses type
129+
- Manager can choose to cancel the claim approval (***'Back' button***) or proceed with the current claim approval (***'Proceed' button***)
130+
131+
![mtd-over-limit](../../../../static/img/integration/hrms/e-claim/mtd-over-limit.png)
132+
133+
2. **YTD Claim Over Limit:**
134+
- The app will prompt this dialog box if total approval amount (including previous claim transactions) already exceed the yearly limit of the expenses type
135+
- Manager is **NOT ALLOWED** to approve claim transaction that already exceed the year limit
136+
137+
![ytd-over-limit](../../../../static/img/integration/hrms/e-claim/ytd-over-limit.png)
138+
139+
#### Claim Comment Dialog Box
140+
Manager can enter a comment for the claim approval / claim status update (optional) before proceed the updates
141+
142+
![claim-comment-dialog](../../../../static/img/integration/hrms/e-claim/claim-comment-dialog.png)
143+
144+
#### Claim Status Update Successful
145+
The app will prompt a dialog message upon successful update on the claim status
146+
147+
![claim-status-update-successful](../../../../static/img/integration/hrms/e-claim/claim-status-update-successful.png)
148+
149+
### Notification
150+
#### Claim Approval
151+
User will receive the following notification once manager approves his claim:
152+
153+
1. App Notification
154+
155+
![claim-approval-app-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-app-noti.png)
156+
157+
2. Email Notification
158+
159+
![claim-approval-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-email-noti.png)
160+
161+
### Claim Approval Failed
162+
User will receive the following notification if manager failed to approve his claim (exceed year limit):
163+
164+
1. App Notification
165+
166+
![claim-approval-failed-app-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-failed-app-noti.png)
167+
168+
2. Email Notification
169+
170+
![claim-approval-failed-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-failed-email-noti.png)
171+
172+
### Claim Approval Rejected
173+
User will receive the following notification once manager rejects his leave:
174+
175+
1. App Notification
176+
177+
![claim-approval-rejected-app-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-rejected-app-noti.png)
178+
179+
2. Email Notification
180+
181+
![claim-approval-rejected-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-rejected-email-noti.png)
182+
183+
## Activity Center
184+
User can view his and his team’s (manager only) claim transaction updates from the Activity Center (Dashboard | Activity Center (Bell icon on top left))
185+
186+
![activity-center](../../../../static/img/integration/hrms/e-claim/activity-center.png)

0 commit comments

Comments
 (0)