Page Properties page-properties
Learn about the different properties a page can have and how they control the behavior of the page and how it is managed.
Overview and Property Availability overview
Page properties can control many aspects of a page from the page’s title and branding to its permissions. The properties are distributed across several tabs, some of which may be hidden depending on the type of page. Like most properties in AEM, page properties can be inherited.
Basic Tab basic
Title & Tags title-tags
-
Title - Defines the page meta title for SEO purposes as well as the title displayed in the page content (unless overridden)
- The title of the page is shown in various locations in the AEM UI including the Sites card/list views in the Sites Console.
- This is a mandatory field.
-
Tags - Defines the page meta tags for SEO purposes
-
You can add or remove tags from the page by updating the list in the selection box.
-
Use the drop-down to select from existing tags.
-
After selecting a tag is it listed below the selection box. You can remove a tag from this list using the x.
-
A completely new tag can be entered by typing the name in an empty selection box.
- The new tag is created when you press enter.
- The new tag will then be shown with a small star on the right indicating that it is a new tag.
-
An x appears when you mouse-over a tag entry in the selection box, which can be used to remove that tag for this page.
-
For more information about tags, see Using Tag.
-
-
Hide in Navigation - Indicates whether the page is shown or hidden in the page navigation of the resulting site
Branding branding
Apply a consistent brand identity across pages by appending a brand slug to each page title. This functionality requires use of the Page Component from release 2.14.0 or later of the Core Components.
-
Brand Slug
- Override - Check to define the brand slug on this page.
- The value is inherited by any child pages unless they also have their Override values set.
- Override value - The text of the brand slug to be appended to the page title.
- The value is appended to the page title after a pipe character such as
Cycling Tuscany | Always ready for the WKND
- The value is appended to the page title after a pipe character such as
- Override - Check to define the brand slug on this page.
HTML ID html-id
- ID - HTML ID to apply to the component.
More Titles and Description more-titles
-
Page Title - A title to be used on the page
- This is typically used by title components.
- If empty, the Title is used.
-
Navigation Title - You can specify a separate title for use in the navigation (for example, if you want something more concise).
- If empty, the Page Title is used.
-
Subtitle - A subtitle for use on the page
-
Description - Your description of the page, its purpose, or any other details you want to add
On/Off Time on-off-time
The on/off time for a page is a convenient way to temporarily hide content that is already published. The content remains on the publish instance when it is off. Turning a page off does not unpublish the content.
-
On Time - The date and time at which the published page is made visible (rendered) on the publish environment. The page must be published, either manually or by pre-configured auto-replication.
- If already published, this page is available on the publish instance, but kept dormant (hidden) until rendering at the specified time.
- If not published and configured for auto-replication, the page is automatically published, then rendered, at the specified time.
- If not published and not configured for auto-replication, the page is not automatically published, so a 404 is seen when an attempt to access the page is made.
-
Off Time - Similar to and often used in combination with On Time, this defines the time at which the published page is hidden on the publish environment.
Leave these fields (On Time and Off Time) empty for pages you want to publish and have available immediately and have available on the publish environment until they are deactivated (the normal scenario).
Vanity URL vanity-url
This property lets you enter a vanity URL for this page, which can allow you to have a shorter and/or more expressive URL. For example, if the Vanity URL is set to welcome
to the page identified by the path /v1.0/startpage
for the website http://example.com
, then http://example.com/welcome
would be the vanity URL of http://example.com/content/v1.0/startpage
- Must be unique.
- Do not support regex patterns.
- Should not be set to an existing page.
-
Add - Select to show a field to define a vanity URL for the page.
- Select again to add multiple.
- Select the Remove icon to delete the vanity URL.
-
Redirect Vanity URL - Indicates whether you want the page to use the vanity URL or redirect to the page’s actual URL
Advanced advanced
Settings settings
-
Language - The page language
-
Language Root - Must be checked if the page is the root of a language copy
-
Redirect - Indicates the page to which this page should automatically redirect with an HTML
302 Found
status- Permanent Redirect - When checked, the page redirects to the target path provided along with an HTML
301 Moved Permanently
status.
- Permanent Redirect - When checked, the page redirects to the target path provided along with an HTML
-
Design
-
Alias - Specifies an alias to be used with this page
- For example, if you define an alias of
private
for the page/content/wknd/us/en/magazine/members-only
, then this page can also be accessed via/content/wknd/us/en/magazine/private
- Creating an alias sets the
sling:alias
property on the page node, which only impacts the resource, not the repository path. - Pages accessed by aliases in the editor cannot be published. Publish options in the editor are only available for pages accessed via their actual paths.
- See Localized page names under SEO and URL Management Best Practices for more information.
- For example, if you define an alias of
Configuration configuration
-
Inherited from <path> - Enable/disable inheritance of the Cloud Configuration for the page
- Toggles availability of Cloud Configuration for editing
-
Cloud Configuration - The path to the selected configuration
Template Settings template-settings
-
Allowed Templates - Defines the list of templates that are available within this sub-branch
- Each value must be an absolute path to a template.
- Use
/.*
to allow all templates below this path.
-
Use Page as Template - Create a new template based on the current page.
- Only applies to pages created for use with the Universal Editor leveraging Edge Delivery Services.
Authentication Requirement authentication
- Enable - Enables use of authentication to access the page
- Login Page - The page to be used for login
Export export
- Export Configuration - Specifies an export configuration
SEO seo
-
Canonical Url - Used to overwrite the page’s canonical URL
- If left blank the page’s URL is its canonical URL.
-
Robots Tags - Use the dropdown to select the robots tags to control the behavior of search engine crawlers
- Some options conflict with each other, in which case the more permissive option take precedence.
-
Generate Sitemap - When selected, a
sitemap.xml
is generated for this page, and its descendants.
Images images
Featured Image featured-image
This section is used to select and configure the image to be featured. This is used in components referencing the page; for example, teasers, page lists, etc.
- Image - You can Pick an asset, or browse for a file to upload, then Edit, or Clear the selected image.
- Alternative Text - A text used to represent the meaning and/or function of the image, commonly used by screen readers
- Inherit - Value taken from the DAM asset - When checked, the alternative text is populated with the value of the
dc:description
metadata in DAM.
Thumbnail thumbnail
This section is used to select and configure the image thumbnail for the page. This is used in components referencing the page; for example, teasers, page lists, etc.
- Generate Preview - Generate a preview of the page to use as thumbnail
- Upload Image - Upload an image to use as thumbnail
- Select Image - Select an existing asset to use as the thumbnail
- Revert - This option becomes available after you have made a change to the thumbnail. If you do not want to keep your change, you can revert that change before saving.
Cloud Services cloud-services
- Cloud Service Configurations - Defines which configuration is used for cloud services for the page
- Inherited from - For Live Copies and Language Copies, cloud configurations are by default inherited from the Blueprint.
- Uncheck to override inheritance
Personalization personalization
ContextHub Configurations contexthub-config
- ContextHub Path - Define the ContextHub configuration
- Segments Path - Define the Segments path
Targeting Configuration targeting-config
- Brand - Defines a Brand to specify a scope for Targeting
- This option requires the user account to be in the
Target Administrators
group.
- This option requires the user account to be in the
Permissions permissions
Use the Permissions tab to define which users, groups, or closed user groups (CUGs) can access and/or modify the page.
- Add Permissions
- Edit Closed User Group
- View the Effective Permissions
Blueprint blueprint
This tab is only visible for pages that serve as blueprints. Blueprints serve as the basis for Live Copies, and are part of Multi Site Management.
- Rollout - Initiate a rollout of blueprint content to the Live Copies
- Live Copy Overview - Open a window to browse the Live Copy page structure
- Current Live Copies - A list of pages that are based on (that is, are Live Copies of) the selected blueprint page
Live Copy live-copy
This tab is only visible for pages that are configured as live copies. As with blueprints, Live Copies are part of Multi Site Management.
- Synchronize - Synchronize Live Copy with blueprint, keeping local modifications
- Reset - Reset Live Copy to state of blueprint, removing local modifications
- Suspend - Suspend Live Copy from further rollout modifications
- Detach - Detach Live Copy from blueprint
Source source
- Displays the path of the blueprint for this Live Copy
Status status
- Lists current Live Copy status of the page
Configuration live-copy-config
- Live Copy Inheritance - If checked, the Live Copy configuration is effective on all children.
- Inherit Rollout Configs from Parent - If checked, the rollout configuration is inherited from the parent of the page.
- Choose Rollout Config - Defines the circumstances under which modifications are propagated from the Blueprint and only available when Inherit Rollout Configs from Parent is not selected
- List of excluded paths
Preview preview
When a preview environment is enabled, the following details are available:
- Preview URL - The URL used for accessing the content on the preview environment
Progressive Web App progressive-web-app
Through a simple configuration, a content author can enable progressive web app (PWA) features for experiences created in AEM Sites. Your site can then behave like a native app by becoming it installable on the home screen of the visitors’ device and available offline.
Configure installable experience config-pwa
-
Enable PWA - When enabled, visitors of the page can install the site as a PWA.
-
Startup URL - URL that should be loaded when the user launches the web app
- If the URL is relative the manifest URL is used as a base URL to resolve
- When empty, the URL of the page from which the app was installed is used.
- It is recommended to set a value.
-
Display Mode - How the browser should be hidden or otherwise presented to the user on the local device
-
Screen orientation - How the PWA will handle device orientations
-
Theme color - The color of the app that affects how the local user’s operating system displays the native UI toolbar and navigation controls
-
Background color - The background color of the app, which is shown as the app loads
-
Icon - The icon that represents the app on the user’s device when the PWA is installed
Cache management (Advanced) cache-management
-
Caching strategy and frequency of content refresh - Defines the caching model for your PWA.
-
Files to cache for offline use
- File pre-caching (technical preview) - Files hosted on AEM are saved to the local browser cache when the service worker is installing and before it is used.
- Client-side Libraries - Client-side libraries to cache for offline experience
- Path inclusions - Network requests for the defined paths are intercepted and cached content is returned in accordance with the configured Caching strategy and frequency of content refresh
- Path exclusions - These files will never be cached regardless of the settings under File pre-caching and Path inclusions.