Skip to content

refactor: usage structure, grammar error & markdown format #12

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

Open
jssql1234 wants to merge 16 commits into
base: master
Choose a base branch
from
Open

refactor: usage structure, grammar error & markdown format #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
7dbc0fb
feat: add wiki docs & restructure
yichensql-gif Sep 19, 2025
3e7ed48
fix: Updated File folder content resolving markdown warning)
SQLwilson Oct 23, 2025
2ee5eb1
refactor: change general img structure and fixed warning for pcb, soc…
yichensql-gif Oct 17, 2025
0c33400
fix: rephase some grammar
yichensql-gif Oct 23, 2025
76df788
fix : update HR page image names code formatting (to resolve yellow …
LimXD2003 Oct 17, 2025
e218405
fix: fix trailing spaces and image description names to kebab-case
LimXD2003 Oct 25, 2025
3395da3
refactor: clear markdownlint warning in payroll and restructured the …
sqltjjun-code Oct 15, 2025
e8db3ec
fix: fix image description in usage/payroll/guide.md
sqltjjun-code Oct 27, 2025
2cda1e1
feat : update leave & E-leave faq format
JT-SQL Oct 13, 2025
d33b7d3
fix : change the format follow markdownlint for leave & e-leave
JT-SQL Oct 13, 2025
89fed04
fix : modify the format follow markdownlint for e-leave
JT-SQL Oct 28, 2025
c432904
fix : change the format follow markdownlint for leave
JT-SQL Oct 28, 2025
70fa774
fix : change format by following markdownlint
JT-SQL Oct 28, 2025
f7b3043
refactor: modify the markdown format, typo issue and tidy content (fi…
jssql1234 Oct 30, 2025
5a07529
fix: modify markdown error and restructure content
yichensql-gif Nov 11, 2025
cfc1a67
refactor: modify the markdown format, typo issue and tidy content (se…
jssql1234 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
20 changes: 10 additions & 10 deletions docs/getting-started/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ SQL Payroll consists of 3 main modules:

| Module | Description |
| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| [**Maintain Allowance**](../usage/payroll/maintenance/maintain-allowance.md) | Define the allowance type, rate and contribution |
| **Maintain Claims** | Define the claims type and amount |
| [**Maintain Commission**](../usage/payroll/maintenance/maintain-commission.md) | Define the commission type, rate and contribution |
| [**Maintain Contribution**](../usage/payroll/maintenance/maintain-contribution.md) | Enable to set Bonus, Director Fee, EPF, working hour/day per month, OT, etc. |
| **Maintain Deduction** | Define the deduction type, rate and contribution |
| [**Maintain Frequency**](../usage/payroll/maintenance/maintain-frequency.md) | Enable to set different frequency, eg. weekly, half month |
| [**Maintain Overtime**](../usage/payroll/maintenance/maintain-overtime.md) | Define the overtime type, rate , unit type, and contribution |
| [**Maintain Payment Method**](../usage/payroll/maintenance/maintain-payment-method.md) | Define the bank information |
| [**Maintain Wages**](../usage/payroll/maintenance/maintain-wages.md) | Enable to set different contribution on Wages, such EPF, SOCSO, EIS, PCB, OT,EA and HRDF |
| [**Maintain Allowance**](../usage/payroll/setup.md#maintain-allowance) | Define the allowance type, rate and contribution |
| [**Maintain Claims**](../usage/payroll/setup.md#maintain-claim) | Define the claims type and amount |
| [**Maintain Commission**](../usage/payroll/setup.md#maintain-commission) | Define the commission type, rate and contribution |
| [**Maintain Contribution**](../usage/payroll/setup.md#maintain-contribution) | Enable to set Bonus, Director Fee, EPF, working hour/day per month, OT, etc. |
| [**Maintain Deduction**](../usage/payroll/setup.md#maintain-deduction) | Define the deduction type, rate and contribution |
| [**Maintain Frequency**](../usage/payroll/setup.md#maintain-frequency) | Enable to set different frequency, eg. weekly, half month |
| [**Maintain Overtime**](../usage/payroll/setup.md#maintain-overtime) | Define the overtime type, rate , unit type, and contribution |
| [**Maintain Payment Method**](../usage/payroll/setup.md#maintain-payment-method) | Define the bank information |
| [**Maintain Wages**](../usage/payroll/setup.md#maintain-wages) | Enable to set different contribution on Wages, such EPF, SOCSO, EIS, PCB, OT,EA and HRDF |

## Other Basic modules

| Module | Description |
| --------------------------------------------------------------------- | -------------------------------------------------------------------- |
| [**Maintain Employee**](../usage/human-resource/maintain-employee.md) | Help to maintain employees biodata |
| [**Maintain Employee**](../usage/human-resource/human-resources-setup.md#maintain-employee) | Help to maintain employees biodata |
| **Maintain Branch** | Define the branch name, eg. HQ, branch A, B, C, etc |
| **Maintain Department** | Define the department, eg. Accounts, Sales, Production, etc |
| **Maintain Group** | Define the group level, eg. Director, Manager, Executive, Clerk, etc |
Expand Down
4 changes: 2 additions & 2 deletions docs/integration/hrms/autostart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ description: A guide to enable Auto Start (Android only)
This setting only available on **Android** devices that supports Auto Start
:::

**Step:** Search **'SQL HRMS'** | Allow Auto Start
**Step:** Search **'SQL HRMS'** | Allow Auto Start

![autostart](../../../static/img/integration/hrms/autostart/autostart.png)

:::info
Expand Down
4 changes: 2 additions & 2 deletions docs/integration/hrms/e-claim/sync-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: An E Claim sync cloud guide in SQL Payroll
- **Red Highlight:** Rejected claim
- Editable columns:
- Comment
- Action:
- Action:
- Approved
- Reject
- Unapprove
Expand All @@ -22,6 +22,7 @@ description: An E Claim sync cloud guide in SQL Payroll
![sync-cloud](../../../../static/img/integration/hrms/e-claim/sync-cloud.png)

## Edit Mode

**Step 1:** Right-click on the grid | Edit

![sync-cloud-edit](../../../../static/img/integration/hrms/e-claim/sync-cloud-edit.png)
Expand All @@ -34,4 +35,3 @@ description: An E Claim sync cloud guide in SQL Payroll
- Amount

**Step 2:** Save

137 changes: 78 additions & 59 deletions docs/integration/hrms/e-leave/app-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,45 @@
sidebar_position: 2
title: App Usage
description: An E Leave features in SQL HRMS app guide
slug: /integration/hrms/e-leave/app-usage
---

## Dashboard

![dashboard](../../../../static/img/integration/hrms/e-leave/dashboard.png)

- **Leave Status Count Summary**
- User’s total approved, pending and rejected leaves in the current year
- User can tap on each status to view leave applications with the respective status
- **Upcoming Leave**: User’s upcoming approved leave
- User’s total approved, pending and rejected leaves in the current year
- User can tap on each status to view leave applications with the respective status
- **Upcoming Leave**: User’s upcoming approved leave
- **Leave Balance Summary (AL, MC and UL)**
- User can tap on the card to view detailed leave balance for all his leave types
- User can tap on the card to view detailed leave balance for all his leave types

## Leave Balance

### Employee
### Employee (Leave Balance)

User can view leave balance of different year by navigating to different year

![leave-balance-employee](../../../../static/img/integration/hrms/e-leave/leave-balance-employee.png)

### Manager

If user is a manager, he can view his team's leave balance by tapping on the employee card
apply
![leave-balance-manager](../../../../static/img/integration/hrms/e-leave/leave-balance-manager.png)

## Leave Application

### Employee
### Employee (Leave Application)

![leave-app-employee](../../../../static/img/integration/hrms/e-leave/leave-app-employee.png)

**Step 1:** Select leave duration type: Full Day, Half Day, Custom Time

**Step 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*** :
- ***'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))
Expand All @@ -49,6 +52,7 @@ If user is a manager and has the Manager Auto Approval access (set in payroll sy
:::

### Apply Leave On Behalf (Manager only)

Manager can help his team to apply leave on behalf by tapping on the employee card to switch employee

![apply-on-behalf](../../../../static/img/integration/hrms/e-leave/apply-on-behalf.png)
Expand All @@ -57,12 +61,14 @@ Manager can help his team to apply leave on behalf by tapping on the employee ca
- Leave applied by Verify Manager will be posted as **Pending Approval**

#### Skipped Public Holiday / Rest Day Dialog box

App will automatically skipped all the public holidays and rest days if found within the applied date range

![skip-ph-rd](../../../../static/img/integration/hrms/e-leave/skip-ph-rd.png)

#### Leave Application Warning Dialog Box
The app will help to do the following checkings after user click on the ***'Submit' button***:

The app will help to do the following checkings after user click on the ***'Submit' button***:

1. **Duplicate Leave Application:** Prompts if there is leave applied on the same date

Expand All @@ -79,10 +85,11 @@ The app will help to do the following checkings after user click on the ***'Subm
![exceed-ytd-dialog](../../../../static/img/integration/hrms/e-leave/exceed-ytd-dialog.png)

:::info
User can choose to change the leave details by submitting a new leave (***'Reapply' button***) or proceed (***'Proceed' button***) with the current leave application (not allowed if leave application exceeds year limit)
User can choose to change the leave details by submitting a new leave (***'Reapply' button***) or proceed (***'Proceed' button***) with the current leave application (not allowed if leave application exceeds year limit)
:::

#### Leave Application Successful

1. Successful Dialog Box

![leave-successful-emp](../../../../static/img/integration/hrms/e-leave/leave-successful-emp.png)
Expand All @@ -99,18 +106,18 @@ User can choose to change the leave details by submitting a new leave (***'Reapp

![leave-status](../../../../static/img/integration/hrms/e-leave/leave-status.png)

- User can view all his leave applications once enter this page.
- User can view all his leave applications once enter this page.
- User can apply filter and sorting order to view different leave application listing:
- Filtering options:
- Leave type
- Date range
- Leave status
- Sorting options:
- Date
- Leave type
- Leave status
- Filtering options:
- Leave type
- Date range
- Leave status
- Sorting options:
- Date
- Leave type
- Leave status
- User can batch edit cancel **Approved / Pending Approval / Pending Verification / Rejected** leave applications
- Type of leave status:
- Type of leave status:

| **Icon** | **Leave Status** | **Remark** |
| :------- | :--------------- | :--------- |
Expand All @@ -125,10 +132,11 @@ User can choose to change the leave details by submitting a new leave (***'Reapp

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

- User are allowed to edit the leave application details or cancel the leave on **Approved / Pending Approval / Pending Verification** leave applications.
- User are allowed to edit the leave application details or cancel the leave on **Approved / Pending Approval / Pending Verification** leave applications.
- ***'View Change Log' button:*** View change log of the leave

## Team Leave (Manager only)

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

1. **Approval Manager:** Can approve employee leave
Expand All @@ -137,48 +145,49 @@ Manager Types: (refer [Manager Authority Settings](payroll-setup.md#manager-auth

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

- Manager can view all leave applications of his managing team once enter this page.
- Manager can view all leave applications of his managing team once enter this page.
- Manager can apply filter and sorting order to view different leave application listing:
- Filtering options:
- Leave type
- Show replacement leave only
- Date range
- Leave Status
- Branch
- Department
- Sorting options:
- Date
- Leave type
- Leave Status
- Manager can batch edit leave application status by clicking on the top right icon. (refer [Batch Leave Approval](#batch-leave-approval))
- Filtering options:
- Leave type
- Show replacement leave only
- Date range
- Leave Status
- Branch
- Department
- Sorting options:
- Date
- Leave type
- Leave Status
- Manager can batch edit leave application status by clicking on the top right icon. (refer [Batch Leave Approval](#batch-leave-approval))

### Leave Approval

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

- ***'View Change Log’ button:*** View change log of the leave
- Managers can apply different actions on his team’s leave application based on the leave status and his authority
- Actions that can be done by **Approval Manager**:
| **Leave 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**:
| **Leave Status** | **Allowed Actions** |
| :--------------- | :------------------ |
| Pending Verification | Verify, Reject |
| Pending Approval | Undo Verify, Reject |
| Approved | Reject |
| Approved (Sync) | - |
| Rejected | Verify, Undo Reject |
| Cancelled | - |
- Managers can apply different actions on his team’s leave application based on the leave status and his authority
- Actions that can be done by **Approval Manager**:
| **Leave 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**:
| **Leave Status** | **Allowed Actions** |
| :--------------- | :------------------ |
| Pending Verification | Verify, Reject |
| Pending Approval | Undo Verify, Reject |
| Approved | Reject |
| Approved (Sync) | - |
| Rejected | Verify, Undo Reject |
| Cancelled | - |

#### Leave Approval Warning Dialog Box
The following checkings will be carried out when manager approving a leave:

The following checkings will be carried out when manager approving a leave:

1. **MTD Leave Over Limit:**
- Manager are allowed to proceed leave approval with same / other leave type (only if there are other leave type options) if total leave day applied (including previous leave application) already exceed the monthly limit of the leave type
Expand All @@ -200,16 +209,19 @@ The following checkings will be carried out when manager approving a leave:
![ytd-over-limit](../../../../static/img/integration/hrms/e-leave/ytd-over-limit.png)

#### Leave Comment Dialog Box

Manager can enter a comment for the leave approval (optional) before proceeding with the updates

![leave-comment-dialog](../../../../static/img/integration/hrms/e-leave/leave-comment-dialog.png)

#### Leave Status Update Successful

The app will prompt a dialog message upon successful update on the leave status

![leave-status-update-successful](../../../../static/img/integration/hrms/e-leave/leave-status-update-successful.png)

### Batch Leave Approval

**Step 1:** Select the action that manager wants to carry out (Approval Manager View and Verify Manager View)

![batch-leave-edit1](../../../../static/img/integration/hrms/e-leave/batch-leave-edit1.png)
Expand All @@ -223,8 +235,10 @@ Batch Leave Approval will undergo the same checkings as Leave Approval and warni
:::

### Leave Approval Notification
#### Leave Approval
User will receive the following notification once manager approves his leave:

#### Leave Approval Notify Message

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

1. App Notification

Expand All @@ -235,7 +249,8 @@ User will receive the following notification once manager approves his leave:
![leave-approval-email-noti](../../../../static/img/integration/hrms/e-leave/leave-approval-email-noti.png)

#### Leave Approval Failed
User will receive the following notification if manager fails to approve his leave (exceed year limit):

User will receive the following notification if manager fails to approve his leave (exceed year limit):

1. App Notification

Expand All @@ -246,7 +261,8 @@ User will receive the following notification if manager fails to approve his lea
![leave-approval-failed-email-noti](../../../../static/img/integration/hrms/e-leave/leave-approval-failed-email-noti.png)

#### Leave Rejected
User will receive the following notification once manager rejects his leave:

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

1. App Notification

Expand All @@ -259,20 +275,23 @@ User will receive the following notification once manager rejects his leave:
## Leave Calendar

### My Leave Calendar

User can view all the leave applied in calendar view (excluding rejected and cancelled leave applications)

![leave-calendar](../../../../static/img/integration/hrms/e-leave/leave-calendar.png)

- User can tap on the leave cards to enter Leave Application Detail page to view more info / perform edit action

### Team Leave Calendar
User can view his team’s applied leave in the calendar view

User can view his team’s applied leave in the calendar view

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

- **Only manager** can tap on the leave cards that belongs to his managing team (refer [Manager Authority Settings](payroll-setup.md#manager-authority-settings)) to enter **Leave Approval** page to view more info / perform leave approval

## Activity Center

User can view his and his team’s (manager only) leave application updates from the Activity Center (Dashboard | Activity Center | Bell icon (top left))

![activity-center](../../../../static/img/integration/hrms/e-leave/activity-center.png)
![activity-center](../../../../static/img/integration/hrms/e-leave/activity-center.png)
Loading