OneClick Administration Pages

Contents
casp10
Contents
Access the OneClick Administration Pages
The OneClick Administration Pages are accessible from the OneClick home page. Only OneClick users with OneClick web administration privileges can access these web pages.
To access the OneClick Administration Pages, click Administration in the OneClick home page.
spec--mainadminpagetoolbar_SCR
About the OneClick Administration Pages
The Administration Pages provide a navigation panel to select specific features to configure, and a contents panel on the right that displays the configuration information for each feature. The menu bar contains the following options:
  • Home
    Opens the OneClick home page.
  • CA Spectrum Documentation
    Opens the CA Spectrum documentation page.
  • Debugging
    Opens the Debugging page, which contains links to and information about the debugging tools that are included with CA Spectrum.
    Only use the debugging tools with the help of CA Support.
  • Report Manager
    Opens the Report Manager Admin Tools pages.
    For more information about administering Report Manager, see Install Report Manager.
The administrative pages that are listed in the navigation panel reflect any OneClick add-on applications that are installed.
spec--adminhomepage_SCR.png
The navigation panel and the other OneClick web page links remain available from any OneClick administration page.
CAC Configuration Page
Use the CAC Configuration page to configure OneClick to use Common Access Cards (CAC).
For more information, see Common Access Card Authentication.
eHealth Configuration Page
Use the eHealth Configuration page to configure OneClick for connection to an eHealth server. Any changes that you make on this page are reflected in OneClick clients that are launched subsequently. You can use the Test button to test any eHealth configuration changes before you save them.
For more information about integrating CA Spectrum and eHealth, see
Email Configuration Page
Use the Email Configuration page to configure OneClick to integrate with your existing email system. Operators can then email alarm-related information from OneClick to assigned troubleshooters and other individuals.
The default SMTP Server Host entry for the mail server is "mailhost", which is a common DNS alias for the mail server. If your environment does not use this alias, you can add an entry for “mailhost” to the /etc/hosts file on the OneClick web server.
Reload EvFormat/PCause Configuration
The EvFormat/PCause Configuration page lets you reload modified Event Format or Probable Cause files into the OneClick server.
You can also reload the EvFormat/PCause files from the command line if desired. Use the command line to reload EvFormat/PCause files from any server.
Follow these steps:
  1. Obtain and install GNU wget.
    GNU wget is a simple freeware utility.
  2. Run the following command:
    wget http://ochost:ocport/spectrum/admin/ecds.jsp?reload=Reload --user username --password password
    • ochost
      Specifies the hostname of the OneClick web server.
    • ocport
      Specifies the port number of your OneClick web server.
    • username
      Specifies an administrator username for the OneClick web server.
    • password
      Specifies an administrator password for the OneClick web server.
Landscapes Page
Use the Landscapes page to view the status for all the landscapes (SpectroSERVERs) that the OneClick server is currently monitoring. You can identify information related to a distributed SpectroSERVER (DSS) setup, including any parent and child landscapes. You can perform a manual synchronization between all distributed models with their corresponding models on the master landscape using the Sync With Master button.
You can manually add or remove landscapes monitored by this OneClick server. You can remove only landscapes that you have manually added.
LDAP Configuration Page
Use the LDAP Configuration page to configure the OneClick web server to use an external LDAP server for user authentication.
This administration page includes the following settings and functionality:
  • LDAP Server Settings
    Server settings to identify a primary and secondary LDAP server by IP address and port number, use SSL, add an SSL certificate, and specify timeout values when attempting to connect to or query the LDAP server.
  • Save LDAP Passwords to CA Spectrum Database
    Lets you give access to OneClick users if the LDAP server is down, based on their last known correct LDAP password.
  • User Name Lookup
    Configure OneClick lookups of usernames, either as a User by Search or a User by Pattern lookup.
  • Test LDAP Configuration
    Once you have configured the OneClick interface with an external LDAP server, lets you test the configuration.
If three consecutive LDAP-based login failures occur, a critical alarm is generated on the VNM that is hosting the Location Server for the OneClick web server.
MySQL Password Page
OneClick has its own MySQL Server users and passwords: a basic user (OC_user) and an administrative user (OC_admin). Both are used to access the MySQL reporting database on behalf of CA Spectrum applications such as Report Manager and Service Manager, but the administrative user can also grant privileges to other users for this database. For greater security, CA Spectrum provides the MySQL Password page which lets you change the passwords of the OneClick MySQL users.
Do not attempt to manually change the MySQL user passwords using a MySQL client connection. Storage of the passwords in OneClick depends on MySQL connectivity. As a result, the only safe way to change the passwords is through the OneClick MySQL Password Administration page.
The MySQL Password page contains the following settings:
  • Default User
    Specifies the credentials for the default OneClick MySQL Server user (OC_user) that CA Spectrum uses to access the reporting database used in OneClick web applications.
    • Current Password
      Specifies the current password for the OC_user MySQL user.
    • New Password
      Specifies a new password for the OC_user MySQL user.
    • Confirm New Password
      Confirms the new password for the OC_user MySQL user.
  • Admin User
    Specifies the credentials for the administrative OneClick MySQL Server user (OC_admin) that CA Spectrum uses to access the reporting database used in OneClick web applications and grant privileges to other users for this database.
    • Current Password
      Specifies the current password for the OC_admin MySQL user.
    • New Password
      Specifies a new password for the OC_admin MySQL user.
    • Confirm New Password
      Confirms the new password for the OC_admin MySQL user.
OneClick maintains the MySQL server user credentials so that it can connect to MySQL. OneClick stores this password in an encrypted form for security purposes.
NSM Configuration Page
The NSM Configuration page lets you configure OneClick for connecting to an NSM dashboard and an NSM report server. Only OneClick clients launched after you save any changes reflect the changed settings.
OneClick Client Configuration Page
OneClick uses the Java Web Start framework developed by Sun Microsystems to launch the OneClick Console from the OneClick home page in a browser. To determine how to launch the OneClick Console (for example, the location of necessary JAR files), the Java Web Start framework relies on several Java Network Launching Protocol (JNLP) configuration files for the launch parameter values.
The OneClick Client Configuration page lets you configure settings associated with the OneClick client. These settings are used by the JNLP files which are located in the directory at the following location:
C:\win32app\SPECTRUM\tomcat\webapps\spectrum
Any modifications that you make to the JNLP files are saved to custom files in the following directory:
$SPECROOT\custom\common\config
  • Supported JRE Versions
    Specifies which versions of JRE can be installed on the client to start OneClick. If none of the specified versions are installed, the user cannot start the OneClick Console from the OneClick home page and, instead, receives an error message. Multiple JRE versions can be specified as needed. When multiple JRE versions are specified, Java Web Start processes precedence from the top of the list to the bottom of the list.
    • Allow new versions
      Allows OneClick clients to run any JRE version beyond the specified required JRE, including both major and minor JRE releases. Please be advised, as with any custom JRE configuration, using a JRE version other than the version which is provided to you could result in undesirable application behavior.
    CA Spectrum supports a documented minimum JRE version level, and supports running the OneClick user interface in that minimum version, or in any later version, unless noted otherwise in the product documentation. We also test with new JRE versions as they become available and update the CA Spectrum product documentation, the online Support knowledge base, or both, if specific JRE versions are incompatible.
  • Java Memory Usage
    The Java Memory Usage section lets you set the minimum and maximum size of the object heap for the Java Virtual Machine used by OneClick clients. For more information, see Configure OneClick Client Memory Settings.
    • Minimum Client Memory Usage (megabytes)
      The minimum amount of memory, in megabytes, that must be available on the client to start OneClick.
      Default:
      96
    • Maximum Client Memory Usage (megabytes)
      The maximum amount of memory, in megabytes, that OneClick can use on the client.
      Default:
      1024
  • OneClick Client Inactivity
    Lets you configure OneClick to check clients for inactivity and time inactive clients out. This feature is disabled by default. If enabled, when timeout occurs, users can enter their username and password to continue using the OneClick client. Inactivity is determined by the absence of keyboard or mouse activity is detected for the specified amount of time.
Enable Inactive OneClick Client Timeout
You can configure CA Spectrum to check OneClick clients for inactivity and time out those clients that have been inactive for a specified amount of time. This setting can enhance network security. For example, if a user leaves the OneClick client running unattended on a desktop, it times out.
Follow these steps:
  • Click Administration in the OneClick home page.
    The Administration Pages open.
  • Click OneClick Client Configuration.
    The OneClick Client Configuration page opens.
  • Complete the settings in the OneClick Client Inactivity section as needed:
    • OneClick Inactivity Timeout (minutes)
      Specifies the number of minutes of inactivity to allow before timing out (logging off) a OneClick client.
      Default:
      0 (Disabled)
    • Applet Inactivity Timeout (minutes)
      Specifies the number of minutes of inactivity to allow before timing out (logging off) an applet.
      Default:
      0 (Disabled)
    If you have OneClick clients that are dedicated to network monitoring and inactivity is likely, you can remove the Inactivity Timeout privilege for a user. The user cannot receive a timeout if the timeout setting has been specified.
  • Click Save.
    Timeout of inactive OneClick clients is now enabled.
Performance Center Integration Configuration Page
The Performance Center Integration Configuration page lets you configure event sharing between CA Spectrum and CA Performance Center.
The Performance Center Integration Configuration page contains the following settings:
  • Event Polling Interval
    Specifies how frequently CA Spectrum queries the Performance Center Event Manager component for events. If you modify this value, the new polling interval takes effect at the next polling cycle.
    Default:
    60 seconds
  • Event Polling
    Enables or disables event polling.
For more information, see CA Performance Center and CA Spectrum.
Service Desk Configuration Page
You can view, configure, test, and save CA Spectrum and CA Service Desk Manager integration settings using the Service Desk Configuration administration page.
Before configuring OneClick to connect to CA Service Desk Manager, download and install the integration components on your CA Service Desk Manager server.
You can create and modify CA Service Desk Manager server and admin user parameters, enable and disable the CA Spectrum and CA Service Desk Manager integration, and add and remove CA Spectrum alarms that generate CA Service Desk tickets.
Single Sign-On Configuration Page
The Single Sign-On Configuration page lets you enable and select a Single Sign-On option for CA Spectrum. CA Spectrum supports Single Sign-On using CA Embedded Entitlements Manager (CA EEM) or CA SiteMinder®.
When you save changes to these configuration settings, the OneClick server is automatically restarted in order to apply the changes. If you encounter errors during the restart, see Start and Stop the OneClick Web Server from an Administration Web Page for troubleshooting tips.
CA Spectrum Configuration Page
You can view and set the following CA Spectrum configuration parameters:
  • Main Location Server Name
  • Backup Location Server Name
  • Admin User Name
  • SpectroSERVER Polling Interval (sec)
  • SpectroSERVER Request Timeout (sec)
  • The properties of the object request broker (ORB) used by the OneClick web server for CORBA-based communication with the SpectroSERVER
You can also restart the OneClick server so that any modifications that require a restart can take effect. If you encounter errors during the restart, see Start and Stop the OneClick Web Server from an Administration Web Page for troubleshooting information.
For more information about the implementation of Common Object Request Broker Architecture (CORBA) in CA Spectrum, see the section.
SPM Data Export Page
The SPM Data Export page lets you change the following settings for SPM (Service Performance Manager) Data Export:
  • SPM Data Export Enabled
    Specifies whether SPM Data Export is enabled or disabled. You must enable it to modify all the other settings.
  • Log File Cycle Time (min)
    Specifies when (in minutes) the SPM log file is saved and closed, and a new file is opened for logging.
  • Log File Directory
    Sets the full path to the directory where SPM log files are stored. The directory structure specified must be created prior to saving.
  • Landscape Filter
    Specifies which landscapes SPM data is obtained from.
  • Restart OneClick Server
    Restarts the OneClick server so that any setting changes that require a server restart can take effect.
SPM Template Naming Page
This page allows you to specify the naming convention for tests created on test hosts that have had a SPM test template applied to them:
  • IP Address
    The test name consists of the template name and the IP address of the test target, which may be the test host or a particular device.
  • Model Name
    The test name consists of the template name and the model name of the test target, which may be the test host or a particular device.
For information about working with SPM test templates, see Service Performance Manager.
SSL Certificates Page
You can use the SSL Certificates page to view and add SSL certificates used by the OneClick web server.
  • File with Certificate
    Uploads the new key certificate you want the OneClick web server to use.
  • Alias Name
    Specifies a short name for the certificate. This name should be consistent with some of the other commands that may need to be used with it. For example: “ldap” when setting up ldap; “ssl” or “tomcat” when setting up web server SSL.
    For LDAP configuration information, see LDAP Configuration. For OneClick SSL configuration, see Name Resolution Requirements.
  • Overwrite
    Specifies whether to overwrite an existing certificate with this new certificate. To overwrite an existing certificate, you must load the new certificate with the same alias name of the existing certificate.
    • Yes
      Overwrites the existing certificate.
    • No
      Does
      not
      overwrite the existing certificate.
  • List
    Opens a list of certificates already added to the keystore. Certificates are listed by alias name.
  • Save
    Saves your changes and prompts you to restart the OneClick web server.
Watch Reports
The Watch Reports page lets you generate reports about multiple watches. A
watch
is a mechanism for adding thresholds for model attributes. Watches let you monitor network elements, such as routers, with a high level of detail. They also provide current data that can be used with other CA Spectrum tools in network analysis.
For more information, see Watches.
Web Server Logs Configuration Page
You can use the Web Server Logs Configuration page to view and set OneClick server log file rotation settings. The OneClick web server log files are located in the <$SPECROOT>/tomcat/logs directory.
You can set an alarm notification when the log file directory becomes larger than a specified size in megabytes. You can view the current size of the log file directory. You can specify the age in days at which a log file is deleted from the directory.
Web Server Memory Page
You can use the Web Server Memory page to view and set the maximum amount of memory the OneClick server uses. Any changes you make require you to restart the OneClick server. You can also view the percentage of the maximum memory allocation the OneClick server is currently using.
You can also restart the OneClick server so that any modifications that require a restart can take effect. If you encounter errors during the restart, see Start and Stop the OneClick Web Server from an Administration Web Page for troubleshooting information.
Web Server Performance
The
Web Server Performance
page displays the '
Infer Pipes in Global Collections
' option. By default, this option is set to "
Yes
". This option creates pipes between devices that are connected through Wide Area (WA) Links, even when the link is not contained in the Global Collection.
You can disable this option if the GC topology rendering is slow.
Select "
No
" from the drop-down list, and then click the
Save
button.
This will prevent the pipes from being drawn between devices that are connected via WA links when the link is not contained in the Global Collection.
 
The Top Impacting Outages View
You can use the Top Impacting Outages View in the Spectrum OneClick home page to see the most impacting outages in your infrastructure. The impacting outages are calculated from the weighted number of devices unavailable during the outage of all impacted devices that were unavailable due to the outage as well as the duration of the outage.
This functionality is designed to help IT managers and Network Administrators to know top impacting outages and accordingly take necessary steps to reduce future outages.
To use the Top Impacting Outages feature, install the Spectrum Report Manager (SRM) with OneClick. Though SRM is installed, this functionality does not require CABI. For information about prerequisites and installation process see, Report Manager Installation and Administration.
Note:
You must have Spectrum Administrator privileges to access this page. 
Top Impacting Outages
The Top Impacting Outages in your infrastructure are viewed based on the Peak Impact Count or the Impact Weight.
Peak Impact Count is the maximum number of devices, weighted with their individual criticality values that were unreachable because of the outage. The criticality attribute (0x1290c) can be set on each device model to add a weight to the individual devices. By default, its value is set to 1 for device models.
Impact Weight is calculated by multiplying the Peak Impact Count with the outage duration. Thus it gives a true indication of the impact of the outage by taking into account not only the Impact Count but also the outage duration.
Note:
After the view has been generated, it retains the data until it is manually refreshed. Alternatively, the view parameters can be changed and the view can be regenerated.
The Top Impacting Outages view displays only unplanned outages.
Important! For better view of this page in Internet Explorer it is recommended to disable the compatibility view of your browser.
Calculation of the Peak Impact Count and Impact Weight
The following example describes the calculation process of Peak Impact Count and Impact Weight.
Example: If three devices A, B and C with default criticality value of 1 for each device and are connected as follows:
Top Imapcting Outages-Example.png
Suppose device A goes down causing the device B and C to be unreachable, and Spectrum detects device A as the root cause of the failure, and the failure condition is cleared in 30 minutes.
In this case:
Outage duration = 30 minutes
Peak impact count = 3 (sum of criticality values of devices A, B and C)
Impact weight = 3 x 30 = 90
Now, if an outage in device B is 10 times more expensive than a standard device, you can modify the Criticality of B to 10.
In this case:
Outage duration = 30 minutes
Peak impact count = 12 (sum of criticality values of devices A (1), B (10) and C (1))
Impact weight = 12 x 30 = 360
Settings
The Settings section allows you to select the settings to generate the Top Impacting Outages view. Click Settings Icon.png to view or modify the settings such as the number of top outage records to be retrieved, the retrieval window and the method of retrieval determining the top outages. You can save the configuration for future use.
Scope:
  • The Top Impacting Outages View displays only the completed outages data whose duration is within the specified time window as selected in the ‘Last X days’ parameter in Settings.
  •  It does not display the ongoing outages and outages whose duration is more than the specified time window.
    Example: An outage that lasts for 45 days, while the Last X days’ parameter is set to 30 days.
  •  Recently completed outages data is displayed in the Top Impacting Outages View only after a next SRM poll (default SRM poll interval time is 1 hour).
The Settings section includes the following options:
Top Outages
Lets you select the number of top outage records that you want to view.
Limit: 50 to 1000 in multiples of 50.
Retrieved by
Lets you select the category by which you want to retrieve the top outage devices.
Values: Peak Impact Count and Impact Weight.
Example: Consider two outages as follows:
Device
Duration
Impact Count
Impact Weight
Device A
30 min
10
300
Device B
120 min
5
600
 In this case:
The top impacting outage by impact weight is Device B and the top impacting outage by impact count is Device A.
in the last X days
Lets you select the number of days for which you want to view the outage devices data. You can view only the past 30 days outage devices data.
Save
Saves the Settings for future use.
Run
Generates the Top Impacting Outages View for the given settings.
Refresh icon Refresh Icon.png
Refreshes the Top Impacting Outages View results for the current settings.
Note:
Below is the functionality when multiple spectrum users use Top Impacting Outages View.
The Settings are specific to OneClick and only one set of settings are saved to the following file:
<SPECROOT>\tomcat\webapps\spectrum\console\impactoutage\config\impact-outage-config.xml. If multiple Spectrum users save different settings, only the last saved settings are stored to file.
The dynamically selected new settings are reset to old values from configuration file on clicking the Run or Refresh button. In order to reuse new settings, first save them and then generate the view.
For each spectrum user, the last generated view results are saved to a file with user name at the following location on OneClick server. The results in the file are overwritten if the user re-runs or refreshes from Top Impacting Outages View.
<SPECROOT>\ tomcat\webapps\spectrum\console\impactoutage\reports\username-ImpactOutage-Results.xml
Important!
The saved Settings are reset to default settings during the upgrade or patch install (if patch has related fix). If required, backup the settings configuration file impact-outage-config.xml, reconfigure and save the settings post upgrade.
Generate Top Impacting Outages view
You can generate a Top Impacting Outages view.
Follow these steps:
  1. Open the OneClick home page
  2. Click the Top Impacting Outages
  3. Set the configuration in the Settings section
  4. Click Run
‘Request processed successfully’ message appears on the screen. The view is generated and the Top Impacting Outages details are displayed on the screen.
You can see the following details in the Top Impacting Outages view:
Outage Start Time
The outage start date and time.
Duration (hh:mm:ss)
The period of time between outage start and end time.
Device
The name of the device which caused or impacted by outage..
Location
The location of the device which caused or impacted by outage.
Peak Impact Count
The maximum number of devices weighted with their individual criticality values that were unreachable because of the outage. This value is retrieved from the respective alarm generated for the outage device.
The criticality attribute (0x1290c) can be set on each device model to add a weight to the individual devices. By default, it is set to 1 for device models.
Impact Weight
The outage impact weight.
Impact Weight = Peak Impact Count X Outage Duration (in Minutes).
At the bottom of the view, it displays the details of current displayed view, generation date and settings used.
The GIS View
The GIS (Geographical Information System) View displays device models geographically on the Google maps. You can view the model name and model handle details of a device when mouse over on that device in this view. When you click the device in this view, it displays the device details in OneClick. The condition of the device model is also highlighted. For example, a device model with critical condition is displayed in red color. By default, the map focuses on the USA.
The GIS View feature does not work if you integrate CA Spectrum with CA SiteMinder SSO.
You can configure the default location by entering your favorite location in gisGC.config file. The source of input for GIS View is Global Collection (GC) or list of IP addresses. The default primary source is GC. You can configure the default source to IP address list by modifying the 'UseGisGCconfig=no' in gisGC.config file.
Enter the IP addresses for which you want CA Spectrum to display GIS view in the following files:
For GC: 
$SPECROOT/tomcat/webapps/spectrum/console/gisGC.config
We recommend using unique name for GC
For IP addresses list: 
$SPECROOT/tomcat/webapps/spectrum/console/gisIPAddressList.config
  • The free version of Google's APIs allows you to view limited number of devices (as per Google API policy) in GIS View. If you have an enterprise license key, then you can update the following property file to view more devices in GIS View.
  • We recommend to configure hundred or less devices for GIS View.
$SPECROOT/tomcat/webapps/spectrum/console/googleAPIKEY.config
The following image shows how the GIS View looks like:
SPEC--GISView.png