feat: initialize project backend structure and document system specifications across all modules
This commit is contained in:
44
docs/specs/onecatalogue/catalogue.md
Normal file
44
docs/specs/onecatalogue/catalogue.md
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: "Catalogue"
|
||||
type: OpenSpec
|
||||
status: Draft
|
||||
domain: OneCatalogue
|
||||
---
|
||||
|
||||
# Catalogue
|
||||
|
||||
## Requirement Definition
|
||||
A Catalogue groups items for online redemptions (e.g., Cash-back rebates, frequent flyer miles, merchant vouchers). All items included in the Catalogue must be tagged with a specific Catalogue Code. The system supports multiple concurrent catalogues, each with its own Item Master records.
|
||||
|
||||
## Process Flow
|
||||
|
||||
### Pre-Conditions
|
||||
- Users must have access rights to the "Catalogue" screen under the "OneCatalogue" module.
|
||||
- Depending on access rights, users can view, add, edit, or approve catalogue records.
|
||||
|
||||
## Business Rules
|
||||
- Each Catalogue operates within a Start / End date range.
|
||||
- Items are only presented to customers if the current date falls within the Catalogue's effective date range.
|
||||
|
||||
### Data Schema
|
||||
|
||||
#### General Information
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| Catalogue Code | User-specified code identifying the catalogue. Used by front-end systems. | String (10) | Required. |
|
||||
| Description | A description of this catalogue. | String (50) | Required. Default description if no specific language is chosen. |
|
||||
| Effective From Date | Date from which the catalogue is effective. | Date | Required. |
|
||||
| Effective To Date | Date until which the catalogue is effective. | Date | Required. |
|
||||
| Icon | Icon of the catalogue. | Image | Optional. |
|
||||
|
||||
#### Content Configuration
|
||||
| Field Name | Description | Logic Type | Constraints / Rules |
|
||||
|---|---|---|---|
|
||||
| Language | Selected language for specific description setup. | String (Lookup) | Required. |
|
||||
| Description | Description of the catalogue in the chosen language. | String (100) | Required. |
|
||||
|
||||
## Post-Conditions
|
||||
- The Catalogue information is returned to the front-end during Item Enquiry responses for searching.
|
||||
|
||||
## Exception Flow
|
||||
- None specified.
|
||||
Reference in New Issue
Block a user