Magnolia 5.5 reached end of life on November 15, 2019. This branch is no longer supported, see End-of-life policy.
The Definitions app is the single place to find all definitions loaded by Magnolia through the Registry API.
The app displays active definitions from all sources - JCR and YAML - and origins - classpath, JCR and file system.
Light development introduced an additional configuration source in Magnolia and the app provides an overview of both JCR and file-based definitions. At a glance, back and front-end developers can see the definition sources.
In the Definitions app users can:
The app also shows definition decorations and configuration errors.
The app includes all definitions that are bound to a Registry (for example TemplateDefinitionRegistry ).
Definition types:
Templates | Template definitions | |
Dialogs | Dialog definitions | |
Apps | App definitions | |
| Themes | Theme definitions |
Renderers | Renderer definitions | |
Fieldtypes | Field type definitions | |
Mediaeditors | Media editor definitions | |
MessageViews | Message view definitions | |
Workflows | Workflow definitions | |
Workitemhandlers |
The app offers numerous filtering options to allow you to quickly find what you are looking for. Options can be combined to filter within options and grouped by definition type.
Example: Definitions from 1. all sources and 2. all modules, of 3.all types, with 4. the word teaser, grouped by 5. definition type.
You can refine the results displayed in the dropdown lists by typing the first letter(s) of the expected result in the field. For example in From modules type m for all module names starting with the letter m and ma for only the Mail and Marketing Tags modules
Options:
From module | Of type | With name | Grouped by | |||
optional Select module. Field displays all modules. Default is any modules. | optional Select definition type. Default is all types. | optional Type search term. | required Group results by type, name or source. Default is definition type. | optional Select to display only invalid definitions. Default is all definitions. | optional Select to display only YAML definitions. Default is all definitions. | optional Select to display only decorated definitions. Default is all definitions. |
You can expand any definition node to view a representation of the full configuration.
Example: File-based teaser
component in the MTK module.
Dedicated actions allow you to access a definition for editing in either the Resource files or Configuration app:
textImage
component definition from the Travel demo in the Definitions and Resources apps.login
component definition from the Public User Registration module in the Definitions and Configuration apps.All YAML definitions display in the Source column as File. The origin of these definitions could be the file system or the classpath. You can see each origin in the Resource files app.
Decorated definitions are marked in the Is decorated? column. The Show definition decorators action opens the Applied definition decorators popup which shows the source file and the decorated path of each decorator. Click to access the source file in the Resource files app.
Example: home
template from the Travel Demo (EE Pro version).
The app makes it easy to find problematic definitions:
The app is based on the content app framework and configured in YAML on the classpath at /src/main/resources/definitions-app/apps/definitions-app.yaml
.
The app requires NO additional configuration and it is NOT advisable to make any changes to the configuration file.