McQueen/module-vendor-sales-report
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve email subject configuration documentation

Browse Source 
- Clarify subject template placeholders in system.xml comment
- Update README.md to be more explicit about {{month}} and {{year}} usage
- Add example in copilot-instructions.md for better clarity
This commit is contained in:
shopkeeperdev
2025-11-03 17:29:40 -05:00
parent fc2838d68a
commit 9afacc7fe1
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/copilot-instructions.md vendored
View File

@@ -93,7 +93,7 @@ SELECT * FROM cron_schedule WHERE job_code = 'shopkeeper_vendorsalesreport_month
### Configuration ### Configuration
- **Email Recipients**: Must be comma-separated, validated before sending - **Email Recipients**: Must be comma-separated, validated before sending
- **Order Status**: Stored as comma-separated string, converted to array by helper - **Order Status**: Stored as comma-separated string, converted to array by helper
- **Subject Templates**: Support `{{month}}` and `{{year}}` placeholders - **Subject Templates**: Support `{{month}}` and `{{year}}` placeholders for dynamic email subjects (e.g., "Monthly Report - {{month}} {{year}}")
### Performance ### Performance
- **Raw SQL**: Used for performance with large datasets - avoid ORM for report queries - **Raw SQL**: Used for performance with large datasets - avoid ORM for report queries

2
README.md
View File

@@ -66,7 +66,7 @@ php bin/magento cache:flush
#### Email Settings #### Email Settings
- **Enable Email**: Enable/disable email delivery - **Enable Email**: Enable/disable email delivery
- **Email Recipients**: Comma-separated list of email addresses - **Email Recipients**: Comma-separated list of email addresses
- **Email Subject**: Subject line for automated emails (supports {{month}} and {{year}} placeholders) - **Email Subject**: Subject line for automated emails (use {{month}} and {{year}} placeholders for dynamic values)
- **Email Sender**: Choose which store email identity to use as sender - **Email Sender**: Choose which store email identity to use as sender
### Example Configuration ### Example Configuration

2
etc/adminhtml/system.xml
View File

@@ -37,7 +37,7 @@
</field> </field>
<field id="subject" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="0" showInStore="0"> <field id="subject" translate="label comment" type="text" sortOrder="30" showInDefault="1" showInWebsite="0" showInStore="0">
<label>Email Subject</label> <label>Email Subject</label>
<comment>Subject line for automated report emails. Use {{month}} and {{year}} for dynamic values.</comment> <comment>Subject line for automated report emails. Use {{month}} and {{year}} placeholders for dynamic values (e.g., "Monthly Report - {{month}} {{year}}").</comment>
<depends> <depends>
<field id="enabled">1</field> <field id="enabled">1</field>
</depends> </depends>