1.8 Dashboard App

Dashboard is the main user interface for:

  • Administering the system, reviewing analytics, data, and generating reports.

  • Providing a unified administration space for users working with multiple Retailys applications at once.

  • Third-party applications do not need to write their own admin front ends; they can simply use <dashboard:section> in the manifest to define how their data or functionality should appear in the Dashboard (e.g., forms, tables, charts).

The Dashboard consists of multiple visual components:

  • Main Menu (Left Menu): Allows users to switch between “routes.”

  • Top Bar: A top navigation bar with basic features (search, notifications, language switching, user menu, etc.).

  • Canvas: A container for the primary page content (which may include controls like tables, charts, etc.).

  • Routes: Logical representation of menu items and subpages. Each route points to a particular canvas="someCanvas".

  • Controls: Individual widgets—datagrids, forms, charts, etc.

  • Datasets / Resources: In the manifest, you define the data sources (e.g., Datanest entities, bridging tables), and the Dashboard uses those definitions to build the UI.

Last updated