feat: initialize project backend structure and document system specifications across all modules

docs/specs/introduction/terminology.md

@@ -0,0 +1,42 @@
+---
+title: "Terminology"
+type: OpenSpec
+status: Draft
+domain: Introduction
+---
+
+# Terminology
+
+This document defines the terms used across the OLS (One Loyalty System) modules.
+
+## Term Definitions
+
+| Term | Definition |
+|---|---|
+| Amount vs Quantity | - **Amount**: Used in connection with monetary amounts (e.g., Dollars). For example, "Transaction Amount".<br>- **Quantity**: Refers to the number of units of an entity, not monetary value. For example, "Award Quantity" or "Redeem Quantity". |
+| Pool Balance Bucket (Bucket) | Used in the context of a Reward Pool Bucket. A bucket is determined based on the pool entity level and expiration date. |
+| Bucket Expiry Date | - If used in the context of a Counter, refers to the Counter Expiry.<br>- If used in the context of a Reward Pool Bucket, refers to the Pool Expiry. |
+| Campaign Rule (Rule) | A business rule defining the conditions under which a reward will be given, including the type and quantity of the reward. It includes **Rule Criteria** and **Rule Formula**. |
+| CEP | **Counter Extract & Process**. A module for setting up job requests to extract a specified counter based on criteria and using the counter value as a transaction amount to process against Campaign Rules. Includes batch processes to execute requests. |
+| Contributor | Identifies an entity which funds the rewards given under a specific Rule. One or more Contributors can be set up. **Rule Contributor Settings** define the percentage billed to each Contributor (totaling 100%). Default is the transacting business entity if only one exists. Used in end-of-day settlement reports. |
+| Counter | Used to track a customer's transaction statistics (e.g., spend frequency, spend total for specific criteria like MCC). Periodic counts (e.g., monthly) are tracked in separate **Counter Buckets** with a specific **Counter Bucket Date**. |
+| Effective Period | Defines a Start Date and End Date range during which a parameter is effective. Generally starts at 00:00:00 and ends at 23:59:59. Time is considered a discrete quantity in seconds. |
+| Expiry Policy | Defines how rewards expire. New policies based on Card Types will be supported. |
+| Formula | Defines the calculation formula used for calculating the reward quantity. Comprises:<br>- **Formula Header**: General parameters (e.g., max reward amount, rounding rules, Gross vs Nett amount).<br>- **Formula Detail**: Specific calculations, each with an Execution Sequence number (executed in descending order). |
+| Gross Amount | The payment amount before any reward deduction. |
+| Pool (Reward Pool) | Tracks each type of reward (e.g., points, coupons). Associated with a **Pool Expiry Policy**. Rewards expiring on a given date are tracked in a **Pool Bucket** with a **Bucket Expiry Date**. |
+| REP | **Redeem, Extract and Process**. A module for setting up requests to redeem a specified Pool based on criteria, and to output the redemption transaction details. |
+| Rule Criteria | Defines the conditions to be met for a rule to apply. |
+| Rule Pool | A Reward Pool which is updated with the results of a Rule Formula. Each Rule is associated with one Rule Pool. |
+| Transaction Amount | Mandatory column in OLS for award processing. Used as the principal quantity for reward calculations. For payment transactions:<br>- **Gross Amount**: Total payment amount.<br>- **Nett Amount**: Amount remaining after offsetting with redeemed rewards. (Logged in OLS as Gross Amount). |
+| OLS Transaction Code (TC) | The key used to locate applicable Rules for a transaction record. If no Rule is linked to a TC, no reward calculation occurs. Must be defined in the TC look-up table. |
+
+## Document Structure Reference
+The standard modules defined across the system include:
+1. Introduction
+2. OneAccess
+3. Customer Management
+4. Campaign Management
+5. OneCatalogue
+6. OneMarketing
+7. OneTargeting