Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/integration/vision/gift/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Introduction

The Gifts feature, accessible through **Main Dashboard > Wallet > Gifts**, allows managers to create digital gifts. All users can then redeem these gifts using coins earned by completing missions.
The Gifts feature, accessible through **Main Dashboard > Wallet > Gifts**, allows managers to create digital gifts that all users can redeem using coins earned from completing missions.

|![gift](../../../../static/img/integration/vision/gift/giftIntro1.png)|![gift](../../../../static/img/integration/vision/gift/giftIntro2.png)|
|:--------------------------------|:--------------------------------|
13 changes: 6 additions & 7 deletions docs/integration/vision/gift/manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ After manager creates a gift, users will receive notification regarding the new
| **Redemption Validity Start Date** | The first date when the gift can be redeemed. | Required |
| **Redemption Validity End Date** | The last date when the gift can be redeemed. | Required |
| **Clear** | Clears all content on the current page. | - |
| **Next** | Navigates to the previous page. | - |
| **Next** | Navigates to the next page. | - |

3. Gift Redemption Criteria

Expand All @@ -41,8 +41,8 @@ After manager creates a gift, users will receive notification regarding the new
| Properties | Description | Note |
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
| **Redeem Coins** | To specify the amount of coins required to redeem the gift. | Required |
| **Category** | To select a category to classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
| **Available Quantity** | To specify the total number of units of the gift that are available for redemption. | Required |
| **Category** | To classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
| **Available Quantity** | To specify the total number of gift units available for redemption. | Required |
| **Max Allowable Redemption Per Employee** | To specify the maximum number of times a user can redeem the gift.| Required |
| **Attactment** | To upload an image associated with the gift, such as a product photo or promotional graphic, through the mobile's camera or gallery. | - |
| **Clear** | Clears all content on the current page. | - |
Expand All @@ -51,7 +51,7 @@ After manager creates a gift, users will receive notification regarding the new

## Gift Update

1. Choose Gift - To update a gift, the manager can go to **More icon > Manage Gift** and select the gift want to be update.
1. To update a gift, the manager can go to **More icon > Manage Gift** and select the gift to be updated.

|![gift](../../../../static/img/integration/vision/gift/gotoManageGift.png)|![gift](../../../../static/img/integration/vision/gift/chooseEditGift.png) |
|:------------------------------------|:-----------------------------------------------------|
Expand Down Expand Up @@ -85,20 +85,19 @@ After clicking **Issue**, select **Confirm** to complete issuing the gift.

### Check Issuance

To check completed issuances, **toggle on Issued Gift**s to display the latest issued gift.
To check completed issuances, **toggle on Issued Gifts** to display the latest issued gift.

|![gift](../../../../static/img/integration/vision/gift/gotoIssuedPage.png)|![gift](../../../../static/img/integration/vision/gift/checkIssuance.png) |
|:------------------------------------|:-----------------------------------------------------|

## Manage Gift

### Gift Status

|Active Gifts|Inactive Gifts |
|:--------------------------------|:---------------------------------|
|![gift](../../../../static/img/integration/vision/gift/activeGift.png)|![gift](../../../../static/img/integration/vision/gift/inactiveGift.png)|

|Propertise|Description|
|Properties|Description|
|:--------------------------------|:--------------------------------|
|**Inactive Gifts Switch - Toggle Off**|Displays all active gifts.|
|**Deactivate**|Deactivate all currently selected active gifts|
Expand Down
28 changes: 14 additions & 14 deletions docs/integration/vision/gift/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,26 @@ These feature are available to both **manager** and **employee**.

:::

## Gift Redeem
## Gift Redemption

1. Gift Filter Type
**1. Gift Filter Type**

|Gift Category Filter Chip|Filter Drawer|
|:--------------------------------|:--------------------------------|
|![gift](../../../../static/img/integration/vision/gift/filterChip.png)|![gift](../../../../static/img/integration/vision/gift/filterDrawer.png)|

|Propertise|Description|
|Properties|Description|
|:--------------------------------|:--------------------------------|
|**Gift Category Filter Chip**|Displays all gifts that match any of the chosen categorie.|
|**Gift Category Filter Chip**|Displays all gifts that match any of the selected categories.|
|**Clear**| Deselect all the selected filter option.|
|**Shop By Price Filter**|Display gifts that match any of the chosen specific price ranges.|
|**Shop By Price Filter**|Display gifts that match any of the selected specific price ranges.|
|**Sort by Featured**|Display the gifts bassed on popularity in descending order.|
|**Sort by Newest**|Display the most recently added gifts in descending order.|
|**Sort by Price: High-to-Low**|Display gifts from expensive to cheap.|
|**Sort by Price: Low-to-High**|Display gifts from cheap to expensive.|
|**Sort by Price: High-to-Low**|Display gifts from most expensive to least expensive.|
|**Sort by Price: Low-to-High**|Display gifts from to least expensive to most expensive.|
|**Reset**|Select all the filter options again.|

2. Select gift - After selecting a gift, and a **bottom bar will appear**.
**2. Select Gift**: After choosing a gift, a bottom bar will appear.

:::info[Note]

Expand All @@ -40,32 +40,32 @@ Once the gift has expired, it will no longer be displayed for redemption. The ma
|![gift](../../../../static/img/integration/vision/gift/chooseGift.png)|![gift](../../../../static/img/integration/vision/gift/redeemGift.png)|
|:--------------------------------|:--------------------------------|

|Propertise|Description|
|Properties|Description|
|:--------------------------------|:--------------------------------|
|**Validity Duration**|The period during which the gift can be redeemed. The gift will not be available for redemption before or after this period.|
|**Terms and Conditions**|A clickable text that directs users to the page outlining the rules, requirements, guidelines, and limitations they must agree to in order to redeem the gift.|
|**Max Redeem**|The maximum quantity of a gift that a user is allowed to redeem. |
|**Quantity Input Field**|A field that allow users to enter the desired quantity to redeem .It can be adjusted by either entering an amount in the text field or using the plus and minus buttons.|
|**Quantity Input Field**|A field that allows users to enter the desired quantity to redeem. It can be adjusted by either entering a value in the text field or using the plus and minus buttons.|
|**Redeem**|A button to add the selected gift to the gift cart.|

3. Confirm Redemption - After clicking **Redeem**, select **Confirm** to redeem the gift. If the redemption is successful, a success dialog will appear automatically.
**3. Confirm Redemption**: After tapping **Redeem**, select **Confirm** to redeem the gift. If the redemption is successful, a success dialog will appear automatically.

|![gift](../../../../static/img/integration/vision/gift/confirmRedeem.png)|![gift](../../../../static/img/integration/vision/gift/redeemSuccess.png)|
|:-----------------------------------|:-----------------------------------|

4. View Redemption - To view redeemed gifts, users can go to **Cart icon> MyRedemption**. If a gift shows as **0/1 issued**, it means that **one redemption has been made**, but it **has not yet been issued**.
**4. View Redemption**: To view redeemed gifts, users can go to **Cart icon > My Redemption**. If a gift displays **0/1 issued**, it means one redemption has been made but **has not yet been issued**.

:::info[Note]

Users will need to wait for approval or issuance from the manager before the gift can be used.
Users must wait for manager approval or issuance before the gift can be used.

:::

|![gift](../../../../static/img/integration/vision/gift/goRedeemCart.png)|![gift](../../../../static/img/integration/vision/gift/myRedemption.png)|
|:-----------------------------------|:-----------------------------------|

## Redemption Log
Redemption log lets users view a history of redeemed rewards, showing who redeemed each reward and when it was redeemed.
The redemption log allows users to view the history of redeemed rewards, including who redeemed each reward and when it was redeemed.

To view the redemption log, users can go to **More icon> Redemption Log**.

Expand Down
25 changes: 14 additions & 11 deletions docs/integration/vision/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This feature is only available to **manager**.

## Introduction

**Group** is a feature that allows manager to do grouping in advance. These groups can then be applied when creating a Target, Assignment or Upskill without requiring manager to select the members individually.
**Group** is a feature that allows manager to do grouping in advance. These groups can then be applied when creating a *Target, Assignment or Upskill* without requiring manager to select the members individually.

## Manage Group

Expand All @@ -22,31 +22,34 @@ Manager can view all the created groups in **Main Dashboard | Manage Group**. In

### Add Group

![Manage Group - Add](../../../static/img/integration/vision/group/g-add.png)
| ![Manage Group - Add](../../../static/img/integration/vision/group/g-add-1.jpg) | ➜ | ![mobileDemo](../../../static/img/integration/vision/group/g-add-2.jpg) |
|:---:|---|:---:|

1. Tap **Add** to create a new group.
1. Tap **Add icon** on the top right to create a new group.
2. Enter **Group Name**.
3. Select **Group Members** and their **Roles**.
4. Tap **Save** to save the group.
3. Select participants as **Admin**, **Group Leader** and **Group Members**.
4. Tap **Add** to save the group.

### Edit Group

![Manage Group - Edit](../../../static/img/integration/vision/group/g-edit.png)
| ![Manage Group - Edit](../../../static/img/integration/vision/group/g-edit-1.jpg) | ➜ | ![mobileDemo](../../../static/img/integration/vision/group/g-edit-2.jpg) |
|:---:|---|:---:|

1. Tap on the **group card** that you want to edit. You'll see the previously saved Group Name, Group Members, and their Roles.
3. Edit by changing either the **Group Name**, **Group Members**, or their **Roles**.
4. Tap **Save** to save the changes.
1. Tap on the **group card** that you want to edit. You will see the previously saved *Group Name*, *Admin*, *Group Leader*, and *Group Members*.
3. Edit by changing either the **Group Name**, **Admin**, **Group Leader** and **Group Members**.
4. Tap **Save** to save the changes, or **Cancel** to discard the changes.

### Delete Group

![Manage Group - Delete](../../../static/img/integration/vision/group/g-delete.png)

1. Swipe **Left** on the group card that you want to delete. Tap **Delete**.
2. Confirm by tapping **Yes**.
3. You can also delete a group when editing, on the top right **delete icon**.

## Apply Group

Group can be applied when creating a [**Target**](task/manager_view/task_creation/target#step-3---add-members), [**Assignment (Step 3)**](task/manager_view/task_creation/assignment#step-3---add-members) or an [**Upskill (Step 4)**](upskill/manager_view/upskill-creation#step-4---participants-information).
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).

![Manage Group - Apply](../../../static/img/integration/vision/group/g-apply.png)

Expand All @@ -71,6 +74,6 @@ Example:

:::info[Note 2]

When a group is applied to an **assignment, upskill, or individual target**, the **Team Leader** role of any member in that group will be **automatically removed**.
When a group is applied to an **assignment, upskill, or individual target**, the **Group Leader** role of any member in that group will be **automatically removed**.

:::
12 changes: 6 additions & 6 deletions docs/integration/vision/linking-to-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 10

## Introduction

SQL Vision are linked to SQL Account to get the amount of sales target achieved by employees.
SQL Vision is linked to SQL Account to get the amount of sales target achieved by employees.

## Requirement

Expand Down Expand Up @@ -49,7 +49,7 @@ The SQL Accounting Software must be open and logged in during the connection pro

6. Insert the company ID.
7. Click **Get OTP** .
8. Insert the OTP Get from the step 7 into the OTP field.
8. Insert the OTP obtained from the Step 7 into the OTP field.
9. Click **Get Token**.
10. Click **Next** to continue the following steps.

Expand Down Expand Up @@ -77,7 +77,7 @@ Suppose you’re managing a Sales Department and want to track Q1 sales targets:

1. For the mission **"Achieve Q1 Sales Target"**, assign the **"Invoice Based Strategy"** strategy.

2. With this setup, managers can update sales progress daily in SQL Vision by using SQL Vision Sync tool by mapping to the right Strategy ID. Managers can view the updated progress daily in SQL Vision.
2. With this setup, managers can update sales progress daily in SQL Vision using SQL Vision Sync tool by mapping it to the correct Strategy ID. Managers can then view the updated progress daily in SQL Vision.

:::

Expand All @@ -87,7 +87,7 @@ By default, SQL Vision automatically adds two pre-defined strategies to a newly

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

If the system encounters an error and fails to create the pre-defined strategies, you can manually add them by navigating to the Company Configuration section. When this issue occurs, the application will display a dialog box prompting you to add the default strategies manually, as shown in the image below:
If the system encounters an error and fails to create the pre-defined strategies, you can manually add them by navigating to the **Company Configuration** section. When this issue occurs, the application will display a dialog box prompting you to add the default strategies manually, as shown in the image below:

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

Expand All @@ -100,7 +100,7 @@ To add a new strategy, follow these steps:
1. Click the **add icon** to create a new strategy.
2. Enter the strategy name.
3. Click the **Add** button.
4. Strategy added can be preview. Click **X** to remove it.
4. Strategy added can be previewed. Click **X** to remove it.
5. Click **Save** to apply changes.
6. Click **Cancel** to discard the changes.

Expand All @@ -110,7 +110,7 @@ To edit an existing strategy, follow these steps:

![Edit Strategy](../../../static/img/integration/vision/account/strategy-edit.png)

1. Click on the strategy you want like to edit.
1. Click on the strategy you would like to edit.
2. Edit the strategy name.
3. Click the **Edit** button.
4. Click **Save** to apply changes.
Expand Down
4 changes: 2 additions & 2 deletions docs/integration/vision/linking-to-payroll.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 11

## Introduction

SQL Vision are linked with SQL Payroll to process all cash rewards earned by employees.
SQL Vision is linked with SQL Payroll to process all cash rewards earned by employees.

## Requirement

Expand Down Expand Up @@ -39,6 +39,6 @@ All rewards will be classified as **Commission** by default. You can change the
:::warning[Warning]

- You are **allowed** to process the reward for specific employees if the expected payout month is **within or before** the payroll process month.
- If you **choose not to process** particular reward, update the expected payout date for the employee in SQL Vision through **[Wallet | Manage Payout](wallet#manage-payoutentitlement-page)**.
- If you **choose not to process** particular reward, update the expected payout date for the employee in SQL Vision through **[Wallet | Manage Payout](wallet#manage-payoutentitlement)**.

:::
3 changes: 2 additions & 1 deletion docs/integration/vision/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ sidebar_position: 1

![OTP Email](../../../static/img/integration/vision/login/receiveOTP.png)

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

![Resend OTP](../../../static/img/integration/vision/login/resendOTP.png)

4. Verification
Expand Down
Loading