Partial Page Rendering URL

Info: Available since brXM version 12.3.0

Overview

Partial page rendering allows you to include a specific dynamic page fragment, managed by the Web Content Management System (WCMS), within an external web application. For example, you can embed only the main content area of a product detail page (such as http://www.example.com/products/hippobloomy.html) into your e-commerce site, while excluding sections like top, menu, and footer.

You can configure dedicated HST SiteMapItems and HST Pages for each fragment you want to include. However, this approach requires additional configuration.

Bloomreach Content supports partial page rendering URLs natively. You can specify a "subPath" in the navigational URL to render only a specific component of a page. For example, a request to http://www.example.com/products/hippobloomy.html./main/content renders only the main/content component, not the entire page. The "subPath" is added after the standard page URL using the delimiter "./".

Using SubPath to Target a Child Component

Consider the following resolved component hierarchy for the page at http://www.example.com/products/hippobloomy.html:

/productpage:
  jcr:primaryType: hst:component
  # SNIP
  /top:
    jcr:primaryType: hst:component
    # SNIP
  /menu:
    jcr:primaryType: hst:component
    # SNIP
  /main:
    jcr:primaryType: hst:component
    # SNIP
    /content:
      jcr:primaryType: hst:component
      # SNIP
  /footer:
    jcr:primaryType: hst:component
    # SNIP
copy

The component structure can also be visualized as:

____________________________________________
|                  top                      | 
|___________________________________________|
|           |             main              |
|           |     ______________________    |
| menu      |     |       body          |   |
|           |     |                     |   |
|           |     |_____________________|   |
|___________|_______________________________|
|                  footer                   | 
|___________________________________________|

To render only the main/body component, use the URL http://www.example.com/products/hippobloomy.html./main/body. To render only the menu component, use http://www.example.com/products/hippobloomy.html./menu.

If you understand the component hierarchy, you can use partial page rendering URLs to integrate specific fragments into external websites without additional configuration for HST SiteMapItems or HST Pages.

Configuring the SubPath Delimiter

By default, the subPath delimiter is set to "./". This default is recommended for most use cases. If you need to change the delimiter, configure the following property in /WEB-INF/hst-config.properties:

container.request.path.suffix.delimiter = ./

The subPath delimiter is also used in Content/Context-Aware JAX-RS Services. If you change the delimiter, ensure you use the same value in both configurations.