Skip to content

Commit 60613d8

Browse files
jssql1234anndreawbryanngyc
authored
feat: add vision documentation (v1.5.0) (#17)
* feat: add vision first time setup, faq & introduction * update: vision docs to match vision v1.5.0 --------- Co-authored-by: anndreaw <andrea.xhwong@gmail.com> Co-authored-by: bryanngyc <bryangyc19@gmail.com>
1 parent 407e98e commit 60613d8

54 files changed

Lines changed: 242 additions & 68 deletions

Some content is hidden

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

docs/integration/vision/faq.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
sidebar_position: 11
3+
title: FAQ
4+
---
5+
6+
## Payroll & Sync Settings
7+
8+
### Error: Missing drive link detected.
9+
`Missing drive link detected. Please contact your system administrator to enable the drive link and ensure SQL Payroll is updated to version 1.2025.288.232 or later before re-syncing`
10+
11+
![Missing Drive Link error](../../../static/img/integration/vision/faq/missingDriveLink.png)
12+
13+
This error occurs when no Drive link is present to upload attachments or images.
14+
15+
**Fix it in SQL Payroll:**
16+
17+
- Check if drive link is present in SQL Payroll. May refer [**Drive Setup**](/integration/hrms/payroll-setup#sql-drive)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
sidebar_position: 2
3+
title: "First Time Setup"
4+
---
5+
6+
## SQL Payroll Company
7+
8+
1. Navigate to Files > Company Profile and enter company details
9+
2. Important Fields :
10+
- Company Name
11+
- Email (for getting OTP)
12+
13+
![company-profile](../../../static/img/integration/vision/setup/company.png)
14+
15+
## SQL Drive
16+
17+
If you wish to upload images or attachments in Gift module or Assignment module you will require this step. If no may skip to the next step.
18+
19+
:::info[Prerequisites]
20+
May contact SQL support to register email address for SQL Drive.
21+
22+
Make sure you are logging into an ADMIN user before proceed with the steps below.
23+
:::
24+
25+
1. Navigate to File > Company Profile..., click on the ☁️.
26+
![sql-drive1](../../../static/img/integration/hrms/payroll-setup/sql-drive1.png)
27+
28+
2. Switch on Drive.
29+
![sql-drive2](../../../static/img/integration/hrms/payroll-setup/sql-drive2.png)
30+
31+
3. Click on "Log in" > Log in with Google. Enter your Gmail account + password and press on "Grant access".
32+
![sql-drive3](../../../static/img/integration/hrms/payroll-setup/sql-drive3.png)
33+
34+
4. Save.
35+
36+
## SQL Payroll Employees
37+
38+
1. Navigate to Human Resource > Maintain Employee
39+
2. Create New Employees or go to existing employees
40+
3. Important Fields:
41+
- Employee Code
42+
- Name
43+
- Manager Tag (This will determine their role in SQL Vision)
44+
- Active Tag
45+
- Email (For each employee to login to their account)
46+
47+
![employee](../../../static/img/integration/vision/setup/employee.png)
48+
4. Optional Fields:
49+
- Group > Branch / HR Group / Department may be used to categorise employee
50+
51+
![grouping](../../../static/img/integration/vision/setup/grouping.png)
52+
53+
## Sync to SQL Vision
54+
55+
This step will automatically sync all data to SQL Vision. If in future have any changes e.g. employee info, may perform this step again.
56+
57+
1. ☁️ > Sync Cloud..
58+
2. Click Sync All
59+
![payroll-sync](../../../static/img/integration/vision/setup/sync.png)
60+
61+
62+
:::info Login
63+
64+
After completing the setup, you can proceed to log in to the employee account as usual.
65+
66+
:::

docs/integration/vision/gift/manager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ To check completed issuances, **toggle on Issued Gifts** to display the latest i
107107

108108
### Expired Gift
109109

110-
The activation will **fail** if the gift has expired. To activate the gift, the manager must [**update**](#gift-update) its **Redemption Validity End Date**.
110+
When activating expired gifts, a **new expiry date** must be set for each selected. The expiry date must be **later than the current date**.
111111

112-
|![gift](../../../../static/img/integration/vision/gift/expiredGift.png)|![gift](../../../../static/img/integration/vision/gift/activationFailed.png) |
112+
|![expired gift](../../../../static/img/integration/vision/gift/expiredGift.png)|![activate expired gift](../../../../static/img/integration/vision/gift/activateExpiredGift.png) |
113113
|:------------------------------------|:-----------------------------------------------------|

docs/integration/vision/group.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,6 @@ Manager can view all the created groups in **Main Dashboard | Manage Group**. In
3939
2. Edit by changing either the **Group Name**, **Admin**, **Group Leader** and **Group Members**.
4040
3. Tap **Save** to save the changes, or **Cancel** to discard the changes.
4141

42-
### Delete Group
43-
44-
![Manage Group - Delete](../../../static/img/integration/vision/group/g-delete.png)
45-
46-
1. Swipe **Left** on the group card that you want to delete. Tap **Delete**.
47-
2. Confirm by tapping **Yes**.
48-
3. You can also delete a group when editing, on the top right **delete icon**.
49-
5042
## Apply Group
5143

5244
Group can be applied when creating a [**Target**](task/manager_view/task_creation/target#step-3---participants-information), [**Assignment (Step 3)**](task/manager_view/task_creation/assignment#step-3---participants-information) or an [**Upskill (Step 4)**](upskill/manager_view/upskill-creation#step-4---participants-information).
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
sidebar_position: 1
3+
title: "Introduction"
4+
---
5+
6+
## What is SQL Vision
7+
8+
SQL Vision is a task management system designed to work with SQL Payroll & SQL Account. With SQL Vision, managers and employees share clear goals, track performance in real time, and get rewards transparently.
9+
10+
Find out more about [SQL Vision](https://www.sql.com.my/sql-vision/)
11+
12+
## Demo
13+
14+
This system supports both **mobile** and **web applications**, allowing users to access the platform across multiple devices.
15+
16+
The **mobile application** is designed for both **users and managers**, providing convenient access to essential features and enabling quick interactions on the go.
17+
18+
The **web application**, on the other hand, focuses more on **management and administrative functionalities**. It provides managers with a more comprehensive interface for monitoring, managing data, and performing administrative tasks.
19+
20+
You can explore the system through the demo links below:
21+
22+
- 🌐 **Web Application Demo**
23+
[WebApp](https://vision.sql.com.my/)
24+
25+
- 📱 **Mobile Application Demo**
26+
[Android](market://details?id=my.com.sql.app.vision) |
27+
[IOS](https://apps.apple.com/my/app/sql-vision/id6736932365)

docs/integration/vision/linking-to-account.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 10
2+
sidebar_position: 12
33
---
44

55
# Linking to SQL Account
@@ -48,7 +48,7 @@ SQL Vision is linked to SQL Account to get the amount of sales target achieved b
4848
![Sync Program](../../../static/img/integration/vision/account/get-otp-and-token.png)
4949

5050
6. Insert the company ID.
51-
7. Click **Get OTP** .
51+
7. Click **Get OTP** . (The OTP will be sent to the email set in SQL Payroll > File > Company Profile)
5252
8. Insert the OTP obtained from the Step 7 into the OTP field.
5353
9. Click **Get Token**.
5454
10. Click **Next** to continue the following steps.
@@ -83,7 +83,7 @@ Suppose you’re managing a Sales Department and want to track Q1 sales targets:
8383

8484
### Pre-defined Strategy
8585

86-
By default, SQL Vision automatically adds two pre-defined strategies to a newly created company, as shown in the image below:
86+
By default, SQL Vision automatically adds four pre-defined strategies to a newly created company, as shown in the image below:
8787

8888
![Predefined Strategy](../../../static/img/integration/vision/account/predefined-strategy.png)
8989

docs/integration/vision/linking-to-payroll.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 11
2+
sidebar_position: 13
33
---
44

55
# Linking to SQL Payroll

docs/integration/vision/login.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Login
33
description: A brief guide on logging into the SQL VISION mobile application
4-
sidebar_position: 1
4+
sidebar_position: 3
55
---
66

7-
1. Enter the user company email address
7+
1. Enter the user's email address
88

9-
![Login Email](../../../static/img/integration/vision/login/email.png)
9+
![Login Email](../../../static/img/integration/vision/login/loginPage.png)
1010

1111
2. Submit email
1212

@@ -17,7 +17,7 @@ sidebar_position: 1
1717

1818
3. **Resend OTP** allows user to request again an One-Time Password(OTP)
1919

20-
![Resend OTP](../../../static/img/integration/vision/login/resendOTP.png)
20+
![Resend OTP](../../../static/img/integration/vision/login/requestOTP.png)
2121

2222
4. Verification
2323
1. Enter the received OTP

docs/integration/vision/main-dashboard.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 4
33
---
44

55
# Main Dashboard
@@ -14,23 +14,23 @@ sidebar_position: 2
1414

1515
### Upskill
1616

17-
- Displays all available courses and courses in which the user is currently enrolled.
17+
- Displays all available courses and the courses in which the user is currently enrolled.
1818

1919
### Gantt Chart
2020

2121
- Displays a visual timeline of tasks and deadlines, allowing the user to track progress across project.
2222

2323
### Wallet
2424

25-
- Displays earned cash and coins, transaction history, and available rewards for redemption.
25+
- Displays earned cash and coins, transaction history, upcoming payouts and rewards available for redemption.
2626

2727
### Manage Task
2828

29-
- Allows user to create, edit and update tasks, track task progress and review completed tasks.
29+
- Allows users to create, edit, and update tasks, track task progress, and review completed tasks.
3030

3131
### Manage Upskill
3232

33-
- Allows user to create, edit and update courses, track course progress and review completed course.
33+
- Allows users to create, edit and update courses, track course progress and review completed course.
3434

3535
### Manage Group
3636

@@ -62,7 +62,7 @@ sidebar_position: 2
6262

6363
![Earned Card](../../../static/img/integration/vision/main-dashboard/earnedCard.png)
6464

65-
- Displays the cash and coin rewards earned by the user for the current or previous month, allowing easy tracking of monthly earnings.
65+
- Displays the user's cash and coin rewards for the current or previous month, allowing easy tracking of monthly earnings.
6666

6767
## Account Setting
6868

@@ -89,7 +89,7 @@ Details are **view-only** and **cannot be edited** or **modified** from the mobi
8989
### Company Configuration (Manager)
9090

9191
- Enables managers to view and modify company settings, including the closing period (days), estimated payout day, and payment strategies.
92-
- Managers can switch between Default and Customize strategies and use the search bar to quickly locate specific strategies.
92+
- Managers can view default strategies and configure custom strategies with the Default and Customize tab.
9393
- For more details about strategy, refer to [**Linking to SQL Account | Strategy**](./linking-to-account.md#strategy).
9494

9595
![Company Configuration](../../../static/img/integration/vision/account/predefined-strategy.png)
@@ -103,6 +103,22 @@ Details are **view-only** and **cannot be edited** or **modified** from the mobi
103103

104104
![Switch Company](../../../static/img/integration/vision/main-dashboard/switchCompany.png)
105105

106+
### Storage
107+
108+
- Show the total space used by SQL Vision and provide option to clear cache.
109+
110+
![Storage](../../../static/img/integration/vision/main-dashboard/storage.png)
111+
112+
### Devices
113+
114+
- Displays the devices currently logged into the account and allows users to manually remove any of them, except the current device.
115+
116+
![Devices](../../../static/img/integration/vision/main-dashboard/devices.png)
117+
118+
:::warning NOTE
119+
*This function is accessible only by using the Vision application.*
120+
:::
121+
106122
### Help
107123

108124
- Directs users to SQL Vision’s documentation page for support resources and user guides.

docs/integration/vision/task/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Task",
3-
"position": 3,
3+
"position": 5,
44
"link": {
55
"type": "generated-index",
66
"description": "Guidance to Task Module in SQL Vision."

0 commit comments

Comments
 (0)