How to change the Spectrum OneClick banner and / or icon

Document ID : KB000048728
Last Modified Date : 26/07/2018
Show Technical Document Details
Introduction:

Description:

When OneClick (OC) is launched in the top left hand of the console there is the OC icon (white square with "I") along with:

Console - CA Spectrum OneClick

This view can be modified to display your own banner or icon of choice for example to use Company branding, or renaming to make it easily distinguishable when running more than one OC console.

Solution:

In order modify the default OC banner or icon do the following:

Change Banner:

  1. Close OneClick and browse to the directory:
          Spectrum\tomcat\webapps\spectrum\WEB-INF\console\config directory​

        2.  Copy the:custom-branding-config.xml to the directory:

          Spectrum\custom\console\config

        3. Edit the custom-branding-config.xml file by nesting <app-brand-name> tag within <branding-config> tag found at the bottom of the doc:

<branding-config>

<app-brand-name>CUSTOMERBRANDING</app-brand-name>

</branding-config>

          4. You can also easily modify the icon to customer branding or something else by also adding <app-icon> tag within <branding-config> tag (make sure to save the image in the Spectrum\custom\images directory):

<app-icon>images/lfc.gif</app-icon>

E.G:

           <branding-config>
           <app-brand-name>CUSTOMERBRANDING</app-brand-name>
           <app-icon>images/lfc.gif</app-icon>
           </branding-config>

          5. Restart OneClick

NOTE:

  1. The Spectrum\tomcat\webapps\spectrum\WEB-INF\console\config\ custom-branding-config.xml file when opened explains usage and provides examples.
  2. Please also refer to the OneClick Customization guide for additional details.
 

Example of modified Spectrum\custom\console\config \custom-branding-config.xml file in full:

 
<?xml version="1.0" encoding="UTF-8"?>
<!--
 
 
   CA Technologies, Inc.
   One CA Plaza
   Islandia, NY 11749 USA
 
   Copyright (c) 2013 CA Technologies, Inc.
   All rights reserved.
 
   IN NO EVENT SHALL CA TECHNOLOGIES INCORPORATED BE LIABLE FOR
   ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES
   WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT
   OF OR RELATED TO THIS SOFTWARE, EVEN IF CA TECHNOLOGIES INCORPORATED
   HAS BEEN ADVISED OF, KNOWN, OR SHOULD HAVE KNOWN, THE POSSIBILITY OF
   SUCH DAMAGES.
 
 
-->
<!--
-->
 
<!--
   This configuration allows for application branding.  This file must be
   copied to: $INSTALL/custom/console/config before modifying it.
 
   The following tags can be specified for "branding-config"
 
     "app-brand-name" -
 
       Specifies the brand name of the application. 
       see NOTE under app-suite-name.
 
     "app-suite-name" -
 
       Specifies the suite name of the application.
 
       NOTE: The title of the application will be formed by using
             app-brand-name and app-suite-name, where app-brand-name will
             precede app-suite-name.
 
             If app-brand-name is specified, but app-suite-name is not,
             then the title will be app-brand-name (and vise versa).
 
             If both tags are omitted then factory defaults will be used.
 
     "navigation-name" -
 
       Specifies the name of the root node in the Navigation view.
 
     "app-icon" -
 
       Specifies the location of the top left corner application image.
       Recommended size: is 16x16 to 48x48 (pixels)
       Recommended locations:
           $INSTALL/tomcat/webapps/spectrum/images
           $INSTALL/tomcat/webapps/spectrum/images/Background
 
     "splash-image" - 
 
       Specifies the location of the application splash dialog image.
       Recommended size: is 600x400 (pixels)
       Recommended locations: see app-icon
 
 
     "logo-button" - 
 
       The following tags can be specified for "logo-button"
 
         "button-icon" - 
 
           logo image for the branded button.
           Recommended size: is 100x40 (pixels)
           Recommended locations: see "app-icon" 
 
         "mouse-over-text" - 
 
           specifies the text to display when the mouse is over the button.
 
         "click-action" - 
 
           if the button is clicked a web browser will be launched using
           the specified URL. if not specified no action will take place.
 
      "about-dialog" -
 
        The following tags can be specified for "about-dialog"
 
          "company-name" -
 
             The name of the company who is branding the application.
 
          "company-url" -
 
             Specifies a url to the company.
 
          "support-url" -
 
             Specifies a url to support for the company.
 
          "company-city-address" -
             
             Specifies the first half of the company address.
 
          "company-street-address" -
 
             Specifies the second half, the more specific part of an address.
 
 
  Below is a complete example of the supported application branding:
 
  <branding-config>
 
    <app-brand-name>SPECTRUM</app-brand-name>
 
    <app-suite-name>OneClick</app-suite-name>
 
    <navigation-name>Navigation Tree</navigation-name>
 
    <app-icon>images/rbell.gif</app-icon>
 
    <splash-image>images/console_splash.png</splash-image>
 
    <logo-button>
      <button-icon>images/weboperator.gif</button-icon>
      <mouse-over-text>CA Technologies</mouse-over-text>
      <click-action>www.ca.com</click-action>
    </logo-button>
 
    <about-dialog>
      <company-name>CA Technologies</company-name>
      <company-url>www.ca.com</company-url>
      <support-url>supportconnect.ca.com</support-url>
      <company-city-address>Islandia, NY 11749 USA</company-city-address>
      <company-street-address>One CA Plaza</company-street-address>
    </about-dialog>
 
  </branding-config>
 
 
-->
 
<branding-config>
 
<app-brand-name>CUSTOMERBRANDING</app-brand-name>
 
<app-icon>images/lfc.gif</app-icon>
 
</branding-config>
Instructions:
Please Update This Required Field