Naming Conventions

Last update: April 17, 2024

CREATED FOR:

  • Developer

Nodes in the repository are subject to naming conventions of the Java Content Repository. However AEM imposes further conventions for the name of page nodes.

Naming Conventions for Pages

These naming conventions are implemented at various levels:

JCR Utilities

JcrUtil is the AEM implementation of the JCR utilities. Of particular interest to validating names are the character mappings that it controls and the following validations:

  • isValidName

    • Checks if the name is not empty and contains only valid chars.
    • Can be used to check whether a proposed name is valid.

  • createValidName

    • This creates a valid label out of an arbitrary string.
    • It can be used to create a name from a title.

Page Manager

PageManager provides methods for page level operations, based on JCRUtil.

Standard UI

The standard, touch-enabled UI:

  • Validates the name according to the restrictions imposed by PageManager when either:

    • a page title is provided for conversion into the node name
    • an explicit node name is provided

Classic UI

The classic UI imposes tighter restrictions:

  • Validates the name when an explicit node name when either:

    • a page title is provided for conversion into the node name
    • an explicit node name is provided

  • Valid characters (only these characters are actually valid when a page is created from within the classic UI, even though PageManagerImpl would allow additional characters):

    • ‘a’ to ‘z’
    • ‘A’ to ‘Z’
    • ‘0’ to ‘9’
    • _ (underscore)
    • - (dash/minus)
recommendation-more-help