feat: initialize project backend structure and document system specifications across all modules
This commit is contained in:
377
docs/specs/archive/onecatalogue.md
Normal file
377
docs/specs/archive/onecatalogue.md
Normal file
@@ -0,0 +1,377 @@
|
||||
---
|
||||
title: "OneCatalogue"
|
||||
type: OpenSpec
|
||||
status: Draft
|
||||
---
|
||||
# OneCatalogue
|
||||
|
||||
## About Redemption Item in OLS system
|
||||
|
||||
### Overview
|
||||
|
||||
1. The catalogue is used to set up items for online (web site, Mobile App) redemptions.
|
||||
2. Redemption items such as Cash-back rebates, frequent flyer miles conversion and merchant vouchers can be set up in the redemption catalogue.
|
||||
3. Front-end systems access the catalogue through web services to display available items.
|
||||
4. Front-end systems accept user requests to redeem and send these requests to OLS for authorization (deduction of the relevant points) and to generate the fulfilment files for sending to designated recipient systems.
|
||||
5. Catalogues are managed through the browser-based administration screens, which update the catalogue in real-time. Once “Approved” the item is available commencing on the Start Date.
|
||||
6. Functions include adding catalogues to the system, adding items to catalogues, setting price rules and processing redemption requests from front-end systems.
|
||||
7. OLS also provides an administration function for back-office staff to redeem items through the administration screens directly on behalf of customers.
|
||||
|
||||
## Catalogue
|
||||
|
||||
### Requirement Definition
|
||||
|
||||
* + - 1. A Catalogue must be defined and all items to be included in the Catalogue must be tagged with the Catalogue code before customers access the items.
|
||||
2. A Catalogue code is tagged against each Item Master record.
|
||||
3. More than one Catalogue can be configured at the same time, but each Catalogue must have its own set of Item master records.
|
||||
4. Each Catalogue has a Start / End date range and items in the Catalogue will be picked for presentation to customer only if the current date falls in the Start / End date range for that Catalogue.
|
||||
|
||||
### Process Flow
|
||||
|
||||
==tbd==
|
||||
|
||||
### Trigger
|
||||
|
||||
* + - * 1. If an item is to be tagged to a Catalouge that has not yet been defined.
|
||||
|
||||
### Pre-Conditions
|
||||
|
||||
1. Users have to have access rights in “Catalogue” screen under “OneCatalouge” module.
|
||||
2. Depending on the user's access rights, they can view, add, edit, or approve catalogue records.
|
||||
|
||||
### Wireframe
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Business Rules
|
||||
|
||||
1. Click on Catalouge icon in navigation panel under OneCatalouge to get a listing of existing catalogs.
|
||||
2. Click on Add button ([Image Removed]) in the screen to bring up the edit form; clicking on the MoreOutLined icon (⋮) then click on Edit icon (!) also brings up the same edit form. The edit form for Catalouge is illustrated in section 7.2.5.
|
||||
3. **Descriptions**
|
||||
|
||||
| | | | |
|
||||
| --- | --- | --- | --- |
|
||||
| **Index** | **Field** | **Description** | **Data type** |
|
||||
| **General Information /Thông tin chung** | | | |
|
||||
| | Catalogue Code \*/Mã nhóm danh mục | User-specified code identifying the catalogue. Used by front-end system when requesting for item information. | ~~X(20)~~ X(10) |
|
||||
| | Description\*/ Mô tả | A description of this catalogue. For user reference only. Default description which will be used in case there is no specific description for chosen language. | X(50) |
|
||||
| | Effective From Date \*/Có hiệu lực từ ngày | Catalogue is effective only when the processing date is between Start Date and End Date, inclusive. | Date |
|
||||
| | Effective To Date \*/Có hiệu lực đến ngày | Date |
|
||||
| | Icon/ Biểu tượng | Allow to upload/remove the icon of catalogue | Image |
|
||||
| **Content Configuration: This step is used to setup the description of catalogue follow each language.** **This is optional step** | | | |
|
||||
| | Select Language /Chọn ngôn ngữ | Click to add specific description | Button |
|
||||
| | Language \*/Ngôn ngữ | A drop-down list to select the language which need to be setup specific description. | Drop-down Select one Get from master data |
|
||||
| | Description\*/Mô tả | A description of this catalogue. For user reference on MP only. | X(100) |
|
||||
|
||||
### Post- Conditon
|
||||
|
||||
The Catalouge information for each item can be returned to the front-end during an Item Enquiry response message for the front-end to use in searching the catalogue for items.
|
||||
|
||||
### Exception Flow
|
||||
|
||||
N/A
|
||||
|
||||
## Category
|
||||
|
||||
### Requirement Definition
|
||||
|
||||
A catalog is the main folder to organize categories and items for materials. A category is a group within a catalog that contains items. All items to be included in the Catalogue must be tagged with the Category code. Multiple Categories can be linked to form a hierarchy of categories. The hierarchy of categories is used on Member site.
|
||||
|
||||
### Process Flow
|
||||
|
||||
### Trigger
|
||||
|
||||
If an item is to be tagged to a catagory that has not yet been defined.
|
||||
|
||||
### Pre-Conditions
|
||||
|
||||
1. Users have to have access rights in “Category” screen under “OneCatalouge” module.
|
||||
2. Depending on the user's access rights, they can view, add, edit, or approve category records.
|
||||
|
||||
### Wireframe
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Business Rules
|
||||
|
||||
1. Click on the category icon in the navigation panel under OneCatalouge to get a listing of existing catalogues.
|
||||
2. Click on the Add button ([Image Removed]) in the screen to bring up the edit form; clicking on the MoreOutLined icon (⋮) and then clicking on the Edit icon (!) also brings up the same edit form. The edit form for the category is illustrated in section 7.3.4.
|
||||
3. **Descriptions**
|
||||
|
||||
| | | | |
|
||||
| --- | --- | --- | --- |
|
||||
| **Index** | **Field** | **Description** | **Data type** |
|
||||
| **General Information /Thông tin Chung** | | | |
|
||||
| | Category Code \*/Mã danh mục vật phẩm | User-specified code identifying the category. Used by front-end system when requesting item information. | ~~X(20)~~ X(10) |
|
||||
| | Description\*/ Mô tả | A description of this category. For user reference only. Default description which will be used in case there is no specific description for the chosen language. | X(100) |
|
||||
| | Effective From Date /Có hiệu lực từ ngày | Category is effective only when the processing date is between the Start Date and the End Date, inclusive. If an effective date is not provided then this is a non-expire category. | Date |
|
||||
| | Effective To Date /Có hiệu lực đến ngày | Date |
|
||||
| | Parent Category | Multiple Categories can be linked to form a hierarchy of categories. | Drop-down Select one The parent categories value from master data. |
|
||||
| | Display Ordering /Thứ tự hiển thi | The display ordering sequence on the Member Site. | 9(3) |
|
||||
| | Icon/ Biểu tượng | Allow to upload/remove the icon of the category. | Image |
|
||||
| | Image group /Nhóm hình ảnh | Drop-down list to select the image group | Drop-down Select one |
|
||||
| | Image /Ảnh vật phẩm | Condition field This field is only active and required when the image group is selected | Drop-down Select one Lookup value from Image Stock screen by selected image group. |
|
||||
| | Preview | Preview of selected image | Image |
|
||||
| | Add image/Thêm mới ảnh vật phẩm | Quick add feature to support user add image from this screen. The new image will be automatiom approved when the category is approved | Button |
|
||||
| **Content Configuration: This step is used to setup the description of catalogue follow each language.** **This is optional step** | | | |
|
||||
| | Select Language /Chọn ngôn ngữ | Click to add specific description | Button |
|
||||
| | Language \*/Ngôn ngữ | A drop-down list to select the language which need to be setup specific description. | Drop-down Select one Get from master data |
|
||||
| | Description\*/Mô tả | A description of this category in the choosen language. For user reference on MP only. | X(100) |
|
||||
|
||||
### Post –Condition
|
||||
|
||||
### Exception Flow
|
||||
|
||||
## Item master
|
||||
|
||||
### Requirement Definition
|
||||
|
||||
Describe details about a particular item: e.g. prices, quantities, availability dates, terms and conditions, etc. Item Master Records cannot be created unless the Stock Code is in place.
|
||||
|
||||
### Process Flow
|
||||
|
||||
### Trigger
|
||||
|
||||
New items need to be defined.
|
||||
|
||||
### Pre –Condition
|
||||
|
||||
1. Users have to have access rights in the “Item Master” screen under the “OneCatalouge” module.
|
||||
2. Depending on the user's access rights, they can view, add, edit, or approve Item Master records.
|
||||
|
||||
### Wireframe
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Business Rules
|
||||
|
||||
1. Click on Item Master icon in navigation panel under OneCatalouge to get a listing of existing catalogs.
|
||||
2. Click on Add button ([Image Removed]) in the screen to bring up the edit form; clicking on the MoreOutLined icon (⋮) then click on Edit icon (!) also brings up the same edit form. The edit form for Item Master is illustrated in section 7.4.4
|
||||
3. **Description**
|
||||
|
||||
| | | | |
|
||||
| --- | --- | --- | --- |
|
||||
| **Index** | **Field** | **Description** | **Data type** |
|
||||
| **General information: Mandatory Step** | | | |
|
||||
| | Catalogue Code\*/Nhóm vật phẩm | The Catalogue for which this item is being configured. | Drop-down Select one |
|
||||
| | Category/Danh mục vật phẩm | Select the category under which this item is to be tagged, to facilitate searching in the customer-facing page – e.g. Retailer Vouchers, Frequent Flyer Points, Cash Rebate, etc. | Drop-down Multiples select |
|
||||
| | Item Code\*/Mã vật phẩm | Enter the item code to be added to the catalogue. This is Item identify. | X(10) |
|
||||
| | Item Name \*/Tên vật phẩm | Short description field used by customer-facing application for display for Catalogue item. The text can include control characters. This is default name in case there is no specific item name of chosen language in the member site. | X(50) |
|
||||
| | Redemption From Date From\*/Có hiệu lực từ ngày | “**From Date**” & “**To Date**” specify the period within this item is available and may be included in the Catalogue display and when after which it becomes unavailable and is excluded from the Catalogue display. OLS will reject the Start Date and End Date if they are outside the Catalogue/Category Start Date and End Date period. Once the item has been started for redemption, only End date will be allowed to modify. | Date |
|
||||
| | Redemption To Date \*/ Có hiệu lực đến ngày | Date |
|
||||
| | Redemption Store /Đối tác | Supplier of this item. The merchant (Store) that has to be configured appropriately in order for straight-through settlement processing. | Drop-down Select one |
|
||||
| | Redemption Transaction Code\*/Mã giao dịch đổi thưởng | OLS TC used for redemption processing and logging. | Drop-down Select one |
|
||||
| | Award Transaction Code/Mã giao dịch tặng thưởng | OLS TC If selected, the **OLS** **Transaction Code”** used to locate any award campaign rules to be executed as a result of the catalogue item redemption. | Drop-down Select one |
|
||||
| | Item Type \*/ Loại vật phẩm | The type of item Choose one of following types : * + 1. Miles 2. Physical 3. eVoucher 4. Donation 5. Cash rebate 6. Other | Radio button Item type list from master data |
|
||||
| | Voucher Code /Mã voucher | Condition field A drop-down to select voucher code This field is only active and required when item is an eVoucher | Drop-down Select one |
|
||||
| | Face value/ Partner Point / Giá trị vật phẩm | Condition field This field is only active and required for Cash rebate/eVoucher/Miles item. This is the value of the cash rebate/voucher /miles that customer sees. This value is not used if the Face Value is also specified in the Item Price set-up | 9(14,2) Should be positive value |
|
||||
| | Display on Member Site | Turn off to restrict this item in member site. | Switch button Default ON |
|
||||
| | Hot item /Vật phẩm hot | Condition field This field is active only when this item is displayed on the member site Choose to indicate this is a hot item. Used to display on Member Site. | Switch button Default OFF |
|
||||
| | Display Ordering/ Thứ tự hiển thị | Condition filed This field is active only when this item is displayed on the member site The ordering sequence to display on member site | 9(3) Should be greater than 0 if provided |
|
||||
| | Track Quantiy on Hand/ Theo dõi số lượng vật phẩm | ON mode if the item is an item and that requires inventory control: the “Quantity-on-Hand” is updated for such items during redemption. If this is a Voucher Code item, this field is force-set to Yes and cannot be changed. | Switch button Default OFF |
|
||||
| | Initialize Quantity of Stocks/ Số lượng ban đầu | Condition filed This field is only active and required if track quantity on hand. Canot edit this value if this item has been redeemed. This field is not activated for the Evoucher item due to the number of voucher being generated by another feature (via the Voucher Code screen or batch file). | 9(9) Should be positive value. In case item has been redemmed, then not allow to modify this field. Just display only |
|
||||
| **Item detail : Mandatory step** **This step involves configuring the details of each item in multiple languages. By doing so, the system can utilize the specific details tailored to each language.** | | | |
|
||||
| | Select Language /Chọn ngôn ngữ | Click to add specific item detail. | Button |
|
||||
| | Language \*/Ngôn ngữ | A drop-down list to select the language which need to be setup specific description. | Drop-down Select one Get from master data |
|
||||
| | Item name\*/Tên vật phẩm | Specific item name in the choosen language. | X(50) |
|
||||
| | Item Description/Mô tả vật phẩm | Specific item description in the chosen language. | X(100) |
|
||||
| | Item content/Thông tin chi tiết | The content of item in the choosen language | X(2000) |
|
||||
| | How to use /Cách sử dụng | The way to use the item in the choosen language | X(2000) |
|
||||
| | Term and Conditon/ Điều khoản | Term and Conditon Free text to be returned in the Terms and Conditions field in the Web Service message and in redemption output template letters and email. | X(2000) |
|
||||
| **Item Image /Ảnh vật phẩm** Optional step | | | |
|
||||
| | Select image | Click to add image for item | Button |
|
||||
| | Image group /Nhóm hình ảnh | Drop-down list to select the image group | Drop-down Select one |
|
||||
| | Image /Ảnh vật phẩm | Condiiton field This field is only active and required when image group is selected | Drop-down Select one Lookup value from Image Stock screen by selected image group. |
|
||||
| | Sort Order | The display odering sequence on Member Site. | 9(3) Should be greater than 0 if provided |
|
||||
| | Preview | Preview of selected image | Image |
|
||||
| | Add image/Thêm mới ảnh vật phẩm | Quick add feature to support user add image from this screen. The new image will be automatiom approved when the category is approved | Button |
|
||||
| **Contact and Address information** Optional step | | | |
|
||||
| | Add Address | Click to add item address where we can to use this item | Button |
|
||||
| | City\* | The drop-down to select the city where can use this item | Drop-down Select one |
|
||||
| | Address | Address detail | X(200) |
|
||||
| | Email | Email address | X(100) |
|
||||
| | Phone | Phone number | X(20) |
|
||||
|
||||
### Post-Conditions
|
||||
|
||||
* + 1. The newly created item should have all required fields populated with valid data.
|
||||
2. The system should add/updated items in the database.
|
||||
3. Other screen which lookup to item screen must be able to use new item.
|
||||
|
||||
### Exception Flow
|
||||
|
||||
## Item price
|
||||
|
||||
### Requirement Definition
|
||||
|
||||
* + - 1. Outlines the specifc criteria, functionalities and parameter that determine and manage item prices in the OLS:
|
||||
1. Point valuation: Define the conversion rate between reward points and redemption quanity (e.g 100 point = 1 Ticket movie voucher) to establish the baseline for item redemption.
|
||||
2. Criterions pricing: specify if different pricing tiers will be available for customer based on their account type or redemption channel or specific criterions such as gender, redemption quantity,etc.
|
||||
3. Redemption options: Define the types of items price available for redemption, including using point only or both cash and points.
|
||||
|
||||
### Process Flow
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Trigger
|
||||
|
||||
* + - 1. New item is defined and must define item price to process redemption processing for this item.
|
||||
2. If an item is to be tagged to a price that has not yet been defined.
|
||||
|
||||
### Pre-Conditions
|
||||
|
||||
1. Users have to have access rights in “Item Master” screen under “OneCatalouge” module.
|
||||
2. User have to have access rights in “Item Price” Screen under “OnCatalouge” module.
|
||||
3. Depending on the user's access rights, they can view, add, edit, or approve Item Price records.
|
||||
|
||||
### Wireframe
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Business Rules
|
||||
|
||||
1. Click on Item Master icon in navigation panel under OneCatalouge to get a listing of existing item master.
|
||||
2. Click to view detail any active item master records to bring up the “Item Price” screen as a new tab under item master detail record.
|
||||
3. Click on Add button ([Image Removed]) in the screen to bring up the edit form; clicking on the MoreOutLined icon (⋮) then click on Edit icon (!) also brings up the same edit form. The edit form for Item Price is illustrated in section 7.5.5
|
||||
4. **Edit Screen Description**
|
||||
|
||||
| | | | |
|
||||
| --- | --- | --- | --- |
|
||||
| **Index** | **Field** | **Description** | **Data type** |
|
||||
| **General information** | | | |
|
||||
| | Item Code \*/ Mã vật phẩm | Item code | Display if configure item pirce under specific item. Drop-down list to select an item code to configure the item price |
|
||||
| | Price Code\*/Mã giá | The identify of the item price For user refrence only | X(10) |
|
||||
| | Pirce Name \*/Tên giá | Default name of the price For user reference only | X(100) |
|
||||
| | Effective Start Date \*/ Hiệu lực từ ngày | **From Date**” & “**To Date**” specify the period within this price. | Date |
|
||||
| | Effective End Date \*/ Hiệu lực tới ngày | Date |
|
||||
| | Redemption Channel \*/Kênh đổi thưởng | The drop-down to select the redemption channel. Supported channels are: Call Center Mobile Application Internet Banking Etc | Drop-down Select one |
|
||||
| | Account Type Group/Nhóm loại tài khoản | Optional filed If Account Type or Account level is selected then account type group is blocked and vice versa. | Drop-down Multi-select |
|
||||
| | Product Account Level /Hạng tài khoản | Optional field The drop-down to select the Account level (Card Level) to this this price applies. Leave as empty if all Account level are applies to this prce. If Account type group are selected in previous step then this field is blocked and vice versa | Drop-down Select one |
|
||||
| | Product Account Type/Loại tài khoản | Optional field Optional field Multi-select drop-down to select the Account Type (Card Type) of selected account level in previous step which will be applies to this price. Leave as empty if all account types of selected PAL are applies to this price. If Account type group are selected in previous step then this field is blocked and vice versa | Drop-down Multi-select |
|
||||
| | Redemption Pool\*/Pool đổi thưởng | Select the Pool from which to deduct points for redeeming this item | Drop-down Select one |
|
||||
| | Use Only Points from Selected PA Type/Chỉ sử dụng điểm từ các loại nhóm tai khoản được chỉ định | Restrict the use of points for redemption of this item at this price to only points earned by the selected account Type/ATG | Switch button Default OFF |
|
||||
| | Face value /Trị giá vật phẩm | If transacting Customer/Account meets the criteria in this set-up, what the Customer receives is this “Face Value”. E.g. if this is 500 KrisFlyer Miles, Customer receives 500 KrisFlyer Miles for redeeming one of this item. | 9(12,2) Should be greater than 0 if provided |
|
||||
| | Price in point \*(Full redemption) / Giá trị điểm | Price of item if paid for fully in points from the selected Pool | 9(12,2) Should be greater than 0 if provided |
|
||||
| | Original price /Giá gốc | The original price of the item For user reference only | 9(12,2) Should be greater than 0 if provided |
|
||||
| | Partial Redemption Allowed/Cho phép đổi thưởng 1 phần | If allowed, customer can use a mix of points and cash to pay for this item. The number of points and amount of cash are derived from “Price in Cash Value-per Point” and “Minimum Partial Redeem Points”. See the description for these fields. | Swith button Default OFF |
|
||||
| | Minimum Partial Redeem Points/Số điểm tối thiểu | Condition field This field is only active and required when Partinal Redemption is allowed. Customer must use at least this number of points to redeem this item. | 9(12,2) Should be greater than or equal to 0 if provided 0 for full cash redemption |
|
||||
| | Cash per point/ Số tiền chi trả | Condition field This field is only active and required when Partinal Redemption is allowed. This is used to calculate the amount of cash required to redeem this item after taking into account the points redeemed, if any. | 9(12,2) Should be greater than 0 if provided |
|
||||
| | Appliable Taxes | The drop-down list to select the tax rate to be applicable. | Drop –down Select one Get data from “Tax Rate Maintenance” Screen |
|
||||
| **Price detail :** **Optional step. If not provide then use default item price name to display if needed** | | | |
|
||||
| | Select language /Chọn ngôn ngữ | Click to add item price detail on each language For user reference only | Button |
|
||||
| | Language \*/Ngôn ngữ | The drop-down to select the language to setup the specific item price detail | Drop-down Select one |
|
||||
| | Item price Name \*/Tên giá | The specific name of chosen language For user reference only | X(100) |
|
||||
| | Description/ Mô tả | The description of the price For user reference only | X(500) |
|
||||
| **Item criteria** A part to add criteria to meet the price The approach the same as Rule criteria but just display all criteria which be tagged to “Item price “ module only | | | |
|
||||
| | | [Image Removed] | Click to add new criteria |
|
||||
| | | [Image Removed] | Depended on the purpose of each campaign rule and the criterions list need to be setup to allocate and arrange all criterions into only one or many group. Click on “[Image Removed]” button to create new group. |
|
||||
| | | [Image Removed] | This button is used to exclude all the coming transaction meet the rule criteria. Switch NOT button are applied on combinaiton of all group OR on all criteria on each group. |
|
||||
| | | Right panel | List all active criteria on the system. Each criteria per category will be defined as an attribute and to be tagged for “Item Price “ module |
|
||||
| | | Drag/Drop criteria | Each criteria can be drag one more time on each CP rule. The operator and filler value for each criteria will be display base on data type of selected criteria. |
|
||||
| | | [Image Removed] | Click to delete criteria |
|
||||
| | | [Image Removed] | Operator between difference groups on the same campagn rule OR operator between difference criterions on the same group per each Campaign Rule. |
|
||||
|
||||
### Post-Conditions
|
||||
|
||||
With the item price configuration then here is the flow to get item price.
|
||||
|
||||
Valid price
|
||||
|
||||
[Image Removed]
|
||||
|
||||
What is the price of the transaction
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Exception Flow
|
||||
|
||||
## Voucher Code
|
||||
|
||||
### Requirement Definition
|
||||
|
||||
1 If the Item to be set up is for distribution of Voucher Numbers to customers, and these Voucher Numbers are from external partner merchants, then the Voucher Numbers must first be set up in OLS by uploading/creating the stock of Voucher Numbers.
|
||||
|
||||
2 This voucher upload file must contain the Voucher Code (which identifies what this voucher is for – e.g. “$5 Lazada Voucher”), the period within which the vouchers are accepted at the partner merchant, and the individual voucher serial numbers (Voucher Numbers).
|
||||
|
||||
3 The file format is set out later (to be decided).
|
||||
|
||||
4 This upload can be done using the “Upload” functions in this screen.
|
||||
|
||||
### Process Flow
|
||||
|
||||
### Trigger
|
||||
|
||||
N/A
|
||||
|
||||
### Pre-Conditions
|
||||
|
||||
1. Users have to have access rights in “Voucher Management” screen under “OneCatalouge” module.
|
||||
2. Depending on the user's access rights, they can view, add, edit, or approve Voucher records.
|
||||
|
||||
### Wireframe
|
||||
|
||||
* + - 1. **Create/Edit mode**
|
||||
|
||||
[Image Removed]
|
||||
|
||||
* + - 1. **View mode**
|
||||
|
||||
[Image Removed]
|
||||
|
||||
1. Listing page
|
||||
2. **Voucher Detail view**
|
||||
1. Listing Page
|
||||
|
||||
[Image Removed]
|
||||
|
||||
* 1. View
|
||||
|
||||
Click to any record on the listing page to bring up the detail view as following:
|
||||
|
||||
[Image Removed]
|
||||
|
||||
### Business Rules
|
||||
|
||||
1. Click on Voucher icon in navigation panel under OneCatalogue to get a listing of existing Voucher Code as illustrated in section Wireframe.
|
||||
2. Click on Add button ([Image Removed]) in the screen to bring up the edit form; clicking on the MoreOutLined icon (⋮) then click on Edit icon (!) also brings up the same edit form. The edit form for Voucher is illustrated in section Wireframe.
|
||||
3. Double click on any existing record in Active Tab then the Voucher Detail listing is illustrated in section 7.6.5.
|
||||
4. The system just allow to view the Voucher detail only.
|
||||
5. Can not allow deleting the voucher Code if voucher have been redeemed.
|
||||
6. **Screen description**
|
||||
|
||||
| | | | |
|
||||
| --- | --- | --- | --- |
|
||||
| **Index** | **Field** | **Description** | **Data type** |
|
||||
| **Screen 1: Voucher Code** | | | |
|
||||
| | **Voucher statistic / Tổng hợp thông tin voucher** **This is displayed for active record only** | | |
|
||||
| | Total Voucher /Tổng voucher | Total the serial number voucher belong to the choosen voucher code | Display as interger format |
|
||||
| | Available Vouchers /Số voucher khả dụng | Total the valid voucher and ready to use: The voucher has not yet been redeemed and non- expired. |
|
||||
| | Redeemed Vouchers/ Voucher đã đổi thưởng | Total the numner of the successfully redeemed vouchers. |
|
||||
| | Cancelled Vouchers/ Voucher đã hủy | Total the number of the fail redeemed vouchers which is cancelled by customers/system by specific reason. |
|
||||
| | Expired Vouchers/Voucher đã hết hạn | Total the number of expired voucher that has not yet been redeemed. Use processing date to compare with expiry date of the voucher. |
|
||||
| | **Voucher Code Detail information** | | |
|
||||
| | Voucher Code\*/Mã voucher | Identifies the voucher. | ~~X(20)~~ X(10) |
|
||||
| | Description /Mô tả | The description of the voucher. For user reference only. | X(100) |
|
||||
| | Supplier / Nhà cung cấp | The partner/ organization that issues or provides the voucher | Drop-down Select one |
|
||||
| | Expiry Policy \*/ Hạn sử dụng | A drop-down list with the following choices: * Fixed Date: Voucher will expire after the date specified in the “Expiry Date” parameter. * N days from Transaction Date: Voucher will expire after N days from Redemption Date (Transaction Date). * N days from Post Date: Voucher will expire after N days from redemption transaction is posted on the OLS. * N Months from Transaction Date: Voucher will expire after N months from redemption Date. * N months from Post Date: Voucher will expire after N moths from the moment a redemption transaction is posted on the OLS. | Drop-down Select one |
|
||||
| | Expiry Date / Ngày hết hạn | Condition field This field is only active and required when the expiry policy is “Fixed Date”. **A transaction which redeem this voucher is not allowed to have Transaction Date later than this date.** Can not allow editing the policy (including the relative field that be used to determine expiry date of the voucher) | Date |
|
||||
| | N Param/ Tham số N | Condition field This field is only active and required when the Expiry Policy selected in the previous step requires a parameter N param. e.g. “N days from Transaction Date” | 9(3) Should be greater than or equal to 0 if provided |
|
||||
| | Generate Voucher /Khởi tạo voucher | Turn on when the voucher is generated by OLS instead partner. The system will automation create the number of vouher which user will provide on next step. This field can’t be changed if the voucher have been redeemed. | Swith button Default OFF |
|
||||
| | Quantity /Số lượng | Condition filed This filed is only active and required if “Generate Voucher” in the previous step under ON mode. Specifies the number of voucher codes to be generated. **When a voucher code record is approved in the system, the system should automatically generate voucher numbers corresponding to the entered quantity.** This field can’t be changed if the voucher have been redeemed. In case users want to change then it should be “re-stock”/ “void” voucher use case instead. | 9(5) Should be greater than 0 if provided |
|
||||
| | This is a promo code/ Đây là mã khuyến mãi | Turn on when this is a promo code. For user reference only | Swith button Default OFF |
|
||||
| | ~~Voucher Type/Loại voucher~~ Promotion Type/Loại khuyến mãi | Conditon filed This field is only active and required when this voucher is a promo code. A drop-down list with the following choices: * Fixed Percentage Discount: This type of voucher offers a discount as a percentage of the total purchase amount. * Fixed Monetary Value Discount: Instead of a percentage, this voucher provides a fixed monetary discount. * Cashback Voucher: For this type of voucher, the customer receives a certain percentage of the purchase amount back as cashback to use on future purchases. * Gif Voucher: This type of voucher is often purchased as a gift for someone else. It typically has a fixed monetary value that the recipient can use towards their purchases. | Drop-down Select one |
|
||||
| | Value /Giá trị | The specific value which customer can get from chosen voucher type. Condition field This field is only active and required when “Fixed Monetary Value” / “Fixed Percentation Discount” are selected on the previous step. | 9(14,2) Should be greater than 0 if provided |
|
||||
| **Screen 2: Voucher Detail** **Each voucher No is displayed under one detail record in listing page** **Voucher detail is introduced as a subtab of Active voucher record.** | | | |
|
||||
| | Voucher Code | Choosen voucher code | Display |
|
||||
| | Voucher No | The serial voucher number of choosen voucher |
|
||||
| | Redemption Date | The date when voucher is redeemed |
|
||||
| | Expiry Date | Expiry date of the voucher number which is based on choosen expiry policy of the choosen voucher |
|
||||
| | Redemption Indicator | One of following values: * No: If voucher is not used for any redemption transaction. * Yes: If voucher have been redeemed by customer. |
|
||||
| | Fulfillment Status | One of following values: * New: When voucher is created/uploaded in OLS then the fuillment status should be new to indicator that voucher to be availbale to redeem. * Issued: The FFS is changed into Issued when voucher is successfully redeemed in the OLS. * **Fulfilled: The FFS is changed into Fulfilled when voucher is successfully redeemed and partner accept this voucher.** * Cancelled: FFS is changed intpo “Cancelled” if the customer cancels the transaction or if there are issues with the voucher that prevent its redemption. * Rejected: The vendor has rejected the voucher due to some reasons such as term and conditions, policy changes.etc. The fufillment status is updated when fulfilment status is changed. |
|
||||
|
||||
* + - 1. User who can create new voucher can use “upload” function to upload the voucher file into OLS
|
||||
|
||||
### Post-Conditions
|
||||
|
||||
### Exception Flow
|
||||
|
||||
Reference in New Issue
Block a user