Files
loyalty-agent-service/docs/specs/onemarketing/marketing_message.md

70 lines
3.5 KiB
Markdown

---
title: "Marketing Message"
type: OpenSpec
status: Draft
domain: OneMarketing
---
# Marketing Message
## Requirement Definition
Manages (CRUD) all message templates used in the system. A Message Template can be built for different channels (SMS, Push Notification, Email). The message can be based on pre-defined parameters or HTML files.
## Process Flow
### Pre-Conditions
- Users must have access rights in the "Marketing Message" module.
- Depending on rights, users can view, add, edit, or approve message templates manually.
- OMR criteria must be defined as attributes available in the right panel for drag-and-drop setup.
## Business Rules
### Data Schema (SMS Message)
| Field Name | Description | Logic Type | Constraints / Rules |
|---|---|---|---|
| Message ID | Unique identifier. | String (10) | Required. No special characters. |
| Message Description | Description. | String (100) | Required. |
| SMS Type | Promotion/Marketing or Transaction. | String (Lookup) | Required. |
| Effective Date From | Start date of the effective period. | Date | Required. |
| Effective End Date | End date of the effective period. | Date | Required. |
| SMS Brand Name | Select SMS Sender. | String (Lookup) | Required. |
| Message | Message content. Supports drag/drop parameters. | String (5000) | Required. Unicode (non-GSM). No images, subject, or attachments. |
### Data Schema (Email Message)
| Field Name | Description | Logic Type | Constraints / Rules |
|---|---|---|---|
| Message ID | Unique identifier. | String (10) | Required. No special characters. |
| Message Description | Description. | String (100) | Required. |
| Email Type | Promotion/Marketing or Transaction. | String (Lookup) | Required. |
| Effective Date From | Start date of the effective period. | Date | Required. |
| Effective End Date | End date of the effective period. | Date | Required. |
| Use Type | Use Message or Upload Template. | Enum | Required. |
| Sender Name | Name of sender. | String (100) | Required. |
| From Email | Configured email address. | String (100) | Required. |
| Subject | Subject of email. | String (100) | Required. |
| Preview Text | Preheader of Email. | String (100) | Optional. Defaults to first line of content if not provided. |
| Message / Upload File | HTML content or uploaded template file. | String / File | Required based on Use Type. |
### Data Schema (Push Notification)
| Field Name | Description | Logic Type | Constraints / Rules |
|---|---|---|---|
| Message ID | Unique identifier. | String (10) | Required. No special characters. |
| Message Description | Description. | String (100) | Required. |
| Notification Type | Promotion/Marketing or Transaction. | String (Lookup) | Required. |
| Effective Date From | Start date of the effective period. | Date | Required. |
| Effective End Date | End date of the effective period. | Date | Required. |
| Message Title | Primary text at the top. | String (50) | Required. |
| Message | Main content. Supports drag/drop parameters. | String | Required. |
| Image Type | Single (No image), Richer (1 image), Carousel (>1 images). | Enum | Required. |
| Upload Image | Images for Richer or Carousel push. | Image / URL | Required if Image Type is not Single. |
| Link URL | URL to navigate to. | String (100) | Required. |
### Testing Message
- A "Send sample" function exists for all channel types to test the message rendering using a sample phone number, email, or CIF number.
## Post-Conditions
- All configured messages are available for use in Marketing Request, Campaign Rule, and Item Master.