Configure the Channel Type and Region Icons

Overview

This page explains how to configure channel type and region icons in the channels overview of Bloomreach Content.

Channel Type Icon

You can configure the channel type icon by setting the hst:type property on the channel node in the Console:

/hst:myproject/hst:configurations/myproject/hst:workspace:
  /hst:channel:
    hst:type: website
copy

The default type values with provided placeholder icons are:

ipad-magazine, mobile, website

Note: If you change the channel type, review and update any related blueprint configuration as needed.

Channel Region Icon

The region icon is determined by the country code in the locale (for example, CN in zh_CN) defined on the relevant mount or available from the content root.

In earlier versions of Bloomreach Content, the full locale (such as zh_CN) was used to select the region icon. For backward compatibility, if no icon matches the country code, the system attempts to match the full locale.

Default region icons are available for these country codes:

CN, DE, ES, FR, NL, RU, US

Using Custom Icons

To use custom icons, store the icon files in the repository. Configure the icon locations using path templates as properties of the node /hippo:configuration/hippo:frontend/cms/cms-experience-manager/experience-manager-perspective/options/overview:

/hippo:configuration/hippo:frontend/cms/cms-experience-manager/experience-manager-perspective/options/overview:
  channelRegionIconPath: /content/gallery/channels/${region}.png/${region}.png/hippogallery:original
  channelTypeIconPath: /content/gallery/channels/${type}.png/${type}.png/hippogallery:original
copy

The default configuration uses the ${type} and ${region} placeholders. Starting from versions 14.7.14 and 15.2.3, you can also use ${id}, ${name}, and ${locale} placeholders, which correspond to properties of the org.onehippo.cms7.services.hst.Channel class.

Note: For version 16 and earlier, use the path /hippo:configuration/hippo:frontend/cms/hippo-channel-manager/channel-manager-perspective/channel-list instead.

Example: Custom Region Icons for British and Australian Channels

To display British and Australian flags in the Channels overview:

1. Prepare 16x16 PNG icons for the British and Australian flags. Name the files according to their locale codes:

   • en_GB.png
   • en_AU.png

2. In the CMS, open the Content application and select Images.

3. Create a root folder named channels.

4. Upload the icon files into the channels folder.

5. In the Console, navigate to:

   • /hippo:configuration/hippo:frontend/cms/cms-experience-manager/experience-manager-perspective/options/overview (version 17 and up), or
   • /hippo:configuration/hippo:frontend/cms/hippo-channel-manager/channel-manager-perspective/channel-list (version 16 and lower).

6. Add or update the channelRegionIconPath property with the following value, using the ${region} placeholder:

   /content/gallery/channels/${region}.png/${region}.png/hippogallery:original
   

7. Save your changes to the repository.

After completing these steps, the British and Australian channels will display the correct flag icons in the Channels overview.