â Helpdesk Rating Five Stars
Odoo 18
Helpdesk
Customer Satisfaction
Transform your customer feedback experience by replacing Odoo's standard
3-emoticon rating system with an intuitive 5-star rating system. Gain more
granular insights into customer satisfaction and improve your helpdesk service quality.
⨠Key Features
5-star rating system (1-5 stars) replacing the standard 0-3 emoticon system
Interactive star rating widget with hover effects for web forms
Clickable star links in email rating requests for one-click feedback
Automatic migration of existing ratings from 0-3 to 0-5 scale
Enhanced rating reports and analytics with 0-5 scale calculations
Beautiful star display in backend ticket views (form, tree, kanban)
Responsive design optimized for mobile and desktop
Accessible UI with keyboard navigation and ARIA labels
Full compatibility with Odoo's rating API and other modules
Duplicate rating prevention with automatic update logic
đ Requirements
- Odoo Version: 18.0 or higher
- Required Modules: helpdesk, rating, mail, web
- Python Version: 3.10 or higher
- Database: PostgreSQL 12 or higher
đ Installation
â ī¸ Important: Before installing, it's recommended to backup your database,
especially if you have existing rating data. The module will automatically migrate
existing ratings from the 0-3 scale to the 0-5 scale.
Step 1: Copy Module to Addons Directory
Copy the helpdesk_rating_five_stars folder to your Odoo addons directory:
cp -r helpdesk_rating_five_stars /path/to/odoo/addons/
Or if using custom addons directory:
cp -r helpdesk_rating_five_stars /path/to/custom/addons/
Step 2: Update Addons Path (if needed)
Ensure your odoo.conf includes the addons directory:
addons_path = /path/to/odoo/addons,/path/to/custom/addons
Step 3: Restart Odoo Server
Restart your Odoo server to load the new module:
sudo systemctl restart odoo
Or if running manually:
./odoo-bin -c /path/to/odoo.conf
Step 4: Update Apps List
- Log in to Odoo as an administrator
- Go to Apps menu
- Click the Update Apps List button
- Click Update in the confirmation dialog
Step 5: Install the Module
- In the Apps menu, remove the "Apps" filter to show all modules
- Search for "Helpdesk Rating Five Stars"
- Click the Install button
- Wait for installation to complete (migration runs automatically)
â
Installation Complete! The module is now active and all existing
ratings have been migrated to the 0-5 scale.
âī¸ Configuration
The module works out of the box with zero configuration required. However, you can
customize certain aspects if needed:
Email Templates
To customize the rating request email template:
- Go to Settings â Technical â Email â Templates
- Search for "Helpdesk Rating Request"
- Edit the template to customize the email content and styling
- The star links are automatically generated and should not be removed
Star Icon Customization
The module uses Unicode star characters (â) by default. To use custom icons:
- Edit
static/src/scss/rating_stars.scss
- Modify the star icon styles or replace with custom images
- Restart Odoo and clear browser cache
Rating Migration Mapping
The default migration mapping converts old ratings as follows:
| Old Rating (0-3) |
New Rating (0-5) |
Description |
| 0 |
0 |
No rating / Not rated |
| 1 (đ Unhappy) |
3 (âââ) |
Neutral / Average |
| 2 (đ Okay) |
4 (ââââ) |
Good / Satisfied |
| 3 (đ Happy) |
5 (âââââ) |
Excellent / Very Satisfied |
đ Usage Examples
Example 1: Customer Rating via Email
- Customer receives a rating request email after ticket is closed
- Email contains 5 clickable star links
- Customer clicks on the 4th star to give a 4-star rating
- System records the rating and redirects to a thank you page
- Helpdesk agent sees 4 filled stars in the ticket view
Example 2: Customer Rating via Web Form
- Customer clicks "Rate this ticket" link in email or portal
- Web form displays 5 interactive stars
- Customer hovers over stars to preview rating
- Customer clicks on desired star to select rating
- Customer submits the form
- Rating is saved and displayed in backend views
Example 3: Viewing Rating Statistics
- Helpdesk manager navigates to Helpdesk â Reporting â Ratings
- Dashboard shows average ratings calculated on 0-5 scale
- Manager can filter by rating value (1-5 stars)
- Manager can group ratings by team, agent, or time period
- Export includes rating values in 0-5 range
Example 4: Viewing Ratings in Ticket Views
Form View:
- Open any helpdesk ticket
- Rating is displayed as filled stars in the rating section
- Example: 3-star rating shows âââââ
List View:
- Navigate to Helpdesk â Tickets
- Rating column shows compact star display
- Sort and filter by rating value
Kanban View:
- Switch to kanban view in tickets
- Each ticket card shows star rating
- Quick visual feedback on customer satisfaction
Example 5: Handling Duplicate Ratings
- Customer rates a ticket with 3 stars
- Customer changes their mind and clicks the rating link again
- Customer selects 5 stars
- System updates the existing rating to 5 stars (no duplicate created)
- Confirmation message indicates rating was updated
đ§ Troubleshooting
Stars Not Displaying in Backend
Solution:
- Clear browser cache and reload the page
- Ensure the module is properly installed and activated
- Check browser console for JavaScript errors
- Verify that static files are being served correctly
Email Rating Links Not Working
Solution:
- Verify that the rating token is valid and not expired
- Check that the base URL is configured correctly in Odoo settings
- Ensure the rating controller route is accessible
- Check server logs for any errors
Migration Issues
Solution:
- Check the Odoo server logs for migration errors
- Verify database permissions for the Odoo user
- If migration fails, uninstall the module, fix issues, and reinstall
- Contact support if data integrity issues occur
Rating Values Outside 1-5 Range
Solution:
- The module enforces validation constraints
- Invalid values are rejected with error messages
- Check for custom code that might bypass validation
- Review database constraints are properly applied
đ Security & Access Control
The module implements the following security measures:
- Token-based authentication: Rating submissions require valid tokens
- Public access: Customers can submit ratings without logging in
- Restricted modification: Only authorized users can modify ratings in backend
- Audit logging: All rating changes are logged for accountability
- Input validation: All rating values are validated server-side
- SQL injection prevention: Uses Odoo ORM for all database operations
đ Accessibility Features
The module is designed with accessibility in mind:
- Keyboard navigation: Use arrow keys to navigate stars, Enter to select
- ARIA labels: Screen readers announce star ratings correctly
- Touch-friendly: Stars are sized appropriately for mobile devices
- High contrast: Star colors meet WCAG 2.1 AA standards
- Focus indicators: Clear visual feedback for keyboard users
đ Compatibility
This module is compatible with:
- Odoo 18 Community and Enterprise editions
- All standard Odoo modules that use the rating system
- Custom modules that properly inherit from rating.rating
- Multi-company configurations
- Multi-language installations (translatable strings)
âšī¸ Note: The module maintains full API compatibility with Odoo's
standard rating system, ensuring no breaking changes for other modules.
đ Technical Details
Module Structure
- Models: Extends rating.rating and helpdesk.ticket
- Controllers: Custom rating submission controller
- Views: Enhanced backend views with star display
- Templates: Email and web form templates
- JavaScript: OWL-based star rating widget
- Styles: SCSS for star styling and responsive design
Database Changes
- No new tables created
- Modifies constraints on rating.rating.rating field
- Adds computed fields for star display
- Migration script updates existing rating values
đ Support
For support and assistance:
- Contact your Odoo administrator for installation help
- Review the module documentation in the
static/description/ directory
- Check the Odoo server logs for error messages
- Consult the module source code for technical details
đ License
This module is licensed under LGPL-3. See the LICENSE file for details.
đĨ Credits
Developed for Odoo 18 Helpdesk application enhancement.
Helpdesk Rating Five Stars | Version 1.0 | Odoo 18