🎓 Chatter Tutorial - Learn Chatter Functionalities

A comprehensive tutorial module to master Odoo's chatter integration with practical examples and inline documentation

✨ Key Features

📦 What's Included

• Contact Notes Model: A complete example model with full chatter integration
• Demo Buttons: Interactive buttons showing how to create messages from Python code
• Comprehensive Views: Tree, Form, Kanban, and Search views with best practices
• Inline Documentation: Extensive code comments explaining every aspect
• Working Examples: Real methods demonstrating message_post() and activity_schedule()
• Tutorial Page: Dedicated tab in the form view with learning resources

🎯 Learning Objectives

🚀 How to Use

1. Install the Module: Install erpl_chatter_tutorial from Apps menu
2. Open the App: Navigate to "Chatter Tutorial" application
3. Create a Contact Note: Click "New" to create your first contact note
4. Explore Chatter: Scroll down to see the chatter section with followers, activities, and messages
5. Try Demo Buttons: Go to the "Tutorial - Chatter Demo" tab and click the action buttons
6. Review the Code: Check the source code in models/contact_note.py and views/contact_note_views.xml

👨‍💻 Code Examples

Creating an Internal Message

def action_send_internal_message(self):
    """Post an internal message (note)"""
    for record in self:
        record.message_post(
            body="This is an internal message!",
            message_type='comment',
            subtype_xmlid='mail.mt_note',  # Internal note
        )
    return True

Scheduling an Activity

def action_create_activity(self):
    """Schedule a follow-up activity"""
    for record in self:
        activity_type = self.env.ref('mail.mail_activity_data_todo')
        record.activity_schedule(
            activity_type_id=activity_type.id,
            summary='Follow-up on note',
            note='Activity created from code',
            user_id=record.user_id.id,
            date_deadline=fields.Date.today() + timedelta(days=7)
        )
    return True

Form View with Chatter

<form string="Contact Note">
    <sheet>
        <!-- Your form fields here -->
    </sheet>
    
    <!-- Chatter Section -->
    <div class="oe_chatter">
        <field name="message_follower_ids" widget="mail_followers"/>
        <field name="activity_ids" widget="mail_activity"/>
        <field name="message_ids" widget="mail_thread"/>
    </div>
</form>

📋 Technical Details

🎓 Models Included

contact.note

Main tutorial model demonstrating chatter integration with:

• mail.thread - Provides messaging and follower features
• mail.activity.mixin - Adds activity scheduling capabilities
• Multiple field types with tracking enabled
• Methods for creating messages and activities programmatically
• State management with chatter notifications

contact.note.tag

Simple tag model for categorizing notes (demonstrates many2many relations)

💡 Best Practices Demonstrated

• Proper model inheritance for chatter support
• Using tracking=True for automatic change logging
• Correct usage of message_post() with different subtypes
• Activity scheduling with proper parameters
• Structured form views with chatter section
• Comprehensive inline code documentation
• Security access rights configuration

📖 Documentation

The module includes comprehensive documentation in the code:

• models/contact_note.py: Detailed docstrings explaining each method and field
• views/contact_note_views.xml: XML comments explaining view structure and widgets
• Tutorial Tab: In-app documentation with usage instructions

🔧 Installation

1. Download or clone this module to your Odoo addons directory
2. Update the apps list in Odoo
3. Search for "Chatter Tutorial" in the Apps menu
4. Click Install
5. Navigate to the "Chatter Tutorial" application to start learning!

🆘 Support & Contact

This module is developed and maintained by ERP Labz. For support, customization, or custom Odoo development services, please contact us:

• Website: erplabz.com
• Company: ERP Labz

📜 License

This module is licensed under OPL-1 (Odoo Proprietary License v1.0).