Using the Sling Resource Merger in AEM as a Cloud Service using-the-sling-resource-merger-in-aem

Overlays of resources using the search paths.

Overrides of component dialogs for the touch-enabled UI (cq:dialog), using the resource type hierarchy (by means of the property sling:resourceSuperType).

The content of the customized definition has a higher priority than that of the original (that is, it overlays or overrides it).

Where necessary, properties defined in the customization, indicate how content merged from the original is to be used.

ensure that customization changes are not made in /libs.

reduce the structure that is replicated from /libs.

When using the Sling Resource Merger it is not recommended to copy the entire structure from /libs as this would result in too much information being held in the customization (usually /apps). Duplicating information unnecessarily increases the chance of problems when the system in upgraded in any way.

sling:hideProperties ( String or String[])

Specifies the property, or list of properties, to hide.

The wildcard * hides all.

sling:hideResource ( Boolean)

Indicates whether the resources should be completely hidden, including its children.

sling:hideChildren ( String or String[])

Contains the child node, or list of child nodes, to hide. The properties of the node are maintained.

The wildcard * hides all.

sling:orderBefore ( String)

Contains the name of the sibling node that the current node should be positioned in front of.

Overlay

• The definition of the navigation entry for the Sites console, as shown in the rail is defined at:

  /libs/cq/core/content/nav/sites/jcr:title

• To overlay this, create the following node:

  /apps/cq/core/content/nav/sites

  Then update the property jcr:title as required.

Override

• The definition of the touch-enabled dialog for the Texts console, is defined at:

  /libs/foundation/components/text/cq:dialog

• To override this, create the following node - for example:

  /apps/the-project/components/text/cq:dialog

Add a property

The property does not exist in the /libs definition, but is required in the /apps overlay/override.

1. Create the corresponding node within /apps
2. Create the new property on this node ``

Redefine a property (not auto-created properties)

The property is defined in /libs, but a new value is required in the /apps overlay/override.

1. Create the corresponding node within /apps

2. Create the matching property on this node (under / apps)

   • The property will have a priority based on the Sling Resource Resolver configuration.

   • Changing the property type is supported.

     If you use a property type different to the one used in /libs, then the property type you define is used.

Redefine an auto-created property

By default, auto-created properties (such as jcr:primaryType) are not subject to an overlay/override to ensure that the node type currently under /libs is respected. To impose an overlay/override you have to recreate the node in /apps, explicitly hide the property and redefine it:

1. Create the corresponding node under /apps with the desired jcr:primaryType

2. Create the property sling:hideProperties on that node, with the value set to that of the auto-created property; for example, jcr:primaryType

   This property, defined under /apps, will now take priority over the one defined under /libs

Redefine a node and its children

The node and its children are defined in /libs, but a new configuration is required in the /apps overlay/override.

1. Combine the actions of:

   1. Hide children of a node (keeping the properties of the node)
   2. Redefine the property/properties

Hide a property

The property is defined in /libs, but not required in the /apps overlay/override.

1. Create the corresponding node within /apps

2. Create a property sling:hideProperties of type String or String[]. Use this specify the properties to be hidden/ignored. Wildcards can also be used. For example:

   • *
   • ["*"]
   • jcr:title
   • ["jcr:title", "jcr:description"]

Hide a node and its children

The node and its children are defined in /libs, but not required in the /apps overlay/override.

1. Create the corresponding node under /apps

2. Create a property sling:hideResource

   • type: Boolean
   • value: true

Hide children of a node (while keeping the properties of the node)

The node, its properties and its children are defined in /libs. The node and its properties are required in the /apps overlay/override, but some or all child nodes are not required in the /apps overlay/override.

1. Create the corresponding node under /apps

2. Create the property sling:hideChildren:

   • type: String[]
   • value: a list of the child nodes (as defined in /libs) to hide/ignore

   The wildcard * can be used to hid/ignore all child nodes.

Reorder nodes

The node and its siblings are defined in /libs. A new position is required so the node is recreated in the /apps overlay/override, where the new position is defined in reference to the appropriate sibling node in /libs.

• Use the sling:orderBefore property:

  1. Create the corresponding node under /apps

  2. Create the property sling:orderBefore:

     This specifies the node (as in /libs) that the current node should be positioned before:

     • type: String
     • value: <before-SiblingName>

Overlay:

• purpose: merge resources based on their search path

• mount point: /mnt/overlay

• usage: mount point + relative path

• example:

  • getResource('/mnt/overlay' + '<relative-path-to-resource>');

Override:

• purpose: merge resources based on their super type

• mount point: /mnt/overide

• usage: mount point + absolute path

• example:

  • getResource('/mnt/override' + '<absolute-path-to-resource>');