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

Essentials Plugin Archetype

This feature is available since version 13.0.0

Use the Essentials Plugin Archetype to create a basic skeleton Essentials Plugin as a starting point for developing your own Essentials Plugin.

Use the Essentials Plugin Archetype

To use the Essentials Plugin Archetype, execute the following command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
-DarchetypeRepository= \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-essentials-plugin-archetype \

Replace the value of the archetypeVersion parameter with a newer version as necessary. When prompted, make sure to select a unique ID for your plugin. You can

maven clean install

the resulting Maven project. In order to use the plugin in your local Essentials instance, add it as an extra dependency to your essentials/pom.xml file, like so:


After rebuilding and restarting this project, the new plugin will show up on the Essentials Library list.

Essentializer Plugin

As an alternative to the Essentials Plugin Archetype, consider trying the "Essentializer" plugin, an Essentials plugin which supports you in extracting CMS project changes into an Essentials Plugin. The Essentializer plugin is available on the BloomReach Forge:

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?

    We rely on cookies

    to optimize our communication and to enhance your customer experience. By clicking on the Accept and Close button, you agree to the collection of cookies. You can also adjust your preferences by clicking on Manage Preferences. For more information please see our Privacy policy.

    Manage cookies
    Accept & close

    Cookies preferences

    Accept & close