Skip to content
CA Spectrum - 10.2 to 10.2.3
Documentation powered by DocOps

Using CA Spectrum WebClient

Last update June 6, 2018

This page describes how to use CA Spectrum WebClient in the following topics:

Information! Starting from CA Spectrum 10.2.2 release, CA Spectrum WebClient is enhanced to improve accessibility for differently abled users. The Spectrum WebClient enhancements provide a better user experience enabling different types of users to use WebClient and accomplish their vital business tasks. 

 With these enhancements, in WebClient you can see changes in icons, new color coding and status text denoting model severity/icon conditions. Icons have additional indicators such as labels so that you can easily identify the severity. For more information about accessibility enhancements in WebClient, see WebClient Accessibility Features

WebClient Overview

CA Spectrum provides WebClient as a lighter version with limited functionality of OneClick thick client for managing alarms and topology.

WebClient is a part of the CA Spectrum package and it is available when you install CA Spectrum. You do not need any additional configuration.

Launch WebClient

You can launch the WebClient using any of the following browsers:

  • Chrome 54 or higher (recommended browser)
  • Firefox 50 or higher
  • Internet Explorer (IE) 11 or higher

Use one of the following procedures:

Procedure 1:

  1. Enter the URL (http://<oneclickhostname><:portnumber>/spectrum) in the browser.
    The 'oneclickhostname' and the 'portnumber' are the hostname and port number of a running OneClick server which is accessible to you. 

  2. Enter your credentials, and Click OK.

  3. Click WebClient on the OneClick home page to launch the WebClient in a new tab of the current browser window.
    WebClient is launched, and you are logged in.

Procedure 2:

  1. Enter the URL (http://<oneclickhostname><:portnumber>/spectrum/webclient/index.jsp) in the address bar.
    The 'oneclickhostname' and the 'portnumber' are the hostname and port number of a running OneClick server which is accessible to you.  
  2. Enter your credentials, and Click OK.
    WebClient is launched, and you are logged in.

Information! WebClient also supports secure connections.

The following image depicts the WebClient with various menu options:

The WebClient UI elements are organized as follows:

  • Filter pane: Displays various filters using which you can filter the alarms in Alarm table. See Filters Pane for more information.
  • Alarms Table: Displays alarms based on the selected filter. By default, it displays 10 alarms in a page based on the Latest 100 Alarms filter. See Alarms Pane for more information.
  • Alarm Dashboard: Displays alarm count for critical, major, and minor alarms. The alarms count depends on the filter that is applied in Available Filters. 
  • Preferences button: Displays preferences for WebClient and Alarm Table Column and allows you to cofigure preferences for WebClient and Alarm Table. See Preferences for more information.
  • Filter and Search options: Includes Available Filters, Local Filters (Assignment, Severity, and Type) and the Search option. You can access these filters in the Alarm pane. See Filter and Search options for more information.
  • Alarm Management buttons: Allows you to perform various alarm management actions such as acknowledge, clear, assign the troubleshooter. See Alarm Management buttons for more information.
  • Alarm Details pane: Displays details such as Alarm Title, Symptom, Causes, Recommended actions, and also displays default and custom attributes for alarms and models. You can view or hide this pane using the Preferences window.
  • Impact pane: Displays symptom and impact details of the selected alarm. You can view or hide this pane using the Preferences window. See Impact Pane for more information.
  • Neighbour Topology pane: Displays neighboring models information. You can view or hide this pane using the Preferences window. See Neighbor Topology Pane for more information.
  • Device Details pane: Displays details of the device on which the alarm is generated. You can view or hide this pane using the Preferences window. See Device Details Pane for more information.
  • UIM Performance Chart pane: This pane is displayed only for UIM models. It displays the performance chart for UIM devices that are discovered in Spectrum. See UIM Performance Chart for more information.

Note: You cannot create or modify any global collection, global collection hierarchy, or alarm filter from WebClient.

Deployment Best Practices for WebClient Topology

For each session of the WebClient topology, the corresponding topology model objects are loaded in the tomcat memory, which increases the tomcat memory usage. To support more number of WebClient topology sessions, the tomcat memory needs to be increased accordingly.

Before rolling out the CA Spectrum WebClient to operators in your enterprise, it is recommended that you review the following test performance data. Following data explains the total number of WebClient sessions per OneClick server with indicative number of models in topology for the given tomcat memory. This data helps you to plan and allocate resources accordingly.

Following data is the indicative WebClient performance test data for a OneClick server with 8GB memory based on the internal testing:

• 75 clients can simultaneously render 1000 models in Spectrum WebClient topology and can load 10,000 alarms in the Alarm Table.
• 20 clients can simultaneously render 5000 models in Spectrum WebClient topology and can load 10,000 alarms in the Alarm Table.

Information! Total number of WebClient topology models across the sessions would determine the overall memory requirement for OneClick Server. If you increase available OneClick server memory to 16 GB, you can have 150 clients each with 1000 models.

Render only WebClient Topology

Starting from CA Spectrum 10.2.2 release, WebClient allows you to consume only Topology view for your other applications such as CA UIM and CAPM.  You can expose the Spectrum topology to your operators, to immediately identify the problem areas, in real-time. Topology driven monitoring eliminates the need for redundant duplication of work for each application.

An administrator can generate a URL for a landscape by adding a new attribute (topology) to the URL and embeds the URL in other applications (Eg: CA UIM or CA PM). Operators can render only the topology for the selected landscape without any additional login.

Following is a sample url for viewing only topology for UMP:
https://<oneclickhostname>:<oneclickportnumber>/spectrum/webclient/index.jsp?topology

Using this URL user can view only topology and the left panel for selecting a global collection or landscapes.

Note: By removing the '?topology' parameter from the url, you can view and operate all the WebClient functionalities.

If you have access to the CA Spectrum installation directory, you can change the CA Spectrum logo on the WebCient page to their brand name. The CA Spectrum logo is on the top-left corner of the WebClient page.

Follow these steps:

  1. Open the "header.jsp" file in a text editor from "$SPECROOT\Spectrum\tomcat\webapps\spectrum\webclient".
  2. Locate the following section in this file:

    Customize CA Spectrum Logo
    <a href="index.jsp" class="logo">
              <!-- mini logo for sidebar mini 50x50 pixels -->
              <span class="logo-mini">CA</span>
              <!-- logo for regular state and mobile devices -->
              <span class="logo-lg"><b>CA</b>      Spectrum</span>
            </a>
  3. Remove CA, and specify your brand name in between the following tag:

    <span class="logo-mini">CA</span>
  4. Replace CA and Spectrum with your brand and product name in between the following tag:

    <span class="logo-lg"><b>CA</b>      Spectrum</span>
  5. Save the file, and refresh the WebClient page.

    The Logo is customized.

Add Custom Menus in WebClient 

Starting from CA Spectrum 10.2.3 release,  in the WebClient you can view menu items that are configured in the custom-menu-config.xml. You can use new menu items to launch third-party URLs and append selected Alarm or Device attributes as parameters.

Note: Using the menu items in WebClient, you can launch URLs for the selected alarms and devices. Launching the third-party applications, scripts is not supported in this release. Select only one alarm or device to launch the custom URL configured in WebClient.

The <$SPECROOT>/tomcat/webapps/spectrum/WEB-INF/console/config/custom-menu-config.xml file contains examples on how to add custom menus and custom menu items to your WebClient console as shown in the images. You need to copy this file in to the <$SPECROOT>/custom/console/config/ directory if the file is not already in this directory.

 

Note: You can configure only the menu items, which contain the <launch-browser> tag and only these menu items are shown in the WebClient.
The following tags are not considered for the WebClient:
<toolbar-image> , <accelerator>, <popup-visibility> , <context> and <filter> 

The <expression> tag content is not rendered in WebClient.

The following image shows the Custom menu and its new menu items to launch URLs for the selected alarms.

The process for creating new menus in WebClient is same as the process defined for OneClick Client. You create WebClient menus and menu items using the <menu> and <item> XML elements. The <menu> element can enclose one or more <item> elements that define the commands that are available on the menu. The <item> element can enclose several other elements that define how the menu item appears and behaves. For more information about XML elements and steps for creating custom menus, see the Customizing the OneClick Console Menu section.

Enable Inactive Timeout for WebClient 

Starting from CA Spectrum 10.2.3 release, you can configure CA Spectrum WebClient to check for inactivity timeout. This setting can enhance network security. For example, if a user leaves the WebClient running unattended on a desktop, it times out. You can do this setting in the OneClick Administration page.

Follow these steps:

  1. Log in to OneClick client. 
  2. Click the Administration tab in the OneClick home page.
  3. Click OneClick Client Configuration from the OneClick Administration section.
  4. Specify the number of minutes of inactivity to allow before timing out in the OneClick Client/WebClient Inactivity Timeout (minutes) field.
    Default: 0 (Disabled)
  5. Click Save.
    Timeout of inactive WebClient sessions is now enabled.

Resize/Expand Table Columns

Starting from CA Spectrum 10.2.3 release, you can resize Alarm Table columns to view full details of the column. When you place the mouse curser between two columns headers, an expand arrow appears, you can drag it towards the column which you want to resize.

Sign Out of WebClient

Click the Username icon (beside  icon on the top-right corner) to sign out of WebClient.

Note: When an administrator signs out of WebClient, the OneClick home page session also ends.

Was this helpful?

Please log in to post comments.

  1. WILLIAM BARNES
    2017-03-02 03:38

    many of the links are broken. I tried to click preference, which is supposed to take me to the "preferences" section. It did nothing.

    1. Vijaya Kumar Gonela
      2017-03-03 12:56

      WILLIAM BARNES,
      Thanks for your feedback!
      We have fixed links issue. All the links in this page should work fine now.
      Regards,
      Team DocOps