Configure the Channel Type and Region Icons - BloomReach Experience - Open Source CMS

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

08-01-2018

Configure the Channel Type and Region Icons

Introduction

Goal

Configure the channel type and region icons in the channels overview.

Background

Channels in the channels overview are represented by a type icon (e.g. website, mobile) and a region icon (typically a country flag). These icons can be customized through configuration.

Channel Type Icon

The channel type can be configured via the Console on the channel node itself:

/hst:hst/hst:configurations/myhippoproject/hst:workspace:
  /hst:channel:
    hst:type: website

The default type values for which placeholder icons are provided are:

ipad-magazine, mobile, website
If you modify the channel type, don't forget to update any blueprint configuration if needed.

Channel Region Icon

The region icon is determined by the country code in the locale (e.g. CN in zh_CN) that is defined on the appropriate mount or present via the content root.

In previous versions of Bloomreach Experience Manager the full locale (e.g. zh_CN) was used to determine the region icon. For backwards compatibility the system will fall back on matching the full locale if no available icon matches the country code.

Default icons are provided for the following countries:

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

Use Custom Icons

Custom icons can be used by storing them in the repository. The locations are configured via path templates stored as properties of the node /hippo:configuration/hippo:frontend/cms/hippo-channel-manager/channel-manager-perspective/channel-list:

/hippo:configuration/hippo:frontend/cms/hippo-channel-manager/channel-manager-perspective/channel-list:
  channelRegionIconPath: /content/gallery/channels/${region}.png/${region}.png/hippogallery:original
  channelTypeIconPath: /content/gallery/channels/${type}.png/${type}.png/hippogallery:original

The example above uses the placeholders ${type} and ${region}. All fields of the class org.onehippo.cms7.services.hst.Channel can be used, e.g. : id, name, type, locale, hostname.

I18n support for custom types and locales can be achieved by overlaying the resource bundle org.onehippo.cms7.channelmanager.channels.ChannelIconPanel in your project.

Example

You have British and Australian channels and you want to display the corresponding flags in the Channels overview.

Create or obtain 16x16 icons of the British and Australian flags and use the corresponding locales for their filenames. For example, if you use the PNG file format:

  • en_GB.png
  • en_AU.png

In the CMS, open the Content perspective and select Images.

Add a root folder and name it "channels".

In the new "channels" folder, upload your icon files.

In the Console, browse to the node /hippo:configuration/hippo:frontend/cms/hippo-channel-manager/channel-manager-perspective/channel-list.

Add the property channelRegionIconPath and set its value to the following pattern using the ${region} placeholder:

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

Write your changes to the repository.

The British and Australian channels should now have corresponding flags in the Channels overview.

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?