Skip to content

Commit 732a379

Browse files
committed
refactor: modify the markdown format, typo issue and tidy content (first draft)
2 parents 27d8ed8 + 097db38 commit 732a379

File tree

390 files changed

+1310
-1316
lines changed

Some content is hidden

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

390 files changed

+1310
-1316
lines changed

docs/faq/date-format.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

docs/faq/error-calendarinfo.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/faq/missing-code.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

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/app-usage.md

Lines changed: 43 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,19 @@ description: An E Claim features in SQL HRMS app guide
99
![dashboard](../../../../static/img/integration/hrms/e-claim/dashboard.png)
1010

1111
- **Claim Status Count Summary**:
12-
- User's total approved, pending and rejected claims in the current year
13-
- User can tap on each status to view claims with the respective status
12+
- User's total approved, pending and rejected claims in the current year
13+
- User can tap on each status to view claims with the respective status
1414
- **Claim Amount Summary**: User's total amount of pending and approved claims submitted in the current year
1515
- **Claim Balance Summary**: User’s pending and approved claims on each expenses types by month and by year
1616

1717
## Claim Submission
18-
**Step 1:**
18+
19+
**Step 1:**
1920

2021
**Default Claim:** Select expense type, claim date, amount and description
2122

2223
**E-Invoice Claim:** Select attachment that includes a **VALID** E-Invoice QR code
24+
2325
- User can view the MTD limit, YTD limit and claim balance for each selected expenses type
2426
- For E-Invoice Claim, post date, ref 1 and ref 2 will be filled in based on the E-Invoice and are not editable
2527
- 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))
@@ -29,7 +31,8 @@ description: An E Claim features in SQL HRMS app guide
2931
![claim-submission](../../../../static/img/integration/hrms/e-claim/claim-submission.png)
3032

3133
#### Claim Submission Warning Dialog Box
32-
The app will help to do the following checkings after user click on the ***'Submit' button***:
34+
35+
The app will help to do the following checkings after user click on the ***'Submit' button***:
3336

3437
1. **Exceed MTD Limit:** Prompts if total submitted amount (including previous submission) exceed the monthly limit of the expenses type
3538

@@ -44,6 +47,7 @@ User can choose to change the claim details by submitting a new claim (***'Reapp
4447
:::
4548

4649
#### Claim Submission Sucessful
50+
4751
The app will prompt this dialog message upon successful submission
4852

4953
1. Successful Dialog Box
@@ -59,20 +63,21 @@ The app will prompt this dialog message upon successful submission
5963
![claim-successful-email-noti](../../../../static/img/integration/hrms/e-claim/claim-successful-email-noti.png)
6064

6165
## Claim Status
66+
6267
User can view all his claim transactions once enter this page
6368

6469
![claim-status](../../../../static/img/integration/hrms/e-claim/claim-status.png)
6570

6671
- User can apply filter and sorting order to view different claim transaction listing:
67-
- Filtering options:
68-
- Expenses type
69-
- Date range
70-
- Claim status
71-
- Sorting options:
72-
- Date
73-
- Expenses type
74-
- Claim Status
75-
- Type of claim status:
72+
- Filtering options:
73+
- Expenses type
74+
- Date range
75+
- Claim status
76+
- Sorting options:
77+
- Date
78+
- Expenses type
79+
- Claim Status
80+
- Type of claim status:
7681

7782
| **Icon** | **Claim Status** | **Remark** |
7883
| :------- | :--------------- | :--------- |
@@ -86,31 +91,33 @@ User can view all his claim transactions once enter this page
8691

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

89-
- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
94+
- User are allowed to edit the claim transaction details or cancel the claim on **Pending Approval** claims.
9095
- ***'View Change Log' button***: View change log of the claim
9196

9297
## Team Claim (Manager only)
98+
9399
Manager can view all claim transactions of his team once enter this page
94100

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

97103
- Manager can apply filter and sorting order to view different claim transaction listing:
98-
- Filtering options:
99-
- Expenses type
100-
- Date range
101-
- Claim Status
102-
- Branch
103-
- Department
104-
- Sorting options:
105-
- Date
106-
- Expenses type
107-
- Claim Status
104+
- Filtering options:
105+
- Expenses type
106+
- Date range
107+
- Claim Status
108+
- Branch
109+
- Department
110+
- Sorting options:
111+
- Date
112+
- Expenses type
113+
- Claim Status
108114

109115
### Claim Approval
110116

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

113119
- Managers can apply different actions on his team’s claim transaction based on the claim status
120+
114121
| **Claim Status** | **Allowed Actions** |
115122
| :--------------- | :------------------ |
116123
| Pending Approval | Approve, Reject |
@@ -122,7 +129,8 @@ Manager can view all claim transactions of his team once enter this page
122129
- ***'View Change Log' button***: View change log of the claim
123130

124131
#### Claim Approval Warning Dialog Box
125-
The following checkings will be carried out when manager approving a claim:
132+
133+
The following checkings will be carried out when manager approving a claim:
126134

127135
1. **MTD Claim Over Limit:**
128136
- The app will prompt this dialog box if total approval amount (including previous claim transaction) already exceed the monthly limit of the expenses type
@@ -137,18 +145,22 @@ The following checkings will be carried out when manager approving a claim:
137145
![ytd-over-limit](../../../../static/img/integration/hrms/e-claim/ytd-over-limit.png)
138146

139147
#### Claim Comment Dialog Box
148+
140149
Manager can enter a comment for the claim approval / claim status update (optional) before proceed the updates
141150

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

144153
#### Claim Status Update Successful
154+
145155
The app will prompt a dialog message upon successful update on the claim status
146156

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

149159
### Notification
160+
150161
#### Claim Approval
151-
User will receive the following notification once manager approves his claim:
162+
163+
User will receive the following notification once manager approves his claim:
152164

153165
1. App Notification
154166

@@ -159,7 +171,8 @@ User will receive the following notification once manager approves his claim:
159171
![claim-approval-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-email-noti.png)
160172

161173
### Claim Approval Failed
162-
User will receive the following notification if manager failed to approve his claim (exceed year limit):
174+
175+
User will receive the following notification if manager failed to approve his claim (exceed year limit):
163176

164177
1. App Notification
165178

@@ -170,7 +183,8 @@ User will receive the following notification if manager failed to approve his cl
170183
![claim-approval-failed-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-failed-email-noti.png)
171184

172185
### Claim Approval Rejected
173-
User will receive the following notification once manager rejects his leave:
186+
187+
User will receive the following notification once manager rejects his leave:
174188

175189
1. App Notification
176190

@@ -181,6 +195,7 @@ User will receive the following notification once manager rejects his leave:
181195
![claim-approval-rejected-email-noti](../../../../static/img/integration/hrms/e-claim/claim-approval-rejected-email-noti.png)
182196

183197
## Activity Center
198+
184199
User can view his and his team’s (manager only) claim transaction updates from the Activity Center (Dashboard | Activity Center (Bell icon on top left))
185200

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

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,18 @@ description: An E Claim setup guide in SQL Payroll
55
---
66

77
## Maintain Claim
8+
89
**Step 1:** Payroll | Maintenance | Maintain Claim… | Select a Claim/ Create New
910

1011
**Step 2:** Set Yearly Limit and Monthly Limit
11-
Option 1: Maintain Claim
12+
Option 1: Maintain Claim
1213

1314
![maintain-claim1](../../../../static/img/integration/hrms/e-claim/maintain-claim1.png)
1415

15-
Option 2: Maintain Employee | Claim Limit tab
16+
Option 2: Maintain Employee | Claim Limit tab
1617

1718
![maintain-claim2](../../../../static/img/integration/hrms/e-claim/maintain-claim2.png)
1819

1920
:::info
2021
Payroll / SQL HRMS app will prioritize claim limit set in Maintain Employee over the claim limit in Maintain Claim
21-
:::
22+
:::

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-

0 commit comments

Comments
 (0)