Skip to content

Commit cb71d9a

Browse files
bryanngycjssql1234
authored andcommitted
update: vision docs to match vision v1.5.0
1 parent 3e9e108 commit cb71d9a

44 files changed

Lines changed: 127 additions & 62 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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ title: FAQ
55

66
## Payroll & Sync Settings
77

8-
### Error: 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
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`
910

1011
![Missing Drive Link error](../../../static/img/integration/vision/faq/missingDriveLink.png)
1112

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).

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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/login.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66

77
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: 3
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: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,23 @@ sidebar_position: 4
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: 4
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/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ There are 3 types of missions in task module: **Assignment**, **Target** and **Q
1717
*Example: Sales Target, Input Data.*
1818

1919
- **Quest:**
20-
A Quest is ideal when the participant is not predetermined or when you want to invite all employees to participate.
20+
A Quest is ideal when participants are not predetermined, allowing employees to freely join and participate.

docs/integration/vision/task/manager_view/assignment.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,20 @@ Managers can view the assignment details that are created such as *title, descri
3434
:::
3535

3636
2. Display employee's assignment details:
37-
- Total cash and coin(s) earned (**Highlighted in red**)
38-
- Log file submitted
39-
- Rewards earned
40-
37+
- Total cash and coin(s) earned
38+
- Timeline with:
39+
- Log file submitted
40+
- Rewards earned (Milestone rewards only entitled once log file approved)
41+
- Rewards that haven't entitled yet
4142
![Manager View Emp Asgmt](../../../../../static/img/integration/vision/task/mgrViewEmpAsgmt.png)
4243

44+
:::info Info
45+
46+
May click on the links to view attachment in phone gallery
47+
48+
:::
49+
50+
4351
### Log File Submission
4452

4553
1. Navigate to: **Log File** > **Log File Card** (highlighted in red)
@@ -138,19 +146,14 @@ Finalising assignment is an **irreversible** action.
138146
The code will match with the code in the summary table.
139147
:::
140148

141-
### Employee Progress
149+
### Employee Progress & Log File
142150

143151
1. Press **Employee Name** (highlighted in red)
144152

145-
![Summary Table](../../../../../static/img/integration/vision/task/summaryTable-1.png)
146-
147-
![Employee Assignment](../../../../../static/img/integration/vision/task/mgrViewEmpCompleteAsmgt.png)
148-
149-
### Employee Log File
150-
151-
1. Navigate to: **Employee Name** (in summary table) > **View Log File**
153+
![Summary Table](../../../../../static/img/integration/vision/task/summaryTable-1.png)
154+
2. Press **Progress Tracker** to view the timeline and history logs
152155

153-
![Log File](../../../../../static/img/integration/vision/task/logFile.png)
156+
![Employee Assignment](../../../../../static/img/integration/vision/task/mgrViewEmpCompleteAsmgt.png)
154157

155158
### Tooltip Reward
156159

docs/integration/vision/task/manager_view/task_creation/assignment.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ This feature is only available to **manager**.
1919
| Properties | Description | Note |
2020
|:-------------------------|:-----------------------------------------------------------------------------------|:--------:|
2121
| **Title** | The title of the mission. | Required |
22-
| **Description** | A detailed description of the mission. | - |
22+
| **Description** | A detailed description of the mission. | - |
2323
| **[Project/Job/Task](#projectjobtask)** | The category for the mission, indicating whether it relates to a project, job, or specific task. | - |
24-
| **Start Date** | The date when the mission begins. | Required |
25-
| **End Date** | The date when the mission ends. The end date must be later than the start date. | Required |
24+
| **Start Date** | The mission start date. | Required |
25+
| **End Date** | The mission end date. The end date must be later than the start date. | Required |
2626
| **Clear** | Clears all content on the current page. | - |
27-
| **Next** | Navigates to the next page. | - |
27+
| **Next** | Navigates to the next page when requirement is met. | - |
2828

2929
### Project/Job/Task
3030

@@ -39,12 +39,12 @@ Select a **Project**, **Job**, and **Task** from the dropdown menus. If any fiel
3939
| Properties | Description | Note |
4040
|:----------------------------------------------------|:----------------------------------------------------------------------|:------------:|
4141
| **[Milestone and Rewards](#milestone-and-rewards)** | Section for entering details about milestones and associated rewards. | At least one |
42+
| **[Bonus](#bonus)** | Section for entering additional bonus rewards. | - |
4243
| **[Consultant Rewards](#consultant-rewards)**| Section for selecting consultants and specifying their respective rewards.| - |
4344
| **[Payment By](#payment-by)** | Section for selecting the payment method and specifying the payout month. | Required |
44-
| **[Bonus](#bonus)** | Section for entering additional bonus rewards. | - |
4545
| **Clear** | Clears all content on the current page. | - |
4646
| **Back** | Navigates to the previous page. | - |
47-
| **Next** | Navigates to the next page. | - |
47+
| **Next** | Navigates to the next page when requirement is met. | - |
4848

4949
### Milestone and Rewards
5050

@@ -58,6 +58,17 @@ Select a **Project**, **Job**, and **Task** from the dropdown menus. If any fiel
5858
| **Add** | Adds a new milestone along with its respective rewards. |
5959
| **Delete** | Deletes a specific milestone and its associated rewards. |
6060

61+
### Bonus
62+
63+
![assignment](../../../../../../static/img/integration/vision/mi_creation/a-2.4.png)
64+
65+
| Properties | Description |
66+
|---------------|-------------------------------------------------------------------------------------|
67+
| **Description** | Text field to enter a description for the bonus. *(e.g., extra points that you hope the employee can achieve, though it is not mandatory)* |
68+
| **Rewards** | Text field to enter the rewards available to the achievers of the particular bonus. |
69+
| **Add** | Adds a new bonus along with its respective rewards. |
70+
| **Delete** | Deletes a new bonus along with its respective rewards. |
71+
6172
### Consultant Rewards
6273

6374
![assignment](../../../../../../static/img/integration/vision/mi_creation/a-2.2.png)
@@ -90,16 +101,6 @@ There are two types of payment methods:
90101
- **Inclusive Setting:** *If January and August are set as inclusive months, rewards entitled from February to August will be paid in August, while rewards entitled from September to January will be paid in January.*
91102
- **Exclusive Setting:** *If January and August are set as exclusive months, rewards entitled from January to July will be paid in August, and rewards entitled from August to December will be paid in January.*
92103

93-
### Bonus
94-
95-
![assignment](../../../../../../static/img/integration/vision/mi_creation/a-2.4.png)
96-
97-
| Properties | Description |
98-
|---------------|-------------------------------------------------------------------------------------|
99-
| **Description** | Text field to enter a description for the bonus. *(e.g., extra points that you hope the employee can achieve, though it is not mandatory)* |
100-
| **Rewards** | Text field to enter the rewards available to the achievers of the particular bonus. |
101-
| **Add** | Adds a new bonus along with its respective rewards. |
102-
| **Delete** | Deletes a new bonus along with its respective rewards. |
103104

104105
## Step 3 - Participants Information
105106

docs/integration/vision/task/manager_view/task_creation/target.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,58 @@ Team option is not available for quests.
6161

6262
:::
6363

64-
:::tip Tips to create a Team Target Mission
64+
<!-- :::tip Tips to create a Team Target Mission
6565
6666
To set up a team target, create two identical missions: one with the **Individual** setting and the other with the **Team** setting.
6767
6868
1. Add the team leader to the Team target and their team members to both the Team and Individual targets.
6969
7070
2. The team leader’s target will now reflect the collective achievements of the entire team and include a unique reward, while each member will have their own individual targets and rewards!
7171
72+
::: -->
73+
:::tip Tips for Creating Team Target Missions
74+
75+
Below are two recommended approaches for setting up team-based targets depending on how rewards should be distributed.
76+
77+
---
78+
79+
**1. Team Target Mission (Leader-Only Reward)**
80+
81+
This method allows the **team leader to receive a reward based on the collective performance of the team**, while team members work toward their own individual targets.
82+
83+
**Steps:**
84+
85+
1. Create two identical missions:
86+
- One with the **Individual** setting.
87+
- One with the **Team** setting.
88+
89+
2. Assign the team leader to the Team mission.
90+
91+
3. Assign all team members to:
92+
- The Team mission
93+
- The Individual mission
94+
95+
**Result:**
96+
97+
- The team leader's target will reflect the combined achievements of the entire team and include a special reward.
98+
- Each team member will still have their own individual targets and rewards.
99+
100+
---
101+
102+
**2. Team Target Mission (Shared Reward)**
103+
104+
This method allows **all members of the team to work together toward the same goal and receive the reward collectively** once the target is achieved.
105+
106+
**Steps:**
107+
108+
1. Create a Team mission.
109+
2. Assign **all members as team leaders** within the mission.
110+
111+
**Result:**
112+
113+
- All members contribute toward the same shared target.
114+
- Once the goal is achieved, everyone receives the reward.
115+
- This setup encourages collaboration and collective performance across the team.
72116
:::
73117

74118
### Strategy
@@ -162,7 +206,7 @@ The "Less Than and Equal" condition is applied to reward employees who achieve r
162206
| Properties | Description |
163207
|-------------|----------------------------------------------------------------------------------------------------------|
164208
| **Target** | Text field to input the target amount. (Note: Only the **Between** condition will have two text fields.) |
165-
| **Rewards** | Text field to enter the rewards available to the achievers of the particular target. There are 3 types of rewards: <br/> &nbsp;&nbsp; 1. **Percentage (%):** A percentage of the target amount awarded to the members *(e.g., 2%)*. <br/> &nbsp;&nbsp; 2. **Cash (RM):** Commission or allowance provided through the SQL Account on the payout date. <br/> &nbsp;&nbsp; 3. **Coins:** Digital coins that can be used to redeem gifts in SQL Vision via [**Gift**](../../../gift/introduction.md). |
209+
| **Rewards** | Text field to enter the rewards available to the achievers of the particular target. There are 3 types of rewards: <br/> &nbsp;&nbsp; 1. **Percentage (%):** A percentage of the target amount awarded to the members *(e.g., 2%, 2.5%)*. <br/> &nbsp;&nbsp; 2. **Cash (RM):** Commission or allowance provided through the SQL Account on the payout date. <br/> &nbsp;&nbsp; 3. **Coins:** Digital coins that can be used to redeem gifts in SQL Vision via [**Gift**](../../../gift/introduction.md). |
166210
| **Add** | Adds a new target along with its respective rewards. |
167211
| **Delete** | Deletes a specific target and its associated rewards. |
168212

0 commit comments

Comments
 (0)