Skip to content

feat: add vision documentation #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
songlim327 merged 1 commit into from
Feb 3, 2025
Merged

feat: add vision documentation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/integration/vision/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "SQL Vision",
"position": 4,
"link": {
"type": "generated-index",
"description": "SQL Vision related topics"
}
}
8 changes: 8 additions & 0 deletions docs/integration/vision/gift/_category_.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Gift",
"position": 8,
"link": {
"type": "generated-index",
"description": "Guidance to create Gift and redeem Gift in SQL Vision."
}
}
11 changes: 11 additions & 0 deletions docs/integration/vision/gift/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 1
---

# Gift 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.

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

117 changes: 117 additions & 0 deletions docs/integration/vision/gift/manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
sidebar_position: 3
---

# Manager
:::info[Note]

These feature is only available to **manager**.

:::

## Gift Creation
:::info[Note]
After a manager creates a gift, users receive a notification about the new gift.
:::
To add a new gift, managers can go to **More icon> Add Gift**.

![gift](../../../../static/img/integration/vision/gift/gotoAddGift.png)

### 1. Gift Redemption Details

![gift](../../../../static/img/integration/vision/gift/addGiftStep1.png)

| Properties | Description | Note |
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
| **1.0 Name** | The name of the gift. | Required |
| **1.1 Description** | A detailed description of the gift. | Required |
| **1.2 Terms & Conditions** | To specify the rules, requirements, guidelines, and limitations that the user must agree to in order to redeem the gift. | Required |
| **1.3 Redemption Validity Start Date** | The first date when the gift can be redeemed. | Required |
| **1.4 Redemption Validity End Date** | The last date when the gift can be redeemed. | Required |
| **1.5 Clear** | Clears all content on the current page. | - |
| **1.6 Next** | Navigates to the previous page. | - |

### 2. Gift Redeemption Criteria

![gift](../../../../static/img/integration/vision/gift/addGiftStep2.png)

| Properties | Description | Note |
|:-----------------------------|:-----------------------------------------------------------------------------------|:--------:|
| **2.0 Redeem Coins** | To specify the amount of coins required to redeem the gift. | Required |
| **2.1 Category** | To select a category to classify the gift, such as Uncategorised, Food & Beverages, Shopping, Service, Entertainment, Digital Goods, or Travel Accommodation. | Required |
| **2.2 Available Quantity** | To specify the total number of units of the gift that are available for redemption. | Required |
| **2.3 Max Allowable Redemption Per Employee** | To specify the maximum number of times a user can redeem the gift.| Required |
| **2.4 Attactment** | To upload an image associated with the gift, such as a product photo or promotional graphic, through the mobile's camera or gallery. | - |
| **2.5 Clear** | Clears all content on the current page. | - |
| **2.6 Back** | Navigates to the previous page. | - |
| **2.7 Create** | To submit and create the new gift entry after filling in all required details. | - |


## 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.
|![gift](../../../../static/img/integration/vision/gift/gotoManageGift.png)|![gift](../../../../static/img/integration/vision/gift/chooseEditGift.png) |
|:------------------------------------|:-----------------------------------------------------|

### 2. Update Gift Details
In step 2 of edit mode, the user can update the gift's status using the **"Set as Active"** field.

:::info[Note]

The **Active** status can only be set if the Redemption Validity End Date is **on or after** the the current date.

:::

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

## Gift Issue

### 1. Choose Gift Issuance Request

The gift can only be issued after the user has redeemed it. To issue a gift, the manager can go to **More icon > Manage Redemption** and select a gift issuance request.

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

### 2. Confirm Issuance
After clicking **Issue**, select **Confirm** to complete issuing the gift.
|![gift](../../../../static/img/integration/vision/gift/issueConfirmation.png)|![gift](../../../../static/img/integration/vision/gift/doneIssuedGift.png) |
|:------------------------------------|:-----------------------------------------------------|

### 3. Check Issuance

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

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


## Manage Gift

### 1. Gift Status

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

|Propertise|Description|
|:--------------------------------|:--------------------------------|
|**1.0 Inactive Gifts Switch - Toggle Off**|Displays all active gifts.|
|**1.1 Deactivate**|Deactivate all currently selected active gifts|
|**1.2 Inactive Gifts Switch - Toggle On**|Displays all inactive gifts.|
|**1.3 Active**|Activate all currently selected inactive gifts|

### 2. Expired Gift

The activation will **fail** if the gift has expired. To activate the gift, the manager must [**update**](#2-update-gift-details) its **Redemption Validity End Date**.

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




75 changes: 75 additions & 0 deletions docs/integration/vision/gift/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
sidebar_position: 2
---

# User

:::info[Note]

These feature are available to both **manager** and **employee**.

:::

## Gift Redeem
### 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|
|:--------------------------------|:--------------------------------|
|**1.0 Gift Category Filter Chip**|Displays all gifts that match any of the chosen categorie.|
|**1.1 Clear**| Deselect all the selected filter option.|
|**1.2 Shop By Price Filter**|Display gifts that match any of the chosen specific price ranges.|
|**1.3 Sort by Featured**|Display the gifts bassed on popularity in descending order.|
|**1.4 Sort by Newest**|Display the most recently added gifts in descending order.|
|**1.5 Sort by Price: High-to-Low**|Display gifts from expensive to cheap.|
|**1.6 Sort by Price: Low-to-High**|Display gifts from cheap to expensive.|
|**1.7 Reset**|Select all the filter options again.|


### 2. Choose gift
Choose a gift, and a bottom bar will appear.
:::info[Note]

Once the gift has expired, it will no longer be displayed for redemption. The manager will need to [**update**](../gift/manager.md#2-update-gift-details) the redemption validity end date to reactivate the gift for future redemptions.

:::

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

|Propertise|Description|
|:--------------------------------|:--------------------------------|
|**1.0 Validity Duration**|The period during which the gift can be redeemed. The gift will not be available for redemption before or after this period.|
|**1.1 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.|
|**1.2 Max Redeem**|The maximum quantity of a gift that a user is allowed to redeem. |
|**1.3 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.|
|**1.4 Redeem**|A button to add the selected gift to the gift cart.|

### 3. Confirm Redemption
After clicking **Redeem**, select **Confirm** to confirm. 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**.

:::info[Note]

Users will need to wait for approval or issuance from the manager 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.

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

|![gift](../../../../static/img/integration/vision/gift/gotoRedemption.png)|![gift](../../../../static/img/integration/vision/gift/redemptionLog.png)|
|:-----------------------------------|:-----------------------------------|
137 changes: 137 additions & 0 deletions docs/integration/vision/linking-to-account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
sidebar_position: 9
---

# Linking to SQL Account

## Introduction

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

## Requirement

- SQL Vision Sync
- SQL Account
- SQL Vision
- Internet Access

## Setup

1. **Run SQLVisionSync-Setup.exe**

2. Click **Next | Next | Next | Install**

3. Click **Finish**

## Connect SQL Account and SQL Vision with SQL Vision Sync

![Sync Program](../../../static/img/integration/vision/account/text-connection.png)

1. Insert the SQL accounting DFC file into the corresponding field of SQL Vision Sync. You can find the SQL account DFC file in the path specified within the SQL Account Database of the SQL Accounting Software.

![Sync Program](../../../static/img/integration/vision/account/location-DCF-file.png)

2. Open the dropdown and select the database from the dropdown lsit.

3. Insert the user name and password fields with the SQL Accounting Software user name and password.

4. Click **Test Connection**.
:::info[Hint]

The SQL Accounting Software must be open and logged in during the connection process.

:::

5. Click **Next** to continue the following steps.


![Sync Program](../../../static/img/integration/vision/account/get-otp-and-token.png)

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

![Sync Program](../../../static/img/integration/vision/account/export-data.png)

11. Select the last export date
12. Click **Export Data**.
13. Once the data is exported, the SQL Vision mobile app will sync and display the data retrieved from the SQL Accounting Software.

:::info[Parameter for SQL Vision Sync]

![Sync Program](../../../static/img/integration/vision/account/export-log-file.png)

:::

## Strategy

The **Strategy** is a formula that helps managers and the application categorize specific targets for each mission. This setup allows the application to accurately retrieve the target amounts associated with a mission from the SQL Account system.

:::tip Example Scenario

<!-- Suppose you’re managing a Sales Department and want to track quarterly targets for different product lines: -->
Suppose you’re managing a Sales Department and want to track Q1 sales targets:

<!-- 1. **Define a Strategy**
Create a strategy named **"Q1 Product Line A Sales"** to track sales targets for Product Line A for the first quarter. -->

1. **Assign Strategy to Mission**
For the mission **"Achieve Q1 Sales Target"**, assign the **"Invoice Based Strategy"** strategy.
<!-- For the mission **"Achieve Q1 Sales Target for Product Line A"**, assign the **"Invoice Based Strategy"** strategy. -->

2. **Automated Target Tracking**
With this setup, the application will automatically retrieve and update the sales progress daily, based on employee achievements recorded in SQL Account. Managers can view this updated progress daily in SQL Vision.
<!-- With this setup, the application will automatically retrieve and update the sales progress for Product Line A daily, based on employee achievements recorded in SQL Account. Managers can view this updated progress daily in SQL Vision. -->

:::

### 1.0 Pre-defined Strategy

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

![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, SQL Vision 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)

### 1.1 Creating or Editing a Strategy

Coming Soon.

<!-- Managers can create or modify strategies by navigating to **Main Dashboard > Side Bar > Company Configuration**.

![Company Configuration](../../../static/img/integration/vision/main-dashboard/companyConfiguration.png)

#### 1. Add Strategy

To add a new strategy, follow these steps:

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

| Step | Description |
|:----------------------|:---------------------------------------------------------|
| **1. Add Icon** | Click the add icon to create a new strategy. |
| **2. Text Field** | Enter the name of your strategy. |
| **3. Add Button** | Click the add button to preview the new strategy. |
| **4. Preview** | View your strategy in the preview. Use the X to remove it if needed. |
| **5. Save Button** | Save your new strategy. |
| **6. Cancel Button** | Cancel your creation. |

#### 2. Edit Strategy

To edit an existing strategy, follow these steps:

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

| Step | Description |
|:----------------------|:------------------------------------------------------------------|
| **1. Edit Icon** | Click the edit icon to modify an existing strategy. |
| **2. Text Field** | Change the name of the strategy as needed. |
| **3. Edit Button** | Click the edit button to preview your modifications. |
| **4. Preview** | View the strategy in the preview. Use the Edit Icon to re-edit if necessary. |
| **5. Save Button** | Save your updated strategy. |
| **6. Cancel Button** | Cancel the modification. | -->

Loading