feat: add qr code clock method documentation

docs/integration/clock-in.md

@@ -0,0 +1,157 @@
+---
+sidebar_position: 1
+---
+
+# SQL Clock In  
+
+Time Attendance QR Code related guidelines  
+
+:::info
+To setup Time Attendance QR Code, may refer to [Time Attendance Payroll Setup](hrms/e-tms/payroll-setup)
+:::
+
+## Login
+
+### Login
+
+:::info[IMPORTANT]
+Only **Managers** are able to log into this app
+:::
+
+**Step 1:** Enter email | Next  
+
+    ![login1](../../static/img/integration/clock-in/login1.png)
+
+**Step 2:** Enter OTP sent to your email | Login  
+
+    ![login2](../../static/img/integration/clock-in/login2.png)
+
+**Step 3:** Select a company and branch  
+
+    ![login3](../../static/img/integration/clock-in/login3.png)
+
+### Try Demo Account 
+
+User may try out the app as manager  
+
+**Step 1:** Start Exploring
+
+    ![try-live-demo1](../../static/img/integration/clock-in/try-live-demo1.png)
+
+**Step 2:** Testing Company (Demo Data) | Select a Branch  
+
+    ![try-live-demo2](../../static/img/integration/clock-in/try-live-demo2.png)
+
+    - **Logout icon (top right):** Logout from SQL Clock In app  
+
+## Permission  
+
+### Camera  
+
+**From SQL Clock In app**  
+
+**Step:** Select ***'While using the app'***  
+
+    ![permission-camera1](../../static/img/integration/clock-in/permission-camera1.png)
+
+**From Device Settings**  
+
+**Step:** App Info | App permissions | Camera | Select ***'Allow only while using the app'***  
+
+    ![permission-camera2](../../static/img/integration/clock-in/permission-camera2.png)  
+
+### Nearby Devices (Bluetooth)  
+
+**From SQL Clock In app**  
+
+:::info
+For **Android 11 and below**, may skip to Step 2
+:::
+
+**Step 1:** Select ***'Allow'***   
+
+    ![permission-bluetooth1](../../static/img/integration/clock-in/permission-bluetooth1.png)  
+
+**Step 2:** Turn on Bluetooth Service
+
+    ![permission-bluetooth2](../../static/img/integration/clock-in/permission-bluetooth2.png)  
+
+**From Device Settings**  
+
+:::info
+Only for **Android 12 and above**
+:::
+
+**Step:** App Info | App permissions | Nearby devices | Select ***'Allow'***  
+
+    ![permission-bluetooth3](../../static/img/integration/clock-in/permission-bluetooth3.png)  
+
+### Location
+
+**From SQL Clock In App**  
+
+:::info
+For **Android 12 and above**, may skip to Step 2
+:::
+
+**Step 1:** Select ***'While using the app'***  
+
+    ![permission-location1](../../static/img/integration/clock-in/permission-location1.png)  
+
+**Step 2:** Turn on Location Service  
+
+    ![permission-location2](../../static/img/integration/clock-in/permission-location2.png)  
+
+**From Device Settings**  
+
+:::info
+Only for **Android 11 and below**
+:::
+
+**Step:** App Info | Permissions | Location | Select ***'Allow only while using the app'***   
+
+    ![permission-location3](../../static/img/integration/clock-in/permission-location3.png)  
+
+## Dashboard  
+
+    ![dashboard](../../static/img/integration/clock-in/dashboard.png)
+
+    - ***'Clock In / Out'* button:** Navigate to [QR Scanner](#qr-scanner) 
+    - **Gear icon (top right):** Navigate to [Settings](#settings)   
+    - **Logout icon (top right):** Logout from SQL Clock In app  
+
+## QR Scanner  
+
+For employees to scan the QR Code generated from SQL HRMS app to clock in / out  
+
+    ![qr-scanner](../../static/img/integration/clock-in/qr-scanner.png)
+
+    - The scanner will sleep after a duration of inactivity
+    - The scanner will wake up when there's motion detected
+    - The duration of inactivity and motion detection sensitivity can be adjusted in the [settings](#settings)  
+    - ***Error icon*** at the top right corner will only appear when there are issues  
+      - Tap on the icon to view what are the issues (only those with issues will appear)
+
+| **Issue** | **Explanation** |  
+| :--------- | :-------------- |  
+| Wifi is not detected | Make sure that the scanner is connected to wifi |  
+| 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) |  
+| 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) |  
+
+| **Dialog Message** | **Explanation** |  
+| :----------------- | :-------------- |  
+| ![dialog1](../../static/img/integration/clock-in/dialog1.png) | Employee scanned an invalid QR Code that is not generated from SQL HRMS app |  
+| ![dialog2](../../static/img/integration/clock-in/dialog2.png) | Employee scanned an expired QR Code |  
+| ![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 |  
+| ![dialog4](../../static/img/integration/clock-in/dialog4.png) | Employee is under a different branch and is not allowed to clock in / out |  
+| ![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) |  
+| ![dialog6](../../static/img/integration/clock-in/dialog6.png) | Employee has successfully clocked in |  
+| ![dialog7](../../static/img/integration/clock-in/dialog7.png) | Employee has successfully clocked out |  
+
+## Settings
+
+    ![setting](../../static/img/integration/clock-in/settings.png)
+
+    - **Camera View:** User can switch the default direction of the QR Scanner camera  
+    - **Screen Off:** User can adjust how long (1 to 30 mins) of inactivity is allowed before the scanner sleeps  
+    - **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

@@ -1,6 +1,6 @@
 {
   "label": "SQL HRMS",
-  "position": 1,
+  "position": 2,
   "link": {
     "type": "generated-index",
     "description": "Human Resource Management System (HRMS) related topics"

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

@@ -13,23 +13,26 @@ Enable **Autostart** for SQL HRMS to ensure E TMS features work accordingly (ref
     ![dashboard](../../../../static/img/integration/hrms/e-tms/dashboard.png)  
 
 - **Session Card:** User's work session shift time
+    - 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  
     - It shows user's first Clock In and last Clock Out of the day with an estimated calculation of late in and early out
     - User can tap on the card to direct to User's Attendance Log
     - User can tap on the ***'Clock In' button*** to direct to Clock In / Clock Out page
-        - If no work session is assigned, the button will be disabled  
+        - If no work session is assigned or no clock method is selected, the button will be disabled  
 - **Upcoming Holiday:** User's upcoming public holidays
 
 
 ## Clock In / Clock Out
 
+### By GPS
+
 | **Button** | **Explanation** |
 | :--------- | :-------------- |
 | ![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) |  
 | ![clock-button2](../../../../static/img/integration/hrms/e-tms/clock-button2.png) | SQL HRMS app is trying to get user's current location | 
 | ![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 | 
 | ![clock-button4](../../../../static/img/integration/hrms/e-tms/clock-button4.png) | User's location is mocked and is not allowed to Clock In / Out | 
-| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is within work location and is allowed to Clock In | 
-| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is within work location and is allowed to Clock Out | 
+| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is within work location and is allowed to Clock In |  
+| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is within work location and is allowed to Clock Out |  
 
 **Clock In**  
 
@@ -66,16 +69,48 @@ If user forget to clock out, the app will reset the time tracking after 10 hours
     - An earn replacement leave application will be posted when employee clocked out
     - 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
 
-    ![clock-out7](../../../../static/img/integration/hrms/e-tms/clock-out7.png)
+    ![clock-out7](../../../../static/img/integration/hrms/e-tms/clock-out7.png)  
+
+### By QR  
+
+| **Button** | **Explanation** |  
+| :--------- | :-------------- |  
+| ![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) |  
+| ![clock-button5](../../../../static/img/integration/hrms/e-tms/clock-button5.png) | User is allowed to Clock In |  
+| ![clock-button6](../../../../static/img/integration/hrms/e-tms/clock-button6.png) | User is allowed to Clock Out |  
+
+**Clock In**  
+
+    ![clock-in3](../../../../static/img/integration/hrms/e-tms/clock-in3.png)  
+
+- **'Attachments'** field will not be available  
+- Proceed to Clock In will generate a QR Code that will be scanned by SQL Clock In app  
+    - User can adjust the brightness of the screen with the slider  
+    - The QR Code will only be valid for 20s before user will need to regenerate a new QR Code  
+
+**Clock Out**  
+
+    ![clock-out8](../../../../static/img/integration/hrms/e-tms/clock-out8.png)  
+
+- If ***'Claim OT' switch*** is turned on, it will go through similar OT validations as *By GPS* before QR Code is generated  
+
+:::warning
+Screenshotting the QR Code is not allowed!
+:::
 
 ### Work Location
 
 **Step:** Tap ***'View Work Location' label button***  
 
     ![work-location](../../../../static/img/integration/hrms/e-tms/work-location.png)  
 
+- **Purple Location icon:** Employee's current location
 - **Green Check icon:** Location that the employee is currently in
 
+:::info
+Multiple work locations with the same coordinate will be considered as one
+:::
+
 ## Work Session Calendar
 
 ### My Work Session
@@ -86,7 +121,8 @@ User can view his own work session in calendar view
 
 - **Red font with purple box:** Public Holiday
 - **Purple box:** Rest Day
-- **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))
+- **Icon (bottom right corner):** Clock Method
+- **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
 
 ### Team Work Session
 

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

@@ -66,12 +66,24 @@ Option 2: Click on ***'P' button*** | Select date
 **Step 3:** Enter Break Time
 - May add up to 3 break times
 
-**Step 4:** Select Rules  
-- ***'Clock In / Clock Out' checkbox:*** Requires to clock in / out in SQL HRMS app
-- ***'GPS Monitoring' checkbox:*** Post status update if employee left work location
+**Step 4:** Select a Clock Method
+- ***'GPS' checkbox:*** Clock in / out using employee's location in SQL HRMS app
+- ***'QR' checkbox:*** Clock in / out using QR Code generated from SQL HRMS app and scan it on SQL Clock In app
+
+:::info
+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.
+2. Clock Method on days without work session, public holiday and rest day is by default **GPS**.
+:::
+
+**Step 5:** Select Rules  
+- ***'GPS Monitoring' checkbox:*** Post status update if employee left work location 
 - ***'Site Photo' checkbox:*** Requires to take photo before clock in / out (User cannot upload picture from album)
 
-**Step 5:** Save
+:::info
+***'GPS Monitoring'*** and ***'Site Photo'*** will be disabled if ***'QR'*** or ***no clock method*** is selected
+:::
+
+**Step 6:** Save  
 
 **Optional**
 - User may select ***'Leave Rules'*** if applicable

docs/integration/hrms/permission.md

@@ -146,4 +146,54 @@ If you have disabled this feature previously, you can skip all of the following
 
 **Step 2:** Select ***'Allow Full Access'***  
 
-    ![ios-photo3](../../../static/img/integration/hrms/permission/ios-photo3.png)  
+    ![ios-photo3](../../../static/img/integration/hrms/permission/ios-photo3.png)
+
+## Nearby Devices / Bluetooth
+
+### Android  
+
+**From SQL HRMS app**  
+
+:::info
+For **Android 11 and below**, may skip to Step 2  
+:::
+
+**Step 1:** Select ***'Allow'***   
+
+    ![android-bluetooth1](../../../static/img/integration/hrms/permission/android-bluetooth1.png)
+
+**Step 2:** Turn on ***Bluetooth service***  
+
+    ![android-bluetooth2](../../../static/img/integration/hrms/permission/android-bluetooth2.png)
+
+**From Device Settings**  
+
+:::info
+Only for **Android 12 and above**  
+:::
+
+**Step:** App Info | App permissions | Nearby devices | Select ***'Allow'***  
+
+    ![android-bluetooth3](../../../static/img/integration/hrms/permission/android-bluetooth3.png)  
+
+### iOS
+
+**From SQL HRMS app**  
+
+**Step 1:** Select ***'Allow'***  
+
+    ![ios-bluetooth1](../../../static/img/integration/hrms/permission/ios-bluetooth1.png)  
+
+**Step 2:** Select ***'Settings'*** | Toggle ***'Bluetooth'*** on | Return to SQL HRMS   
+
+    ![ios-bluetooth2](../../../static/img/integration/hrms/permission/ios-bluetooth2.png)  
+
+**From Device Settings**  
+
+**Step 1:** Settings | Search for ***'SQL HRMS'*** | Toggle ***'Bluetooth'*** on  
+
+    ![ios-bluetooth3](../../../static/img/integration/hrms/permission/ios-bluetooth3.png)  
+
+**Step 2:** Settings | Bluetooth | Toggle ***'Bluetooth'*** on  
+
+    ![ios-bluetooth4](../../../static/img/integration/hrms/permission/ios-bluetooth4.png)