Configure the Console for different environments - Enterprise Java Content management system - Hippo CMS

Configure the Console for different environments

It is recommended to configure the console application to create a visual cue for the user in order that he be aware of the environment he is working in (test, acceptance, production), in order to prevent mistakes from happening a user has multiple consoles open in different environments.

For this purpose, it is possible to configure the page title, the favicon and the style of the menu bar. 

Adjust the page title

Specify the following properties on  /hippo:configuration/hippo:frontend/console/console/root:

  • page.title ( String) to differ from the default "Hippo CMS console"
  • page.title.showservername ( Boolean) to add the ServerName from the HttpServletRequest to the title after a separator
  • page.title.separator ( String) to differ from the default @

Adjust the color of the menu bar

//onehippo-prod.global.ssl.fastly.net/binaries/ninecolumn/content/gallery/connect/library/deployment/10.0/console-bar.png

Specify the following properties to  /hippo:configuration/hippo:frontend/console/console/top:

  • bar.styles ( String, multiple)
  • bar.style.urlparts ( String, multiple)

Both properties must have the same number of values. The URL parts will be compared to the current URL of the request. The first one that matches will be chosen. A match is found when the url contains the urlpart given. The corresponding bar.style will be applied to the div that is the background to the buttons. An example could be "background: orange;" to give that bar an orange color. This way you can apply a strong visual cue to help the user be aware of the environment he is working in.

Suppose your application runs on test.myapp.com, acct.myapp.com, www.myapp.com/cms. Then you can add these three values in  bar.style.urlparts. Giving distinguishing parts will also work.

Adjust the favicon

Specify the following properties on /hippo:configuration/hippo:frontend/console/console/root

  • favicon.path

Possible values are:

  • console-red.ico (the default)
  • console-green.ico
  • console-yellow.ico
  • console-blue.ico
  • console-orange.ico
  • console-purple.ico
  • console-teal.ico

You can create an icon of your own. Place that in you CMS module in a folder  src/main/resources/org/hippoecm/frontend/plugins/console. Use the name of your icon (i.e. my-console-fav.ico) as the favicon.path property.

Configure the Console for different environments

It is recommended to configure the console application to create a visual cue for the user in order that he be aware of the environment he is working in (test, acceptance, production), in order to prevent mistakes from happening a user has multiple consoles open in different environments.

For this purpose, it is possible to configure the page title, the favicon and the style of the menu bar. 

Adjust the page title

Specify the following properties on  /hippo:configuration/hippo:frontend/console/console/root:

  • page.title ( String) to differ from the default "Hippo CMS console"
  • page.title.showservername ( Boolean) to add the ServerName from the HttpServletRequest to the title after a separator
  • page.title.separator ( String) to differ from the default @

Adjust the color of the menu bar

//onehippo-prod.global.ssl.fastly.net/binaries/ninecolumn/content/gallery/connect/library/deployment/10.0/console-bar.png

Specify the following properties to  /hippo:configuration/hippo:frontend/console/console/top:

  • bar.styles ( String, multiple)
  • bar.style.urlparts ( String, multiple)

Both properties must have the same number of values. The URL parts will be compared to the current URL of the request. The first one that matches will be chosen. A match is found when the url contains the urlpart given. The corresponding bar.style will be applied to the div that is the background to the buttons. An example could be "background: orange;" to give that bar an orange color. This way you can apply a strong visual cue to help the user be aware of the environment he is working in.

Suppose your application runs on test.myapp.com, acct.myapp.com, www.myapp.com/cms. Then you can add these three values in  bar.style.urlparts. Giving distinguishing parts will also work.

Adjust the favicon

Specify the following properties on /hippo:configuration/hippo:frontend/console/console/root

  • favicon.path

Possible values are:

  • console-red.ico (the default)
  • console-green.ico
  • console-yellow.ico
  • console-blue.ico
  • console-orange.ico
  • console-purple.ico
  • console-teal.ico

You can create an icon of your own. Place that in you CMS module in a folder  src/main/resources/org/hippoecm/frontend/plugins/console. Use the name of your icon (i.e. my-console-fav.ico) as the favicon.path property.