configure_default_dashboard.md

title	description
Default dashboard configuration	Configure default dashboard.

Configure default dashboard

You can configure default dashboard under the ibexa.system.<scope>.admin_group configuration key.

Create ibexa_dashboard.yaml file in the config/packages/ directory. The following example configuration defines default dashboard:

ibexa:
    system:
        admin_group:
            dashboard:
                container_remote_id: dashboard_container
                default_dashboard_remote_id: default_dashboard
                users_container_remote_id: user_dashboards
                predefined_container_remote_id: predefined_dashboards
                section_identifier: dashboard
                content_type_identifier: dashboard_landing_page
                container_content_type_identifier: folder

Configuration can be set per SiteAccess or SiteAccess group.

All the settings in the configuration are reflected in the back office.

Container remote ID

Defines starting location container for all the dashboards, including customized and predifined ones. You can see it in the Admin panel, Dashboards section, Dashboards folder in the content tree. In the Technical details tab, it is defined as Location remote ID.

Default dashboard remote ID

Specifies default predefined dashboard. All the users can see this dashboard as a starting dashboard in the back office. You can see it in the Admin panel, Dashboards section, Default dashboard folder inside of Predefined dashboards container in the content tree. In the Technical details tab, it's defined as Location remote ID.

Users container remote ID

Defines a container for users folders, which contain all customized dashboards. You can see it in the Admin panel, Dashboards section, User dashboards folder inside of main Dashboards container in the content tree. In the Technical details tab, it's defined as Location remote ID.

Predefined container remote ID

Defines a container that contains all predefined dashboards created by Administrator. You can see it in the Admin panel, Dashboards section, Predefined dashboards folder inside of main Dashboards container in the content tree. In the Technical details tab, it's defined as Location remote ID.

Section identifier

Specifies the name of the Section.

Content type identifier

It is an identifier that represents dashboard content type. You can find it in the Admin panel, Dashboard content Ttpe section, View/Global properties tab.

Container content type identifier

Determines the content type identifier of the container for dashboards and lets you create additional structure for the predefined dashboards. By default all the dashboards containers are set as a folders.

If the folder content type doesn't exist or is modified, you can use another one, for example:

ibexa:
    system:
        default:
            dashboard:
                container_content_type_identifier: user_dashboard_container

The custom content type should be a container and needs to have a field type with name identifier.