Using CA Spectrum WebClient

This page describes how to use CA Spectrum WebClient in the following topics:
casp101
HID_Webclient
This page describes how to use CA Spectrum WebClient in the following topics:
Overview
CA Spectrum provides a light version WebClient for managing alarms.
The following image shows how the WebClient looks:
 web_client.png
Once you launch WebClient, it connects with the specified OneClick server to retrieve up to 100 latest alarms. It subscribes to the OneClick server to receive alarm updates.
WebClient also retrieves the following categories of alarms on demand:
  • All the alarms.
  • Alarms based on time (last 1, 2, 4, 6, 12, and 24 hours).
  • Global collections and global collections hierarchy that are accessible to you in OneClick, and their associated alarms.
  • Available landscapes and alarms asserted on them.
  • Alarms based on alarm filters that are accessible to you in OneClick.
    The WebClient page contains the Filters pane to retrieve these categories of alarms on demand. In the Filters pane, all these categories are available as filters. When you select a particular filter, WebClient retrieves up to 10,000 alarms of that category by default. You can configure this number in the range of 1 to 50,000 in Preferences.
  • WebClient is part of CA Spectrum 10.1 package. It is available when you install CA Spectrum 10.1.
  • WebClient only retrieves all these categories of alarms, so that you can perform the following alarm management activities:
    • Acknowledge, unacknowledge, and clear alarms.
    • Assign and unassign troubleshooters.
    • Create service desk ticket for alarms.
  • You cannot create or modify any global collection, global collection hierarchy, or alarm filter from WebClient.
  • Alarms on models that are not accessible to you in OneClick, are not retrieved and displayed by WebClient.
Launch WebClient
WebClient is a web based application, you can launch it on the following browsers:
  • Internet Explorer (IE) 11 or higher
  • Firefox 42 or higher
  • Chrome 46 or higher
Launch WebClient using any one of the following procedures:
Procedure 1:
  1. Open an IE, Firefox, or a Chrome browser window.
  2. Enter the "http://
    <oneclickhostname><:portnumber>
    /spectrum" URL in the address bar.
  3. Enter your credentials, and Click OK.
  4. 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. Open an IE, Firefox, or a Chrome browser window.
  2. Enter the "http://
    <oneclickhostname><:portnumber>
    /spectrum/webclient/index.jsp" URL in the address bar.
  3. Enter your credentials, and Click OK.
    WebClient is launched, and you are logged in.
  • In the URL, you must specify the hostname and port number of a running OneClick server which is accessible to you.
  • Chrome 46 or higher is the recommended browser.
Alarms Pane
Once you launch WebClient, this pane displays up to 100 latest alarms (critical, major, and minor respectively). In this case, maintenance alarms are also displayed if you select the
Maintenance alarms
in Preferences. When you select the required filter in the Filters pane, this pane displays the alarms based on that filter.
Alarms are displayed in tabular format in pages. Each alarm is displayed as a row entry in the table. The columns specify various details of each alarm. You can drag and drop a column heading to shift that column to left or right.
By default, up to 10 alarms are displayed in one page. You can configure your required pagination in the Pagination drop-down list box for the current session. You can also save the pagination as a preference for the next sessions in Preferences.
  • The
    Alarms Dashboard
    contains alarm count icons of critical, major, and minor severity. It displays the total number of critical, major, and minor alarms that are present in your OneClick environment.
  • Click a particular severity count icon in the
    Alarms Dashboard
    to view up to 10,000 alarms of that severity in the Alarms pane. You can configure this number in the range of 1 to 50,000 in Preferences.
  • Click the connection_status.png button to view the connection status of Tomcat server, SpectroSERVERs (or landscapes), and Archive Managers (or Events).
Alarm Management Buttons
The Alarms pane contains the following alarm management buttons:
Acknowledge Alarms
Click the ack.png button to acknowledge multiple alarms that are selected in the table.
Unacknowledge Alarms
Click the unack.png button to unacknowledge multiple alarms that are selected in the table.
Clear Alarms
Click the clear.png button to clear multiple alarms that are selected in the table. You can only clear the user-clearable alarms
.
Assign Troubleshooter
Click the assign.png button to assign troubleshooters to multiple alarms that are selected in the table. When you assign troubleshooter to alarms, mail notification is sent to that troubleshooter. WebClient retrieves all the troubleshooters that are added in OneClick. If troubleshooters are not added in OneClick, you cannot add troubleshooters from WebClient.
Unassign troubleshooters
Click the unassign.png button to unassign troubleshooter for multiple alarms that are selected in the table.
Create Service Desk ticket
Click the create_service_desk.png button to create a service desk ticket for a single alarm that is selected in the table. The Request/Incident number is created for the selected alarm, you can view this Incident number in the Ticket Details column of the selected alarm. If Service Desk integration is not enabled, WebClient throws an error when you try to create a Service Desk ticket for an alarm.
Filter and Search Options
The Alarms pane contains the following Local filter and search options:
Filter Options
Use the Severity, Type, and Troubleshooter filters to view alarms based on severity, model type, and Troubleshooter.
  • If there are no critical alarms in OneClick, the Severity filter drop-down does not include “Critical” in the list.
  • If there is no WA_Link model modeled in OneClick, the Type filter drop-down does not include "WA_link" in the list.
  • You cannot use the troubleshooter filter when:
    • The same troubleshooter is assigned to all the alarms.
    • There is no troubleshooter assigned to all the alarms.
    • There is only one alarm that has a troubleshooter assigned.
      In this case, use the Search option to view alarms based on troubleshooter.
 
Search Option
The search bar is a text based search to find single or multiple alarms in the alarms table. Enter any column value in the search bar to find the respective alarms.
Examples:
  • If you enter the IP address of a device in the search bar, the search result displays all the alarms that are asserted on that device.
  • Suppose, there are alarms in the table for which a troubleshooter is already assigned. If you enter the name of that troubleshooter in the search bar, the search result displays all the alarms that are assigned to that troubleshooter.
Export Option
The Alarms pane contains the Export option to export all the alarms to CSV and Excel. You can also copy the alarms to clipboard, and print alarms.
Triage Buttons
The Alarms pane contains the following triage buttons:
Ping
Click the ping.png to send an ICMP ping to the devices that are in context of the selected alarms. The ICMP ping is initiated from the SpectroSERVER.
Poll
Click the poll.png button to poll the devices that are in context of the selected alarms. The poll is initiated from the SpectroSERVER.
Traceroute
Click the Traceroute.png button to determine the route (path) to the device that is in context of the selected alarm over a maximum of 30 hops. The round-trip time of packets received from each hop is also measured. Traceroute is initiated from the SpectroSERVER.
Alarm Details Pane
This pane displays the following details of a single alarm that is selected in the alarms table:
  • Alarm TITLE
  • SYMPTOMS
  • PROBABLE CAUSES
  • RECOMMENDED ACTIONS
You can close this pane. From
Preferences
>
Show Windows
, select the
Alarm Details
check box to reopen this pane.
Impact Pane
 This pane displays the symptom alarms and the Management Lost Impact details of an alarm that is selected in the Alarms pane,.
Example: If you have the “CHASSIS DOWN” alarm selected in the Alarms pane, the Impact pane displays the following alarms that were correlated to that alarm:
  • INFERRED CONNECTOR CONTACT STATUS LOST
  • DEVICE HAS STOPPED RESPONDING TO POLLS
  • BLADE STATUS UNKNOWN
The Management Lost Impact displays the details of impacted devices due to the selected “CHASSIS DOWN” alarm.
You can close this pane. From
Preferences
>
Show Windows
, select the
Impact
check box to reopen this pane.
Neighbor Topology Pane
The Neighbor topology displays all the neighboring models that are connected to the device in context of the selected alarm in the Alarms pane. When you select an alarm that is raised on a router, the following image shows how the Neighbor Topology pane displays its connectivity details:
Neighbour_Topology.png
When you place your mouse on a connected device, the mouse-hover is activated and Name, Network Address, Model Type Name, Model Class, MAC Address, and Location details are displayed.
You can close this pane.
From Preferences>Show Windows
, select the
Neigbhor Topology
check box to reopen this pane.
Filters Pane
This pane contains the following filters:
Latest 100 Alarms
Click this filter to view up to 100 latest alarms that exist in OneClick.
All Alarms
Click this filter to view all the alarms that exist in OneClick. In a DSS environment, alarms of all the landscapes are displayed.
Time Filters
Click this filter to view the alarms that occurred in the last few hour(s). The options available under this filter are: 1, 2, 4, 6, 12, 24 hours.
Example:
Suppose, 4 alarms were generated in the last 2 hours, and 2 alarms were generated in the last 1 hour in your CA Spectrum environment. In this case, selecting the 2 hours option displays 6 alarms. If you select the 1 hour option, 2 alarms are displayed.
Global Collections
Click this filter to view all the Global Collections that exist in OneClick. Select a particular Global Collection to view all the alarms asserted on it.
Global Collections Hierarchy
Click this filter to view all the Global Collections hierarchy that exist in OneClick. Select a Global Collection in a folder to view all the alarms asserted on it.
Landscapes
Click this filter to view all the landscapes that exist in your DSS environment. Select a particular landscape to view all the alarms asserted on that landscape. Select multiple landscapes to view the alarms asserted on those landscapes.
Alarm Filters
Click this filter to view all the alarms filters that exist in OneClick. Select a particular alarm filter to view alarms based on that alarm filter.
Example:
Suppose, an alarm filter called “major_alarms” for major alarms was retrieved from OneClick. In this pane, if you select the “major_alarms” filter, WebClient retrieves and displays major alarms.
By default, up to 10,000 alarms are retrieved and displayed when you select any filter except the
Latest 100 Alarms
filter. You can configure this value in the range of 1 to 50,000 in Preferences.
Preferences Button
You can set certain configurations of the WebClient page as your preferences. When you log in again, WebClient loads with those preferences . Use the settings.png button to set your preferences for the WebClient page.
  • To apply the preferences in the current session, click Apply. When you click Apply, the WebClient page reloads and your preferences are saved for the next session.
  • To apply the preferences in the next session or after a page reload, click Save.
  • To apply the default preferences in the current session, click Reset.
You can set the following preferences:
Alarms
Enter the number of alarms to be retrieved and displayed by WebClient for any filter, in this box. You can enter any value in the range of 1 to 50,000. This configuration is also applicable to the severity count icons in the
Alarms Dashboard
. This value is not applicable to the
Latest 100 Alarms
filter.
Default Value
: 10,000
Examples:
  • Suppose, you entered 12000 in this box and clicked
    Apply
    . In this case, when you select any filter in the Filters pane, WebClient retrieves up to 12000 alarms of that category and displays them in the Alarms pane.
  • Suppose, you entered 12000 in this box and clicked
    Apply
    . In this case, when you click a severity count icon in the
    Alarms Dashboard
    , WebClient retrieves up to 12000 alarms of that severity and displays them in the Alarms pane.
Maintenance alarms
Select this check box to view maintenance alarms.
Alarm Filter
Select this check box to save the alarm filter that you selected as your preference for the next session. When you launch WebClient again, it displays the alarms based on that selected alarm filter. If that saved alarm filter is deleted or not available to you in OneClick, WebClient displays alarms based on the
Latest 100 Alarms
filter in the next session.
Monochrome Theme
Select this check box to apply black and white theme on the WebClient page. Once you select this check box, the monochrome theme is applied on the WebClient immediately without a page reload.
Row Color
Select this check box to apply the severity color on alarm rows in the alarms pane. Once you select this check box, all critical, major, and minor alarms are highlighted in Red, Orange, and Yellow in the table immediately without a page reload.
Page length
Select
 
a value from this drop-down to set the number of alarms that are shown in one page of the Alarms pane.
Show Windows
Clear the Alarm Details, Impact, or the Neighbor Topology check box to close that pane. Once you clear these check boxes, all the three panes close immediately without a page reload.
Debug
When you face any problem with WebClient, select the required log level (trace, info, debug, warning, or error) from the drop-down.
Sign Out of WebClient
Click the username icon (beside settings.png icon on the top-right corner) to sign out of WebClient. When an administrator signs out of WebClient, the OneClick home page session also ends.
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 (beside the slide button).
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:
    <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.