Introduction
Introduction
In the Empress Framework, it’s a common requirement to manage multiple sites (tenants) using the same application, where each site may need specific customizations on top of the given DocType. These customizations could range from additional Custom Fields to specific naming conventions or other configuration that caters to specific needs.
This guide aims to walk developers through the various approaches provided by the Empress Framework to allow for site-specific customization. These techniques are integral to the development of scalable business solutions in Empress, offering the flexibility to tailor applications to meet the unique needs of each tenant.
Approaches for Customization
Empress Framework provides multiple ways to implement site-specific customization:
-
Custom Field: This is a DocType that keeps track of site-specific fields.
-
Property Setter: This strategy keeps track of specific properties that are overridden in DocType and its children.
-
Customize Form: This feature offers a view that simplifies the customization of DocTypes.
-
Client Script: Client-side event handlers offer additional functionality.
-
Server Script: This feature enables developers to add additional server-side business logic.
-
Custom DocPerm: This feature allows for additional permissions, handled via the Role Permission Manager.
Delving Into the Customize Form
The Customize Form is a powerful feature that simplifies the process of overriding properties of a DocType and adding Custom Fields via a single view.
When you modify any properties of the DocType via Customize Form, the underlying DocType doesn’t change. Instead, new custom objects are added to override these properties, and this process is done in a seamless manner.
Adding Custom Links and Actions
Starting from version 13, you can also add or edit Links and Actions via the Customize Form. These changes are saved in the same DocTypes (DocType Link and DocType Action), but with a custom property checked.
These additional custom configurations are automatically applied when metadata is fetched via frappe.get_meta.
Conclusion
Allowing for site-specific customization in multi-tenant applications is a critical feature in the Empress Framework. It provides developers the flexibility to tailor applications to the unique needs of each tenant, enhancing the overall user experience without altering the core DocType. By leveraging these features, developers can effectively integrate and customize business solutions in Empress, promoting scalability and adaptability.