This app descriptor has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.
For the updated implementation, see App descriptor for Magnolia 6 UI instead.
An app descriptor describes an app. The descriptor assigns the app a name, icon and implementation class. The name of the app content node must be unique as it is used to refer to the app across the system. This means you cannot name your own app
pages since a Pages app already exists.
Referring to a content type
This approach keeps the app descriptor very short. There is no need to specify the below mentioned properties. The content types and content apps frameworks automatically generate and register an app description based on the content type definition.
Example:You can tailor the app descriptor within the same file by adding additional configuration which will overwrite any configuration with the same name coming from the
!content-typedirective. Alternatively create a decoration. For further details please see Using Magnolia Content Types - Creating a content app based on the content type.
Here is an example descriptor for a
Node containing subapps.
Fully qualified name of the Java class that contains the app business logic. The class must implement the App interface.
Name of the app.
If a value is not provided, either the file name (without the suffix .yaml) or the JCR node name is used.
optional, default is
App descriptor class that reads the configuration. The class must implement the AppDescriptor interface.
Describes the app with a content type.
For this to work, you have to:
The following stock apps have a contentType class assigned so that they can be easily referenced:
Use the Definitions app to check the name of the content type.
optional , default is
Enables and disables the app.
The name of an SVG app icon. See How to add SVG icons for apps.
Message bundle for localized labels.
Label displayed on the app icon in the app launcher.
Name of a custom app theme.
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 this example the helloworld app is provisioned to
travel-demo-publisher roles. The role property name (
publishers) is arbitrary - use any name you like. The value must be a valid role name.