Single Delivery Web Application Mode

Single Delivery Web Application Mode is a supported project structure in Bloomreach Content. This mode maintains the default structure used in projects before version 13 and supports only a single delivery web application. Single Delivery Web Application Mode is primarily intended for projects upgrading from earlier versions, as it reduces the number of required upgrade steps. After upgrading, you can optionally restructure the project to use Multi Delivery Web Application Mode. This aligns the project with the structure referenced throughout the documentation.

Characteristics of Single Delivery Web Application Mode

A project using Single Delivery Web Application Mode has the following characteristics:

  • The site module is not divided into sub-modules.
  • There is no separate cms-dependencies module.
  • There is no separate module for repository data definitions specific to the delivery web application's HST configuration.
  • The hst.configuration.rootPath property in the delivery web application's hst-config.properties file is set to /hst:hst.
  • The cms/src/main/resources/hcm.properties file sets use.hcm.sites to false.
  • The delivery web application's META-INF folder does not contain a hcm-site.yaml file.

Repository Data Handling in Single Delivery Web Application Mode

In Single Delivery Web Application Mode, repository data definitions are packaged and bootstrapped from the CMS/platform web application. This includes HST configuration and web files specific to the delivery web application. As a result, the delivery web application's configuration is bundled with the CMS/platform web application, which ties the delivery web application to a specific version of the CMS/platform web application.

The CMS/platform web application uses HST configuration stored in the repository under /hst:platform. The delivery web application uses HST configuration stored under /hst:hst, as specified in the hst-config.properties file.

The use.hcm.sites property in the hcm.properties file, located at the class-loader root of the delivery web application, instructs the Configuration Management mechanism to use delivery web application-specific definitions packaged with the CMS/platform web application. It does not look for separate definitions provided by each delivery web application.

Using Essentials with Single Delivery Web Application Mode

By default, Essentials expects a project structure that uses Multi Delivery Web Application Mode. To enable Essentials to work correctly with a project in Single Delivery Web Application Mode, update the essentials/src/main/resources/project-settings.xml file as follows:

  • Set <hstHcmDependenciesAlias> to CMS (use uppercase).
  • Set <cmsDependenciesModule> to the CMS WAR module directory, typically cms.
  • Set <siteComponentsSubModule> to the delivery WAR module directory, typically site.
  • Set <siteWebappSubModule> to the delivery WAR module directory, typically site.

After making these changes, Essentials can interact correctly with a project using Single Delivery Web Application Mode.

Share Feedback
Page: /about/for-architects/multi-site-multi-tenant/single-site-mode
Section: About
Category *