Page History
Include Page | ||||
---|---|---|---|---|
|
Info |
---|
App descriptor is part of the Magnolia 6 UI framework. The fully qualified class name is If you work with the Magnolia 5 UI framework, see App descriptor for Magnolia 5 UI instead. |
Table of Contents |
---|
Anchor | ||||
---|---|---|---|---|
|
Code Block | ||
---|---|---|
| ||
icon: icon-app class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor appClass: info.magnolia.ui.framework.app.BaseApp label: Base App subApps: |
App descriptor properties
subApps | required Node containing subapps. | ||||||
appClass | required Fully qualified name of the Java class that contains the app business logic. The class must implement the
| ||||||
name | optional App name. If no value is specified, either the file name (without the suffix | ||||||
class | optional, default is App descriptor class that reads the configuration. The class must implement the
Another possible value is | ||||||
datasource | optional Connects the app to a data source. For this to work, you have to use the | ||||||
enabled | optional, default is Enables or disables the app. | ||||||
icon | optional Name of an SVG app icon. See How to add SVG icons for apps. | ||||||
i18nBasename | optional Message bundle for localized labels. | ||||||
label | optional Label displayed on the app icon in the app launcher. | ||||||
theme | optional Name of a custom app theme. |
Permissions
The permission to use an app is granted in the permissions
configuration. The subnodes are roles. This allows you to provision the app to certain users in your organization.
In the following example, the app is provisioned to the travel-demo-editor
and travel-demo-publisher
roles. The property names (editors
and publishers
) are arbitrary—you can use any name you like. The value must be a valid role name.
Code Block | ||
---|---|---|
| ||
appClass: info.magnolia.ui.framework.app.BaseApp class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor icon: icon-app label: Base App permissions: roles: editors: travel-demo-editor publishers: travel-demo-publisher |