Skip to content

Commit 3653d2c

Browse files
refactor: usage
1 parent 8f04548 commit 3653d2c

File tree

12 files changed

+989
-1020
lines changed

12 files changed

+989
-1020
lines changed

docs/usage/human-resource/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Where to get the appointment letters
1414

1515
**Solution:**
1616

17-
1. Go to **Human Resource | Maintain Employee**..., you can found the following common use employee letters:
17+
1. Go to **Human Resource > Maintain Employee**..., you can find the following common use employee letters:
1818

1919
- Acceptance of Resignation Letter
2020
- Appointment Letter

docs/usage/human-resource/additional-functions.md renamed to docs/usage/human-resource/guide.md

Lines changed: 62 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -10,54 +10,54 @@ tags: ["SQL Payroll", "HR", "Functions"]
1010

1111
:::note
1212

13-
- Not applicable for Export Email Client or Export to PDF
14-
- For Email Client, 10 records in one PDF, email to 1 recipient, system unable to generate password due to not sure which password should get
13+
- This feature is not applicable for **Export to Email Client** or **Export to PDF**.
14+
- If there are multiple records (e.g., 10 records) in one PDF to be emailed to a single recipient, the system cannot generate a password as it cannot determine which password to apply.
1515

1616
:::
1717

1818
### Prerequisites
1919

2020
:::info
21-
In order to use this, users computer must configure with window email first
21+
To use this feature, the user's computer must be configured with a Windows email client.
2222
:::
2323

2424
### Setup
2525

26-
1. Navigate to **Human Resource** > **Maintain Employee**
26+
1. Navigate to **Human Resource** > **Maintain Employee**.
2727

28-
2. Key in the PDF password and enter the email address
28+
2. Enter the PDF password and the email address.
2929

3030
![des-maintain-employee-1](../../../static/img/usage/human-resource/hr-function-images/maintain-employee-1.png)
3131

32-
3. Next, go to **Payroll** > **Print Payslip**. Choose the month End Payslip, Apply and Preview
32+
3. Next, go to **Payroll** > **Print Payslip**. Select the Month End Payslip, click **Apply**, and then **Preview**.
3333

34-
4. Click on the 🔽 beside the excel export, click on **Export to Email Client (Batch)**
34+
4. Click the 🔽 arrow beside the Excel export icon and select **Export to Email Client (Batch)**.
3535

3636
![des-export-to-email-client-batch](../../../static/img/usage/human-resource/hr-function-images/export-to-email-client-batch.png)
3737

3838
:::tip
39-
For Testing purpose, you may activate the module at File > Customize Payroll Module and ticked **Batch Email**
39+
For testing purposes, you can activate the module by going to **File** > **Customize Payroll Module** and checking **Batch Email**.
4040
:::
4141

4242
![des-batch-email](../../../static/img/usage/human-resource/hr-function-images/batch-email.png)
4343

4444
:::warning Error
45-
If you haven't configure your window email, you will see an error message as below. Make sure yo have configure your window email before doing these steps.
45+
If you haven't configured your Windows email client, you will see the error message below. Ensure your email client is configured before proceeding.
4646
:::
4747

4848
![des-error](../../../static/img/usage/human-resource/hr-function-images/error.png)
4949

50-
### Simple Steps To use IC as PDF Password
50+
### Steps to Use IC as PDF Password
5151

52-
1. Navigate to **Human Resource** > **Maintain Employee**
52+
1. Navigate to **Human Resource** > **Maintain Employee**.
5353

54-
2. Click on one employee record, hold the `Shift` key in the keyboard and click on the last record to highlight all
54+
2. Click on one employee record, hold the `Shift` key on your keyboard, and click the last record to highlight all employees.
5555

56-
3. Click on 🔽 button beside More, select Batch Edit
56+
3. Click the 🔽 arrow beside **More** and select **Batch Edit**.
5757

58-
4. From the columns, click on field Chooser and select **Name2**, **New IC**
58+
4. In the columns section, click **Field Chooser** and select **Name2** and **New IC**.
5959

60-
5. Save the structure, copy and paste the New IC value to Name2 column
60+
5. Save the structure, then copy the **New IC** values and paste them into the **Name2** column.
6161

6262
![des-ic-as-pdf-password-1](../../../static/img/usage/human-resource/hr-function-images/ic-as-pdf-password-1.png)
6363

@@ -70,142 +70,134 @@ In order to use this, user’s computer must configure with window email first
7070
## Employee Login
7171

7272
:::info
73-
This guide explains how to configure and create an account for the employee in SQL Payroll which allow the employee to view their details
73+
This guide explains how to configure and create an account for the employee in SQL Payroll which allows employees to view their details.
7474
:::
7575

76-
### Employee Login Setup
76+
1. In SQL Payroll, navigate to **Human Resource** > **Maintain Employee**.
7777

78-
1. In SQL Payroll, go to **Human Resource** > **Maintain Employee**
79-
80-
2. Click on **Change Password**
78+
2. Click **Change Password**.
8179

8280
![des-change-password](../../../static/img/usage/human-resource/hr-function-images/change-password.png)
8381

84-
3. Enter a new password for the employee
82+
3. Enter a new password for the employee.
8583

8684
![des-enter-password](../../../static/img/usage/human-resource/hr-function-images/enter-password.png)
8785

88-
4. Next, ask the employee to open SQL Payroll, login into it by using the **Employee Code** and **Password** configured previously. That's it! 🥳
86+
4. Next, instruct the employee to open SQL Payroll and log in using the **Employee Code** and **Password** configured previously. That's it! 🥳
8987

9088
![des-login](../../../static/img/usage/human-resource/hr-function-images/login.png)
9189

92-
5. Finally, here's an example of employee view
90+
5. Below is an example of the employee view:
9391

9492
![des-employee-view](../../../static/img/usage/human-resource/hr-function-images/employee-view.png)
9593

9694
## Print Letter
9795

9896
:::info
99-
This guide explains how to print Appointment, Confirmation, Increment letter
97+
This guide explains how to print Appointment, Confirmation, and Increment letters.
10098
:::
10199

102-
### Print Letter Setup
103-
104-
1. Navigate to the **Maintain Employee** panel
100+
1. Navigate to the **Maintain Employee** panel.
105101

106102
![des-v](../../../static/img/usage/human-resource/hr-function-images/navigate.png)
107103

108-
2. Select the employee
104+
2. Select an employee.
109105

110106
![des-select-employee](../../../static/img/usage/human-resource/hr-function-images/select-employee.png)
111107

112-
3. Click preview reports
108+
3. Click **Preview Reports**.
113109

114110
![des-preview-report](../../../static/img/usage/human-resource/hr-function-images/preview-report.png)
115111

116-
4. Select the report you want by double clicking it
112+
4. Double-click the desired report to select it.
117113

118114
![des-select-report](../../../static/img/usage/human-resource/hr-function-images/select-report.png)
119115

120-
5. This is the example of the appointment letter
116+
5. Below is an example of an appointment letter:
121117

122118
![des-letter-example](../../../static/img/usage/human-resource/hr-function-images/letter-example.png)
123119

124-
#### Increment Letter
120+
### Increment Letter
125121

126122
:::note
127-
For increment letter, make sure increment is set in **history** in order for the report to work
123+
For the increment letter, ensure that an increment is recorded in **History** for the report to generate correctly.
128124
:::
129125

130-
1. Navigate to **Human Resource** > **Maintain Employee**
126+
1. Navigate to **Human Resource** > **Maintain Employee**.
131127

132128
![des-navigate-1](../../../static/img/usage/human-resource/hr-function-images/navigate-1.png)
133129

134-
2. Alternatively, you can click on the **Maintain Employee** available in the homepage
130+
2. Alternatively, click **Maintain Employee** on the homepage.
135131

136132
![des-navigate-2](../../../static/img/usage/human-resource/hr-function-images/navigate-2.png)
137133

138-
3. Go to the employee details, click on History from the tab view
134+
3. Open the employee details and click the **History** tab.
139135

140136
![des-inc-letter-select-employee](../../../static/img/usage/human-resource/hr-function-images/inc-letter-select-employee.png)
141137

142-
4. Click preview reports
138+
4. Click **Preview Reports**.
143139

144140
![des-inc-letter-click-preview](../../../static/img/usage/human-resource/hr-function-images/inc-letter-click-preview.png)
145141

146-
5. Select the report you want to print
142+
5. Select the report you wish to print.
147143

148144
![des-inc-letter-select-report](../../../static/img/usage/human-resource/hr-function-images/inc-letter-select-report.png)
149145

150-
#### Increment letter setup in history
146+
#### Increment Letter Setup in History
151147

152148
![des-increment-letter-setup](../../../static/img/usage/human-resource/hr-function-images/increment-letter-setup.png)
153149

154150
## Maintain Employee with MyKad Reader
155151

156-
### MyKad Reader Setup
157-
158-
1. Link your Smart Card Reader to your computer
152+
1. Connect your Smart Card Reader to your computer.
159153

160-
2. Reader will turn red light when you success link to your computer
154+
2. The reader's light will turn red when successfully connected.
161155

162156
![des-reader](../../../static/img/usage/human-resource/hr-function-images/reader.png)
163157

164-
3. Put MyKard into reader
158+
3. Insert the MyKad into the reader.
165159

166-
4. Reader will show blue light when success read your MyKad
160+
4. The reader's light will turn blue when the MyKad is successfully read.
167161

168162
![des-plug-in-mykad](../../../static/img/usage/human-resource/hr-function-images/plug-in-mykad.png)
169163

170-
5. Open your SQL Payroll New Employee Profile > **Read MyKad**
164+
5. In SQL Payroll, open a **New Employee** profile and click **Read MyKad**.
171165

172166
![des-read-mykad](../../../static/img/usage/human-resource/hr-function-images/read-mykad.png)
173167

174-
6. Select **Reader Devices** > **Click Read Card**
168+
6. Select **Reader Devices** and click **Read Card**.
175169

176170
![des-read-card](../../../static/img/usage/human-resource/hr-function-images/read-card.png)
177171

178-
7. Click **Read MyKad**
172+
7. Click **Read MyKad**.
179173

180174
![des-read-mykad-physical](../../../static/img/usage/human-resource/hr-function-images/read-mykad-physical.png)
181175

182-
8. Inside System will auto fill up MyKard Detail
176+
8. The system will automatically fill in the MyKad details:
183177

184-
- **(NAME , ADDRESS , ID Number, D.O.B, GENDER)**
178+
- **(NAME, ADDRESS, ID Number, D.O.B, GENDER)**
185179

186180
![des-result](../../../static/img/usage/human-resource/hr-function-images/result.png)
187181

188182
## Recurring Zakat
189183

190-
### Recurring Zakat Setup
191-
192-
1. Go to **Maintain Employee**:
184+
1. Go to **Maintain Employee**.
193185

194186
![des-maintain-employee-button](../../../static/img/usage/human-resource/hr-function-images/maintain-employee-button.png)
195187

196-
2. Select the respective employee and go to Deduction
188+
2. Select the respective employee and go to the **Deduction** tab.
197189

198190
![des-deduction](../../../static/img/usage/human-resource/hr-function-images/deduction.png)
199191

200-
3. Enter a deduction and tick Zakat check box. You will notice that the other contribution checkbox will be unticked
192+
3. Enter a deduction and check the **Zakat** box. Note that other contribution checkboxes will be automatically unchecked.
201193

202194
![des-check-zakat](../../../static/img/usage/human-resource/hr-function-images/check-zakat.png)
203195

204-
4. Key in Rate and set the period of contribution in the Date From and Date To column.
196+
4. Enter the **Rate** and set the contribution period in the **Date From** and **Date To** columns.
205197

206198
![des-key-in-rate](../../../static/img/usage/human-resource/hr-function-images/key-in-rate.png)
207199

208-
5. Save and process your month end. You will see the amount in your Gross Zakat
200+
5. Save and process the month-end payroll. The amount will appear in **Gross Zakat**.
209201

210202
![des-result-1](../../../static/img/usage/human-resource/hr-function-images/result-1.png)
211203

@@ -217,15 +209,13 @@ For increment letter, make sure increment is set in **history** in order for the
217209
This is a **Paid Module**
218210
:::
219211

220-
For company which also provide a loan for their employee(s) that is expected to be paid back by deduct from the salary with interest.
212+
This module is for companies that provide loans to employees, which are repaid through salary deductions with interest.
221213

222214
## Maintain Loan
223215

224-
At here allow the user to setting up the loan for the Selected Employee...
225-
226-
### Maintain Loan Setup
216+
This section allows users to set up loans for selected employees.
227217

228-
Assuming we had the following scenario:
218+
Assume the following scenario:
229219

230220
| Field Name | Properties |
231221
|-----------------------------|-------------------|
@@ -235,36 +225,36 @@ Assuming we had the following scenario:
235225
| Number of Repayment (Months)| 60 |
236226
| First Repayment Date | 01 Mar 2013 |
237227

238-
#### Loan Amount & Interest Amount
228+
### Loan Amount & Interest Amount
239229

240-
1. Click **New** & Enter As Following.
230+
1. Click **New** and enter the details as follows:
241231

242232
![des-maintain-loan-step-1](../../../static/img/usage/human-resource/hr-function-images/maintain-loan-step-1.jpg)
243233

244-
2. Click **Schedule | Generate**... Button.
234+
2. Click the **Schedule | Generate...** button.
245235

246236
![des-maintain-loan-step-2](../../../static/img/usage/human-resource/hr-function-images/maintain-loan-step-2.jpg)
247237

248-
3. Click **Ok** button to confirm.
238+
3. Click **OK** to confirm.
249239

250240
4. Click **Save**.
251241

252-
#### Auto Repayment
242+
### Auto Repayment
253243

254-
1. Go to process as normal at [New Payroll](/usage/payroll/general#create-payroll).
244+
1. Process payroll as usual (refer to [New Payroll](/usage/payroll/general#create-payroll)).
255245

256-
2. At the Selected Employee Paysheet Click **Loan**.
246+
2. In the selected employee's paysheet, click **Loan**.
257247

258248
![des-auto-repayment-step-1](../../../static/img/usage/human-resource/hr-function-images/auto-repayment-step-1.jpg)
259249

260-
#### Advanced Repayments
250+
### Advanced Repayments
261251

262-
1. At **Transaction** Tab
252+
1. In the **Transaction** tab:
263253

264254
![des-advanced-repayment-step-1](../../../static/img/usage/human-resource/hr-function-images/advanced-repayment-step-1.jpg)
265255

266256
## Print Loan Repayment History
267257

268-
This is to generate/print the Ledger/History of Loan given by company for the selected/All Employees Report...
258+
This generates/prints the Ledger/History of loans given by the company for selected or all employees.
269259

270260
![des-loan-repayment-history-step-1](../../../static/img/usage/human-resource/hr-function-images/loan-repayment-history-step-1.jpg)

0 commit comments

Comments
 (0)