Skip to content

Commit 42bc09d

Browse files
jssql1234yichensql-gifSQLwilsonLimXD2003sqltjjun-code
authored
feat: add wiki docs and restructure folder hierarchy (#14)
* feat: add wiki docs & restructure * fix: Updated File folder content resolving markdown warning) * refactor: change general img structure and fixed warning for pcb, socso and tools * fix: rephase some grammar * fix : update HR page image names code formatting (to resolve yellow highlight from markdownlint) * fix: fix trailing spaces and image description names to kebab-case * refactor: clear markdownlint warning in payroll and restructured the usage/payroll folder structure, and renamed img(s) meaningful * fix: fix image description in usage/payroll/guide.md * feat : update leave & E-leave faq format * fix : change the format follow markdownlint for leave & e-leave * fix : modify the format follow markdownlint for e-leave * fix : change the format follow markdownlint for leave * fix : change format by following markdownlint * fix: modify markdown error and restructure content * refactor: tidy filename and structure --------- Co-authored-by: yichensql-gif <yichen123sql@gmail.com> Co-authored-by: SQLwilson <sqlwilson@gmail.com> Co-authored-by: LimXD2003 <limyuhang022@gmail.com> Co-authored-by: sqltjjun-code <sqltjjun@gmail.com> Co-authored-by: JT-SQL <jingtangsql@gmail.com>
1 parent a48cca5 commit 42bc09d

File tree

502 files changed

+3418
-2031
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

502 files changed

+3418
-2031
lines changed

‎.vscode/settings.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎docs/getting-started/modules.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ SQL Payroll consists of 3 main modules:
1818

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

3131
## Other Basic modules
3232

3333
| Module | Description |
3434
| --------------------------------------------------------------------- | -------------------------------------------------------------------- |
35-
| [**Maintain Employee**](../usage/human-resource/maintain-employee.md) | Help to maintain employees biodata |
35+
| [**Maintain Employee**](../usage/human-resource/setup.md#maintain-employee) | Help to maintain employees biodata |
3636
| **Maintain Branch** | Define the branch name, eg. HQ, branch A, B, C, etc |
3737
| **Maintain Department** | Define the department, eg. Accounts, Sales, Production, etc |
3838
| **Maintain Group** | Define the group level, eg. Director, Manager, Executive, Clerk, etc |

‎docs/integration/hrms/autostart.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ description: A guide to enable Auto Start (Android only)
88
This setting only available on **Android** devices that supports Auto Start
99
:::
1010

11-
**Step:** Search **'SQL HRMS'** | Allow Auto Start
12-
11+
**Step:** Search **'SQL HRMS'** | Allow Auto Start
12+
1313
![autostart](../../../static/img/integration/hrms/autostart/autostart.png)
1414

1515
:::info

‎docs/integration/hrms/e-claim/sync-cloud.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: An E Claim sync cloud guide in SQL Payroll
1313
- **Red Highlight:** Rejected claim
1414
- Editable columns:
1515
- Comment
16-
- Action:
16+
- Action:
1717
- Approved
1818
- Reject
1919
- Unapprove
@@ -22,6 +22,7 @@ description: An E Claim sync cloud guide in SQL Payroll
2222
![sync-cloud](../../../../static/img/integration/hrms/e-claim/sync-cloud.png)
2323

2424
## Edit Mode
25+
2526
**Step 1:** Right-click on the grid | Edit
2627

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

3637
**Step 2:** Save
37-

‎docs/integration/hrms/e-leave/app-usage.md‎

Lines changed: 78 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,45 @@
22
sidebar_position: 2
33
title: App Usage
44
description: An E Leave features in SQL HRMS app guide
5+
slug: /integration/hrms/e-leave/app-usage
56
---
67

78
## Dashboard
89

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

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

1819
## Leave Balance
1920

20-
### Employee
21+
### Employee (Leave Balance)
22+
2123
User can view leave balance of different year by navigating to different year
2224

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

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

3033
## Leave Application
3134

32-
### Employee
35+
### Employee (Leave Application)
3336

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

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

3841
**Step 2:** Select leave date, leave time, leave type, description
3942
- User can view year balance and leave taken for the selected leave type
40-
- ***'I'm taking leave' checkbox*** :
43+
- ***'I'm taking leave' checkbox*** :
4144
- Checked: Normal leave application
4245
- Unchecked: Apply leave as OT replacement
4346
- 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))
@@ -49,6 +52,7 @@ If user is a manager and has the Manager Auto Approval access (set in payroll sy
4952
:::
5053

5154
### Apply Leave On Behalf (Manager only)
55+
5256
Manager can help his team to apply leave on behalf by tapping on the employee card to switch employee
5357

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

5963
#### Skipped Public Holiday / Rest Day Dialog box
64+
6065
App will automatically skipped all the public holidays and rest days if found within the applied date range
6166

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

6469
#### Leave Application Warning Dialog Box
65-
The app will help to do the following checkings after user click on the ***'Submit' button***:
70+
71+
The app will help to do the following checkings after user click on the ***'Submit' button***:
6672

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

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

8187
:::info
82-
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)
88+
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)
8389
:::
8490

8591
#### Leave Application Successful
92+
8693
1. Successful Dialog Box
8794

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

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

102-
- User can view all his leave applications once enter this page.
109+
- User can view all his leave applications once enter this page.
103110
- User can apply filter and sorting order to view different leave application listing:
104-
- Filtering options:
105-
- Leave type
106-
- Date range
107-
- Leave status
108-
- Sorting options:
109-
- Date
110-
- Leave type
111-
- Leave status
111+
- Filtering options:
112+
- Leave type
113+
- Date range
114+
- Leave status
115+
- Sorting options:
116+
- Date
117+
- Leave type
118+
- Leave status
112119
- User can batch edit cancel **Approved / Pending Approval / Pending Verification / Rejected** leave applications
113-
- Type of leave status:
120+
- Type of leave status:
114121

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

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

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

131138
## Team Leave (Manager only)
139+
132140
Manager Types: (refer [Manager Authority Settings](payroll-setup.md#manager-authority-settings))
133141

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

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

140-
- Manager can view all leave applications of his managing team once enter this page.
148+
- Manager can view all leave applications of his managing team once enter this page.
141149
- Manager can apply filter and sorting order to view different leave application listing:
142-
- Filtering options:
143-
- Leave type
144-
- Show replacement leave only
145-
- Date range
146-
- Leave Status
147-
- Branch
148-
- Department
149-
- Sorting options:
150-
- Date
151-
- Leave type
152-
- Leave Status
153-
- Manager can batch edit leave application status by clicking on the top right icon. (refer [Batch Leave Approval](#batch-leave-approval))
150+
- Filtering options:
151+
- Leave type
152+
- Show replacement leave only
153+
- Date range
154+
- Leave Status
155+
- Branch
156+
- Department
157+
- Sorting options:
158+
- Date
159+
- Leave type
160+
- Leave Status
161+
- Manager can batch edit leave application status by clicking on the top right icon. (refer [Batch Leave Approval](#batch-leave-approval))
154162

155163
### Leave Approval
156164

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

159167
- ***'View Change Log’ button:*** View change log of the leave
160-
- Managers can apply different actions on his team’s leave application based on the leave status and his authority
161-
- Actions that can be done by **Approval Manager**:
162-
| **Leave Status** | **Allowed Actions** |
163-
| :--------------- | :------------------ |
164-
| Pending Verification | Approve Reject |
165-
| Pending Approval | Approve, Reject |
166-
| Approved | Undo Approved, Reject |
167-
| Approved (Sync) | - |
168-
| Rejected | Approve, Undo Rejected |
169-
| Cancelled | - |
170-
- Actions that can be done by **Verify Manager**:
171-
| **Leave Status** | **Allowed Actions** |
172-
| :--------------- | :------------------ |
173-
| Pending Verification | Verify, Reject |
174-
| Pending Approval | Undo Verify, Reject |
175-
| Approved | Reject |
176-
| Approved (Sync) | - |
177-
| Rejected | Verify, Undo Reject |
178-
| Cancelled | - |
168+
- Managers can apply different actions on his team’s leave application based on the leave status and his authority
169+
- Actions that can be done by **Approval Manager**:
170+
| **Leave Status** | **Allowed Actions** |
171+
| :--------------- | :------------------ |
172+
| Pending Verification | Approve Reject |
173+
| Pending Approval | Approve, Reject |
174+
| Approved | Undo Approved, Reject |
175+
| Approved (Sync) | - |
176+
| Rejected | Approve, Undo Rejected |
177+
| Cancelled | - |
178+
- Actions that can be done by **Verify Manager**:
179+
| **Leave Status** | **Allowed Actions** |
180+
| :--------------- | :------------------ |
181+
| Pending Verification | Verify, Reject |
182+
| Pending Approval | Undo Verify, Reject |
183+
| Approved | Reject |
184+
| Approved (Sync) | - |
185+
| Rejected | Verify, Undo Reject |
186+
| Cancelled | - |
179187

180188
#### Leave Approval Warning Dialog Box
181-
The following checkings will be carried out when manager approving a leave:
189+
190+
The following checkings will be carried out when manager approving a leave:
182191

183192
1. **MTD Leave Over Limit:**
184193
- 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
@@ -200,16 +209,19 @@ The following checkings will be carried out when manager approving a leave:
200209
![ytd-over-limit](../../../../static/img/integration/hrms/e-leave/ytd-over-limit.png)
201210

202211
#### Leave Comment Dialog Box
212+
203213
Manager can enter a comment for the leave approval (optional) before proceeding with the updates
204214

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

207217
#### Leave Status Update Successful
218+
208219
The app will prompt a dialog message upon successful update on the leave status
209220

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

212223
### Batch Leave Approval
224+
213225
**Step 1:** Select the action that manager wants to carry out (Approval Manager View and Verify Manager View)
214226

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

225237
### Leave Approval Notification
226-
#### Leave Approval
227-
User will receive the following notification once manager approves his leave:
238+
239+
#### Leave Approval Notify Message
240+
241+
User will receive the following notification once manager approves his leave:
228242

229243
1. App Notification
230244

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

237251
#### Leave Approval Failed
238-
User will receive the following notification if manager fails to approve his leave (exceed year limit):
252+
253+
User will receive the following notification if manager fails to approve his leave (exceed year limit):
239254

240255
1. App Notification
241256

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

248263
#### Leave Rejected
249-
User will receive the following notification once manager rejects his leave:
264+
265+
User will receive the following notification once manager rejects his leave:
250266

251267
1. App Notification
252268

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

261277
### My Leave Calendar
278+
262279
User can view all the leave applied in calendar view (excluding rejected and cancelled leave applications)
263280

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

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

268285
### Team Leave Calendar
269-
User can view his team’s applied leave in the calendar view
286+
287+
User can view his team’s applied leave in the calendar view
270288

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

273291
- **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
274292

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

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

0 commit comments

Comments
 (0)