The following sections provide an overview of the configuration models for features that enable content spotlighting in the reference implementation.
The Record Spotlight cartridge can promote either specific featured records or a set of dynamic records based on a navigation state.
The response model
for this cartridge is
RecordSpotlight, which includes a list of
Record objects and an optional action to show all
records (in the case of a dynamic record spotlight).
The Record Spotlight configuration model allows you to configure the selected records and "See All" link within a record spotlight, as well as the record fields to pass through to the cartridge response model.
The
configuration model for this cartridge is
RecordSpotlightConfig. It includes the following
properties:
|
Property name |
Description |
|---|---|
|
|
A string representing the maximum number of
records that this spotlight can contain. If the content administrator
designates specific records in the Experience Manager, the number of records
cannot exceed the value of
|
|
|
A
|
|
|
A Boolean that determines whether to display
the "See All" link. The link requires a value for
|
|
|
A string representing the display text for a link that represents the navigation state of a dynamic record spotlight. If this string is not configured, no link is generated for the client application. |
|
|
For aggregated records, returns all derived
properties to the end user. Defaults to
|
|
|
For aggregated records, returns all snippeted
properties to the end user. Defaults to
|
|
|
For aggregated records, returns all
geodistance properties to the end user. Defaults to
|
|
|
A list of record fields to pass through from
the record to the
|
|
|
For aggregated records, a list of sub-record
fields to pass through from each sub-record to the
|
You can configure which properties and dimensions can be displayed in a spotlight.
Although the content administrator can designate the records for a spotlight either by specifying a search and navigation query or by specifying individual record IDs, the Assembler query that fetches the spotlighted records is always a navigation query (using records in the specific record case). Therefore, the configuration that determines which properties and dimensions are returned with the record for spotlighting is "show with record list." This configuration can be overridden in the cartridge handler configuration. For more information about configuring the display of properties and dimensions for the record list, refer to the Developer Studio Help.
Related links
The Record Spotlight cartridge handler extends the
NavigationCartridgeHandler. The application-wide default
configuration in the Assembler context file specifies record properties to pass
through to the cartridge handler response model.
A Record Spotlight cartridge enables a content administrator to specify a set of contextually relevant records to spotlight on a particular page.
The Record Spotlight cartridge template allows a content administrator to configure the following properties on the configuration model:
These properties are configured using the Spotlight Selection editor.
In addition, the cartridge template includes the following pass-through property:
The Media Banner cartridge displays video or images to the site user and can be configured to link to a static page, a single record, or a specified navigation state.
The response model
for this cartridge is
MediaBanner, which includes a
MediaObject and an
ActionLabel that contains a destination link.
The configuration model for the Media Banner cartridge includes a media object and an associated link.
The
configuration model for this cartridge is
MediaBannerConfig. It includes the following properties:
No special configuration is required for the media banner, but your MDEX Engine configuration will affect the display of records in the link selector when setting a navigation state or choosing a specified record.
The Media Banner cartridge handler extends the
NavigationCartridgeHandler, but otherwise does not require
any additional configuration.
The Media Banner enables the content administrator to use the media selector and link editor to create a media banner that links to a specified page, selected record, or dynamic navigation state.
The Media Banner cartridge template allows a content administrator to configure the following properties on the configuration model:
In addition, the cartridge template includes the following pass-through property:
|
Property name |
Description |
|---|---|
|
|
(Optional) The alt-text to display when the end user hovers over the media asset in the application. |
For detailed information about the properties within the
media and
link properties, consult the Javadoc for the
MediaObject and
LinkBuilder classes.
