Workbench definition

Workbench is a view that displays content items in a workspace. It’s part of the content app framework, typically defined in the browser subapp. The workbench contains a list of content views. Common view types are tree, list, and thumbnail.

By default, JCR content apps use the tree view type.

The Pages and Assets apps also use another type of workbench definition: the filtering workbench definition that supports search and filtering capabilities.

This workbench definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.contentapp.configuration.WorkbenchDefinition.

If you work with the Magnolia 5 UI framework, see Workbench definition for Magnolia 5 UI instead.

Example definition

    # add view definitions
    - view:
        $type: thumbnailView
      icon: icon-view-thumbnails
      expandRatio: 1f
  name: wbName

Workbench properties

Property Description



Parent node for the content view definitions. Defines how users can view content in the workbench.

Must contain at least one content view. For more information, see Content view definition.



List of extension views configured in the workbench. Available classes:

  • info.magnolia.ui.contentapp.configuration.ExtensionViewDefinition

  • info.magnolia.ui.chooser.definition.FullTextSearchExtensionViewDefinition

You can see an example extension view configured to display analytics data in the Pages app in the Modules/extensions-and-frameworks/analytics-integration-framework.adoc#_analytics_where_you_need_them documentation.


optional only supported by Pages and Assets app

Contains a list of info.magnolia.ui.filteringapp.filter.FilterViewDefinition.



Actual view definition to be displayed in the extension panel. Must implement the info.magnolia.ui.ViewDefinition interface.


optional, default is 0

Defines how space is divided in the workbench. A value of 1f means that the extension panel occupies the same amount of space as the content panel.


optional, default is false for ExtensionViewDefinition and true for FullTextSearchExtensionViewDefinition

When true, the extension panel is displayed horizontally. For this to work, the view must extend com.vaadin.ui.HorizontalLayout.


optional, default is icon-analytics-app

CSS class that identifies an icon used for the extension panel. For available names, see Icons.


optional, default is workbench

Name of the workbench.


DX Core



This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules
6.3 beta

Magnolia 6.3 beta

Magnolia 6.3 is in beta. We are updating docs based on development and feedback. Consider the 6.3 docs currently in a state of progress and not final.

We are working on some 6.3-beta known issues during this phase.