This article covers a Hippo CMS version 7.7. There's an updated version available that covers our most recent release.

View a document in a channel 

Since CMS 7.7

The 'View' menu for channels is available since CMS 7.7. Projects with older CMS versions can use the old View menu that allows you to see a document in its 'live' and 'preview' environment (i.e. one channel only).

The document editor contains a 'View' menu that lists the names of all channels that document is part of. Clicking on a channel name shows the document in that channel in the channel viewer inside the CMS.

CMS configuration

The list of channels for the document is fetched from the HST via REST. The CMS contains a 'REST proxy' service that uses the CXF JAX-RS client to create a proxy from classes that represent a REST service. These classes are provided by the HST in the 'hst-rest-api' module.

REST proxy service

The REST proxy service to use for the HST can be configured at:


Configuration parameters:

  • rest.uri
    the URI at which the CMS can access the 'CMS REST service' run by the site.
    Default value: ''
    The default host name ('') and mount ('_cmsrest') are set via Spring configuration in the HST, and can be overridden if needed.

  • plugin.class
    Should be 'org.hippoecm.frontend.service.restproxy.RestProxyServicePlugin'

    CMS service ID to use in the plugin framework.
    Default value: ''

"Running the container on a different port than 8080

When running Tomcat or some other container on a different port than 8080, you should change the 'CMS REST service' URI the portnumber. Thus change:
rest.uri ='

Some Spring configuration has to be present in the site module of your project to inject the CMS REST pipeline in the HST. This consists of the file


with the following contents:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns=""

  <import resource="classpath:/org/hippoecm/hst/site/optional/jaxrs/SpringComponentManager-rest-jackson.xml" />
  <import resource="classpath:/org/hippoecm/hst/cmsrest/SpringComponentManager-cmsrest.xml" />


The HST will automatically add a mount for the CMS REST service to the HST hosts configuration at runtime.

If everything is configured correctly, the following URL should return all channels for the UUID of a hippo:handle of a document:<uuid>/channels

View menu

The 'View' menu itself is rendered by the 'channel actions' plugin. Its configuration is located at:


The channel actions plugin recognizes the following properties:

    Service ID of the CMS REST proxy service to use.

  • plugin.class
    CMS plugin class that renders the menu.
    Default: org.onehippo.cms7.channelmanager.plugins.channelactions.ChannelActionsPlugin

Removing the 'View' menu for channels

The view menu for channels can be removed entirely with the following steps:

1. Remove the value 'channelactions' from the multi-string property 'workflow.categories' in these nodes:


2. Remove the node