Skip to content

Commit 31f1d3b

Browse files
jialin97songlim327
authored andcommitted
feat: add etms qr code guide
1 parent eda52be commit 31f1d3b

20 files changed

+108
-10
lines changed

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

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,26 @@ Enable **Autostart** for SQL HRMS to ensure E TMS features work accordingly (ref
1313
![dashboard](../../../../static/img/integration/hrms/e-tms/dashboard.png)
1414

1515
- **Session Card:** User's work session shift time
16+
- Icon on the top right corner (green box) indicates the clock method (by GPS or QR) of the day. If there is no icon displayed, it means that user is not required to clock for that day
1617
- It shows user's first Clock In and last Clock Out of the day with an estimated calculation of late in and early out
1718
- User can tap on the card to direct to User's Attendance Log
1819
- User can tap on the ***'Clock In' button*** to direct to Clock In / Clock Out page
19-
- If no work session is assigned, the button will be disabled
20+
- If no work session is assigned or no clock method is selected, the button will be disabled
2021
- **Upcoming Holiday:** User's upcoming public holidays
2122

2223

2324
## Clock In / Clock Out
2425

26+
### By GPS
27+
2528
| **Button** | **Explanation** |
2629
| :--------- | :-------------- |
2730
| ![clock-button1](../../../../static/img/integration/hrms/e-tms/clock-button1.png) | SQL HRMS app's Location service is unable to start. This may due to the following reasons: <br/><br/> 1. User's location service is not enabled <br/> 2. The required location permission is not allowed <br/><br/> Refer [Location Service and Permission](../permission.md#location) |
2831
| ![clock-button2](../../../../static/img/integration/hrms/e-tms/clock-button2.png) | SQL HRMS app is trying to get user's current location |
2932
| ![clock-button3](../../../../static/img/integration/hrms/e-tms/clock-button3.png) | User is not within work location. However, if user is really within their work location, SQL HRMS app will continuously try to get a more accurate position so that user will be able to Clock In / Clock Out |
3033
| ![clock-button4](../../../../static/img/integration/hrms/e-tms/clock-button4.png) | User's location is mocked and is not allowed to Clock In / Out |
31-
| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is within work location and is allowed to Clock In |
32-
| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is within work location and is allowed to Clock Out |
34+
| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is within work location and is allowed to Clock In |
35+
| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is within work location and is allowed to Clock Out |
3336

3437
**Clock In**
3538

@@ -66,16 +69,48 @@ If user forget to clock out, the app will reset the time tracking after 10 hours
6669
- An earn replacement leave application will be posted when employee clocked out
6770
- When employee tap the ***'Clock Out' button***, a **'Claim As Leave'** dialog will be prompt that allows the employee to pick the leave type that they want to claim
6871

69-
![clock-out7](../../../../static/img/integration/hrms/e-tms/clock-out7.png)
72+
![clock-out7](../../../../static/img/integration/hrms/e-tms/clock-out7.png)
73+
74+
### By QR
75+
76+
| **Button** | **Explanation** |
77+
| :--------- | :-------------- |
78+
| ![clock-button7](../../../../static/img/integration/hrms/e-tms/clock-button7.png) | SQL HRMS app's Bluetooth service is unable to start. This may due to the following reasons: <br/><br/> 1. User's Bluetooth service is not enabled <br/> 2. The required nearby devices permission is not allowed <br/><br/> Refer [Bluetooth Service and Nearby Devices Permission](../permission#nearby-devices--bluetooth) |
79+
| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is allowed to Clock In |
80+
| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is allowed to Clock Out |
81+
82+
**Clock In**
83+
84+
![clock-in3](../../../../static/img/integration/hrms/e-tms/clock-in3.png)
85+
86+
- **'Attachments'** field will not be available
87+
- Proceed to Clock In will generate a QR Code that will be scanned by SQL Clock In app
88+
- User can adjust the brightness of the screen with the slider
89+
- The QR Code will only be valid for 20s before user will need to regenerate a new QR Code
90+
91+
**Clock Out**
92+
93+
![clock-out8](../../../../static/img/integration/hrms/e-tms/clock-out8.png)
94+
95+
- If ***'Claim OT' switch*** is turned on, it will go through similar OT validations as *By GPS* before QR Code is generated
96+
97+
:::warning
98+
Screenshotting the QR Code is not allowed!
99+
:::
70100

71101
### Work Location
72102

73103
**Step:** Tap ***'View Work Location' label button***
74104

75105
![work-location](../../../../static/img/integration/hrms/e-tms/work-location.png)
76106

107+
- **Purple Location icon:** Employee's current location
77108
- **Green Check icon:** Location that the employee is currently in
78109

110+
:::info
111+
Multiple work locations with the same coordinate will be considered as one
112+
:::
113+
79114
## Work Session Calendar
80115

81116
### My Work Session
@@ -86,7 +121,8 @@ User can view his own work session in calendar view
86121

87122
- **Red font with purple box:** Public Holiday
88123
- **Purple box:** Rest Day
89-
- **Location icon:** Direct to Work Location page to view locations where the user is allowed to clock in / clock out on that day (refer [Work Location](#work-location))
124+
- **Icon (bottom right corner):** Clock Method
125+
- **Whole card:** Direct to [Work Location](#work-location) page to view locations where the user is allowed to clock in / clock out on that day
90126

91127
### Team Work Session
92128

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

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,24 @@ Option 2: Click on ***'P' button*** | Select date
6666
**Step 3:** Enter Break Time
6767
- May add up to 3 break times
6868

69-
**Step 4:** Select Rules
70-
- ***'Clock In / Clock Out' checkbox:*** Requires to clock in / out in SQL HRMS app
71-
- ***'GPS Monitoring' checkbox:*** Post status update if employee left work location
69+
**Step 4:** Select a Clock Method
70+
- ***'GPS' checkbox:*** Clock in / out using employee's location in SQL HRMS app
71+
- ***'QR' checkbox:*** Clock in / out using QR Code generated from SQL HRMS app and scan it on SQL Clock In app
72+
73+
:::info
74+
1. 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.
75+
2. Clock Method on days without work session, public holiday and rest day is by default **GPS**.
76+
:::
77+
78+
**Step 5:** Select Rules
79+
- ***'GPS Monitoring' checkbox:*** Post status update if employee left work location
7280
- ***'Site Photo' checkbox:*** Requires to take photo before clock in / out (User cannot upload picture from album)
7381

74-
**Step 5:** Save
82+
:::info
83+
***'GPS Monitoring'*** and ***'Site Photo'*** will be disabled if ***'QR'*** or ***no clock method*** is selected
84+
:::
85+
86+
**Step 6:** Save
7587

7688
**Optional**
7789
- User may select ***'Leave Rules'*** if applicable

docs/integration/hrms/permission.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,54 @@ If you have disabled this feature previously, you can skip all of the following
146146

147147
**Step 2:** Select ***'Allow Full Access'***
148148

149-
![ios-photo3](../../../static/img/integration/hrms/permission/ios-photo3.png)
149+
![ios-photo3](../../../static/img/integration/hrms/permission/ios-photo3.png)
150+
151+
## Nearby Devices / Bluetooth
152+
153+
### Android
154+
155+
**From SQL HRMS app**
156+
157+
:::info
158+
For **Android 11 and below**, may skip to Step 2
159+
:::
160+
161+
**Step 1:** Select ***'Allow'***
162+
163+
![android-bluetooth1](../../../static/img/integration/hrms/permission/android-bluetooth1.png)
164+
165+
**Step 2:** Turn on ***Bluetooth service***
166+
167+
![android-bluetooth2](../../../static/img/integration/hrms/permission/android-bluetooth2.png)
168+
169+
**From Device Settings**
170+
171+
:::info
172+
Only for **Android 12 and above**
173+
:::
174+
175+
**Step:** App Info | App permissions | Nearby devices | Select ***'Allow'***
176+
177+
![android-bluetooth3](../../../static/img/integration/hrms/permission/android-bluetooth3.png)
178+
179+
### iOS
180+
181+
**From SQL HRMS app**
182+
183+
**Step 1:** Select ***'Allow'***
184+
185+
![ios-bluetooth1](../../../static/img/integration/hrms/permission/ios-bluetooth1.png)
186+
187+
**Step 2:** Select ***'Settings'*** | Toggle ***'Bluetooth'*** on | Return to SQL HRMS
188+
189+
![ios-bluetooth2](../../../static/img/integration/hrms/permission/ios-bluetooth2.png)
190+
191+
**From Device Settings**
192+
193+
**Step 1:** Settings | Search for ***'SQL HRMS'*** | Toggle ***'Bluetooth'*** on
194+
195+
![ios-bluetooth3](../../../static/img/integration/hrms/permission/ios-bluetooth3.png)
196+
197+
**Step 2:** Settings | Bluetooth | Toggle ***'Bluetooth'*** on
198+
199+
![ios-bluetooth4](../../../static/img/integration/hrms/permission/ios-bluetooth4.png)
-17.2 KB
Loading
139 KB
Loading
192 KB
Loading
1.76 MB
Loading
1.83 MB
Loading
1.11 MB
Loading
10.3 KB
Loading

0 commit comments

Comments
 (0)