Bloomreach

Bloomreach Documentation version

This article covers a Bloomreach Experience Manager version 12. There's an updated version available that covers our most recent release.

Develop / API Docs

API Docs for Bloomreach Experience Manager 12

Effective October 2025, we're deprecating our publicly hosted Javadocs (javadoc.onehippo.org). After careful analysis, we've determined that the extremely low traffic to these resources indicates minimal usage by our developer community. Since developers can generate these same Javadocs locally from the codebase whenever needed, we've decided to discontinue public hosting rather than migrate the service to our new infrastructure.
This change allows us to focus our resources on maintaining and improving documentation that provides greater value to our users. Developers who require Javadocs can continue to generate them directly from the source code using standard build tools.

The following documentation resources can be built directly from the Bloomreach Experience Manager source code:

Build the Javadocs

Follow the steps below to build the Javadocs on your system:

  1. Run this command from the root folder of the brxm repository to build the Javadocs:

    mvn -Papidoc clean javadoc:javadoc validate

  2. Wait a few minutes for the build to complete.

  3. On successful completion, the target/<version> folder will contain the Javadoc files.

  4. Open the generated HTML files in a browser to view the API reference pages.

More details to build the full brXM project can be found in the Build Bloomreach Experience Manager From Source guide.

Output format

The javadoc build creates a new target/ folder inside the root directory.

Within target/, the sub-folder named after your brXM version contains the developer reference files.

The following table lists which specification each folder contains. To use any specification, start by opening the index.html file from your desired API's folder in a browser. Navigate through the linked resources on the site that opens.

Folder name Spec

bloomreach-ui-extension

 OpenUI Extension Library JavaScript TypeDoc (includes document field and dialog extensions APIs).

hippo-addon-crisp

 CRISP API reference

hippo-cms

 CMS API reference

hippo-cms-commons

 Commons API reference

hippo-repository-api

 Repository API reference

hippo-services-api

 Services API reference

hippo-site-toolkit

 Site Toolkit (HST) API reference

tlddocs

 HST Tag Library JSP/Freemarker
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?