Customizing banner content

Edit online

You can change the appearance of the administrative console user interface by customizing the banner.

Before you begin

Depending on how your system administrator customized your system, you might not have access to this task. To obtain access to this task or to have someone complete it for you, contact your system administrator.

About this task

You can add or modify banner content to alter the appearance of the administrative console user interface.

The default banner area is defined in two files, a JSP file named banner.jsp and a properties file named ui.properties. The banner area consists of four parts:
  • Banner launch link
  • Banner launch logo
  • Banner logo
  • Banner background image

When customizing the banner, adjust the dimensions (width and height) of the components in the banner.jsp. Adjust these dimensions so that the custom logo image is sized properly without any distortion. Also ensure that the entire banner frame is not distorted.

You can change the banner launch link and logo by modifying the ui.properties file. If you want to modify the background image and banner logo, you must create a file to display your banner. This file can be either an HTML or a JSP banner file.

The following property keys in the ui.properties file define the banner launch link and banner launch logo. They also define the URL to the banner background image and logo.
Table 1. Banner property keys
Property key Default value Description
enrole.ui.customerLogo.image ibm_banner.gif

Launch link logo, located in the WAS_PROFILE_HOME\installedApps\node_name\ITIM.ear\itim_console.war\html\images directory. You can also specify a URL pointing to the image file or put this file in the WAS_PROFILE_HOME\installedApps\node_name\ITIM.ear\itim_console.war\custom directory. If this directory does not exist, you must create it. Prefix the path name with /itim/console/custom in the ui.properties file. Specifying no value results in the default ibm_banner.gif file being displayed.
enrole.ui.customerLogo.url www.ibm.com Launch link URL. This value can be specified with or without the HTTP prefix. For instance, you can use www.ibm.com or http://www.ibm.com to specify the launch link URL.
ui.banner.URL This value is left blank by default and displays the default banner area.

The HTML or JSP file that provides the banner logo, background image, and launch link and logo. You can enter either a URL or put this file in the WAS_PROFILE_HOME\installedApps\node_name\ITIM.ear\itim_console.war\custom directory If this directory does not exist, you must create it. Prefix the path name with /itim/console/custom in the ui.properties file.
ui.banner.height 48 Enter the pixel height of the banner.

To modify these files, complete these steps:

Procedure

For software stack installations, do the following tasks:
  1. Make backup copies of the files and store the files you want to modify in a temporary directory.
  2. Edit the files in the temporary directory and copy the updated files back into the deployed WebSphere® directory. You must restart the IBM Verify Identity Governance application for these changes to take effect.

What to do next

Be sure to back up the custom version of the files you have created so your customizations are not lost.