Working with Portlets
Overview
This chapter describes all portlets available in HCM Dashboard. It includes:
•
Understanding the Filtering Option in Portlets
Understanding the Filtering Option in Portlets
The Filter option allows you to narrow down the displayed data. Filtering provides a quick and easy way to identify a specific record that matches a given criteria provided by you. The following are the three filtering types:
The Filter option is available in the following portlets:
•Customer Administration Launch Point
•Customer Cross Launch
•Quick Launch
•User Administration
•Alarm Summary
•Phone Summary
Quick Filter
Quick Filter uses commonly used criteria for a given portlet as a set of predefined filters. The predefined filters list is displayed in the Show drop-down list in the portlet toolbar. The Show drop-down list consists of the following options:
•Manage Quick Filters—Allows you to edit or remove a predefined filter. See Managing Quick Filters
•All—Allows you to clear the filter and retrieve the non-filtered data.
•Predefined Filters List—Lists the predefined filters.
To filter data in a portlet using the Quick Filter option:
Step 1 Click the Show drop-down list.
Step 2 Select one of the predefined filters.
To create a predefined filter, see Advanced Filter
The data appears according to the predefined filter you selected.
Managing Quick Filters
To manage quick filters:
Step 1 Select Manage Quick Filters from the Show drop-down list.
The Manage Quick Filters dialog box appears.
Step 2 Select a predefined filter.
Step 3 Click Edit to edit the predefined filter or click Remove to remove the predefined filter.
Step 4 Click Cancel to close the Manage Quick Filters dialog box.
Filter by Example
To filter data in a portlet using the Filter by Example option:
Step 1 Click Filter from the portlet toolbar or click the Filter drop-down arrow and select Filter by Example.
A text field appears in the column header. The number of text fields depend on the number of column headers.
Step 2 Enter the filtering criteria in the text field. If you enter alphabetic characters, note that they are case-sensitive.
The data in the portlet starts filtering as you type.
To clear the filter and retrieve non-filtered data, click the Close button that appears in the text field after you type the filtering criteria.
Advanced Filter
To filter data in a portlet, using the Advanced Filter option:
Step 1 Click the Filter drop-down arrow.
Step 2 Select Advanced Filter.
A row appears, in which you can create a rule for filtering and then add the rule as a predefined filter.
Step 3 To create a rule and then save the rule as a quick filter:
a. In the first column dropdown, select a filtering option.
Filtering options differ from portlet to portlet. To see the filtering options specific to a portlet, see the Filtering Types and Options table in the corresponding portlet section.
b. Select a relational operator from the second column dropdown list.
Relational operators differ from portlet to portlet. To see the relational operators specific to a portlet, see the Filtering Types and Options table in the corresponding portlet section.
c. Enter the filtering criteria in the text field in the third column.
d. Click Go.
The data appears according to the rule.
e. Click Save to add this rule as a predefined filter.
The Save Quick Filter dialog box appears.
You can also click Clear Filter to clear the filter and retrieve the non-filtered data.
f. Enter a name for the quick filter in the Filter Name field.
g. Click Save.
The rule is saved as a Quick Filter and will appear in the Show drop-down list in the portlet toolbar.
Step 4 Click the Add Criteria button to create another rule.
You can add multiple rules.
Another row appears where you can create another rule for filtering. Go to Step 3 and follow the steps to create a rule and then save the rule as a quick filter.
You can delete the rule created by clicking the Remove Criteria button.
When you create multiple rules, the Match drop-down list appears. This allows you to select one single rule or all rules. The options in the Match drop-down list are All and Any.
Administration Portlets
An admin user can view and modify all portlets. The Administration portlets allow you to view all customers and cross-launch CUOM, vCenter, and FMS web pages for customer-centric views. The following are the Administration portlets:
•Customer Administration Launch Point Portlet
•Customer Cross Launch Portlet
Customer Administration Launch Point Portlet
To view the Customer Administration Launch Point portlet, go to Administration > Customer Administration Launch Point.
The Customer Administration Launch Point portlet allows admin users to configure customer details. As an admin user, you can cross-launch to the domain managers from the portlet. This section includes:
•Editing Domain Manager Details
•Viewing Domain Manager Details
UI Options
Table 2-1 explains the UI options available in the Customer Administration Launch Point portlet.
The UI options in the portlet toolbar appear according to the screen resolution. The screen resolution used is1024 by 768 pixels.
|
|
|
|---|---|
Filter |
Allows you to filter the data displayed in the portlet. See Table 2-2 for the list of filtering types and corresponding options available in the portlet. |
Add Customer |
Allows you to add a new customer. |
Edit Customer |
Allows you to edit customer details. |
Delete Customer |
Allows you to delete customer details. |
View Customer |
Allows you to view customer details. |
Add Domain |
Allows you to add domain manager credentials. |
Edit Domain |
Allows you to edit domain manager credentials. |
Delete Domain |
Allows you to delete domain manager credentials. |
View Domain |
Allows you to view domain manager credentials. |
Filtering Types and Options
See Understanding the Filtering Option in Portlets to understand the Filter option. Table 2-2 lists the filtering types and corresponding options available in the Customer Administration Launch Point portlet.
Adding a Customer
To add a customer:
Step 1 Click Add Customer from portlet toolbar.
The Customer Configuration dialog box appears.
Step 2 Enter the customer name in the Customer Name field. This is a mandatory field.
Step 3 (Optional) Enter the description.
Step 4 Click OK.
The customer is added successfully.
An error message appears and the customer will not be added if:
•You try to add a duplicate customer.
•You do not enter the customer name in the Customer Name field.
Step 5 Click Cancel to close the Customer Configuration dialog box.
Editing a Customer
To edit a customer:
Step 1 Select a customer.
Step 2 Click 
and select Edit Customer.
The Customer Configuration dialog box appears.
Step 3 Edit the description.
You cannot edit the customer name.
Step 4 Click OK.
Step 5 Click Cancel to close the Customer Configuration dialog box.
Deleting a Customer
To delete a customer:
Step 1 Select a customer. You can select one customer or multiple customers.
Step 2 Click and select Delete Customer.
The following message appears in the dialog box.
Are you sure you want to delete the selected customer(s)?
Step 3 Click OK or go to Step 4.
The customer details are deleted from the HCM database.
If the portlet is open, the new data will not be reflected until the server is refreshed or a new session is opened.
Step 4 Click Cancel to cancel the operation.
Viewing a Customer
To view a customer:
Step 1 Select a customer. You can select only one customer.
Step 2 Click and select View Customer.
The Customer Configuration dialog box appears, displaying the details of the selected customer.
Step 3 Click Close to close the Customer Configuration dialog box.
Configuring Domain Managers
You can configure domain managers in the Customer Administration Launch Point portlet. This section includes:
Configuring CUOM
To configure CUOM:
Step 1 Select a customer.
Step 2 Click and select Add Domain.
The Add Domain Manager Configuration dialog box appears.
Step 3 Select CUOM from the Select Domain Manager Name drop-down list.
Step 4 Enter the following details in the Domain Configuration tab:
•IP Address—IP address of the device.
•Admin Username—CUOM admin username.
•Admin Password—CUOM admin password.
•Operator Username—CUOM operator username.
•Operator Password—CUOM operator password.
Step 5 Enter the following details in the Diagnostics Configuration tab:
•JTAPI Username—Username of Java Telephony API (JTAPI).
•JTAPI Password—Password of JTAPI.
JTAPI supports telephony call control and is an extensible API. JTAPI is designed to scale for use in a range of domains. JTAPI can be used from first-party call control in a consumer device, to third-party call control, in large distributed call centers.
The phone tests that are run as part of batch testing and on-demand testing, take control of a real phone in the network and make a call from one phone to another phone. Phone Tests use JTAPI credentials.
While running on-demand phone tests, the JTAPI credentials must be provided in the phone test creation page. The JTAPI credentials must be configured in Cisco Unified Communications Manager for Phone Tests in CUOM to work properly.
•Helper Phone 1—Helper Phone 1 is one of the alternative phone number used to test the configured customer line.
•Helper Phone 2—Helper Phone 2 is another alternative phone number used to test the configured customer line.
Helper Phone 1 and Helper Phone 2 are configured under the same Cisco Unified Communications Manager and are required while running Phone Tests.
•Phone Number—Number of the public switched telephone network (PSTN).
•Nearest IP SLA Device IP—IP address of the nearest IP Service Level Agreement (IPSLA) device.
IP SLA-based diagnostic tests can measure the performance of WAN links and node-to-node network quality. Phone status tests use IP SLA to monitor the reachability of key phones in the network.
Step 6 Click Save.
Step 7 Click Submit.
Step 8 Click Cancel to close the Add Domain Manager Configuration dialog box.
Configuring UCSM
To configure UCSM:
Step 1 Select a customer.
Step 2 Click and select Add Domain.
The Add Domain Manager Configuration dialog box appears.
Step 3 Select UCSM from the Select Domain Manager Name drop-down list.
Step 4 Enter the following details in the Configuration area:
•IP Address—IP address of the device.
•Admin Username—UCSM admin username.
•Admin Password—UCSM admin password.
•Operator Username—UCSM operator username.
•Operator Password—UCSM operator password.
Step 5 Click Save.
Step 6 Click Submit.
Step 7 Click Cancel to close the Add Domain Manager Configuration dialog box.
Configuring FMS
To configure FMS:
Step 1 Select a customer.
Step 2 Click and select Add Domain.
The Add Domain Manager Configuration dialog box appears.
Step 3 Select FMS from the Select Domain Manager Name drop-down list.
Step 4 Enter the following details in the Configuration area:
•IP Address—IP address of the device.
•Admin Username—FMS admin username.
•Admin Password—FMS admin password.
•Operator Username—FMS operator username.
•Operator Password—FMS operator password.
Step 5 Click Save.
Step 6 Click Submit.
Step 7 Click Cancel to close the Add Domain Manager Configuration dialog box.
Configuring vCenter
To configure vCenter:
Step 1 Select a customer.
Step 2 Click and select Add Domain.
The Add Domain Manager Configuration dialog box appears.
Step 3 Select vCenter from the Select Domain Manager Name drop-down list.
Step 4 Enter the following details in the Domain Configuration tab:
•IP Address—IP address of the device.
•Admin Username—vCenter admin username.
•Admin Password—vCenter admin password.
•Operator Username—vCenter operator username.
•Operator Password—vCenter operator password.
Step 5 In the VM Configuration tab, click the Click here to get VM button.
The available virtual machines (VMs) appear in the Available VM box.
Step 6 Move the VM that you want to add, using the following options:
•
—Moves all VMs from the Available VM list to the Selected VM list.
•
—Moves a single VM from the Available VM list to the Selected VM list.
•
—Moves a single VM from the Selected VM list to the Available VM list.
•
—Moves all VMs from the Selected VM list to the Available VM list.
Step 7 Click Save.
Step 8 Click Submit.
Step 9 Click Cancel to close the Add Domain Manager Configuration dialog box.
Calculating VM Timeout Value
You can calculate the VM timeout value and set it according to the number of VMs assigned. The number of Web Services calls to vCenter is based on the number of VMs assigned to each customer.
The default timeout value is 50 seconds and will cover only customers configured with eight VMs. If more than eight VMs are assigned to a customer, use the following formulae to calculate the timeout parameter:
(Number of VMs * 5 seconds) + 10 seconds.
•Number of VMs—Number of VMs assigned.
•5 seconds—Response time for a call.
•10 seconds—Cushion period to run other operations.
For example, the timeout value for 70 VMs will be:
(70 * 5) + 10 = 360.
360 seconds will be the timeout value for 70 VMs.
If you assign more VMs and if there are many customers, vCenter polling might not be completed for all customers before the next polling time.
•If vCenter polling is not completed, you should edit the number of threads in the msscheduler-config.xml file in the INSTALL_DIR/liferay-portal-5.2.2\jboss-tomcat-4.2.3\server\default\conf\portal_props directory. The value should be less than 250.
•If vCenter polling is not completed even after setting the number of threads value to 250, you should configure the polling interval in the Configuration portlet. See Configuring Polling Interval.
Editing Domain Manager Details
To edit domain manager details:
Step 1 Select the customer whose domain manager details you want to edit.
Step 2 Select the domain manager that you want to edit from the table in the portlet.
Step 3 Click and select Edit Domain.
The Edit Domain Manager Configuration dialog box appears.
Step 4 Edit the fields that you want to edit.
Step 5 Click Save.
Step 6 Click Submit.
Step 7 Click Cancel to close the Edit Domain Manager Configuration dialog box.
Deleting a Domain Manager
To delete a domain manager:
Step 1 Select the customer whose domain manager you want to delete.
Step 2 Select the domain manager that you want to delete from the table in the portlet.
Step 3 Click and select Delete Domain.
The following message appears in the confirmation window.
Are you sure you want to delete the selected domain manager(s)?
Step 4 Click OK or go to Step 5.
Step 5 Click Cancel to cancel the operation.
Viewing Domain Manager Details
To view domain manager details:
Step 1 Select the customer whose domain manager details you want to view.
Step 2 Select the domain manager for which you want to see the details.
Step 3 Click and select View Domain.
The View Domain Manager Configuration window appears and you can see the details in the domain manager. These details cannot be changed.
Step 4 Click Close to close the View Domain Manager Configuration dialog box.
Customer Cross Launch Portlet
To view the Customer Cross Launch portlet, go to Administration > Customer Cross Launch.
The Customer Cross Launch portlet displays the list of customers configured in HCM. Select a customer and then select the cross-launch option. Depending on the option you choose, the corresponding domain manager web page is cross-launched.
You can cross launch an unlimited number of windows for different customers. A single session is used for all CUOM cross-launches for a customer.
Note For the UI options to be enabled, you must select a customer.
Table 2-3 explains the UI options available in the Customer Cross Launch portlet.
The UI options in the portlet toolbar appear according to the screen resolution. The screen resolution used is 1024 by 768 pixels.
|
|
|
|
|---|---|---|
Filter |
Allows you to filter the data displayed in the portlet. See Table 2-4 for the list of filtering types and corresponding options available in the portlet. |
|
CUOM |
Alarms |
Allows you to cross-launch the CUOM Alerts and Events page. |
Phones |
Allows you to cross-launch the CUOM Phone Inventory page. |
|
SLV |
Allows you to cross-launch the CUOM Service Level View. |
|
Test |
Allows you to cross-launch the CUOM Diagnostics page. |
|
FMS Alarm |
Allows you to cross-launch the FMS Summary page. |
|
vCenter Alarm |
Allows you to cross-launch vCenter Alarms page. |
|
UCSM Alarm |
Allows you to cross-launch the UCSM Alarms page. |
|
Cross-Launching CUOM
To cross-launch CUOM, you must configure the port number in HCM Dashboard. For example, if CUOM is installed in port number 443, you must configure the port number in HCM Dashboard to 443.
To configure the port number in HCM Dashboard:
Step 1 Navigate to the following directory: INSTALL_DIR\liferay-portal-5.2.2\jboss-tomcat-4.2.3\server\default\deploy\ROOT.war\WEB-INF
Step 2 Open the crosslaunch.properties file.
Step 3 Edit the following parameters, as needed:
•CUOM_LOGIN_PROTOCOL
•CUOM_LOGIN_PORTNUMBER
•CUOM_CROSS_LAUNCH_PROTOCOL
•CUOM_CROSS_LAUNCH_PORTNUMBER
Cross-launching to CUOM will fail if:
•You enter invalid CUOM IP address.
•You enter invalid CUOM admin username or password.
•You enter invalid CUOM operator username or password.
•HTTPS support is not enabled in CUOM.
Filtering Types and Options
See Understanding the Filtering Option in Portlets to understand the Filter option. Table 2-4 lists the filtering types and corresponding options available in the Customer Cross Launch portlet.
Configuration Portlet
To view the Configuration portlet, go to Administration > Configuration.
The Configuration portlet allows the admin user to update configuration parameters. This section includes:
•Configuring Portlet Refresh Frequency
Configuring Polling Interval
To configure polling interval:
Step 1 Go to Configuration > Polling Configuration.
Step 2 Select the domain manager from the Domain Manager drop-down list.
Step 3 Enter the value for the Polling Interval field.
Step 4 Click Save.
Step 5 Click Submit.
Configuring Portlet Refresh Frequency
To configure the refresh frequency of a portlet:
Step 1 Go to Configuration > Portal Configuration.
Step 2 Select the portlet from the Portlet drop-down list.
Step 3 Enter the value for the Refresh Frequency field.
Step 4 Click Save.
Step 5 Click Submit.
Configuring Mediation
For domain managers that are integrated with the Mediation layer, you can configure HCM Dashboard to either communicate to domain managers, directly or through Mediation layer.
To configure HCM Dashboard to communicate to domain managers through Mediation layer:
Step 1 Go to Configuration > Mediation Configuration.
Step 2 From the Mediation Flag drop-down list, select True.
Step 3 Select the protocol from the Protocol drop-down list. The options are:
•HTTP
•HTTPS
Step 4 Click Submit.
To configure HCM Dashboard to communicate to domain managers directly:
Step 1 Go to Configuration > Mediation Configuration.
Step 2 From the Mediation Flag drop-down list, select False.
Step 3 Click Submit.
Quick Launch Portlet
To view the Quick Launch portlet, go to Administration > Quick Launch.
The Quick Launch portlet allows the admin user to navigate to different URLs. This section includes:
Table 2-5 lists the Quick Launch portlet UI options.
The UI options in the portlet toolbar appear according to the screen resolution. The screen resolution used is 1024 by 768 pixels.
|
|
|
|---|---|
Filter |
Allows you to filter the data displayed in the portlet. See Table 2-6 for the list of filtering types and corresponding options available in the portlet. |
Add |
Allows you to add a new URL. |
Edit |
Allows you to edit an existing URL. |
Delete |
Allows you to delete an existing URL. |
Filtering Types and Options
See Understanding the Filtering Option in Portlets to understand the Filter option. Table 2-6 lists the filtering types and corresponding options available in the Quick Launch portlet.
Adding a URL
To add a URL:
Step 1 Click Add from the portlet toolbar.
Step 2 Enter the following details:
a. Description—Description of the URL.
b. URL—URL of the page that you are adding.
Note You can add a maximum of 20 URLs.
Step 3 Click OK.
The URL is added successfully. This URL will be launched in a different window.
Step 4 Click Cancel to close the Quick Launch Point dialog box.
Editing a URL
To edit a URL:
Step 1 Select the Quick Launch row that you want to edit.
Step 2 Click Edit from the portlet toolbar.
You cannot edit the Description field.
The Quick Launch Point dialog box opens.
Step 3 Edit the URL.
Step 4 Click OK.
Step 5 Click Cancel to close the Quick Launch Point dialog box.
Deleting a URL
To delete a URL:
Step 1 Select the Quick Launch row that you want to delete. You can select single or multiple rows.
Step 2 Click and select Delete.
The following message appears in the dialog box.
Are you sure you want to delete the selected link(s)?
Step 3 Click OK.
The selected URL is deleted from the Quick Launch portlet and HCM database.
Step 4 Click Cancel to cancel the operation.
User Administration Portlet
To view the User Administration portlet, go to Administration > User Administration.
The User Administration portlet allows you to manage users and assign specific customers per user. The User Administration portlet manages the admin and operator user details. You can assign privileges and map customers to the user.
You must create a user ID in the Cisco Secure ACS server and then map the new user in the User Administration portlet. The User Administration portlet allows the admin user to create a user with operator or admin credentials. For all admin users, the following details are displayed:
•User ID
•Customers
•Privilege
It includes the following sections:
UI Options
Table 2-7 lists the User Administration portlet UI options.
The UI options in the portlet toolbar appear according to the screen resolution. The screen resolution used is 1024 by 768 pixels.
|
|
|
|---|---|
Filter |
Allows you to filter the data displayed in the portlet. See Table 2-8 for the list of filtering types and corresponding options available in the portlet. |
Add |
Allows you to add a new user. |
Edit |
Allows you to edit user details. |
Delete |
Allows you to delete user details. |
View |
Allows you to view user details. |
Filtering Types and Options
See Understanding the Filtering Option in Portlets to understand the Filter option. Table 2-8 lists the filtering types and corresponding options available in the User Administration portlet.
Adding a User
To add a user:
Step 1 Click Add from the portlet toolbar.
The User Configuration dialog box opens. See Table 2-9 for the UI options.
Note You must be logged in as an admin user to add users.
Step 2 Enter the following details:
a. Used ID—Enter the user ID for the user. This is a mandatory field.
b. Privilege—Select the privilege. The following two options are available:
–Admin—Admin has access to all of the portlets. Admin can create another user with admin or operator privileges. By default, all customers will be selected for this user.
–Operator—Operator has access to all of the portlets except Customer Administration Launch Point and User Management.
c. Available Customers—Lists all added customers. Select the customers that you want to map to the user.
d. Selected Customers—Lists all selected customers.
Step 3 Click OK.
The user is added successfully.
You cannot add users to whom there are no customers assigned.
Step 4 Click Cancel to close the User Configuration dialog box.
Table 2-9 lists the UI options in the User Configuration dialog box.
t
Editing a User
To edit a user:
Step 1 Select a user.
Step 2 Click Edit from the portlet toolbar.
The User Configuration dialog box appears.
Step 3 Modify the user details.
You cannot edit the user ID.
Step 4 Click OK.
The user details are updated successfully.
Step 5 Click Cancel to close the User Configuration dialog box.
Note Admin users cannot edit their own user IDs.
Deleting a User
To delete a user:
Step 1 Select a user. You can select multiple users.
Step 2 Click and select Delete.
Step 3 The following message appears in the dialog box..
Are you sure that you want to delete the selected user(s)?
Step 4 Click OK
The selected user is deleted successfully from the User Administration portlet and HCM database.
Step 5 Click Cancel to cancel the operation.
Note Admin users cannot delete their own user IDs.
Viewing a User
To view a user:
Step 1 Select a user. You can select only one user.
Step 2 Click and select View.
The user details are displayed in the User Configuration dialog box.
You cannot edit user details using the View User option.
Step 3 Click Close to close the User Configuration dialog box.
Dashboard Portlets
The Dashboard portlets are summary portlets and are available to all users. The Dashboard portlets display the alarms by customers, alarms by domain managers, and phone summary.
The following are the Dashboard portlets:
Alarm Summary Portlet
To view the Alarm Summary portlet, choose Dashboard > Alarm Summary.
The Alarm Summary portlet displays the alarms by customers and alarms by domain managers. The Alarm Summary portlet lists all of the customers that administration supports.
When you add or delete a customer, the Alarm Summary portlet information is updated to reflect the status.
This section covers the following topics:
•Understanding the Alarm Summary Information
•Understanding the Color Scheme Used and Alarm Status
•Understanding Domain Manager Specific Alarms
Filtering Types and Options
The Filter option is available in the portlet. See Understanding the Filtering Option in Portlets to understand the Filter option.
When you select the Filter by Example option to filter data, search fields appear in all columns and you must enter alphabetical or numerical data in these fields. If you enter alphabetical or numerical data in the search fields in the First column and the Summary column, no data will be displayed because both columns display graphical data.
If you select the Advanced Filter option and do the following:
Step 1 Select Summary in the Filter dropdown list.
Step 2 Select any one of the relational operators.
Step 3 Enter alphabetical or numerical data in the Text Field.
Step 4 Click Go.
No data will be displayed because the Summary column displays only graphical data.
To understand the color scheme used in HCM Dashboard, see Table 2-12 and to understand the icons used in HCM Dashboard, see Table 2-13.
Table 2-10 lists the filtering types and corresponding options available in the Alarm Summary portlet.
Understanding the Alarm Summary Information
The Alarm Summary portlet displays the information for each customer in tabular format. The total number of critical, warning, and cleared alarms are displayed in the Information Bar in the portlet. Table 2-11 describes the columns in the Alarm Summary portlet.
|
|
|
|---|---|
Customer |
Displays the name of the customer. |
Summary |
The colors in this column represent the different alarms for a customer. For example, if there are only critical alarms for a customer, the table cell will be in red. See Table 2-12 to understand the color scheme used in HCM Dashboard. |
Critical |
Displays the number of critical alarms for each customer. |
Warning |
Displays the number of warning alarms for each customer. |
Information |
Displays the number of informational alarms for each customer. |
Cleared |
Displays the number of cleared alarms for each customer. |
RequireAck |
Displays the number of alarms that require acknowledgement for each customer. |
Total |
Displays the total of alarms for each customer. |
Understanding the Color Scheme Used and Alarm Status
The Alarm Summary portlet shows different alarms with different colors. Table 2-12 lists the colors used and the corresponding alarm status.
|
|
|
|---|---|
Red |
Critical |
Yellow |
Warning |
Blue |
Informational |
Green |
Cleared |
Understanding Domain Manager Specific Alarms
HCM Dashboard displays domain manager specific alarms for each customer in the Alarm Summary portlet. The table in the Alarm Summary portlet is a tree table and supports the display of hierarchical information.
See Figure 2-1 and Table 2-13.
Figure 2-1 Domain Manager Specific Alarms
You must click the node (see number 1 in Figure 2-1 and Table 2-13) to expand and collapse the domain manager specific alarms table. When the node is expanded, another table displays the domain manager specific alarms.
The following list explains the domain manager specific alarms table:
•UCSM—If you enter wrong UCSM credentials or if the UCSM server is down or if UCSM is unable to trace the MAC address for the VMs, the data collected for the previous interval and a red icon is displayed in the domain manager specific alarms table.
•vCenter—If you enter wrong VM credentials or if the VM server is down or if no VMs are configured for the customer in vCenter, the data collected for the previous interval and a red icon is displayed in the domain manager specific alarms table.
•CUOM—If you enter wrong CUOM credentials or if the CUOM server is down, the data collected for the previous interval and a red icon is displayed in the domain manager specific alarms table.
•FMS—A green icon is always displayed in the domain manager specific alarms table because no data is collected from FMS.
In the domain manager specific alarms table, click the domain manager to cross-launch the respective pages:
•UCSM—Cross-launches the UCSM Alarms page.
•vCenter—Cross-launches the vCenter Alarms page.
•CUOM—Cross-launches the CUOM Alarms and Events page.
•FMS—Cross-launches the FMS Alarms page.
Understanding Alarm Mapping
HCM Dashboard and the domain managers categorize the alarms differently. This section explains how HCM Dashboard alarms are mapped with the various domain managers. It includes the following topics:
•vCenter and HCM Dashboard Alarm Mapping
•UCSM and HCM Dashboard Alarm Mapping
•CUOM and HCM Dashboard Alarm Mapping
vCenter and HCM Dashboard Alarm Mapping
Table 2-14 maps vCenter and HCM Dashboard alarms. RequireAck severity will be mapped to zero in HCM Dashboard because HCM Dashboard cannot fetch RequireAck alarms from vCenter.
UCSM and HCM Dashboard Alarm Mapping
Table 2-15 maps UCSM and HCM Dashboard alarms. RequireAck severity will be mapped to zero in HCM Dashboard because HCM Dashboard cannot fetch RequireAck alarms from UCSM.
|
|
|
|---|---|
Critical |
Critical |
Major |
Critical |
Warning |
Warning |
Minor |
Warning |
Info |
Information |
Cleared |
Cleared |
CUOM and HCM Dashboard Alarm Mapping
Table 2-16 maps CUOM and HCM Dashboard alarms.
|
|
|
|---|---|
Critical |
Critical |
Warning |
Warning |
Information |
Information |
Cleared |
Cleared |
RequireAck |
RequireAck |
Phone Summary Portlet
To view the Phone Summary portlet, go to Dashboard > Phone Summary.
The Phone Summary portlet displays the number of configured phones, registered phones, and unregistered phones for each customer.
The Filter option is available in the portlet. See Understanding the Filtering Option in Portlets for details about the Filter option.
When you select the Filter by Example option to filter data, search fields appear in all columns and you must enter alphabetical or numerical data in these fields.
The First column displays only graphical data. If you enter alphabetical or numerical data in the search field in the First column, no data will be displayed.
To understand the icons used in HCM Dashboard, see Table 2-13.
Table 2-17 lists the filtering types and corresponding options available in the Phone Summary portlet.
The Phone Summary portlet displays the following details for each customer:
•Customer—Name of the customer.
•Configured—Number of configured phones for each customer.
•Registered—Number of registered phones for each customer.
•Unregistered—Number of unregistered phones. The Unregistered column in the Phone Summary table contains a red exclamatory mark, if the number of unregistered phones exceeds 10% of the configured phones.
Click the customer name to cross-launch the CUOM Phone Inventory page. When you add or delete a customer, the Phone Summary portlet information is updated to reflect the status.
Diagnostics
The Diagnostics tab lists the Diagnostics Test portlet. For details see Diagnostics Test
Diagnostics Test
To view the Diagnostics Test portlet, go to Diagnostics > Diagnostics Test.
You can use the Diagnostic Test portlet to initiate different tests to verify a given phone IP. The following options are available in the Diagnostics Test portlet:
•Customer—Allows you to select a customer from the drop-down list.
•Test—Allows you to select the type of test. The options are:
•Phone No:—Allows you to enter the phone number that has to be tested.
•Type—Allows you to select the type of Advanced test. The options are:
If you enter wrong CUOM credentials for the customer or if the CUOM server is down, the Diagnostics Test will timeout and an error message will be displayed. The default timeout value is four minutes. You can configure the timeout value in the portal.properties file available in INSTALL_DIR\liferay-portal-5.2.2\jboss-tomcat-4.2.3\server\default\deploy\ROOT.war\WEB-INF directory.
Phone Status Tests
Phone status testing uses Cisco IOS IP SLA technology to monitor the reachability of key phones in the network. A phone status test consists of the following:
•A list of IP phones to test, selected by you.
•A testing schedule that you configure.
•IPSLA-based pings from an IP SLA-capable device (for example, a switch, a router, or a voice router) to the IP phones. IPSLA-based pings can also be from CUOM to the IP phones.
Basic
To run a Basic test:
Step 1 Select a customer from the customer drop-down list.
Step 2 Select the test as Basic from the Test drop-down list.
Step 3 Enter the phone number that has to be tested.
Step 4 Click 
.
The tests are run sequentially and the test results are displayed in the portlet in a tabular format.
After you start the Basic test, a spin indicator shows that the Basic test is in progress.
You cannot initiate another Basic test until the first test is complete. You can navigate to other tabs when the basic test is in progress.
However, if you return to the Basic test tab, the test stops and you must initiate a new test. You can resize the Diagnostics Test portlet when the Basic test is in progress, but the test stops and you must initiate a new test.
Table 2-18 lists the Basic tests and description.
The Basic Test fails and an error message is displayed if you:
•Enter an invalid:
–Phone number.
–JTAPI username.
–JTAPI password.
–Nearest IP SLA Device IP.
•Did not enter the details in the mandatory fields.
Advanced
For advanced diagnostic tests such as synthetic tests and none-to-node (N-2-N) tests, the portlet cross-launches to the CUOM Diagnostics web page. You have to manually enter the parameters in the CUOM Diagnostics web page to run the test.
Synthetic
You can configure synthetic tests to be run on a periodic basis. You should manually enter the parameters in the CUOM Create Synthetic Test web page, to run the test. A synthetic test uses voice applications and analyzes the behavior of the system.
CUOM monitors the information returned from the synthetic test and generates events, based on the results. Synthetic tests verify whether a voice application can service requests from a user. Synthetic tests are used to measure the availability of voice applications.
For example, you can use a synthetic test to verify whether phones can register with a Cisco Unified Communications Manager.
To create a synthetic test:
Step 1 Select a customer from the customer drop-down list.
Step 2 Select the test as Advanced from the Test drop-down list.
Step 3 Select Synthetic from the Type drop-down list.
Step 4 Click .
The Create Synthetic Test page is cross-launched.
Step 5 Select the Test Type in the Create Synthetic Test page.
Step 6 Enter the details in the Create Synthetic Test page.
Step 7 Click Create.
For more information, see Creating Synthetic Tests section of the User Guide for Cisco Unified Operations Manager.
Node-to-Node (N-2-N)
Node-to-node (N-2-N) tests monitor the response time and availability of multiple-protocol networks on both an end-to-end and hop-by-hop basis. You should manually enter the parameters in the CUOM Create Node-to-Node Test page to run the test.
After collecting the data, you can use the CUOM graphing function to examine changes in network performance metrics.
You can select, display, and chart network performance data in real time. You can also configure N-2-N tests to trigger events if certain thresholds are crossed. These events appear in the Monitoring Dashboard.
To create a N-2-N test:
Step 1 Select a customer from the customer drop-down list.
Step 2 Select the test as Advanced from the Test drop-down list.
Step 3 Select N-2-N from the Type drop-down list.
Step 4 Click .
The Create Node-to-Node Test page is cross-launched.
Step 5 Select the Test Type in the Create Synthetic Test page.
Step 6 Enter the details in the Create Node-to-Node Test page.
Step 7 Click OK.
For more information, see Creating a Single Node-To-Node Test section of the User Guide for Cisco Unified Operations Manager.
Feedback