Skip to content

System Configuration

Currently available in beta

Admin Dashboard is currently available in beta, which means some of the features, specifications, and details provided herein are subject to change. We recommend checking back regularly for the most up-to-date information and viewing our roadmap in regard to the general availability release.

There are a number of system configuration options related to the admin dashboard module. These options can be found by logging into the admin and navigating to Stores -> Settings -> Configuration -> Hyvä Themes -> Admin Dashboard. Each option is documented below.

Generic Configuration

Enable Dashboard Widgets

  • Config Path: hyva_admin_dashboard/general/enable
  • Default Value: Yes

This configuration option toggles the dashboard widget functionality on or off. Setting this option to No will remove the Hyvä Commerce dashboard content and prevent admin users from viewing, creating, editing, or deleting widgets.

Keep Default Dashboard Content

  • Config Path: hyva_admin_dashboard/general/keep_default
  • Default Value: Yes

This configuration option toggles the default Magento dashboard content on or off. Setting this option to No will remove the default dashboard blocks, buttons, and store switcher.

Developer Note: Handling Customised Default Dashboards

You can control which blocks are added or removed by this configuration option by customising the Hyva\AdminDashboardFramework\Observer\Adminhtml\PopulateAdminDashboard observer's defaultDashboardBlocks constructor argument via etc/adminhtml/di.xml. The item name is the name of the block and its value is a boolean flag to control its inclusion in the dashboard.

Hyvä Commerce Dashboard Position

  • Config Path: hyva_admin_dashboard/general/widget_dashboard_position
  • Default Value: Before

This configuration option controls whether the Hyvä Commerce dashboard content is displayed before or after the default Magento dashboard content. This configuration option only takes effect when both sets of dashboard content are enabled i.e. when both hyva_admin_dashboard/general/enable and hyva_admin_dashboard/general/keep_default are set to Yes.

Google CrUX History Widget Configuration

Google CrUX History Widget Availability

This set of system configuration is only available when the Hyva_AdminDashboardGoogleCruxHistoryWidget module is installed and enabled.

API Key

  • Config Path: hyva_admin_dashboard/google_crux_history/api_key
  • Default Value: N/A

This configuration option houses the API key for the Google CrUX history API.