|
| 1 | + |
1 | 2 | # OpenSPP Branding Kit |
2 | 3 |
|
3 | | -This document describes the **OpenSPP Branding Kit** module, which provides comprehensive debranding and rebranding functionality for Odoo 17 installations used within the OpenSPP ecosystem. |
| 4 | +The OpenSPP Branding Kit module enables administrators to fully customize the visual identity of their OpenSPP instance and manage its telemetry settings. This module ensures that the platform consistently reflects an organization's brand and provides granular control over data sharing practices. |
4 | 5 |
|
5 | 6 | ## Purpose |
6 | 7 |
|
7 | | -The **OpenSPP Branding Kit** module is designed to: |
| 8 | +The OpenSPP Branding Kit module accomplishes several key objectives to present a unified and controlled platform experience: |
8 | 9 |
|
9 | | -* **Apply OpenSPP Branding**: Replace removed Odoo branding with OpenSPP-specific branding elements, including logos, colors, text, and system information. |
10 | | -* **Control Telemetry and External Communications**: Provide administrators with control over telemetry data collection and external service communications. |
11 | | -* **Hide Paid Applications**: Optionally filter out enterprise and paid Odoo applications from the Apps menu to focus on open-source modules. |
12 | | -* **Customize System Behavior**: Offer configuration options for system naming, documentation URLs, and support links. |
| 10 | +* **Customizes System Branding**: It allows organizations to replace default branding elements across all interfaces with their own, ensuring a consistent and professional appearance for users. This includes custom system names, logos, and support information. |
| 11 | +* **Manages Telemetry Data**: The module provides explicit control over the collection and redirection of anonymous usage statistics, allowing organizations to comply with privacy policies or disable telemetry entirely. This supports data sovereignty requirements. |
| 12 | +* **Removes Non-OpenSPP Elements**: It removes or replaces references to other platforms and promotional content, presenting a clean, OpenSPP-centric user experience. This helps avoid confusion and maintains focus on the social protection program. |
| 13 | +* **Standardizes System Messages**: It customizes default system messages and email signatures to align with OpenSPP branding and communication standards. This reinforces the platform's identity in all user interactions. |
| 14 | +* **Optimizes User Interface**: The module streamlines the user interface for OpenSPP-specific workflows, enhancing usability and relevance for social protection program managers and field staff. |
13 | 15 |
|
14 | 16 | ## Dependencies and Integration |
15 | 17 |
|
16 | | -1. **Odoo 17 Core**: This module is built specifically for Odoo 17 and utilizes its standard extension mechanisms. |
17 | | - |
18 | | -2. **OpenSPP Muk Theme ([theme_openspp_muk](theme_openspp_muk))**: Depends on the OpenSPP Muk theme module which provides the base visual theme and styling framework for the OpenSPP platform. |
| 18 | +The OpenSPP Branding Kit is a foundational module that integrates deeply with the OpenSPP core and other thematic modules to provide a consistent user experience. |
19 | 19 |
|
| 20 | +* It depends on the `base`, `web`, and `base_setup` modules for core system functionality, web client operations, and basic configuration settings, respectively. |
| 21 | +* Crucially, it relies on the :ref:`theme_openspp_muk` module to apply the visual styling and layout that defines the OpenSPP aesthetic. The Branding Kit then layers specific customizations on top of this theme. |
| 22 | +* This module serves other OpenSPP modules by establishing a standardized visual and operational environment. By setting system-wide branding and telemetry rules, it ensures that all other modules operate within a consistent, OpenSPP-branded framework. |
20 | 23 |
|
21 | 24 | ## Additional Functionality |
22 | 25 |
|
23 | | -* **Configuration Management ([ir.config_parameter](ir.config_parameter))**: |
24 | | - * Introduces system-wide configuration parameters with the `openspp.*` prefix for centralized branding control. |
25 | | - * Provides settings for system name, documentation URLs, support links, and telemetry endpoints. |
26 | | - * Enables toggle options for features like hiding paid apps. |
27 | | - |
28 | | -* **Module Filtering ([ir.module.module](ir.module.module))**: |
29 | | - * Implements intelligent filtering of paid applications (OEEL and OPL licensed modules) from the Apps menu. |
30 | | - * Maintains visibility of paid modules in administrative views while hiding them from the standard Apps interface. |
31 | | - * Provides helper methods for counting and filtering paid applications. |
32 | | - |
33 | | -* **Web Interface Customization**: |
34 | | - * Provides custom routes for OpenSPP-specific information pages. |
35 | | - * Modifies session information to include OpenSPP branding data. |
36 | | - * Implements telemetry redirection to OpenSPP endpoints when enabled. |
37 | | - |
38 | | -* **Company Branding Updates ([res.company](res.company))**: |
39 | | - * Automatically updates company information with OpenSPP branding during module installation. |
40 | | - * Sets default report headers and footers with OpenSPP information. |
41 | | - * Updates company website references to OpenSPP URLs. |
42 | | - |
43 | | -* **User Interface Enhancements**: |
44 | | - * Customizes login page styling with OpenSPP branding. |
45 | | - * Modifies backend interface colors and styling. |
46 | | - * Updates user menu items and removes Odoo-specific links. |
47 | | - * Provides custom email signature templates. |
48 | | - |
49 | | -* **Security and Privacy Features**: |
50 | | - * Disables unnecessary telemetry and external communications by default. |
51 | | - * Removes promotional content and enterprise upselling elements. |
52 | | - * Implements proper permission controls for branding configuration. |
53 | | - |
54 | | -## Module Components |
| 26 | +The module offers comprehensive features for brand management and operational control within the OpenSPP platform. |
55 | 27 |
|
56 | | -* **Controllers**: Custom HTTP routes for OpenSPP-specific pages and version information. |
57 | | -* **Models**: Extensions to core Odoo models for branding customization. |
58 | | -* **Data Files**: XML configuration for default parameters and company settings. |
59 | | -* **Views**: XML templates for UI customization across backend, login, and report interfaces. |
60 | | -* **Static Assets**: CSS, JavaScript, and image files for visual branding. |
61 | | -* **Tests**: Comprehensive test suite ensuring proper functionality and coverage. |
| 28 | +### Customizing System Information and Visuals |
62 | 29 |
|
63 | | -## Installation Hooks |
| 30 | +Administrators can personalize various aspects of the OpenSPP interface to match their organization's identity. This includes setting a custom system name, defining specific documentation and support URLs, and controlling the visibility of "Powered by OpenSPP" branding. These changes are reflected across the entire platform, including the login page, system reports, and the backend user interface, ensuring a cohesive look and feel. The module also overrides default email signatures to incorporate OpenSPP branding automatically. |
64 | 31 |
|
65 | | -* **Post-Installation Hook**: Automatically applies initial branding configuration, disables Odoo promotional elements, and updates company information. |
66 | | -* **Uninstall Hook**: Cleanly removes OpenSPP configuration parameters while preserving user data. |
| 32 | +### Telemetry and Data Privacy Control |
67 | 33 |
|
68 | | -## Configuration Options |
| 34 | +The Branding Kit provides essential tools for managing data privacy. Organizations can easily enable or disable the collection of anonymous usage statistics (telemetry) directly from the system settings. For active telemetry, administrators can configure a custom endpoint where this data is sent, allowing for compliance with specific data governance policies or redirection to internal analytics services. This feature empowers organizations to control their data footprint effectively. |
69 | 35 |
|
70 | | -The module provides various configuration parameters that can be adjusted through the Settings interface or directly via system parameters: |
| 36 | +### Interface Optimization |
71 | 37 |
|
72 | | -* `openspp.system.name`: Custom system name displayed throughout the interface |
73 | | -* `openspp.telemetry.enabled`: Enable or disable telemetry data collection |
74 | | -* `openspp.documentation.url`: Custom documentation URL for help links |
75 | | -* `openspp.support.url`: Custom support URL for assistance |
| 38 | +To provide a focused OpenSPP experience, this module removes or modifies elements that refer to other platforms or promote non-OpenSPP services. This includes removing external account URLs from user profiles and optimizing the interface to highlight OpenSPP-specific workflows. By streamlining the user experience and eliminating extraneous content, the module ensures that the platform remains dedicated to its primary mission of social protection program management. |
76 | 39 |
|
77 | 40 | ## Conclusion |
78 | 41 |
|
79 | | -The **OpenSPP Branding Kit** module provides a complete solution for transforming an Odoo 17 installation into a fully branded OpenSPP platform. It ensures consistent branding across all interfaces while maintaining system functionality and providing administrators with granular control over branding and behavior settings. The module's modular architecture and adherence to Odoo best practices ensure compatibility with future updates and seamless integration with other OpenSPP modules. |
| 42 | +The OpenSPP Branding Kit is a pivotal module that empowers organizations to fully brand their OpenSPP instance and manage telemetry, delivering a professional, consistent, and privacy-compliant platform for social protection programs. |
0 commit comments