Thematic page load process - Bloomreach Experience - Open Source CMS

Thematic page load process

Thematic page URL

Thematic pages have a unique URL pattern on your site. A thematic page URL consists of your site's domain or URL, a unique thematic URL pattern, and the name of the page's theme.

During the integration process, you need to choose a thematic URL pattern for all of your thematic pages. Common thematic URLs include  shop, trends, and designs, but you aren't limited to this list. You can choose nearly anything you want to be your thematic URL. You need to choose something now, but you can change it later. If you decide to change the thematic URL pattern, then you need to work with your Bloomreach CSM to make the change.

Page load process

When your customer starts to load a thematic page, the browser sends the request to your website. Here’s an example of the URL pattern that the browser sends to your site:

http://m.www.example.com/popular/white-dresses.html 

 This example URL has the following variables:

  • m indicates that the customer is loading the page on a mobile browser. Bloomreach extracts this information from the browser's user agent. There's only a device type indicator if you use separate page templates for different types of devices.
  • popular is the URL pattern that all of the example company's thematic pages use. You choose your own thematic URL pattern. Examples include trendsglamor, and designs, but you can choose nearly anything you want. It must be unique to your domain. 
  • white-dresses is the name of the thematic page.

JSON page load process

Upon receiving your customer's page load request, your servers recognize the URL pattern as a thematic page and construct a thematic search API call to Bloomreach's servers. Bloomreach returns a JSON response that your servers process. You parse the following data, in particular:

  • Relevant products and their corresponding details, such as prices and descriptions

  • Facets, filters, and links to other relevant thematic pages

  • Page-level information:

    • Title tag
    • H1
    • Meta description
    • Canonical URL
    • Noindex
    • Nofollow

You use this returned data to construct the page. The data is inserted into the same category template that you use throughout your site.  You return this page to your customer.

HTML page load process

Upon receiving your customer's page load request, you extract the page name and the user agent. With this information, you construct an API call to Bloomreach servers. Bloomreach returns the page header and body HTML snippets in a format that’s appropriate for the device type.

The client receives this information and constructs the thematic page, using the URL it originally sent to your site’s servers. The thematic page includes the HTML body snippets, wrapped with site navigation and footer. The client returns this page to your customer.

Error handling

If there's an error in an API call, then your customer's browser behaves the same way that it does when it attempts to load a category page that doesn't exist. Bloomreach doesn't redirect your customer to the homepage nor record the timeout parameter.

Common errors are related to timeouts or a theme name that doesn't exist.

Tip

We recommend that you redirect HTTP errors to your site's home page.

Timeouts

We recommend that you set the timeout for your thematic pages to 2 seconds.

If there's a timeout during a thematic page load, then we recommend that you redirect your customer with a HTTP 302 response code to your site's home page. Append this specific tracking parameter redirected the URL: ?_thto=1. This parameter serves a few purposes: 

  • It ensures that your customers always receive a page load.

  • It collects data to assist Bloomreach in troubleshooting timeouts. 

For example, let’s say that the following page encounters a timeout error when loading:

http://www.example.com/shop/gorgeous-red-cocktail-dresses

Then the site redirects the customer to the home page with a 302 response code, and uses the following URL:

http://www.example.com/?_thto=1

Your Bloomreach TPM can work with you to determine the ideal timeout setting for your requirements.

Bad theme names

If a theme name doesn't exist, then Commerce Organic sends a 404 error. For example, Dresses by Colette assigns gorgeous-red-cocktail-dresses as the theme name for one of its Thematic Pages.

http://www.example.com/shop/gorgeous-red-cocktail-dresses shows site visitors a Thematic Page called Gorgeous Red Cocktail Dresses.

http://www.example.com/shop/gorgeous-red-cocktail-dress shows site visitors a 404 error because the correct theme name uses the plural form of dress: dresses.

As with all other HTTP errors, we recommend that you redirect the error to your site's home page.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?