Skip to content

refactor: hrms and clock in documentation #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
songlim327 merged 2 commits into from
Sep 1, 2026
Merged

refactor: hrms and clock in documentation #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8436e51
refactor: hrms and clock in documentation
Ellynnn May 5, 2026
9ddd0fe
feat: add mileage claim documentation
jialin97 Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/integration/clock-in.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,9 +129,9 @@ Only for **Android 11 and below**

![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
- **_'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

Expand All @@ -142,7 +142,7 @@ For employees to scan the QR Code generated from SQL HRMS app to clock in / out
- 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
- **_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** |
Expand All @@ -160,6 +160,7 @@ For employees to scan the QR Code generated from SQL HRMS app 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 |
| ![dialog8](../../static/img/integration/clock-in/dialog8.png) | Employee has successfully clocked out and claim replacement leave |

## Settings

Expand Down
72 changes: 46 additions & 26 deletions docs/integration/hrms/e-claim/app-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,22 @@ Prorated year claim limit will be applied to user whose Join Year = Current Year

1. Draft the claim:

| Claim | Description |
| ------------------- | ------------------------------------------------------------- |
| **Default Claim** | Select expense type, claim date, amount and description |
| **Receipt Scan** | Select attachment of a receipt |
| **E-Invoice Claim** | Select attachment that includes a **VALID** E-Invoice QR code |
| Claim | Description |
| ------------------- | ----------------------------------------------------------------- |
| **Default Claim** | Select expense type, claim date, amount and description |
| **Mileage** | Select expense type, claim date, address/distance and description |
| **Receipt Scan** | Select attachment of a receipt |
| **E-Invoice Claim** | Select attachment that includes a **VALID** E-Invoice QR code |

- User can view the MTD limit, YTD limit and claim balance for each selected expenses type
- For Mileage Claim,
- Only expenses type where its UOM is "KM" can be used to apply Mileage Claim (refer [here](payroll-setup#maintain-claim))
- **_'Calculate from Address' switch_**: User can input origin and destination for Mileage Claim and system will calculate the approximate distance between the 2 address (Caluclated distance are not allowed to edit)
- **_Amount_** are not allowed to edit as it will be calculate based on the distance and rate
- A map screenshot will be attached if user input origin and destination
- For Receipt Scan,
- Rescan: Resubmit attachment for reanalyzing if the scan result is incorrect
- Refresh Status: Refresh scan status after attachment is uploaded if scanning is still in progress
- **_'Rescan' button_**: Resubmit attachment for reanalyzing if the scan result is incorrect
- **_'Refresh Status' button_**: Refresh scan status after attachment is uploaded if scanning is still in progress
- For E-Invoice Claim, post date, ref 1 and ref 2 will be filled in based on the E-Invoice and are not editable
- 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))

Expand Down Expand Up @@ -88,27 +94,28 @@ User can view all his claim transactions once enter this page
- Claim Status
- Type of claim status:

| **Icon** | **Claim Status** | **Remark** |
| :-------------------------------------------------------------------------------------------------- | :--------------- | :------------------------------------------------------------ |
| ![pending-approval-icon](../../../../static/img/integration/hrms/e-claim/pending-approval-icon.png) | Pending Approval | Status after normal employee applied a claim submission |
| ![approved-icon](../../../../static/img/integration/hrms/e-claim/approved-icon.png) | Approved | Approved by manager from app and not synced to payroll system |
| ![approved-sync-icon](../../../../static/img/integration/hrms/e-claim/approved-sync-icon.png) | Approved (Sync) | Synced and approved on payroll system |
| ![rejected-icon](../../../../static/img/integration/hrms/e-claim/rejected-icon.png) | Rejected | Rejected from app / payroll system |
| ![cancelled-icon](../../../../static/img/integration/hrms/e-claim/cancelled-icon.png) | Cancelled | Cancelled by user from app |
| **Icon** | **Claim Status** | **Remark** |
| :---------------------------------------------------------------------------------------------------------- | :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![pending-approval-icon](../../../../static/img/integration/hrms/e-claim/pending-approval-icon.png) | Pending Approval | Status after normal employee applied a claim submission |
| ![pending-verification-icon](../../../../static/img/integration/hrms/e-claim/pending-verification-icon.png) | Pending Verification | Status after normal employee applied a claim submission (with [Multi-Level Approval](payroll-setup#multi-level-leave-approval--notification-settings)) |
| ![approved-icon](../../../../static/img/integration/hrms/e-claim/approved-icon.png) | Approved | Approved by manager from app and not synced to payroll system |
| ![approved-sync-icon](../../../../static/img/integration/hrms/e-claim/approved-sync-icon.png) | Approved (Sync) | Synced and approved on payroll system |
| ![rejected-icon](../../../../static/img/integration/hrms/e-claim/rejected-icon.png) | Rejected | Rejected from app / payroll system |
| ![cancelled-icon](../../../../static/img/integration/hrms/e-claim/cancelled-icon.png) | Cancelled | Cancelled by user from app |

## Claim Transaction Detail

![claim-detail](../../../../static/img/integration/hrms/e-claim/claim-detail.png)

- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
- User are allowed to edit the claim transaction details or cancel the claim on **Approved / Pending Approval Pending Verification** claims.
- **_'View Change Log' button_**: View change log of the claim

## Team Claim (Manager only)

Manager Types: (refer [Manager Authority Settings](payroll-setup.md#manager-authority-settings))

1. **Approval Manager:** Can approve employee claim
2. **Verify Manager:** Cannot approve employee claim
2. **Verify Manager:** Can verify employee claim (required Approval Manager to approve a claim submission)

![team-claim](../../../../static/img/integration/hrms/e-claim/team-claim.png)

Expand All @@ -129,17 +136,30 @@ Manager Types: (refer [Manager Authority Settings](payroll-setup.md#manager-auth

![claim-approval](../../../../static/img/integration/hrms/e-claim/claim-approval.png)

- Managers can apply different actions on his team’s claim transaction based on the claim status

| **Claim Status** | **Allowed Actions** |
| :--------------- | :--------------------- |
| Pending Approval | Approve, Reject |
| Approved | Undo Approved, Reject |
| Approved (Sync) | - |
| Rejected | Approve, Undo Rejected |
| Cancelled | - |

- **_'View Change Log' button_**: View change log of the claim
- Managers can apply different actions on his team’s claim transaction based on the claim status and his authority

- Actions that can be done by **Approval Manager**:

| **Claim Status** | **Allowed Actions** |
| :--------------------| :--------------------- |
| Pending Verification | Approve, Reject |
| Pending Approval | Approve, Reject |
| Approved | Undo Approved, Reject |
| Approved (Sync) | - |
| Rejected | Approve, Undo Rejected |
| Cancelled | - |

- Actions that can be done by **Verify Manager**:

| **Claim Status** | **Allowed Actions** |
| :--------------------| :--------------------- |
| Pending Verification | Verify, Reject |
| Pending Approval | Undo Verify, Reject |
| Approved | Reject |
| Approved (Sync) | - |
| Rejected | Verify, Undo Rejected |
| Cancelled | - |

#### Claim Approval Warning Dialog Box

Expand Down
3 changes: 2 additions & 1 deletion docs/integration/hrms/e-claim/payroll-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ description: An E Claim setup guide in SQL Payroll

1. Navigate to Payroll > Maintenance > Maintain Claim…, select a Claim or Create New
2. Set Yearly Limit and Monthly Limit
3. Set UOM and Rate (for Mileage Claim)

Option 1: Maintain Claim

Expand All @@ -27,7 +28,7 @@ SQL Payroll/SQL HRMS app will prioritize claim limit set in Maintain Employee ov

![notification-settings](../../../../static/img/integration/hrms/e-claim/notification-settings.png)

- ***'Send EClaim Email Notification' checkbox***: Checked to allow E HRMS app to send claim email notifications to managers
- **_'Send EClaim Email Notification' checkbox_**: Checked to allow E HRMS app to send claim email notifications to managers

## Manager Authority Settings

Expand Down
4 changes: 2 additions & 2 deletions docs/integration/hrms/e-leave/payroll-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ slug: /integration/hrms/e-leave/payroll-setup

![company-profile-hrms-approval-notification](../../../../static/img/integration/hrms/e-leave/company-profile-hrms-approval-notification.png)

- ***'Multi-Level Approval' checkbox***: Checked to enable multi-level approval for leave application in E HRMS app
- ***'Send E Leave Email Notification' checkbox***: Checked to allow E HRMS app to send leave email notifications to managers
- **_'Multi-Level Approval' checkbox_**: Checked to enable multi-level approval for leave application in E HRMS app
- **_'Send E Leave Email Notification' checkbox_**: Checked to allow E HRMS app to send leave email notifications to managers

## Manager Authority Settings

Expand Down
2 changes: 1 addition & 1 deletion docs/integration/hrms/e-payroll/app-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ User can view their company's announcement
![announcement2](../../../../static/img/integration/hrms/e-payroll/announcement2.png)

:::info
Enable **Autostart** for SQL HRMS to ensure Announcement features work accordingly (refer [Autostart](../autostart.md))
For **Android** user, enable **Autostart** for SQL HRMS to ensure Announcement features work accordingly (refer [Autostart](../autostart.md))
:::

### Company Profile
Expand Down
Loading
Loading