Fork me on GitHub

Installation

Bloomreach Forge Maven Repository Configuration

Make sure you have the Forge Maven2 repository reference in the root pom.xml of your project.

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<repositories>
 
  <!-- SNIP -->
 
  <repository>
    <id>hippo-maven2</id>
    <name>Hippo Maven 2 Repository</name>
    <url>https://maven.onehippo.com/maven2-forge//</url>
  </repository>
 
  <!-- SNIP -->
 
</repositories>

Dependency Management

Add all the dependencies in the root pom.xml of your project.

You also need to add forge.pageflow.version property in the properties section. Find the proper version in the Release Notes.

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
<!-- SNIP -->
 
<dependencyManagement>
 
  <!-- SNIP -->
 
  <dependencies>
 
    <!-- SNIP -->
 
    <!-- NOTE: You should set a property named 'forge.pageflow.version' to a version of this plugin! -->
 
    <dependency>
      <groupId>org.onehippo.forge.pageflow</groupId>
      <artifactId>pageflow-repository</artifactId>
      <version>${forge.pageflow.version}</version>
    </dependency>
 
    <dependency>
      <groupId>org.onehippo.forge.pageflow</groupId>
      <artifactId>pageflow-cms</artifactId>
      <version>${forge.pageflow.version}</version>
    </dependency>
 
    <dependency>
      <groupId>org.onehippo.forge.pageflow</groupId>
      <artifactId>pageflow-hst</artifactId>
      <version>${forge.pageflow.version}</version>
    </dependency>
 
    <!-- SNIP -->
 
  </dependencies>
 
  <!-- SNIP -->
 
</dependencyManagement>

Dependencies in Content Delivery Web Application

In either site/components/pom.xml in projects created on brXM v13 or later or site/pom.xml in projects created on earlier versions, add the following dependency:

?
1
2
3
4
<dependency>
  <groupId>org.onehippo.forge.pageflow</groupId>
  <artifactId>pageflow-hst</artifactId>
</dependency>

Dependencies in Content Authoring Web Application

In either cms-dependencies/pom.xml in projects created on brXM v13 or later or cms/pom.xml in projects created on earlier versions, add the following dependencies:

?
1
2
3
4
5
6
7
8
9
<dependency>
  <groupId>org.onehippo.forge.pageflow</groupId>
  <artifactId>pageflow-repository</artifactId>
</dependency>
 
<dependency>
  <groupId>org.onehippo.forge.pageflow</groupId>
  <artifactId>pageflow-cms</artifactId>
</dependency>

Configure the default Page Flow Control Handler (in Bloomreach CMS v13.x+ only)

Since Bloomreach CMS v13, import the following under /hst:********/hst:configurations/hst:default/hst:sitemapitemhandlers through CMS Console:

?
1
2
3
4
5
/defaultpageflowcontrolhandler:
  jcr:primaryType: hst:sitemapitemhandler
  auto.redirection.enabled: true
  enabled: true
  hst:sitemapitemhandlerclassname: org.onehippo.forge.pageflow.hst.sitemapitemhandler.DefaultPageFlowControlHstSiteMapItemHandler

Note: The sitemap item handler above (defaultpageflowcontrolhandler) will be used and explained in the Configuration page in detail.