Build

JCR content repository, HST configuration, component development, REST services, search, security, workflows, plugins, enterprise features, and upgrades

Importersconcept
An importer is custom code that creates nodes in the Java Content Repository (JCR), either directly through the JCR API or indirectly via workflow.
Update Editorconcept
The Groovy updater automates large-scale content modifications in Bloomreach Content, making bulk changes and document refactoring more efficient than manual editing.
Edge Caching with Bloomreach Contentconcept
Edge caching with a CDN improves page load times and local content availability for dynamic pages delivered by Bloomreach Content, but caching the full Page Model API response or fully rendered Freemarker pages at the CDN layer interferes with targeting, segmentation, and instant publication.
Serving Optimized Images from Cloud CDNconcept
Bloomreach Cloud Content customers using PaaS or SaaS can serve CMS-uploaded images through the Cloudflare CDN.
Storing Images and Assets (Externalisation)concept
Bloomreach Content stores binary assets such as images, PDFs, and other files through the JCR-backed repository used by the CMS and SITE applications.
Detecting Personalisation via Custom Valveshow to
The Content Delivery Tier (HST) processes requests through a pipeline of valves assembled with Spring Framework configurations.
SSO General Introductionconcept
Single Sign-On (SSO) in Bloomreach Content uses provider-specific integration, and the implementation depends on the SSO provider, project requirements, and libraries in use.
SSO in CMS with Spring Securityconcept
CMS authentication can use Single Sign-On through Spring Security while an external Identity Provider performs the actual login.
SSO Example: Okta SAML2 Integrationhow to
Okta SAML2 single sign-on (SSO) integrates with Bloomreach Content through Spring Security and OpenSAML.
Performance Test Suiteconcept
The Bloomreach XM performance test suite measures CMS editorial performance in a running Bloomreach Content environment.
Website Development Best Practicesconcept
Essentials setup applies development best practices for Bloomreach Content projects to maintain quality, avoid common issues, and streamline upgrades.
Delivery Tier Component Developmentconcept
Delivery tier component development in Bloomreach Content uses the HST delivery tier, which follows a Hierarchical Model-View-Controller (MVC) pattern.
Hst Component Configuration Propertiesreference
HST component configuration uses repository properties to define rendering, inheritance, and Java-backed behavior.
Define Configuration Parameters for Delivery Tier Components or REST Serviceshow to
Configuration parameters for delivery tier components or REST services are defined in a Java interface with @org.hippoecm.hst.core.parameters.Parameter annotations on getter methods.
HstComponent Java Classconcept
The HstComponent class defines the contract for components used in the Bloomreach Content HST container.
Hst Component Persistable annotation and workflowconcept
Repository nodes are writable from an HstComponent in the doAction method, while doBeforeRender modifications are technically possible but discouraged.
Forms and the HST ActionURLconcept
Bloomreach Content supports the Post-Redirect-Get (PRG) pattern for form submissions in the delivery tier.
HstComponent Java Class Examplesconcept
Custom HstComponent Java classes access content beans, request parameters, and component configuration through the HstRequestContext and component helper methods.
Serve a Dynamic Resourcehow to
Dynamic resources from a page component use hst:resourceURL in the component template and doBeforeServeResource in the component class.
Asynchronous HST Components and Containersconcept
HST components and containers support asynchronous rendering by default.
Hst Configuration Model loadingconcept
The Delivery Tier loads an HST configuration model for each Site web application.
Extend Common Component with a Do-Before-Render Extensionconcept
CommonComponent exposes a doBeforeRender extension point through org.onehippo.cms7.essentials.components.ext.DoBeforeRenderExtension.
Configure a Documentation Link for a Componenthow to
An external documentation link for a component appears as a "?" icon in the Experience Manager application.
Override the Default HST Component Classreference
When a page component does not define hst:componentclassname, the delivery tier (HST) uses org.hippoecm.hst.core.component.GenericHstComponent by default.
Server-Side Parallel Hst Component Preprocessingconcept
Bloomreach Content supports parallel execution at the HstComponent level through #prepareBeforeRender(HstRequest, HstResponse) in the HstComponent interface.
Hello World (Tutorial)tutorial
Bloomreach Content uses the delivery tier (HST) and an MVC pattern to render pages from templates, page components, and sitemap mappings.
Manage Contentconcept
Bloomreach Content separates configuration and content into the hcm-config and hcm-content folders.
YAML Formatconcept
Bloomreach Content uses YAML 1.1 for config definitions in source files.
Manage Configurationconcept
Implementation-specific configuration and optional content are bootstrapped into the repository through YAML resources.
System Properties with Initial Value(s)concept
System properties with initial values in Bloomreach Content are bootstrapped when a single-value property does not exist or when a multi-value property does not yet contain newly added values.
Categorizationconcept
The Configuration Model in Bloomreach Content classifies repository data outside the model as configuration, content, or system.
Use the Folder Tree Performance Improvementreference
brXM 16.4.2 introduces a folder tree performance improvement for the Content application.
Workspace Configurationreference
The Workspace element in repository.xml acts as a template for workspace configuration files.
Folder Item Limit Configurationreference
Folder item limits control how many documents, images, or assets can be added to a folder in Bloomreach Content.
MIME Type Resolution Configurationreference
Bloomreach Content uses a configurable MIME type resolution service to map file extensions to recognized MIME type variants.
Repository Configurationreference
The repository configuration file defines the components and settings for the content repository.
Configure the CMS Folder Listing Page Sizereference
The CMS folder listing uses paged lists in the Bloomreach Content application.
Dynamic Content Beansconcept
Dynamic content bean generation is available in brXM 13.2.0 and later.
How do I add a translatable language?how to
A translatable language is added to the content model in Bloomreach Content by creating a new child node under /hippo:configuration/hippo:frontend/cms/cms-services/localeProviderService and setting its country and language properties.
HST Dynamic Resource Bundles Supportconcept
HST supports dynamic management of Java resource bundles stored in the repository and integrates with JSTL tag libraries.
Dynamic Resource Bundle Node Structureconcept
Resource bundle documents use the resourcebundle:resourcebundle node type in the content repository.
Translations/ i18n - General considerations and remarksconcept
Bloomreach Content uses Unicode throughout its core components, including the JCR-Jackrabbit storage layer and the delivery tier.
JCR APIconcept
Bloomreach Content uses the Java Content Repository (JCR) API, as defined by JSR-170, to access its content repository.
Document Modelconcept
In the Bloomreach Content repository, folders typically use the hippostd:folder type and documents are stored as hippo:handle nodes with child hippo:document variants.
Defining Nodetypes: CNDconcept
A Compact Node Type Definition (CND) specifies the structure and constraints for node types in the Java Content Repository (JCR).
Bootstrap the Content Repositoryconcept
Bootstrapping initializes the Bloomreach Content content repository by importing required node type definitions, content, and application configuration from CND and YAML files.
Lucene Index Export Service Explainedconcept
The Lucene Index Export Service exports the Lucene index from a running production repository as a ZIP file and records the export range in indexRevision.properties.
Top Level Repository Nodesconcept
Bloomreach Content stores content and configuration in a hierarchical node structure in its content repository.
Repository Deployment Settingsreference
Repository deployment settings control Hippo Repository initialization in Bloomreach Content through CMS application web.xml context parameters and startup system properties.
Derived Dataconcept
Derived data is a repository-managed property value that the content repository calculates and sets automatically during session save.
Enhanced XML Importconcept
Enhanced XML Import extends the standard JCR System View XML format in Bloomreach Content.
Repository Event Logconcept
Bloomreach Content stores workflow invocations as nodes in the Java Content Repository (JCR).
Add the Lucene Index Export Service to a Projecthow to
The Lucene Index Export Service exports a Lucene index directly from a running production instance through a Repository JAX-RS service.
Repository resource bundlesconcept
Repository resource bundles provide translations for strings defined through repository configuration in Bloomreach Content.
Node name encodingconcept
In Bloomreach Content, each document and folder has a display name and a node name.
Configure Document Versioningconcept
Basic versioning applies by default to all regular document types except Experience Page Documents.
Patched Jackrabbit in Bloomreach Content Repositoryconcept
Bloomreach Content uses Apache Jackrabbit 2.x as the foundation for its content repository and persistence layer.
Content Repositoryconcept
Bloomreach Content uses a JSR-283-compliant Java Content Repository (JCR) built on Apache Jackrabbit.
Updater Scriptsconcept
Updater scripts perform bulk modifications to repository content using Groovy.
Groovy Updater Script Examplesreference
Groovy updater scripts modify JCR content and HST configuration in place.
Write an Updater Scriptconcept
Groovy updater scripts perform bulk updates on repository content in Bloomreach Content and run in the context of the repository with full access to the JCR API.
Groovy DocumentsInfoScriptreference
DocumentsInfoScript is an updater script that logs information about documents selected by a specified XPath query.
Update Existing Content Itemsconcept
Updating existing content items in a target environment happens as part of a new release when content types change.
Update HST Configuration and Workspace Contentconcept
HST configuration is stored under /hst:hst and includes channel settings such as page templates, page components, sitemaps, and virtual hosts.
Override Compilation Customizer for Groovy Updater Scriptsconcept
Groovy updater scripts in Bloomreach Content can use custom compilation customizers to enforce project-specific security rules.
Update Document Templatesconcept
Deploying new or updated document templates to a target server environment requires a Relaxed Content Node Type Definition (Relaxed CND).
Groovy BinariesInfoScriptreference
BinariesInfoScript is an updater script that logs details about binaries selected by an XPath query.
Update CMS Configurationhow to
Project-specific CMS configuration is stored and version-controlled in the repository-data/application module and lives under /hippo:configuration in the repository.
Run and Develop with Cargohow to
Cargo provides a standard interface for controlling Java EE containers.
Development Environmentconcept
Bloomreach Content development environment setup uses a set of related resources for configuring a local development environment.
Configure Cargo for SSL/TLShow to
Local Cargo-based development environments use HTTP by default in Bloomreach Content projects.
Build Bloomreach Content From Sourcehow to
Bloomreach Content Developer Edition open source projects can be rebuilt from source, modified in a fork, and tested in an implementation project by overriding the relevant version property.
Suppress Log Messages During Unit Testshow to
Expected or harmless log messages during unit tests can be suppressed with test utilities from org.onehippo.cms7:hippo-cms-testutils in test scope.
Develop with Intellijhow to
IntelliJ IDEA supports Bloomreach Content development for editing source files, enabling FreeMarker code completion, and attaching a debugger to a running project.
Use MySQL in a Development Environmenthow to
Configuring a local Bloomreach Content development environment to use MySQL requires adding the MySQL JDBC driver to the root pom.xml, adding the driver to the Cargo classpath, registering a MySQL Resource in conf/context.xml, and creating a custom conf/repository.xml.
Create a Project Distributionhow to
Bloomreach Content projects package as a Tomcat distribution that deploys two WAR files, cms.war and site.war, plus shared, common, and configuration files in Tomcat-specific directories.
Automatic Export Add-onreference
Automatic Export Add-on exports changes from the development content repository to a project’s repository data modules and keeps repository changes reflected in version-controlled files.
Run brXM 15 on Java 17how to
brXM 15 runs on Java 17 only with manual configuration changes.
Bloomreach Forgeconcept
Bloomreach Forge is a community-driven platform for hosting plugins and software projects related to Bloomreach Content.
Enable basic profile logginghow to
Basic profile logging in Bloomreach Content writes performance data to a dedicated log file for analysis.
Run 2 Local Bloomreach Content Instances Simultaneouslyhow to
Two Cargo-based Bloomreach Content instances run simultaneously in a development environment when each instance uses unique ports and a distinct hostname.
Develop with HotSwapAgenthow to
DCEVM and HotSwapAgent enable hot-swapping of code changes in a running Bloomreach Content web application.
Develop with JRebelhow to
JRebel is a third-party development tool that shows code changes instantly without full redeployment, reducing development cycle time in Bloomreach Content.
Develop with Eclipsehow to
Eclipse IDE supports Bloomreach Content development, including project creation, import, build, run, and debugging.
Add host information to logginghow to
Multiple subsites require host information in log entries to identify which subsite generates each entry.
IDE & Tool Supportreference
Bloomreach Content is compatible with widely used Java IDEs and development tools.
Test Suitehow to
The Test Suite project provides example implementations and integrations for Bloomreach Content.
Introduction to Bloomreach Content Incubating Features Policyconcept
Incubating features in Bloomreach Content are new APIs, extension points, or functionalities released for early adoption and feedback.
Debug Wicket AJAX in the CMSreference
The Wicket AJAX debug window is available only in brXM 14.x and is not supported in 15.0 and later.
Create a Selenium test casehow to
Setting the context parameter output-wicketpaths to true in conf/context.xml adds a wicketpath attribute to each element that corresponds to a Wicket component.
Quick Winsconcept
Quick improvements in a Bloomreach Content project improve usability, performance, maintainability, and security.
Developing Bloomreach Content with JRebel and IntelliJhow to
JRebel works with IntelliJ IDEA during Bloomreach Content development to reload classes without recompiling.
Run and Develop with Dockerhow to
Docker runs a Bloomreach Content project in a local development container and supports building a Docker image from the project root with Maven.
Bloomreach Content Essentials Project Setupconcept
Bloomreach Content Essentials is a setup application for new XM implementation projects.
Development Toolsreference
The Essentials setup application includes development tools for configuring selection widgets, defining custom image set types, generating content bean classes, setting up RESTful services, and generating template queries for custom document types.
Using the Essentials Setup Dashboardconcept
The Essentials Setup Dashboard is a web application for initial Bloomreach Content project setup.
Essentials Architecture Overviewconcept
The Essentials setup application architecture in Bloomreach Content centers on essentials.war, which runs alongside cms.war and site.war in Tomcat.
Add the Essentials Setup Application to your Projecthow to
The Essentials setup application adds a predefined project structure, setup dashboard, Library access, and pre-installed Tools to a Bloomreach Content project.
Using the Essentials Setup Application with Existing Bloomreach Content Projectshow to
The Essentials setup application supports Bloomreach Content projects running version 7.9 or later.
Hints and tips for analyzing Java heap dumpsreference
Java heap dump analysis commonly uses Eclipse Memory Analyzer Tool (MAT), VisualVM, or YourKit Java Profiler.
Performance Tuningconcept
General performance tuning options are available for topics not covered in other sections.
Relevance Concepts and Terminologyconcept
The Relevance Module uses collectors, characteristics, target groups, scorers, segments, and personas to derive and apply targeting data for each visitor.
Bloomreach Enterprise Repositoryconcept
Bloomreach Enterprise Repository is an optional extension for running Bloomreach Content in on-premise and cloud environments.
Project Size Limitationsreference
Projects in Bloomreach Content group related items such as channels and documents into a single project for collaboration and review.
Introduction to the Universal Pixel Integration Addonconcept
The Universal Pixel Integration Addon tracks visitor activity across a site with a JavaScript tracking pixel and supports analytics and personalization.
Customize Visitor Analysis UIreference
The visitor analysis UI right-side panel is customizable in Bloomreach Content 17.1 and earlier through a custom visitor details panel class at /hippo:configuration/hippo:frontend/cms/hippo-targeting/visitor-details-panel.
Audit Addon Release Notesrelease notes
The Audit Addon requires an additional license, with licensing details available from an account manager or sales representative.
Audit Addon Exporting Resultsreference
Audit Addon event data exports use the Download button above the search results.
Essentials Plugin Archetypehow to
The Essentials Plugin Archetype provides a template for creating a new Essentials Plugin and generating its initial project structure.
Essentials Plugin Back-Endreference
An Essentials plugin becomes available in the Essentials web application when its plugin JAR is included in the deployed Essentials WAR file.
Plugin Installationreference
Essentials feature plugins require installation, and installation applies changes to project sources and can import nodes and properties into a running repository.
Essentials Plugin Descriptorreference
The plugin descriptor is a JSON file that defines an Essentials plugin and lets Essentials recognize, advertise, install, and use it in the Essentials Dashboard.
Essentials Plugin SDKreference
The Essentials Plugin SDK provides a stable API for developing custom Essentials plugins for Bloomreach Content.
Configure Experience Pageshow to
Experience Pages are available starting in brXM 14.3.0.
Experience Pages Translationsconcept
Experience Pages translation support is available in brXM 14.5.0 and later.
Experience Manager Troubleshootingtroubleshooting
Experience Manager troubleshooting covers common visibility, loading, preview, channel selection, and editing problems in the CMS.
Define a Channel’s Configuration Parametershow to
Channel configuration parameters expose small configurable channel settings, such as a logo or color, in the Experience Manager UI.
Respond to Publish Changes, Discard Changes, and Create Preview Configuration Channel Eventsconcept
Channel events for publish, discard, and preview configuration creation are published to the synchronous HST internal event bus.
Configure the Channel Type and Region Iconsconcept
Channel type icons in the Channels overview come from the hst:type property on the channel node in the Console.
Channel Filteringconcept
Channel filtering controls which channels are visible to CMS users in the Experience manager and under the [view] button for a document.
Abort an Experience Manager Actionconcept
Experience Manager actions abort through a channel event listener on the HST internal event bus by setting an exception on the event object.
Respond to Create Channel and Update Channel Settings Eventsconcept
The HST API provides the org.hippoecm.hst.configuration.channel.ChannelManagerEventListener interface for custom logic that runs after a channel is created from a blueprint or after channel settings are updated.
Make a Channel's Default Resource Bundle IDs Configurable in the Experience Managerconcept
Channel default resource bundle IDs can be exposed as a configurable channel parameter in the Experience Manager.
Respond to a Before Delete Channel Eventconcept
A BeforeChannelDeleteEvent fires on the HST internal event bus when an administrator deletes a channel that is marked as deletable in Bloomreach Content.
Blueprints Configurationconcept
Blueprints define the HST configuration and content used when the Experience Manager creates new channels at runtime.
Experience Pagesconcept
Experience Pages combine content and page layout into a single self-contained page and introduce page-driven management in Bloomreach Content.
Create a Custom Perspectiveconcept
A custom perspective is a distinct application in Bloomreach Content that appears in the navigation UI, including the Extensions menu.
Configure Standard CMS Document Searchconcept
Standard CMS document search in Bloomreach Content is configurable through the SearchingSectionPlugin and related tree loader settings.
Add Internationalization (i18n) To Document Typesconcept
Bloomreach Content supports multiple user interface languages for document types.
Advanced compound type fields configurationconcept
Bloomreach Content compound fields in document types display their field name as the section title and are collapsible by default.
Localization modulesconcept
Bloomreach Content uses localization modules to provide translated interface strings for different languages.
Adjust the Pinger Intervalhow to
The CMS web application sends a pinger callback to the server to keep the authenticated session active and retrieve changes made by other users.
Use large font size for a document fieldconcept
A document field in the editor uses a larger font size when the CSS class hippo-editor-large is applied to that field.
Media Validation ServiceDXPconcept
The Media Validation Service is a daemon module that registers validators for specific MIME types and lets the CMS upload workflow validate file content before accepting uploads.
Image and Asset Upload Validationconcept
Image and asset uploads in Bloomreach Content use validation services to check file size, file extensions, MIME types, and, for images, resolution.
Tweak the CSS of the CMS Editing Templateshow to
Custom CSS can change the appearance of CMS editing templates.
Image and asset upload configurationreference
Bloomreach Content uses the HTML5 file upload plugin for image and asset uploads in the CMS.
Limit the Number of Values in a Multiple Value Fieldconcept
Bloomreach Content supports multiple-type document fields without a default limit on the number of values an author can add in a single document.
Style the buttons on the dashboardhow to
Custom styling for the Bloomreach Content dashboard left panel uses a CMS skin CSS file.
Customize icons for documents in the document listingconcept
Bloomreach Content displays custom icons for specific document types in the document listing.
CMS UI localizationconcept
Bloomreach Content provides localization for the CMS user interface and content translations.
Display a Sub Tree as a Separate Content Sectionhow to
A custom folder node type and CMS UI plugin cluster can display a specific subtree, such as /content/documents/construction, as a separate section in the Content application.
In-Product Feedbackreference
In-product feedback is available in Bloomreach Content 17.2 and later through a "Give feedback" button in the CMS navigation bar.
MIME Type Resolution Serviceconcept
The MIME Type Resolution Service centralizes accepted MIME types for each file extension used during image and asset uploads.
HST Binary Content Resource Serving (BinariesServlet)reference
The BinariesServlet serves binary resources such as images and files from the Java Content Repository (JCR).
Content Disposition Headerreference
The BinariesServlet can add a Content-Disposition header to HTTP responses so browsers treat a file as a downloadable attachment and suggest a filename.
Custom Binary Link Generationhow to
Bloomreach Content generates binary links by default in paths such as /myproject/binaries/content/gallery/myproject/samples/coffee-206142150.jpg and /myproject/binaries/thumbnail/content/gallery/myproject/samples/coffee-206142150.jpg.
Custom Resource Containershow to
Custom resource containers in HST2 map binary URLs to specific binaries in a resource container node.
Implement a Custom File Upload Preprocessorconcept
Custom file upload preprocessors run in Java before uploaded images and assets are stored in the repository.
Use Multiple Image Sets in One Projectconcept
Multiple image sets in one Bloomreach Content project support channels that need distinct frontend designs or content structures.
Binaries that need workflowconcept
Binary files that require workflow are stored as embedded resources within a document.
SiteMapItem Matchingconcept
After a URL matches a Mount, the remaining path segments match against a hierarchical SiteMap of SiteMapItems.
HST Page Diagnostics / Reportingconcept
Bloomreach Content (HST) includes built-in, extensible page diagnostics and reporting.
The HstRequestContext objectconcept
The HstRequestContext is a central HST framework object for request processing.
HST Request Processingconcept
HST request processing uses an inversion of control pattern with Spring Framework configuration.
Hostname Matchingconcept
Hostname matching compares the hostname from the HttpServletRequest with a configured virtualhost in the HST configuration.
Enable and Configure HST Enterprise Cachingconcept
HST Enterprise Caching requires a standard or premium Bloomreach Content license.
HST Request Handlingconcept
HST request handling has two phases: request matching and request processing.
Monitor HST Enterprise Cachingconcept
HST Enterprise Caching in Bloomreach Content requires a standard or premium license.
HST Custom https supportconcept
Bloomreach Content HST supports custom HTTPS enforcement when built-in seamless HTTPS support is too broad for content-specific or business-logic-based rules.
How to add custom jcr event listener through Spring configurationhow to
Custom JCR event listeners in Bloomreach Content register through Spring configuration.
HST Addon Module Supportconcept
An HST Addon Module is a child Spring component bean manager packaged in a separate classpath resource such as a JAR file.
HST Core Spring Extension Pointsconcept
Bloomreach Content projects can use API Spring beans exposed by the HST core and override SPI Spring beans by defining a project-specific bean with the same ID.
HST Spring ComponentManager event publishingconcept
HST application events use the Google Guava EventBus through the org.hippoecm.hst.core.container.ComponentManager interface.
Event Busconcept
The Event Bus in Bloomreach Content delivers platform events such as user logins and document publications to listeners.
Repository JAX-RS Serviceconcept
The Repository JAX-RS Service defines custom REST endpoints for the content repository.
Repository Schedulerconcept
Bloomreach Content provides a repository scheduling service for running jobs within the repository.
Repository-Managed Componentsconcept
Bloomreach Content supports repository-managed components called daemon modules.
Overview of Event Bus Eventsreference
Bloomreach Content broadcasts Event Bus events for user interactions and system actions across security, user management, group management, permissions management, document and folder workflow, channel workflow, and project workflow.
Search Serviceconcept
The Bloomreach Content Search Service provides a Java DSL for building search queries and is intended for use with the Advanced Search feature in the CMS.
Enable Spring Boot Actuatorhow to
Spring Boot Actuator integration is available in brXM 14.6.0 and later.
HST Container Configurationconcept
The HST Container uses HstFilter as the front controller for incoming requests and HstContextLoaderListener to initialize core components when a site application starts.
JMX Management Beans Supportconcept
Bloomreach Content provides default JMX MBeans for monitoring the CMS and Site applications.
Retrieving a pooled sessionreference
Bloomreach Content uses pooled JCR sessions for most HST request processing.
XSS and CRLF injection prevention with HST-2concept
HST-2 includes built-in protections against cross-site scripting (XSS) and CRLF injection.
Freemarker Snippetsconcept
Freemarker snippets in Bloomreach Content web applications cover common template tasks such as listing bean properties, rendering images, outputting HTML fields, including other templates, and setting the locale from HST mount configuration.
HST Freemarker supportconcept
HST supports Freemarker templates as a templating engine.
Head Contributionsconcept
Head contributions let non-root components add DOM elements to a page through their rendering templates while the root component renders those contributions.
Enable Freemarker template supporthow to
Bloomreach Content projects created with the Maven archetype include Freemarker support by default.
Bloomreach Content and Springconcept
Bloomreach Content uses core Spring Framework features, including Dependency Injection and Aspect-Oriented Programming, inside its delivery framework (HST) to manage internal components.
Spring-Managed HST Componentsconcept
Starting with brXM 11, the HST Container can use HST Component beans managed by the Spring Framework ApplicationContext.
Custom Resolution of Client's Originating IP Addressconcept
Bloomreach Content uses the X-Forwarded-For HTTP header by default to determine a client's originating IP address.
Static Webapp Resources Locations and Best Practicesconcept
Static web application resources in Bloomreach Content are stored either in the site web application under src/main/webapp or in the content repository as Web Files, typically bootstrapped from the repository-data-webfiles module.
HST Tag Libraryconcept
The Bloomreach Content delivery framework (HST) provides a tag library for use in JSP and Freemarker templates.
Automatic Scanning for Content-Bean Annotated Classesconcept
Automatic scanning for content-bean annotated classes is enabled by defining the hst-beans-annotated-classes context parameter in web.xml.
Retrieving a non pooled sessionconcept
HST request processing uses pooled Java Content Repository (JCR) sessions by default.
Using Spring Root WebApplicationContext in HSTconcept
A Spring Root WebApplicationContext in an HST site web application uses org.springframework.web.context.ContextLoaderListener by default in web.xml.
HST Server Side Includes Supportconcept
Bloomreach Content (HST) supports generating Server Side Includes (SSI) statements for asynchronous component rendering.
HST-2 Edge Side Includes Supportconcept
Bloomreach Content (HST) supports basic Edge Side Includes (ESI) for external ESI processors such as CDNs and cache servers, and for the built-in HST ESI Processor.
Spring MVC Bridgeconcept
The Spring MVC Bridge integrates Bloomreach Content delivery tier (HST) with Spring Web MVC applications.
Integrate Google Analytics Trackinghow to
Google Analytics tracking for Bloomreach Content uses three modules: hst-google-analytics-repository for configuration, hippo-cms-google-analytics-frontend for the CMS document-hits plugin, and hst-google-analytics-hst for site tracking tags and code.
Use Scoped Variables in JSP Templates and Tag fileshow to
Unified Expression Language (EL) 3.0 supports referencing static fields and methods, and JSPs use javax.servlet.jsp.el.ScopedAttributeELResolver to check whether identifiers match imported class or field names.
Configure Web Filesconcept
Web files configuration in Bloomreach Content controls maximum file size, imported file types, excluded directories, and development-time watching of file changes.
Bootstrap Web Filesconcept
Web files are imported or updated in the repository either through the bootstrap mechanism or by manual upload.
How to access Web Files over a stable URL without <anti-cache> valueconcept
Web file URLs generated with the hst:webfile tag normally include an <anti-cache> segment, such as /webfiles/<anti-cache>/js/script.js.
Web Files Troubleshootingtroubleshooting
Web Files changes appear in the repository only when Web File watch is enabled, the files are in the repository-data/webfiles module or another watched Maven module, the file size stays within the default 256 KB limit, and the file pattern is included.
Secure Web Filesconcept
Public access to static web files in Bloomreach Content is controlled by an allowlist file in the root directory of the web file bundle.
Customize Link Processingconcept
Internal link processing in the Bloomreach Content delivery tier uses sitemap-based document-to-page mapping.
The ComponentRenderingURLconcept
A ComponentRenderingURL renders a single HstComponent or a subtree of HstComponents without reloading the entire page.
Create render URLs without namespaced parametersconcept
Bloomreach Content (HST) generates namespaced query parameters by default when using the hst:renderURL tag.
Respond to Workflow Eventsconcept
Workflow events in Bloomreach Content are posted to the Event Bus when a publication workflow step occurs.
Document Workflowconcept
The org.onehippo.repository.documentworkflow.DocumentWorkflow interface defines workflow operations for publishable documents in Bloomreach Content.
SCXML Workflow Engineconcept
Bloomreach Content includes a workflow engine based on SCXML (State Chart XML) that executes workflow definitions as state machines.
How to implement a custom workflow?concept
A custom workflow in Bloomreach Content requires a workflow interface that extends org.hippoecm.repository.api.Workflow, an implementation that typically extends org.hippoecm.repository.ext.WorkflowImpl, a workflow category configuration in YAML, and a CND file with a matching YAML namespace definition.
SCXML Workflow Executionconcept
The SCXML Workflow Engine in Bloomreach Content executes SCXML workflow definitions stored in the repository through the generic org.onehippo.repository.scxml.SCXMLWorkflowExecutor.
SCXML Workflow Actions and Tasksconcept
The Bloomreach Content SCXML Workflow Engine supports custom SCXML actions based on Apache Commons SCXML org.apache.commons.scxml2.model.Action, but custom actions must use org.onehippo.repository.scxml.AbstractAction as the base class.
SCXML Workflow Definitionconcept
SCXML workflow definitions in Bloomreach Content are stored in the repository under /hippo:configuration/hippo:modules/scxmlregistry/hippo:moduleconfig/hipposcxml:definitions.
Workflow Commentingconcept
Workflow commenting is available in brXM 16.9.2 and later.
Share Feedback
Page: /build
Section: Build
Category *