Dashboard widget internals
Database tables
Database table | Description |
CMS_WidgetCategory | Stores records representing widget categories. |
CMS_Widget | Stores records representing widgets and their configuration. |
CMS_WidgetRole | Stores relationships between widgets and roles. Each entry in this table indicates that a specific widget can be used by users in a given role. |
Widget instance storage
The system stores the content of dashboard widget zones (widget instances) in the database. The location is different for the default content of widget zones and the widget content of user-specific dashboards.
Widget content type | Description | Storage |
Default zone content | The default widget content of zones. Prepared on the Design tab of dashboard templates. | In XML format in the PageTemplateWebParts column of the CMS_PageTemplate table. |
Dashboard zone content | Widget instances in personalized user and dashboard widget zones. The content depends on the current context (user and site). | In the CMS_Personalization table. |
API classes
Class | Namespace | Description |
CMS_WidgetCategory table API | ||
WidgetCategoryInfo | CMS.PortalEngine | Represents individual widget categories. |
WidgetCategoryInfoProvider | Provides management functionality for widget categories. | |
CMS_Widget table API | ||
WidgetInfo | CMS.PortalEngine | Represents individual widget objects. |
WidgetInfoProvider | Provides management functionality for widgets. | |
CMS_WidgetRole table API | ||
WidgetRoleInfo | CMS.PortalEngine | Represents relationships between widgets and roles (permissions). |
WidgetRoleInfoProvider | Provides management functionality for widget-role relationships. | |
CMS_Personalization table API | ||
PersonalizationInfo | CMS.DocumentEngine | Represents personalized versions of pages (for a specific site and user). |
PersonalizationInfoProvider | Provides management functionality for personalization objects. | |
Other classes | ||
WebPartInstance | CMS.PortalEngine | Allows you to work with widget instances. |
WebPartZoneInstance | Allows you to work with web part (widget) zones. | |