Skip to content

Commit f4caba3

Browse files
Ellynnnsonglim327
authored andcommitted
feat: add clock in documentation
1 parent 31f1d3b commit f4caba3

25 files changed

+158
-1
lines changed

docs/integration/clock-in.md

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# SQL Clock In
6+
7+
Time Attendance QR Code related guidelines
8+
9+
:::info
10+
To setup Time Attendance QR Code, may refer to [Time Attendance Payroll Setup](hrms/e-tms/payroll-setup)
11+
:::
12+
13+
## Login
14+
15+
### Login
16+
17+
:::info[IMPORTANT]
18+
Only **Managers** are able to log into this app
19+
:::
20+
21+
**Step 1:** Enter email | Next
22+
23+
![login1](../../static/img/integration/clock-in/login1.png)
24+
25+
**Step 2:** Enter OTP sent to your email | Login
26+
27+
![login2](../../static/img/integration/clock-in/login2.png)
28+
29+
**Step 3:** Select a company and branch
30+
31+
![login3](../../static/img/integration/clock-in/login3.png)
32+
33+
### Try Demo Account
34+
35+
User may try out the app as manager
36+
37+
**Step 1:** Start Exploring
38+
39+
![try-live-demo1](../../static/img/integration/clock-in/try-live-demo1.png)
40+
41+
**Step 2:** Testing Company (Demo Data) | Select a Branch
42+
43+
![try-live-demo2](../../static/img/integration/clock-in/try-live-demo2.png)
44+
45+
- **Logout icon (top right):** Logout from SQL Clock In app
46+
47+
## Permission
48+
49+
### Camera
50+
51+
**From SQL Clock In app**
52+
53+
**Step:** Select ***'While using the app'***
54+
55+
![permission-camera1](../../static/img/integration/clock-in/permission-camera1.png)
56+
57+
**From Device Settings**
58+
59+
**Step:** App Info | App permissions | Camera | Select ***'Allow only while using the app'***
60+
61+
![permission-camera2](../../static/img/integration/clock-in/permission-camera2.png)
62+
63+
### Nearby Devices (Bluetooth)
64+
65+
**From SQL Clock In app**
66+
67+
:::info
68+
For **Android 11 and below**, may skip to Step 2
69+
:::
70+
71+
**Step 1:** Select ***'Allow'***
72+
73+
![permission-bluetooth1](../../static/img/integration/clock-in/permission-bluetooth1.png)
74+
75+
**Step 2:** Turn on Bluetooth Service
76+
77+
![permission-bluetooth2](../../static/img/integration/clock-in/permission-bluetooth2.png)
78+
79+
**From Device Settings**
80+
81+
:::info
82+
Only for **Android 12 and above**
83+
:::
84+
85+
**Step:** App Info | App permissions | Nearby devices | Select ***'Allow'***
86+
87+
![permission-bluetooth3](../../static/img/integration/clock-in/permission-bluetooth3.png)
88+
89+
### Location
90+
91+
**From SQL Clock In App**
92+
93+
:::info
94+
For **Android 12 and above**, may skip to Step 2
95+
:::
96+
97+
**Step 1:** Select ***'While using the app'***
98+
99+
![permission-location1](../../static/img/integration/clock-in/permission-location1.png)
100+
101+
**Step 2:** Turn on Location Service
102+
103+
![permission-location2](../../static/img/integration/clock-in/permission-location2.png)
104+
105+
**From Device Settings**
106+
107+
:::info
108+
Only for **Android 11 and below**
109+
:::
110+
111+
**Step:** App Info | Permissions | Location | Select ***'Allow only while using the app'***
112+
113+
![permission-location3](../../static/img/integration/clock-in/permission-location3.png)
114+
115+
## Dashboard
116+
117+
![dashboard](../../static/img/integration/clock-in/dashboard.png)
118+
119+
- ***'Clock In / Out'* button:** Navigate to [QR Scanner](#qr-scanner)
120+
- **Gear icon (top right):** Navigate to [Settings](#settings)
121+
- **Logout icon (top right):** Logout from SQL Clock In app
122+
123+
## QR Scanner
124+
125+
For employees to scan the QR Code generated from SQL HRMS app to clock in / out
126+
127+
![qr-scanner](../../static/img/integration/clock-in/qr-scanner.png)
128+
129+
- The scanner will sleep after a duration of inactivity
130+
- The scanner will wake up when there's motion detected
131+
- The duration of inactivity and motion detection sensitivity can be adjusted in the [settings](#settings)
132+
- ***Error icon*** at the top right corner will only appear when there are issues
133+
- Tap on the icon to view what are the issues (only those with issues will appear)
134+
135+
| **Issue** | **Explanation** |
136+
| :--------- | :-------------- |
137+
| Wifi is not detected | Make sure that the scanner is connected to wifi |
138+
| Bluetooth is not found | Make sure that the scanner's Bluetooth service is turned on and Nearby devices permission is allowed <br/><br/> Refer [bluetooth service and nearby devices permission](hrms/permission/#nearby-devices--bluetooth) |
139+
| Location is not detected | Make sure that the scanner's Location service is turned on and permission is allowed <br/><br/> Refer [location service and permission](#location) |
140+
141+
| **Dialog Message** | **Explanation** |
142+
| :----------------- | :-------------- |
143+
| ![dialog1](../../static/img/integration/clock-in/dialog1.png) | Employee scanned an invalid QR Code that is not generated from SQL HRMS app |
144+
| ![dialog2](../../static/img/integration/clock-in/dialog2.png) | Employee scanned an expired QR Code |
145+
| ![dialog3](../../static/img/integration/clock-in/dialog3.png) | Employee generated the QR Code under a different company and is not allowed to clock in / out |
146+
| ![dialog4](../../static/img/integration/clock-in/dialog4.png) | Employee is under a different branch and is not allowed to clock in / out |
147+
| ![dialog5](../../static/img/integration/clock-in/dialog5.png) | 1. Employee's Bluetooth service is not turned on <br/> 2. Employee's required *Nearby Devices* permission is not allowed <br/> 3. Employee is not near the scanner <br/> 3. Scanner's Bluetooth service or Location service is not turned on <br/> 4. Scanner's required *Nearby Devices* or *Location* permission is not allowed <br/><br/> For SQL HRMS, refer [bluetooth service and nearby devices permission](hrms/permission/#nearby-devices--bluetooth) <br/> For SQL Clock In, refer [location service and permission](#location) and [bluetooth service and nearby devices permission](#nearby-devices-bluetooth) |
148+
| ![dialog6](../../static/img/integration/clock-in/dialog6.png) | Employee has successfully clocked in |
149+
| ![dialog7](../../static/img/integration/clock-in/dialog7.png) | Employee has successfully clocked out |
150+
151+
## Settings
152+
153+
![setting](../../static/img/integration/clock-in/settings.png)
154+
155+
- **Camera View:** User can switch the default direction of the QR Scanner camera
156+
- **Screen Off:** User can adjust how long (1 to 30 mins) of inactivity is allowed before the scanner sleeps
157+
- **Screen Wake Sensitivity:** User can adjust how sensitive they want their scanner to wake up from motion detection after scanner is asleep

docs/integration/hrms/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "SQL HRMS",
3-
"position": 1,
3+
"position": 2,
44
"link": {
55
"type": "generated-index",
66
"description": "Human Resource Management System (HRMS) related topics"
505 KB
Loading
455 KB
Loading
440 KB
Loading
227 KB
Loading
418 KB
Loading
340 KB
Loading
364 KB
Loading
380 KB
Loading

0 commit comments

Comments
 (0)