Install Unified Reporter

Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
uim83
Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
UR provides the following features:
  • Drag and drop ad hoc report building.
  • Drag and drop dashboard building, with live refresh, and mash-ups of external content.
  • Built-in charting that includes pie, bar, line, multi-series, 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
Prerequisites
Do the tasks described in this section before you install Unified Reporter.
Back up Your Databases
Before you upgrade, it is recommended that you back up the UIM database (
CA_UIM
) and the UR repository
database. Backing up these databases ensures that your monitoring data, and any Unified Reports you have created can be restored.
: The default UR repository database name is
unifiedreporter.
Create a New Tablespace (Oracle Only)
Valid for first-time installations
When you install UR for the first time, the installer guides you through setting up a database connection. If Oracle is your database provider, the installer prompts you to enter a username and password for an Oracle tablespace. You
cannot
use the same username and password from the UIM installation, or the UR installer will display a warning message, and not allow you to proceed.
To complete the UR installation, you must create a new username and password on the Oracle server, and enter this username and password in the Database Connection panel of the installer.
For more information on installing an Oracle database, see Install Oracle.
Ensure JVM is Installed
The installer requires you have a version Java Virtual Machine (JVM) between
1.7.0_06
and
1.7.0_51
installed on the machine. 
To verify that you have a supported JVM, follow these steps:
  1. At the command prompt, enter the following command:
    java -version
    If the listed version is between 
    1.7.0_06
    and
    1.7.0_51
    , proceed to the next section. If the command fails, go to the next step.
  2. If you believe your system has a correct JVM version but the previous step failed, make sure that the JVM is part of the system PATH environment variable.
  3. If there is no directory on the system for Java, install it as follows:
    1. Obtain a Java distribution from http://www.java.com (not affiliated with UIM), and install it according to the directions at that site.
    2. Perform step 2 to ensure that the JVM is included in the PATH environment variable.
Ensure that you get the right package (32-bit or 64-bit) for your operating system. For example, 64-bit operating system requires a 64-bit JVM.
Install Unified Reporter
You can deploy UR to any robot where UMP is installed and running. However, the installer must be executed from the system running the primary hub.
If you have an issue while installing Unified Reporter, you can use the log files in the following locations to troubleshoot issues:
  • <UIMInstallDirectory>\UnifiedReporter\Logs 
  • tmp\ia\ur.log
Follow these steps:
  1. Log in to the CA UIM Customer Support Center site.
  2. Download the installation package for your OS.
  3. Run the installer from the system running the primary hub:
    • Windows:
      Double-click on the installUR.exe file.
    • Linux:
      ./installUR_linux.bin -i [gui | console]
    • Solaris:
      ./installUR_solaris.bin -i [gui | console]
    The GUI mode launches the installation wizard and the console mode runs the installer in command-line mode. When launching the installer from the command line, always include the
    -i gui
    or
    console
    argument.
    The following instructions assume you are running the installation in gui mode, but both modes prompt you for the same information.
  4. Click
    Next
    in the
    Introduction
    panel.
  5. Browse to the location of the UIM Monitor installation.
    By default, UIM is installed in the following locations:
    • Windows 32-bit: C:\Program Files\Nimsoft
    • Windows 64-bit: C:\Program Files (x86)\Nimsoft
    • Linux: /opt/nimsoft
    • Solaris: /opt/nimsoft
  6. Enter the username and password for the administrative UIM user.
  7. Select the UIM Monitor robot where your UMP server is installed.
    If you are upgrading, a dialog informs you of an existing instance of UR on the robot you selected. Click
    Proceed
    , and then go to step 10.If the
    Invalid Upgrade/Reinstall
    dialog appears, you are attempting an upgrade that is not supported. For the supported upgrade path, see the
    UIM Compatibility Matrix
    at: http://support.nimsoft.com/downloads/doc/NMSCompatibility_SupportMatrix_current.pdf
  8. Update the location of the data_engine if the location displayed is not correct.
  9. In the Database Connection panel:
    • Microsoft SQL: You can select
      Database Authentication
      or
      Windows/NT Authentication
      .
    • Oracle: You must enter the username and password for a
      new
      tablespace--
      not
      the user configured for the data_engine--or the installer will not allow you to continue. After you complete the Database Connection panel, the system displays a summary of information about the installation. Proceed to step 10.
    • MySQL: Click
      Next
      .
  10. (Microsoft SQL and MySQL only) Select the appropriate radio button in the Database Schema panel.
  11. (Microsoft SQL and MySQL only) Enter or select a database schema or catalog name.
    If you click the back arrow in your browser after creating a new schema/catalog, and then select
    Create a new schema/catalog
    again, the system will not allow you to use the same name
    a second time. In this case, you must select
    Use an existing schema/catalog
    to use the name you created previously.
  12. In the summary panel about the installation, click
    Install
    if you are satisfied with the information displayed. Click
    Previous
    to edit information in earlier panels.
    A panel with status bars displays while Unified Reporter installs.
    When the installation is complete, a dialog notifies you that the installation was successful.
  13. Click
    Done
    .
Unified Reporter is now installed and ready for use.
Configure Mail Server Settings
If you schedule reports or run them in the background, you can specify email addresses to notify when the report completes. In order to use this feature, you must configure JasperReports Server to contact an email server.
Follow these steps:
  1. Locate the
    js.quartz.properties
    file in the UR directory: <UIM>/probes/service/wasp/webapps/jasperserver-pro/WEB-INF/js.quartz.properties.
  2. Open the
    js.quartz.properties
    file in a text editor.
  3. Enter values for the properties in the js.quartz.properties file, referring to the two tables provided below.
    For mail server configuration, there is an additional property setting for authentication. This file is located on the system where UR is deployed in the following directory: <
    Nimsoft
    >/probes/service/wasp/webapps/jasperserver-pro/WEB-INF/applicationContext-report-scheduling.xml.
  4. After you have edited and saved these two files, restart the JasperReports Server by restarting the wasp probe in either Admin Console or Infrastructure Manager. 
js.quartz.properties
Property
Description
report.scheduler.mail.sender.host
The name of the computer hosting the mail server
report.scheduler.mail.sender.username
The name of the mail server user that JasperReports Server can use
report.scheduler.mail.sender.password
The password of the mail server user
report.scheduler.mail.sender.from
The address that appears in the
From
field on email notifications
report.scheduler.mail.sender.protocol
The protocol that the mail server uses. JasperReports Server only supports SMTP.
Note:
Your entry must be lower case (in this case,
smtp
).
report.scheduler.mail.sender.port
The port number that the mail server uses. For SMTP, the default is typically 25 (values other than 25 may not work in earlier JasperServer versions).
applicationContext-report-scheduling.xml
Property
Bean
Description
javaMailProperties
key="mail.smtp.auth"
reportScheduler
MailSender
If your mail server requires authentication, change this property from false to true.