Skip to content

Commit 8eae845

Browse files
committed
refactor: hrms documentation
1 parent 407e98e commit 8eae845

29 files changed

Lines changed: 40 additions & 52 deletions

docs/integration/hrms/e-claim/app-usage.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,13 @@ Prorated year claim limit will be applied to user whose Join Year = Current Year
2525
| Claim | Description |
2626
| ------------------- | ------------------------------------------------------------- |
2727
| **Default Claim** | Select expense type, claim date, amount and description |
28+
| **Receipt Scan** | Select attachment of a receipt |
2829
| **E-Invoice Claim** | Select attachment that includes a **VALID** E-Invoice QR code |
2930

3031
- User can view the MTD limit, YTD limit and claim balance for each selected expenses type
32+
- For Receipt Scan,
33+
- Rescan: Resubmit attachment for reanalyzing if the scan result is incorrect
34+
- Refresh Status: Refresh scan status after attachment is uploaded if scanning is still in progress
3135
- For E-Invoice Claim, post date, ref 1 and ref 2 will be filled in based on the E-Invoice and are not editable
3236
- 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))
3337

docs/integration/hrms/e-leave/app-usage.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,13 @@ apply
3535
![leave-app-employee](../../../../static/img/integration/hrms/e-leave/leave-app-employee.png)
3636

3737
1. Select leave duration type: Full Day, Half Day, Custom Time
38-
2. Select leave date, leave time, leave type, description - User can view year balance and leave taken for the selected leave type - **_'I'm taking leave' checkbox_** : - Checked: Normal leave application - Unchecked: Apply leave as OT replacement - User need to allow Camera and Photos (only for iOS device) permission to continue the service (refer [Android Permission](../permission.md#android-2) and [iOS Permission](../permission.md#ios-2))
38+
2. Select leave date, leave time, leave type, description
39+
- User can view leave type advanced period, year balance and leave taken for the selected leave type
40+
- Advanced Period: Hours in advanced employee must apply for leave before it starts
41+
- **_'I'm taking leave' checkbox_** :
42+
- Checked: Normal leave application
43+
- Unchecked: Apply leave as OT replacement
44+
- User need to allow Camera and Photos (only for iOS device) permission to continue the service (refer [Android Permission](../permission.md#android-2) and [iOS Permission](../permission.md#ios-2))
3945
3. Submit
4046

4147
:::info
@@ -212,7 +218,7 @@ Batch Leave Approval will undergo the same checkings as Leave Approval and warni
212218

213219
### Leave Approval Notification
214220

215-
#### Leave Approval Notify Message
221+
#### Leave Approved
216222

217223
User will receive the following notification once manager approves his leave:
218224

@@ -226,16 +232,9 @@ User will receive the following notification once manager approves his leave:
226232

227233
#### Leave Approval Failed
228234

229-
User will receive the following notification if manager fails to approve his leave (exceed year limit):
230-
231-
1. App Notification
232-
235+
User will receive an app notification if manager fails to approve his leave (exceed year limit):
233236
![leave-approval-failed-app-noti](../../../../static/img/integration/hrms/e-leave/leave-approval-failed-app-noti.png)
234237

235-
2. Email Notification
236-
237-
![leave-approval-failed-email-noti](../../../../static/img/integration/hrms/e-leave/leave-approval-failed-email-noti.png)
238-
239238
#### Leave Rejected
240239

241240
User will receive the following notification once manager rejects his leave:

docs/integration/hrms/e-tms/app-usage.md

Lines changed: 11 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ Shows the employee's OT entitlement
181181

182182
- User can view his own time attendance summary
183183
- User can tap on the card to direct to [**Attendance Log**](#log) to view detailed summary
184+
- Last processed summary date will be displayed at the bottom
184185

185186
### Team Summary
186187

@@ -196,13 +197,15 @@ Shows the employee's OT entitlement
196197
- No Out
197198
- OT
198199
- Leave
200+
- Last processed summary date will be displayed at the bottom
199201

200202
### Clock On Behalf (Manager only)
201203

202204
Managers are allowed to clock in on behalf for his team by tapping on the **_'Clock on Behalf' button_**
203205

204206
![clock-on-behalf1](../../../../static/img/integration/hrms/e-tms/clock-on-behalf1.png)
205207

208+
- The **_'Clock on Behalf' button_** will only be visible on dates after the last summary processed date until today
206209
- After choosing an employee, the manager is directed to the [**Attendance Log**](#log) where a Right Arrow icon on each log and a **_'Clock In' button_** is visible
207210
- Tap on the Right Arrow icon to direct to Attendance Log Detail
208211

@@ -266,47 +269,19 @@ The notification will appear after employee clocked in and has **_'GPS Monitorin
266269

267270
### Clock On Behalf
268271

269-
- The manager themselves and other managers managing the same employee will receive the following notifications once they clock on behalf for an employee
272+
- The manager themselves and other managers managing the same employee will receive an app notification once they clock on behalf for an employee
273+
![clock-on-behalf-notification1](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification1.png)
270274

271-
- App Notification
272-
273-
![clock-on-behalf-notification1](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification1.png)
274-
275-
- Email Notification
276-
277-
![clock-on-behalf-notification2](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification2.png)
278-
279-
- The employee will receive the following notifications once their manager clock on behalf for them
280-
281-
- App Notification
282-
283-
![clock-on-behalf-notification3](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification3.png)
284-
285-
- Email Notification
286-
287-
![clock-on-behalf-notification4](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification4.png)
275+
- The employee will receive an app notification once their manager clock on behalf for them
276+
![clock-on-behalf-notification2](../../../../static/img/integration/hrms/e-tms/clock-on-behalf-notification2.png)
288277

289278
### Adjusted Attendance Log
290279

291-
- The manager themselves and other managers managing the same employee will receive the following notifications once they adjusted an employee's attendance log
292-
293-
- App Notification
294-
295-
![adjusted-log-notification1](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification1.png)
296-
297-
- Email Notification
298-
299-
![adjusted-log-notification2](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification2.png)
300-
301-
- The employee will receive the following notifications once their manager adjusted their attendance log
302-
303-
- App Notification
304-
305-
![adjusted-log-notification3](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification3.png)
306-
307-
- Email Notification
280+
- The manager themselves and other managers managing the same employee will receive an app notification once they adjusted an employee's attendance log
281+
![adjusted-log-notification1](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification1.png)
308282

309-
![adjusted-log-notification4](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification4.png)
283+
- The employee will receive an app notification once their manager adjusted their attendance log
284+
![adjusted-log-notification2](../../../../static/img/integration/hrms/e-tms/adjusted-log-notification2.png)
310285

311286
### Employee login from a different device
312287

docs/integration/hrms/e-tms/payroll-setup.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ For more Public Holiday options, user may click on the **_'≣'_** on the grid t
8787
:::info
8888

8989
- Only one clock method can be selected. However, if none of the clock method is selected, then the clock in / out button in SQL HRMS app will be disabled and employee does not require to clock in / out.
90-
- Clock Method on days without work session, public holiday and rest day is by default **GPS**.
90+
- Clock Method on days without work session, public holiday and rest day is by default **GPS**. User may update to their desire clock method in [Maintain Calendar](#maintain-calendar).
9191

9292
:::
9393

@@ -184,12 +184,13 @@ Make sure that the work session is set based on the time zone maintained in Comp
184184
- **Black font:** Work Day with Session
185185
- **Grey font:** No schedule is assigned
186186

187-
**Set Work Session:**
187+
**Set Work Session / Clock Method:**
188188

189-
- User may click on **_'R' button_** or **_'W' button_** and select date from calendar
189+
- User may click on **_'R' button_**, **_'W' button_** or **_'M' button_** and select date from calendar
190190
- Use **_'C' button_** to clear Work Session/Rest Day
191191
- Alternatively, user may use **_'Clear All' button_** to clear all Rest Day and Work Session within the date range
192-
- User cannot assign work sessions or change work sessions on dates before summary last processed date
192+
- Note that clock method will also be reset back to **'GPS'**
193+
- User cannot assign work sessions, change work sessions or change clock method on dates before summary last processed date
193194
- On days without work session assigned, no summary will be processed unless there are clock in/clock out logs on that day
194195

195196
### Wizard
@@ -230,7 +231,15 @@ Make sure that the work session is set based on the time zone maintained in Comp
230231
| By Weeks | Assign to every selected day of every selected weeks of the year |
231232
| Custom | Assign to selected dates |
232233

233-
5. Process
234+
5. Next, select a Clock Method
235+
236+
![calendar-wizard3](../../../../static/img/integration/hrms/e-tms/calendar-wizard3.png)
237+
238+
- Selected clock method will only be assigned to Rest Day, Public Holiday and Work Day without session on allowable dates within the selected date range
239+
240+
6. Select a date range
241+
242+
7. Process
234243

235244
:::warning
236245
User cannot assign work sessions or change work sessions on dates before summary last processed date
@@ -259,7 +268,8 @@ Date From need to be after summary last processed date to future dates (dates be
259268
**Explanation:** Delete all schedule (Work Session and Rest Day) of Employee 00006 from 20/5/2024 to 31/12/2024
260269

261270
:::info
262-
Date From need to be after summary last processed date to future dates (dates before summary last processed date are not allowed to delete)
271+
1. Date From need to be after summary last processed date to future dates (dates before summary last processed date are not allowed to delete)
272+
2. When schedule is cleared, clock method will be reset back to **'GPS'**
263273
:::
264274

265275
## Maintain Traveller Location
-166 KB
Loading
-167 KB
Loading
8.83 KB
Loading
728 KB
Loading
30.1 KB
Loading
403 KB
Loading

0 commit comments

Comments
 (0)