Essentials Plugin Archetype - BloomReach Experience - Open Source CMS

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=https://maven.onehippo.com/maven2 \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-essentials-plugin-archetype \
-DarchetypeVersion=13.0.0

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:

<dependency>
  <groupId>org.example</groupId>
  <artifactId>myessentialsplugin</artifactId>
  <version>0.1.0-SNAPSHOT</version>
</dependency>

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: https://github.com/bloomreach-forge/essentializer.

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?