Upgrade Unified Reporter

Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
uim902-9-0-2
Unified Reporter (UR) is an optional component that provides advanced reporting for the Unified Management Portal (UMP).
 
 
2
 
2
 
 
Overview
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.
Prerequisites
Do the tasks described in this section before you upgrade Unified Reporter.
 
 
3
 
3
 
 
Considerations
Review the following points:
  • When installing Unified Reporter, we always recommend using a new database. Using a new database instead of the UIM database ensures that there are no issues with either CA UIM or Unified Reporter upgrade.
    New installation of Unified Reporter is not supported in 9.0.2. You can only upgrade from Unified Reporter 8.5.1 to Unified Reporter 9.0.2 in a non-TLS environment because this upgrade is not supported in a TLS environment.
  •  The default UR repository database name is 
    unifiedreporter
    .
  • CA UIM 8.5.1 and later run on Java 8, and installing Unified Reporter 8.5.1 or later onto a dedicated robot will automatically install the proper java_jre file. You can still run an older version of UR with either Java 6 or 7. To upgrade from an older version of UR to v9.0.2 or later, follow the normal installation procedure.
  • If Windows Authentication is in use in the environment, and therefore an Active Directory service account is used to run the CA UIM service (Nimsoft Robot watcher on the primary hub), make sure to log in to the primary hub as that same Active Directory user prior to executing the installUR.exe. This will ensure that the unifiedreporter database is installed in the context of that user. Failure to do this may result in the Unified Reporter database being inaccessible to the UIM Service user, which will cause the reports to be inaccessible.
  • The UIM Server installer creates a .pem file (certificate.pem) in the 
    <Nimsoft>\security
     folder. The .pem file is a symmetric key that is shared with the required robots, which is then used for communication with the data_engine probe. You copy this .pem file to the remote UMP, UR, and CABI robots and provide the location of the file in the robot.cfg file (
    cryptkey = <.pem file location>
    ). Furthermore, if any impacted probe is not on the same computer where data_engine is present, copy the generated .pem file to the robot computer (where data_engine is not available) and update the robot.cfg file with the .pem file location on that computer. For more information about the robot.cfg file configuration, see Configure the robot.cfg File.
  • 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
  • A wasp probe restart is required before any changes to the 
    js.quartz.properties
     or 
    applicationContext-report-scheduling.xml 
    files can take effect.
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.
(Oracle Only) Create a New Tablespace 
 
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 and Configure Your Database Software.
Upgrade Unified Reporter
It is recommended that you deploy UR on its own robot. However, the installer must be executed from the system running the primary hub.
After you install CA UIM and UR, you must configure the wasp probes on their robots in order to communicate with each other. This includes pointing the UR wasp at the data_engine probe on the primary hub in order to receive data and pointing wasp on the the UIM robot at the UR robot in order to build the UR portlet in UMP and create reports. This is done by including new sections in the configuration files for each wasp probe.
 
Follow these steps:
 
  1. Create a separate system for the UR robot and deploy a robot to that system.
  2. From the archive, deploy wasp to the UR robot.
  3. On the UIM robot, open the wasp 
    Configuration
     window and, under 
    Setup
    , copy the data_engine probe address. Close the window.
  4. On the UR robot, open the wasp 
    Configuration
     window and, under 
    Setup
    , paste the data engine probe address from the UIM robot wasp. Close the window.
  5. From the primary hub, log in to the Customer Support Center site.
  6. Download the installation package for your OS.
  7. Run the UR installer from the system running the primary hub:
  •  
    Windows:
    Double-click on the installUR.exe file.
    If you receive the following error:
     
    This Application has Unexpectedly Quit/ Invocation of this Java Application has caused an Invocation Target Exception/ This application will now exit (LAX)
     
    Run the installer in Windows 7 compatibility mode:
    1. Right-click on InstallUR.exe and select 
      Properties
      .
    2. Click the 
      Compatibility
       Tab.
    3. Click 
      Run this program in compatibility mode 
      and select
       Windows 7
      .
  •  
    Linux:
     
    ./installUR_linux.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 that you are running the installation in gui mode, but both modes prompt you for the same information. Respond to the dialog boxes as appropriate.
  1. Advance through the dialog boxes for running the installer and the language for the installation.
  2. In the Install Location window, browse to the location of the UIM Monitor installation.
  3. In the Authenticate window, enter the username and password for the administrative UIM user.
  4. In the Select Robot window, select the UR robot.
    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 9. If the 
    Invalid Upgrade/Reinstall 
    dialog appears, you are attempting an upgrade that is not supported. For the supported upgrade path, see the Supported Upgrade Paths link
    .
     
  5. In the Configure Database window, update the location of the data_engine if the location displayed is not correct.
  6. Click 
    Next
     and review the database settings:
    • 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. You must also enter an Oracle SID, which is the instance name of the Oracle Server. After you complete the Database Connection panel, the system displays a summary of information about the installation. Proceed to step 9.
    • MySQL: Click 
      Next
      .
  7. (Microsoft SQL and MySQL only) Select the appropriate radio button in the Database Schema panel.
  8. (Microsoft SQL and MySQL only) Click 
    Next
     and 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.
  9. In the Summary window, 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 upgrades.
    When the upgrade is complete, a dialog notifies you that the upgrade was successful.
  10. Click 
    Done
    .
Unified Reporter is now installed.
View Unified Reports in UMP
To view Unified Reports in UMP, wasp on the robot running UMP must contain a pointer to the UR webapp for the robot where UR is installed and running.
 
Follow these steps:
 
  1. On the UMP robot, select the wasp probe and open the 
    Raw Configure
     option.
  2. Open the 
    webapps
     section, and then open the 
    unifiedreports
     section.
  3. Create a new section under 
    unifiedreports
     named 
    custom
    .
  4. Create a new section under 
    custom
     named 
    uncrypted
    .
  5. Create a key under 
    uncrypted
     named 
    external_url
    .
  6. Assign a value to 
    external_url
     as 
    http://<URrobot IP address>/jasperserver-pro
    .
  7. Click 
    OK
    .
  8. Create a new section under 
    webapps
     named 
    jasperserver-pro
    .
  9. Create a key under 
    jasperserver-pro
     named 
    external
    .
  10. Assign a value to 
    external
     as 
    true
    .
  11. Click 
    OK
    .
The wasp probe will restart. When the restart is complete, the Unified Reports portlet will appear in UMP under the Reports page. You can now open Unified Reporter to create reports.
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.