AEM provides various mechanisms to enable you to customize the consoles (and the page authoring functionality) of your authoring instance (touch-optimized UI).
- Clientlibs
Clientlibs allow you to extend the default implementation to realise new functionality, while reusing the standard functions, objects and methods. When customizing, you can create your own clientlib under /apps; for example to hold the code required for your custom component.
- Overlays
Overlays are based on node definitions and allow you to overlay the standard functionality (in /libs) with your own customized functionality (in /apps). When creating an overlay a 1:1 copy of the original is not required, as the sling resource merger allows for inheritance.
These can be used in many ways to extend your AEM consoles. A small selection are covered below (at a high level).
註解：
For further information see:
- Using and creating clientlibs.
- Using and creating overlays.
- Granite
This topic is also covered in the AEM Gems session - User interface customization for AEM 6.0.
注意：
You must not change anything in the /libs path.
This is because the content of /libs is overwritten the next time you upgrade your instance (and may well be overwritten when you apply either a hotfix or feature pack).
The recommended method for configuration and other changes is:
- Recreate the required item (i.e. as it exists in /libs) under /apps
- Make any changes within /apps
For example, the following locations within the /libs structure can be overlaid:
- consoles (any consoles based on Granite UI pages); for example:
- /libs/wcm/core/content
- secondary (inner) rails; for example:
- /libs/wcm/core/content/search
- toolbar(s) (dependent on console; for example sites):
- default
/libs/wcm/core/content/sites/jcr:content/body/content/header/items/default - selection mode
/libs/wcm/core/content/sites/jcr:content/body/content/header/items/selection
- default
- help menu options (dependent on console; for example sites):
- /libs/wcm/core/content/sites/jcr:content/body/help
- information shown on the card view (dependent on console; for example sites):
- /libs/wcm/core/content/sites/jcr:content/body/content/content/items/childpages
註解：
See the Knowledge Base article, Troubleshooting AEM TouchUI issues, for further tips and tools.
Various packages have been made available on Github. These provide code samples related to the tasks covered on this page.
aem-admin-extension-new-console is a sample package showing how to create a new AEM 6 console. This package provides a UI for managing Launches and adds a link in the navigation:
Code on GitHub
You can find the code of this page on GitHub
- Open aem-admin-extension-new-console project on GitHub
- Download the project as a ZIP file
aem-admin-extension-customize-sites is a sample package showing how to customize an existing AEM 6 admin console. This package provides updates to Sites administration:
Code on GitHub
You can find the code of this page on GitHub
- Open aem-admin-extension-customize-sites project on GitHub
- Download the project as a ZIP file
-
You can create a custom console with related actions; for example, Launches at the top level (below Sites):
This involves:
- creating the root space definition of your new console; for example:
- /apps/<yourProject>/admin/ext/launches
- this can contain (according to requirements):
- the corresponding clientlibs for custom actions and less/css definitions
- /apps/<yourProject>/admin/ext/launches/clientlibs
- components that need to be redefined/adjusted; for example, the breadcrumbs, datasource and the launch
- /apps/<yourProject>/admin/ext/launches/components
- the Granite UI page resource:
- /apps/<yourProject>/admin/ext/launches/content/jcr:content
property: sling:resourceType
- /apps/<yourProject>/admin/ext/launches/content/jcr:content
- the page definition of the console
- /apps/<yourProject>/admin/ext/launches/content/jcr:content/head
- /apps/<yourProject>/admin/ext/launches/content/jcr:content/body
- the corresponding clientlibs for custom actions and less/css definitions
To use the new console (for example in the rail for navigation) an ID is used, so that it can be explicitly referenced. The ID is used to connect the console and its navigation definition. The ID is defined in the rail node of the page; for example, for the Sites console:
- the rail node is:
/libs/wcm/core/content/sites/jcr:content/body/rail- here the currentId property is defined:
currentId = cq-sites
- here the currentId property is defined:
For the Launches console example:
- the node is:
- /apps/<yourProject>/admin/ext/launches/content/jcr:content/body/rail
- with the following properties:
- currentId = cq-launches
- sling:resourceType = granite/ui/components/endor/navcolumns
- srcPath = cq/core/content/nav
- creating the root space definition of your new console; for example:
aem-admin-extension-customize-sites is a sample package showing how to customize an existing AEM 6 admin console. This package provides updates to Sites administration:
Code on GitHub
You can find the code of this page on GitHub
- Open aem-admin-extension-customize-sites project on GitHub
- Download the project as a ZIP file
-
You can add a navigation entry in the rail (for example, a custom console such as Launches).
To do this, you create an overlay of:
/libs/cq/core/content/nav
In the /apps overlay:
/apps/cq/core/content/nav
Create the new nodes and properties:
- Extend navigation:
- /apps/cq/core/content/nav/launches
- Specify location in the tree:
- property: sling:orderBefore
- To create the connection, the id property references (i.e. must be the same as) the currentID property for the appropriate console:
- property: id
- value: same as for your console (e.g. cq-launches)
for example: the same value as the currentId property on:
/apps/<yourProject>/admin/ext/launches/content/jcr:content/body/rail
- Extend navigation:
aem-admin-extension-customize-sites is a sample package showing how to customize an existing AEM 6 admin console. This package provides updates to Sites administration:
Code on GitHub
You can find the code of this page on GitHub
- Open aem-admin-extension-new-console project on GitHub
- Download the project as a ZIP file
-
Open the user and/or group management and select the user/group you want to restrict access for.
註解：
Avoid assigning/restricting permissions on a user-by-user basis. It is recommended to use groups.
-
Remove access permissions to the appropriate node(s) under /libs/cq/core/content/nav/sites. These correlate to the navigation options in the rail:
- projects
- sites
- assets
- apps
- forms
- screens
- personalization
- commerce
- tools
- communities
註解：
This feature is optimized for columns of text fields; for other data types it is possible to overlay cq/gui/components/siteadmin/admin/listview/columns/analyticscolumnrenderer in /apps.
Code on GitHub
You can find the code of this page on GitHub
- Open aem-sites-extension-listview-columns project on GitHub
- Download the project as a ZIP file
-
Overlay the list of available columns.
- On the node:
/apps/wcm/core/content/common/availablecolumns - Add your new columns - or remove existing ones.
See Using Overlays (and the Sling Resource Merger) for more information.
- On the node:
-
Optionally:
- If you want to plug additional data, you need to write a PageInforProvider with a
pageInfoProviderType property.
For example, see the class/bundle attached (from GitHub) below.
- If you want to plug additional data, you need to write a PageInforProvider with a
When using a console, a common use case is when the user must select from resources (e.g. pages, components, assets, etc.). This can take the form of a list for example from which the author must choose an item.
In order to keep the list to a reasonable size and also relevant to the use case, a filter can be implemented in the form of a custom predicate. See this article for details.
