Teacher Evaluation Email GUI Workflow
This guide covers how to send teacher evaluation emails through the web interface, configure automatic email settings, and manage email preferences using the graphical user interface.
Table of Contents
- Overview
- Manual Email Sending
- Batch Email Configuration
- Automatic Email Setup
- Email Format Preferences
- Organization SMTP Configuration
- Troubleshooting
Overview
The Teacher Evaluation system provides comprehensive email functionality through an intuitive web interface. You can:
- Send individual evaluation reports via email
- Send batch evaluation summaries via email
- Configure automatic email sending for completed evaluations
- Set email format preferences (PDF, DOCX, CSV)
- Add custom messages to emails
- Override recipient email addresses
- Use organization-specific SMTP settings
Email Features
- Multiple Attachment Formats: PDF, Word Document (DOCX), and CSV
- Custom Messages: Add personalized messages to emails
- Organization Branding: Emails use your organization's name and settings
- Fallback Recipients: Manual email override for cases where teacher email is not available
- Automatic Sending: Configure batch evaluations to send emails upon completion
Manual Email Sending
Sending Individual Evaluation Emails
- Navigate to Evaluation
- Go to Assessment → Teacher Evaluation Dashboard
- Click on any completed individual evaluation
-
Or go directly to:
/assessment/teacher-evaluation/evaluation/{evaluation_id}/ -
Access Email Function
- Look for the "Email Report" button on the evaluation details page
-
Click "Email Report" to open the email dialog
-
Fill Email Details
- Teacher Name: Enter the teacher's full name
- Email Address: Enter the recipient's email address
- Attachment Formats: Select which formats to include:
- ☑️ PDF Report
- ☑️ Word Document
- ☐ CSV Data (optional)
-
Additional Message: Add a custom message (optional)
-
Send Email
- Review the details
- Click "Send Email"
- You'll see a success confirmation
- The recipient will receive the email with attachments
Example Email Content:
Subject: Teacher Evaluation Report - [Teacher Name]
Dear [Teacher Name],
Your Individual Evaluation evaluation report has been generated and is attached to this email.
[Additional Message if provided]
Evaluation Summary
Rubric: [Rubric Name]
Evaluated by: [Evaluator Name]
Evaluation Date: [Date]
Score: [Score]/[Total Possible]
Format: PDF, Word Document
The attached files contain detailed analysis of your teaching feedback quality,
including scores, recommendations, and performance insights.
Best regards,
[Organization Name] Team
Sending Batch Evaluation Emails
- Navigate to Batch
- Go to Assessment → Teacher Evaluation → Batch Dashboard
- Click on any completed batch evaluation
-
Or go directly to:
/assessment/teacher-evaluation/batch/{batch_id}/ -
Access Email Function
- Look for the "Email Report" button on the batch details page
-
Click "Email Report" to open the email dialog
-
Fill Email Details
- Teacher Name: Enter the teacher's full name
- Email Address: Enter the recipient's email address
- Attachment Formats: Select which formats to include:
- ☑️ PDF Summary Report
- ☑️ Word Document Summary
- ☐ CSV Detailed Data (optional)
-
Additional Message: Add a custom message (optional)
-
Send Email
- Review the details including batch summary
- Click "Send Email"
- You'll see a success confirmation with batch statistics
Example Batch Email Content:
Subject: [Organization] - Teacher Evaluation Report - [Teacher Name]
Dear [Teacher Name],
Your Batch Evaluation evaluation report has been generated and is attached to this email.
[Additional Message if provided]
Evaluation Summary
Batch Name: [Batch Name]
Rubric: [Rubric Name]
Evaluated by: [Evaluator Name]
Evaluation Date: [Date]
Total Feedbacks: [Count]
Average Score: [Score]/[Total Possible]
Format: PDF, Word Document
The attached files contain detailed analysis of your teaching feedback quality,
including scores, recommendations, and performance insights.
Best regards,
[Organization Name] Team
Batch Email Configuration
Configuring Auto-Email Settings
- Access Batch Settings
- Navigate to a batch evaluation
-
Click "Edit Batch" or go to:
/assessment/teacher-evaluation/batch/{batch_id}/edit/ -
Email Configuration Section Look for the "Email Settings" section with these options:
-
Send Email on Completion: ☑️ Enable automatic email sending
- Manual Email Recipient: Override email address for manual cases
- Email Format Preferences: Choose default attachment formats
-
Default Email Message: Set a standard message for auto-emails
-
Email Format Options
- PDF Only: Send only PDF format
- Word Document Only: Send only DOCX format
- PDF and Word Document: Send both PDF and DOCX (recommended)
-
All Formats: Send PDF, DOCX, and CSV
-
Save Settings
- Click "Save Batch Settings"
- Settings will apply to future automatic emails
Manual Email Recipient Override
Use Case: When teacher email is not available or for adhoc evaluations
How to Configure:
1. In the batch edit page, find "Manual Email Recipient"
2. Enter the fallback email address (e.g., department.head@university.edu)
3. This email will be used when:
- Teacher profile doesn't have an email
- Evaluation is for a manual teacher entry
- You want to send to a different recipient
Example Scenario:
Batch: "Guest Lecturer Feedback Analysis"
Manual Email Recipient: coordinator@department.edu
Use Case: Guest lecturer doesn't have a profile in the system
Automatic Email Setup
Enabling Auto-Email for Batches
- Create or Edit Batch
- Go to Assessment → Teacher Evaluation → Create Batch
-
Or edit an existing batch
-
Configure Auto-Email
- ☑️ Send email on completion: Enable automatic sending
- Email format preferences: Select
pdf_docx(recommended) -
Email message: Enter default message like:
Your teacher evaluation has been completed. Please review the attached reports and contact us if you have any questions. -
Set Manual Recipient (Optional)
- Add fallback email for cases where teacher email is unavailable
-
Example:
teaching.coordinator@university.edu -
Run Batch Evaluation
- When the batch completes processing
- The system automatically sends emails to:
- Teacher's registered email (if available)
- Manual recipient email (if teacher email not found)
- Includes attachments based on format preferences
Auto-Email Workflow
Batch Completed → Check Auto-Email Enabled → Get Teacher Email → Generate Attachments → Send Email
↓
If No Email Found
↓
Use Manual Recipient Email
Email Format Preferences
Available Formats
- PDF Report
- Professional formatted document
- Includes charts and detailed analysis
- Best for sharing and archiving
-
File size: ~200-500KB
-
Word Document (DOCX)
- Editable format for further customization
- Includes all evaluation details
- Can be modified by recipients
-
File size: ~300-800KB
-
CSV Data Export
- Raw data in spreadsheet format
- Detailed scoring breakdown
- Suitable for further analysis
- File size: ~50-200KB
Setting Default Preferences
For Individual Batches:
1. Edit the batch
2. Set "Email Format Preferences" to:
- pdf_only - PDF format only
- docx_only - Word document only
- pdf_docx - Both PDF and Word (recommended)
- all_formats - PDF, Word, and CSV
For Organization-Wide: 1. Go to Django Admin → Organizations → [Your Organization] 2. Configure organization-wide email preferences 3. These become the default for new batches
User Experience by Format
| Format | Best For | File Size | Editability |
|---|---|---|---|
| Professional sharing, printing | Small | Read-only | |
| DOCX | Further editing, customization | Medium | Fully editable |
| CSV | Data analysis, spreadsheets | Smallest | Raw data |
Organization SMTP Configuration
Setting Up Custom SMTP
Admin Access Required: Organization administrators can configure custom SMTP
- Access Organization Settings
- Go to Django Admin Panel
-
Navigate to Organizations → [Your Organization] → Settings
-
SMTP Configuration
- SMTP Enabled: ☑️ Enable organization SMTP
- SMTP Host: Your mail server (e.g.,
smtp.university.edu) - SMTP Port: Usually 587 (TLS) or 465 (SSL)
- SMTP Username: Your email account username
- SMTP Password: Your email account password
- Use SSL: ☑️ For port 465
- Use TLS: ☑️ For port 587
- From Name: Display name (e.g., "University Evaluation System")
-
From Email: Reply-to address (e.g.,
noreply@university.edu) -
Test Configuration
- Send a test email to verify settings
- Check that emails appear with your organization branding
SMTP Fallback System
If organization SMTP fails or is not configured: - System automatically falls back to default PrepareBuddy SMTP - Emails still get delivered successfully - From address will be from PrepareBuddy notification accounts
Email Flow:
Email Request → Check Organization SMTP → If Available: Use Org SMTP
→ If Not Available/Fails: Use Default SMTP
Troubleshooting
Common Issues and Solutions
1. "Email Report" Button Not Visible
Possible Causes: - Evaluation not completed - User lacks email permissions - Browser cache issues
Solutions: - Ensure evaluation status is "completed" - Check user has examiner role - Refresh page or clear browser cache - Check URL: should be on evaluation/batch details page
2. Email Not Received
Check These Steps: 1. Verify Email Address: Ensure recipient email is correct 2. Check Spam Folder: Emails might be filtered as spam 3. Confirm Email Sent: Look for success message in web interface 4. Check Organization SMTP: If using custom SMTP, verify settings 5. Contact IT: Organization email server might have issues
Success Indicators: - ✅ Green success message appears - ✅ "Email sent successfully" confirmation - ✅ No error messages displayed
3. Attachments Missing
Possible Causes: - File generation errors - Email size limits exceeded - SMTP server restrictions
Solutions: - Try with fewer attachment formats - Check if PDFs generate correctly via download first - Contact administrator about email size limits
4. Wrong Organization Name in Emails
Issue: Email shows incorrect organization name
Solution:
- This was a known issue that has been fixed
- Emails now correctly use batch.rubric.organization name
- If still seeing issues, contact support
5. Authentication Errors
Symptoms: - "Permission denied" messages - Unable to access email functionality
Solutions: - Ensure you're logged in with examiner privileges - Check organization membership status - Contact administrator for role assignment
Email Delivery Debugging
For Administrators:
-
Check Django Logs
bash # Look for email service logs tail -f /path/to/django.log | grep EMAIL_SERVICE -
Common Log Messages:
EMAIL_SERVICE: Starting email send to user@example.com- Email initiatedEMAIL_SERVICE: Email sent successfully- Delivery successful-
FALLBACK_EMAIL: Using account: notification@preparebuddy.com- Using fallback SMTP -
SMTP Testing ```python # Django shell test from qbank.utils.email_service import send_teacher_evaluation_email
result = send_teacher_evaluation_email( recipient='test@example.com', teacher_name='Test Teacher', report_type='Test Email', organization=your_organization, attachments=[], additional_message='This is a test email' ) print(f"Email result: {result}") ```
Getting Help
For Users: - Contact your organization administrator - Check this documentation for common solutions - Use the "Help" section in the web interface
For Administrators: - Check Django admin logs - Verify SMTP configuration - Test email functionality with simple emails first - Contact technical support if issues persist
Support Contacts: - Organization Issues: Your local IT administrator - Technical Problems: System administrator - Feature Requests: Contact development team
Quick Reference
Email Workflow Summary
- Complete Evaluation/Batch → Status becomes "completed"
- Click "Email Report" → Opens email dialog
- Fill Details → Teacher name, email, formats, message
- Send Email → System generates attachments and sends
- Confirmation → Success message with details
Key URLs
- Individual Evaluation:
/assessment/teacher-evaluation/evaluation/{id}/ - Batch Evaluation:
/assessment/teacher-evaluation/batch/{id}/ - Batch Edit:
/assessment/teacher-evaluation/batch/{id}/edit/ - Email Templates: Django Admin → Email Templates
Default Settings
- Format Preference: PDF + Word Document
- Auto-Email: Disabled by default
- SMTP: Uses organization SMTP if configured, otherwise defaults to system SMTP
- Email Template: Standard teacher evaluation email template
For API integration and programmatic email sending, see the Teacher Evaluation Email API documentation.
