Unified Reporter

Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
uim901
UnifiedReporter
Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
 UR requires a license update. To update the license, see the 
Unified Reporter License Update
 section on this page. This update is required to continue to use existing UR reports.
UR provides the following features:
  • Drag and drop ad hoc report building.
  • Drag and drop dashboard building, with live refresh, and mashups of external content.
  • Built-in charting that includes pie, bar, line, multiseries, area, and many other chart types.
  • A library of out-of-box (OOB) reports that save time and effort.
  • Database abstraction using JSON query extractors.
  • Self-service parameterized web reporting.
  • Report scheduling, distribution, and historical versioning.
  • Access to any data source, including the UIM database.
In addition, UR provides developers and power users with:
  • The iReport graphical report designer for building more complex reports.
  • Print-ready pixel-perfect production reporting
 
Contents
 
 
 
Unified Reporter License Update
Unified Reporter (UR) requires a license update. This update is required to continue to use existing UR reports. There are two possible upgrade paths depending on the state of your license.
Unified Reporter License Update with an Existing Unexpired License
 If your license has already expired, see the following 
Unified Reporter License Update with an Expired License
 procedure.
 
 
Follow these steps:
 
  1. Obtain the wasp_unified_reports_license package from the Archive page at http://support.nimsoft.com.
  2. Deploy the wasp_unified_reports_license package to the robot where UR is installed.
Unified Reporter License Update with an Expired License
When Unified Reporter (UR) is installed, an expired license can cause the repository installation to fail. Use this procedure to install or upgrade UR with the updated license package.
 
Follow these steps:
 
  1. Obtain the wasp_unified_reports_license package from the Archive page at http://support.nimsoft.com.
  2. Run the UR installation until it fails. This usually occurs while trying to deploy the repository.  A Retry/Cancel/Continue installation pop-up error appears. Leave the installation in this unfinished state.
  3. Deactivate the wasp probe on the designated robot for UR. This is usually the robot with UMP.
  4. Deploy the wasp_unified_reports_license package to the UR robot.
  5. Activate the wasp probe on the UR robot.
  6. When this wasp probe has a value in both the PID and a port columns in Infrastructure Manager or Admin Console, select 
    Retry 
    in the UR installation pop-up error to complete the installation.
 
For iReport:
 After replacing the Unified Reporter License, follow the instructions for Installing the iReport Commercial License in the Set Up iReport article.
Deploy Unified Reporter
Additional licensing is required to use UR. UR is not automatically installed with UMP.
 
Follow these steps:
 
  1. Before you install UR, install UMP
  2. Obtain the following packages from http://support.nimsoft.com:
    1. The appropriate UR install package for your environment (Downloads page).
    2. The wasp_unified_reports_license package (Archive page).
  3. Deploy the packages to the appropriate robot.
  4. Access UR from the Reports page in UMP, or you can add it to a page of your choice.
 Beginning with CA UIM v8.51, Unified Reporter runs with Java 8, the version installed with CA UIM v8.51 and later. UR running on its own robot (the recommended configuration) with Java 7 are not affected by this change.
Users and Permissions
Users must have the ACL permission 
Unified Reports
 to access UR.
UR users comprise two types: account contact users and bus users. Account contact users can only see the Public > Nimsoft Monitor folder, and the folder to which they belong. By default, account contact users have read-only access to the repository, unless they have the 
Portal Administration
 permission, which grants them full access to their account folder only.
Bus users with the 
Portal Administration
 permission can see the folders of all the accounts, and have full access to the repository.
Add Users in CA UIM
Unified Reporter (UR) users must be added in CA UIM.
The UR web application (JasperReports Server Pro) provides a way to add users. However, authentication is handled by CA UIM. If you add a user in UR and then try to log in with that user name, it will not work. Add the user in CA UIM, and then log in to UR.
UR Folder Structure
If you are logged in to UR or iReport as an administrative user and save a report under the root directory of the repository, an error might occur if you then edit the report.
CA UIM out-of-box (OOB) reports in the repository are consolidated under the folder Public > Nimsoft Monitor. Folders are automatically created for accounts when account contact users log in for the first time.
When you upgrade from a version of UR prior to v6.5, the OOB reports are automatically placed under Public > Nimsoft Monitor and removed from the former location in the directory structure.
Options for Out-of-box Reports
When you run an OOB report from the repository, the Options pane appears on the left. The Options pane allows you to customize the report by selecting from the following fields:
  •  
    Top #
    Allows you to set the number of results to 5, 10, or 25. By default this value is set to 10.
  •  
    Time period
    Allows you to set last hour, last day, last week, last month, or last year. By default this value is set to last day.
  •  
    Ignore Pagination
    This check box allows you to view an entire report on one page by scrolling down, rather than by paging through the report. This option can be useful for reports with considerable data, or if you plan to print the report. By default, pagination is enabled.
 With reports of time-series data, such as 
CO2 Emissions Rate,
 the Options pane only displays the Time period field.
Edit the Default List of Values
Bus users with the 
Portal
 
Administration 
ACL permission can edit the values that appear in the 
Top #
 and 
Time period
 lists in the Options pane. All Nimsoft Monitor OOB reports inherit their options from the Top # and Time period lists. Therefore, when you edit the default list of values, the changes are applied to all of the Nimsoft Monitor OOB reports.
 
Follow these steps:
 
  1. From the repository view, expand Public > Nimsoft Monitor > resources > lists.
  2. Select either Time period or Top #, and click 
    Edit 
    in the toolbar.
  3. In the Edit List of Values panel, add or remove the values in the drop-down list.
     The values that you specify for the Time period must be consistent with your database provider.
List of Out-of-box Reports
The following table lists the OOB reports that come with UR. It also lists the probes that must be activated, and the QoS measurement(s) that must be enabled on the probe in order to obtain data for each report.
 
Report Category
 
 
Report Name
 
 
QoS Required
 
 
Probe
 
Applications
Active Directory Replication Age
QOS_AD_REPLICATION_AGE
ad_response
Applications
End to End User Transactions
QOS_E2E_EXECUTION
e2e_appmon
Applications
Remedy Response Time
QOS_REMEDY_REPONSE
remedy_response
Applications/Apache
Apache Busy Workers
QOS_APACHE_BUSYWORKERS
apache
Applications/Apache
Apache Bytes per Request
QOS_APACHE_BYTESPERREQ
apache
Applications/Apache
Apache HTTP Response Time
QOS_APACHE_HTTPRESTIME
apache
Applications/Apache
Apache Idle Workers
QOS_APACHE_IDLEWORKERS
apache
Applications/Apache
Apache Requests Average Time
QOS_APACHE_REQAVETIME
apache
Applications/Apache
Apache Requests Per Second
QOS_APACHE_REQPERSEC
apache
Databases/MySQL
MySQL % of Maximum Allowed Connections
QOS_MYSQL_CONNECTION_USAGE_RATE
mysql
Databases/Oracle
Oracle % Table Space Free
QOS_ORACLE_TABLESPACE_FREE
oracle
Databases/Oracle
Oracle Databases by Size
QOS_ORACLE_DATABASE_SIZE
oracle
Databases/Oracle
Oracle SGA Memory Free
QOS_ORACLE_SGA_MEMORY_FREE
oracle
Databases/Oracle
Oracle Table Space Allocated Free
QOS_ORACLE_TABLESPACE_ALLOC_FREE
oracle
Databases/SQL Server
SQL Server Free Allocated Space
QOS_SQLSERVER_ALLOC_SPACE
sql_server
Databases/SQL Server
SQL Server Response Time
QOS_SQL_RESPONSE
sql_response
Databases/SQL Server
SQL Server Transactions
QOS_SQLSERVER_TRANSACTIONS
sql_server
Databases/SQL Server
SQL Server Users
QOS_SQLSERVER_ACTIVE_USERS
sql_server
Network
DHCP Response Time
QOS_DHCP_RESPONSE
dhcp_response
Network
DNS Response Time
QOS_DNS_RESPONSE
dns_response
Network
Hosts by Response Time
QOS_NET_CONNECT
net_connect
Network
Interfaces by Bandwidth Inbound
QOS_INTERFACE_TRAFFIC_PERC
interface_traffic
Network
Interfaces by Bandwidth Outbound
QOS_INTERFACE_TRAFFIC_PERC
interface_traffic
Network
Interfaces by Discards
QOS_INTERFACE_DISCARDS
interface_traffic
Network
Interfaces by Errors
QOS_INTERFACE_ERRORS
interface_traffic
Network
Interfaces by Queue Length
QOS_INTERFACE_QLEN
interface_traffic
Network
LDAP Response Time
QOS_LDAP_RESPONSE_TIME
ldap_response
Network
NTP Response Time
QOS_NTP_RESPONSE_TIME
ntp_response
Network
URLs by Response Time
QOS_URL_RESPONSE
url_response
Network/Cisco
Cisco by Memory Free
QOS_MEMORY_USAGE
cisco_monitor
Network/Cisco
Cisco by Memory Used
QOS_MEMORY_USAGE
cisco_monitor
Network/Cisco
Cisco CallManager CPU Usage
QOS_CPU_USAGE
ccm_monitor
Network/Cisco
Cisco CallManager Memory Used (%)
QOS_CCM_PERFORMANCE
ccm_monitor
Network/Cisco
Cisco CPU Usage
QOS_CPU_USAGE
cisco_monitor
Network/Cisco
Cisco QoS Drop Bitrate
QOS_CISCO_DROP_BITRATE
cisco_qos
Network/Cisco
Cisco QoS Post Policy Bitrate
QOS_CISCO_POST_POLICY_BITRATE
cisco_qos
Network/Cisco
Cisco QoS Post Policy Bytes
QOS_CISCO_POST_POLICY_BYTE
cisco_qos
Network/Cisco
Cisco QoS Pre Policy Bitrate
QOS_CISCO_PRE_POLICY_BITRATE
cisco_qos
Servers
Servers By CPU Usage
QOS_CPU_USAGE
cdm (local) or rsp (remote)
Servers
Servers by Disk Capacity
QOS_DISK_USAGE_PERC
cdm (local) or rsp (remote)
Servers
Servers by Physical Memory
QOS_MEMORY_PHYSICAL_PERC
cdm (local) or rsp (remote)
Servers
Servers by Processor Queue Length
QOS_PROC_QUEUE_LEN
processes
Servers/Processes
Processes by CPU Usage
QOS_PROCESS_CPU
processes
Servers/Processes
Processes by Memory Usage
QOS_PROCESS_MEMORY
processes
Servers/Processes
Processes by Thread Count
QOS_PROCESS_THREADS
processes
ServiceDesk
Accounts (NMS) by Events
 
nsdgtw
ServiceDesk
Accounts (ServiceDesk) by Incidents
 
nsdgtw
ServiceDesk
Applications by Events and Incidents
 
nsdgtw
ServiceDesk
Devices by Mean Time to Repair vs Service Quality
 
nsdgtw
ServiceDesk
Network Events and Incidents
 
nsdgtw
ServiceDesk
Servers by Events and Incidents
 
nsdgtw
Virtualization/VMware
VMware Guests by CPU MHz
QOS_CPU_USAGE_MHZ
vmware
Virtualization/VMware
VMware Guests by CPU Usage
QOS_CPU_USAGE
vmware
Virtualization/VMware
VMware Hosts by CPU Usage
QOS_CPU_USAGE
vmware
Virtualization/VMware
VMware Hosts by Disk Free
QOS_DISK_FREE
vmware
Virtualization/VMware
VMware Hosts by Memory Usage
QOS_MEMORY_PERC_USAGE
vmware
Virtualization/VMware
VMware Hosts by VM Count
QOS_COUNTER
vmware
Design an Ad Hoc View
This section describes how to design an ad hoc view in UR. After you create an ad hoc view, you can save and open the ad hoc view as a report.
 In addition to the 
Unified Reporter 
ACL permission required to access UR, you must have the 
Portal Administration
 ACL permission to design a report.
 
Follow these steps:
 
  1. Log in to UMP, and go to Unified Reporter.
  2. On the landing page, click 
    Create > Ad Hoc View
    . The Data Chooser wizard opens.
  3. In the Data Chooser:
    1. Select 
      Topics
       at the top of the Data Chooser.
    2. Expand the 
      Public
       folder and browse to 
      Ad Hoc Components > Topics > Nimsoft Monitor Topic
      .
    3. Select 
      Table
      Chart
      , or 
      Crosstab
       from the types of views at the bottom of the Data Chooser. The Input Controls dialog opens.
      If the Input Controls dialog does not open, click the Input Controls icon in the Ad Hoc Editor tool bar.
    Unified Reports 
  4. In the Input Controls dialog:
    1. Specify a time period for the ad hoc view.
    2. Select the desired input controls from the QoS, Source, and Target lists.
    3. Click 
      OK
      .
  5. Drag and drop or double-click fields and measures to add them to the ad hoc view.
  6. Click the Save icon when you are satisfied with the ad hoc view.
    1. Enter a name for the report.
    2. Browse to a location in the repository, and click 
      Save
      .
The ad hoc view and its corresponding report now appear in the repository. You can run the report, or further edit the ad hoc view.
Uninstall Unified Reporter
Uninstall UR by executing the Uninstaller on the system running the primary hub. On Windows systems, the uninstaller can be launched from the Start menu shortcuts, or you can execute the /UnifiedReporter/Uninstall_UnifiedReporter file.
The Uninstaller updates the wasp probe configuration so that UR is no longer available for configuration or startup. The uninstaller does not remove the database tables supporting UR. Therefore, if it is a requirement that the UR files be removed, they must be removed manually.
 
To manually remove UR files:
 
  1. Open Infrastructure Manager.
  2. In the tree view, click on the robot for the hub where UMP and UR are installed.
  3. Right-click the wasp probe in the top-right pane and select 
    Deactivate
     from the pop-up menu.
  4. Remove UR from the wasp probe by following these steps:
    1. Click the wasp probe to select it.
    2. Press <Ctrl> and right-click the wasp probe, then select  
      Raw Configure
       from the pop-up menu.
    3. Expand the webapps node.
    4. Click the jasperserver-pro folder to select it.
    5. Click 
      Delete Section
      .
  5. Remove the following files if present from the robot where UR was deployed:
    • /probes/service/wasp/tmp
    • /probes/service/wasp/bin
    • /probes/service/wasp/tmp_jasper.zip
    • /probes/service/wasp/webapps/jasperserver-pro
    • /probes/service/wasp/webapps/jasperserver-pro.war
  6. Activate the wasp probe.
You can now remove the stored UR data by dropping the UnifiedReporter database. If you reinstall UR, the database and tables are repopulated.
To remove the database for MySQL or SQLServer databases, use the following command in a command line:
SQL> DROP DATABASE database;
To remove the database for Oracle databases, enter the following command in a command line:
SQL> DROP USER username CASCADE;
Uninstall Does Not Remove Unified Reporter
 
Symptom:
 
I ran the UR uninstaller, but UR is still installed on my system.
 
Solution:
 
This might happen if you enter an invalid password when running the uninstaller. You can verify that UR is still installed by pointing your browser to:
httP://<ump_server>:<port>/jasperserver-pro
If the application loads, then UR is still installed. You can also verify that UR is still installed by opening UR in UMP and running a report. If the report runs successfully, UR is installed.
 iReport is not uninstalled by the UR uninstaller. On Windows you can uninstall iReport by using the iReport uninstaller, accessed from the Start menu (JasperSoft > iReport-Professional > Uninstall). On Linux or Solaris, remove the directory that contains the iReport files.