Important

   

This space contains documentation for TrueSight Server Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Server Automation 8.9.

Installing and configuring Yellowfin to enable Live reporting

This topic describes the process to install and configure Live Reporting with TrueSight Server Automation, and includes the following sections:

The Live reporting dashboard displays complete information about patch management, compliance, and job activity in one consolidated view. The dashboard contains multiple reports, many of which you can run live while you are in a patching window, to review up-to-the-minute compliance. 

For more information about the dashboard, see Using the Live Reporting dashboard.

Notes

Use of Yellowfin technology is provided in conjunction with the Live reporting dashboard capability of TrueSight Server Automation. Use of Yellowfin for capabilities other than the Live reporting dashboard or independently of the integrated BMC Product is prohibited.

Make sure that you use the Live Reporting installer that is shipped with the TrueSight Server Automation version that you are using.

System requirements for Live Reporting

This section describes the requirements for installing and using Live Reporting in your environment.

Application server requirements

Requirement

Recommended minimum specifications

Processor

2 x Dual Core 3GHz or faster

RAM

4 GB minimum

Hard Disk

1 GB free space

Operating System

  • Windows 2000 or later
  • Red Hat Enterprise Linux 5.0 and later

Database server requirements

Requirement

Recommended minimum specifications

Processor

2 x Dual Core 3Ghz or faster

RAM

4 GB minimum

Hard Disk

10 GB (preferably with RAID disk mirroring)

Database

For Live Reporting, BMC supports only the following databases as
an application configuration database:

  • Oracle Database 11g R2 and 12c
  • SQL Server 2008 R2 and 2012 R2
  • SQL server 2014

  • SQL Server 2016

Client requirements

Requirement

Recommended minimum specifications

Web Browser

Supported browsers include:

  • Internet Explorer 8+
  • Firefox 2+
  • Opera 8+
  • Safari 2+
  • Chrome
PDF

PDF reader such as Adobe Acrobat Reader for viewing PDF files. This reader is required only if users export Live Reporting reports to PDF.

Requirements for concurrent users

Number of users

CPU requirements

RAM requirements

Developer / Demonstration

Single 2 GHz Xeon or equivalent

2 Gb

25 or Less Concurrent Users

2 x 2 GHz Xeon or equivalent

4 Gb

50 Concurrent Users

4 x 2 GHz Xeon or equivalent

8 Gb

150 Concurrent Users

8 x 2 GHz Xeon or equivalent

16 Gb

Downloading the installation files

Download and extract the Live Reporting installer from the Electronic Product Distribution (EPD) website:

Use the appropriate Live Reporting components, depending on which operating system you are installing on.

For Windows

Installer for Live Reporting (TSSA_LiveReportingInstaller.exe)
 

For Linux

Installer for Live Reporting (TSSA_LiveReportingInstaller.bin)

Before you begin

  • The version of Live Reporting must match the version of TrueSight Server Automation that is installed in your environment.

    Upgrade from an earlier version of Live Reporting is not supported. You must first manually uninstall the existing version and then install the new version. For steps about uninstalling the existing version of Yellowfin, see Uninstalling Live Reporting.

    Note

    Any custom data created in the previous version of Live Reporting (for example, any custom reports, dashboards, views, users, and profiles) might be lost during the Live Reporting uninstallation and installation process. BMC does not support any custom data created in the previous version.

  • When BMC customers use Live Reporting in their production environment, the type of Yellowfin database must match the TrueSight Server Automation database. For example, if your TrueSight Server Automation environment is running MS SQL Server, then your Yellowfin environment must also be running MS SQL Server. You cannot mismatch databases.
  • The database server does not have to reside on the same system as the Live Reporting application. However, BMC recommends that you install Live Reporting on a dedicated host.

  • For Windows or Linux operating system, you can use one of these pre-created databases and database user:
    • SQL Server
    • Oracle
  • For creating a SQL Server database and database user, you need the following information:
    • Host name or IP address of the Windows server running the database
    • Port number that the database listens on. The default port is 1433 for MS SQL Server
    • Credentials of a database user. Do not use the default sa user for the Yellowfin database user; use a more restricted user for the Yellowfin database. Choose one of the following:
      • Database and database user credentials supplied to you by your database administrator,
      • If you are using Windows authentication, make sure that a user account exists in Computer Management and is added to the Administrator group. This step is not required on the server that hosts the database.
    • Credentials of the database administrator (for example, sa).
    For information about pre-creating a Microsoft SQL database, see Walkthrough: Setting up a SQL Server database.
  • For creating an Oracle database and database user, you need the following information:
    • Host name or IP address of the Linux server running the database

    • Port number that the database listens on. The default port is 1521 for Oracle.
    • Oracle SID (for example, ORA112DB) or the Oracle Service Name used to connect with Oracle, as defined in tnsnames.ora.
    • Credential of a database user (do not use system) which is specifically created to configure the Yellowfin metadata.  The schema of the database user must be empty.

    For information about creating an Oracle database, see Walkthrough: Setting up an Oracle database.
 Click here to expand detailed instructions on manually creating a tablespace and Yellowfin database user for Oracle database
  1. Create a yellowfin directory with the correct permissions to store the table space. For example:

    mkdir -p /data1/oracle/product/databases/yellowfin
    chown oracle:dba /data1/oracle/product/databases/yellowfin
  2. Log on to SQL *Plus and connect to the Oracle database. For example:

    su - oracle
    sqlplus /nolog
    connect sys/password@ORA112DB as SYSDBA
  3. Create a Yellowfin table space, which can be used by the Yellowfin installer. For example:

    CREATE TABLESPACE YELLOWFIN LOGGING
    DATAFILE '/data1/oracle/product/databases/yellowfin/YELLOWFIN.dbf'
    SIZE 200M DEFAULT STORAGE (INITIAL 500M NEXT 100M MAXEXTENTS UNLIMITED PCTINCREASE 0);
  4. Create a Yellowfin table space index. For example:

    CREATE TABLESPACE YELLOWFIN_INDEX LOGGING
    DATAFILE '/data1/oracle/product/databases/yellowfin/YELLOWFIN_INDEX.dbf'
    SIZE 50M DEFAULT STORAGE ( INITIAL 500M NEXT 100M MAXEXTENTS UNLIMITED PCTINCREASE 0);
  5. Create a Yellowfin database user and grant required permissions to the user. For example:

    CREATE USER YELLOWFIN
    PROFILE DEFAULT IDENTIFIED BY password
    DEFAULT TABLESPACE YELLOWFIN
    TEMPORARY TABLESPACE TEMP ACCOUNT UNLOCK;
    GRANT CONNECT TO YELLOWFIN;
    GRANT RESOURCE TO YELLOWFIN;
    GRANT CREATE VIEW TO YELLOWFIN;
    GRANT SELECT ANY DICTIONARY TO YELLOWFIN;
    GRANT EXECUTE ON dbms_lock TO YELLOWFIN;
    GRANT UNLIMITED TABLESPACE TO YELLOWFIN;
    GRANT EXECUTE ON DBMS_LOB TO YELLOWFIN;
    GRANT EXECUTE ON DBMS_SQL TO YELLOWFIN;
    GRANT CREATE TABLE TO YELLOWFIN;
    GRANT CREATE SEQUENCE TO YELLOWFIN;
    GRANT CREATE TRIGGER TO YELLOWFIN;
    GRANT CREATE PROCEDURE TO YELLOWFIN;
  6. Alter the data files of the TrueSight Server Automation schema table space and the Index table space to auto extend. For example:

    ALTER DATABASE
    DATAFILE '/data1/oracle/product/databases/yellowfin/YELLOWFIN.dbf'
    AUTOEXTEND ON NEXT 250M;
    ALTER DATABASE
    DATAFILE '/data1/oracle/product/databases/yellowfin/YELLOWFIN_INDEX.dbf'
    AUTOEXTEND ON NEXT 50M;

Step 1: Installing Live Reporting

Depending on which operating system you are installing Live Reporting on, follow one of the following procedures.

This example uses Live Reporting 8.9.03 screenshots. However, the steps are same for Live Reporting 8.9.03 and later.

    Perform the following steps to install Live Reporting on your Windows host.

    Important

    Make sure that the SQL Server Browser service is up and running while setting up the Yellowfin database using a named SQL Server instance.

    1. Run the Live Reporting installation file (for example, TSSA_LiveReportingInstaller.exe) as an administrator.
    2. The first screen of the Live Reporting installation wizard appears. Click Next.
    3. Read the End User License Agreement (EULA) and select I agree to the terms of the license agreement.
      Click Next.

    4. Enter the HTTPS port number of the Yellowfin server that you want to connect to. The default port number is 8443.

      Tip

      Enable the Install Windows Service option, if you want to install Yellowfin as a windows service. This enables Yellowfin to automatically start whenever the server is started.

    5. Select the type of database that you are using with Yellowfin, which is Microsoft SQL for this procedure.

    6. Enter the Yellowfin SQL server database details (which you created in in this step) as displayed in the following screenshot and table:

      Field Description
      Host Name or IP Address Enter the Host name or IP address of the server that runs the Yellowfin SQL server database.
      Port Enter the port that the Yellowfin database listens on. The default port is1433 for an SQL Database.
      Instance Name
      (only visible if the Named Instance option is selected)
      Enter the name of the database instance that you created.
      Database Name Enter the name of the database that you created.
      User Name Enter the user name that you created for the database.
      User Password Enter the user name password that you created for the database.
      Confirm User Password Confirm the user name password that you created for the database.
      Windows Authentication or SQL Server Authentication Select whether the user must log on to the Yellowfin database server using Windows credentials or SQL server credentials.
    7. Enter and confirm the password that you want to assign to the Yellowfin REPORT_ADMIN user. The REPORT_ADMIN user is the default administrator user for Yellowfin.

    8. Enter the Tomcat Web server certificate information as displayed in the below screenshot and table. This information is used to enable an HTTPS connection to Yellowfin.

      Field Description
      Common Name (CN) Enter a name to identify the CA certificate
      Organizational Unit (OU) Enter your organization unit, for example: IDD
      Organization Name (O) Enter your organization name, for example: BMC Software
      Locality Name (L) Enter the name of your locality, for example: San Jose 
      State Name (S) Enter the name of your state, for example: California
      Country (C) Enter the name of your country, for example: USA
      Create Keystore Password Enter the keystore password.
      Important: Enter the password that is set for JRE cacerts keystore in TrueSight Server Automation. The default password set for cacerts is typically changeit.
      Create Keystore Password Confirm the keystore password.
      Important: Enter the password that is set for JRE cacerts keystore in TrueSight Server Automation. The default password set for cacerts is typically changeit.
    9. Enter TrueSight Server Automation database server details as displayed in the following screenshot and table:

      Field Description
      Host Name or IP Address Enter the Host name or IP address of the server that runs the TrueSight Server Automation database.
      Port Enter the port that the TrueSight Server Automation database listens on. The default port is1433 for an SQL Database.
      Instance Name
      (only visible if the Named Instance option is selected)
      Enter the name of the TrueSight Server Automation database instance.
      Database Name Enter the name of the TrueSight Server Automation database.
      User Name Enter the user name of the TrueSight Server Automation database.
      User Password Enter the user name password of the TrueSight Server Automation database.
      Confirm User Password Confirm the user name password of the TrueSight Server Automation database.
      Windows Authentication or SQL Server Authentication Select whether the user must log on to the TrueSight Server Automation database server using Windows credentials or SQL server credentials.
    10. Enter the path to the directory in which you want to install Live Reporting. The default path is C:\Program Files\BMCSoftware\Live_Reporting. Click Next.

      Tip

      Enter a path without extra spaces or punctuation to avoid errors during installation.

    11. Review the information on the Preview screen and click install to start the installation.

      Tip

      The installation should take 20-25 minutes to complete successfully.

    12. After the installation is successful, you must not close the Tomcat window.

    Perform the following steps to install Live Reporting on your Linux host.

    Make sure that X11 forwarding is configured on the remote Linux host.

    1. Run the Live Reporting installation file (for example, BladeLogic_LiveReportingInstaller.bin) as a root user.
    2. The first screen of the Live Reporting installation wizard appears. Click Next.
    3. Read the End User License Agreement (EULA) and select I agree to the terms of the license agreement.
      Click Next.

    4. Enter the HTTPS port number of the Yellowfin server that you want to connect to. The default port number is 8443.

    5. Select the type of database that you are using with Yellowfin, which is Oracle for this procedure.
    6. Enter the Yellowfin Oracle database details (which you created in in this step) as displayed in the following screenshot and table:

      Field Description
      Host Name or IP Address Enter the Host name or IP address of the server that runs the Yellowfin Oracle database.
      Port Enter the port that the Yellowfin database listens on. The default port is 1521 for an Oracle Database.
      Service or SID
      (depending on the option you have selected)
      Enter the database SID or the Service name, depending on which option you have selected.
      User Name Enter the user name of a database user (do not use system) which is specifically created to configure the Yellowfin metadata.

      User Password Enter the password of the user name that you created for the database.
      Confirm User Password Confirm the password of the user name that you created for the database.
    7. Enter and confirm the password that you want to assign to the Yellowfin REPORT_ADMIN user. The REPORT_ADMIN user is the default administrator user for Yellowfin.
    8. Enter the Tomcat Web server certificate information as displayed in the below screenshot and table. This information is used to enable an HTTPS connection to Yellowfin.

      Field Description
      Common Name (CN) Enter a name to identify the CA certificate
      Organizational Unit (OU) Enter your organization unit, for example: IDD
      Organization Name (O) Enter your organization name, for example: BMC Software
      Locality Name (L) Enter the name of your locality, for example: San Jose 
      State Name (S) Enter the name of your state, for example: California
      Country (C) Enter the name of your country, for example: USA
      Create Keystore Password Enter the keystore password.
      Important: Enter the password that is set for JRE cacerts keystore in TrueSight Server Automation. The default password set for cacerts is typically changeit.
      Confirm Keystore Password Confirm the keystore password.
      Important: Enter the password that is set for JRE cacerts keystore in TrueSight Server Automation. The default password set for cacerts is typically changeit.
    9.  Enter TrueSight Server Automation database server details as displayed in the following screenshot and table:

      Field Description
      Host Name or IP Address Enter the Host name or IP address of the server that runs the TrueSight Server Automation Oracle database.
      Port Enter the port that the TrueSight Server Automation database listens on. The default port is 1521 for an Oracle Database.
      Service or SID
      (depending on the option you have selected)
      Enter the database SID or the Service name, depending on which option you have selected.
      User Name Enter the user name of the TrueSight Server Automation database.
      User Password Enter the password of the user name of the TrueSight Server Automation database.
      Confirm User Password Confirm the password of the user name of the TrueSight Server Automation database.
    10. Enter the path to the directory in which you want to install the Live Reporting feature. The default installation path is /opt/bmc/live_reporting. Click Next.

      Tip

      Enter a path without extra spaces or punctuation to avoid errors during installation.

    11. Review the information on the Preview screen and click install to start the installation.

      Tip

      The installation should take 35-40 minutes to complete successfully.

    Step 2: Importing certificate to TrueSight Server Automation application server

    You must import the certificate on every Application Server in your environment. Otherwise, you will see an error when you try to access the Live Reporting data from the Application Servers. This means, if there are multiple Application Servers in your environment, you must repeat the steps to import the certificates on all the servers.

    1. Copy <installed_directory>\Yellowfin\appserver\conf\yellowfin_server.cer and paste it into a temp folder on the TrueSight Server Automation Application Server host.  
    2. Open a administrative command prompt.
    3. Run the keytool command from the jre\bin installed with the TrueSight Server Automation Application Server. The default path for bin directory are as follows:
      For Linux : <installed_directory>/appserver/NSH/br/java/bin
      For Windows : <installed_directory>\appserver\NSH\jre\bin
    4. Import <temp_folder>\yellowfin_server.cer into your TrueSight Server Automation Application Server Java cacerts keystore. The default path for cacerts keystore are as follows:
      For Windows : <installed_directory>\appserver\NSH\jre\lib\security\cacerts
      For Linux: <installed_directory>/appserver/NSH/br/java/lib/security).
      For example, in a Windows environment:

      keytool -import -alias yellowfin-server
       -keystore "C:\Program Files\BMC Software\BladeLogic\appserver\NSH\jre\lib\security\cacerts"
       -trustcacerts -file "C:\temp\yellowfin_server.cer"

      For example, in a Linux environment:

      keytool -import -alias yellowfin-server
       -keystore "/opt/bmc/bladelogic/appserver/NSH/br/java/lib/security/cacerts"
       -trustcacerts -file "/tmp/yellowfin_server.cer"
    5. At the prompt, enter changeit as the default cacerts password.
    6. At the prompt to trust the certificate, enter yes.

      keytool -import -alias yellowfin-server 
        -keystore "<installed_directory>\appserver\NSH\jre\lib\security\cacerts" 
        -trustcacerts -file "<temp_directory>\yellowfin_server.cer"
      Enter keystore password:
      Owner: CN=clm-aus-013663.bmc.com, OU=IDD, O=BMC Software, 
        L=San Jose, ST=California, C=US
      Issuer: CN=clm-aus-013663.bmc.com, OU=IDD, O=BMC Software, 
        L=San Jose, ST=California, C=US
      Serial number: 744eb125
      
      Valid from: Thu Apr 07 07:59:15 GMT-12:00 2016 until: Fri Apr 07 07:59:15 GMT-12
      :00 2017
      Certificate fingerprints:
               MD5:  4D:EE:5D:7A:F1:FF:1F:6B:78:10:89:02:E0:86:D0:C4
               SHA1: 84:7A:C7:D9:18:FF:C8:4B:7D:60:9F:5B:08:A2:81:26:A7:6C:6A:D7
               SHA256: 75:A7:4E:DE:8E:04:D5:2D:6C:09:69:1B:FA:7B:5D:E8:DB:39:5B:
                  68:76:BC:EF:DC:31:BD:04:A5:60:95:66:0E
               Signature algorithm name: SHA256withRSA
               Version: 3
      Trust this certificate? [no]:  yes
      Certificate was added to keystore

       

    7. After you import the certificate, restart the TrueSight Server Automation Application Server in which the certificate is imported.
      For example:

      /etc/init.d/blappserv stop
      /etc/init.d/blappserv start

    Step 3: Verifying the Live Reporting installation

    Follow this procedures to verify the Live Reporting installation.

    1. Verify that whether the Live Reporting is installed successfully by logging on to Yellowfin (https://<yellowfinServerName>:<portNumber>) with the new REPORT_ADMIN user. Update the details for the REPORT_ADMIN profile (for example, enter the temporary password, create and confirm the new password for REPORT_ADMIN, and so on) and save your changes. 

       

    2. After you save your changes, review the default page.

      Tip

      For troubleshooting purposes, see the live_reporting_install_log.txt file of the Live Reporting installer in the /tmp folder in Linux and C:\Users\ADMINI~1\AppData\Local\Temp in Windows.

    Step 4: Configuring the BLAS Admin


    Before you launch the live reporting dashboard, run the following command in the BLAS Admin console. For information about starting the BLAS admin console, see Starting the Application Server Administration console.

    set livereporting livereportingurl https://<hostname>:<portNumber>

    Replace the variables with values, as described in the following table:

    VariableDescription
    <hostname>Host name of the server hosting the Yellowfin server
    <portNumber>

    Port number that the Yellowfin server listens on.

    Note

    If you are running multiple BladeLogic Application Servers in your environment, you only need to set the Live Reporting URL one time. However, you must import the yellowfin_server.cer into each Application Server in order to cross-launch the Live Reporting Dashboard with HTTPS.

     Examples:
    set livereporting livereportingurl https://<yellowfinServerName>:8443


    Step 5: Creating an automation principal for REPORT_ADMIN

    You need an automation principal to create an BladeLogic Application Server session to communicate with Yellowfin.

     Perform the following steps to create the automation principal for the REPORT_ADMIN user:

    1. Log on to TrueSight Server Automation Console using your RBAC Admin (RBACAdmin) credentials. For more information, see RBACAdmin and BLAdmin users.
    2. In the RBAC Manager folder, select Automation Principals.
    3. Create a new automation principal by right-clicking and selecting New > Automation Principal from the pop-up menu. The Automation Principal Creation wizard appears.
    4. Enter the following details to create your Automation principal for the REPORT ADMIN:

      FieldDescription
      NameEnter REPORT_ADMIN
      Description(Optional) Enter descriptive text
      Principal IDEnter REPORT_ADMIN
      DomainLeave empty
      PassphraseEnter the modified password of the REPORT_ADMIN user (not the temporary password that you created while running the post installer script)
      ConfirmRe-enter the modified password of the REPORT_ADMIN user
    5. Click Finish.

    Step 6: Assigning authorization to your role

    Perform the following steps:
    1. Remain logged on to TrueSight Server Automation Console using your RBAC Admin credentials. For more information, see RBACAdmin and BLAdmin users.
    2. In the RBAC Manager folder, select Roles.
    3. Right-click on the role that you will assign to the user, who launches the Live reporting dashboard (for example, BLAdmins), and select Open from the pop-up menu. Alternatively, create a new role for this by right-clicking and selecting New > Role from the pop-up menu.

    4. Click the System tab at the bottom of the Available Authorizations list.
    5. Assign the Report.Writer authorization to the role, by clicking and moving the Report.Writer authorization from the Available Authorizations box to the Selected Authorizations box.

      Tip

      Enter Report in the Type to filter field to shrink the number of roles that are displayed.


    6. Make sure the role now has the Report.Writer authorization.
    7. Assign the AutomationPrincipal.Read authorization to the role, by clicking and moving the AutomationPrincipal.Read authorization from the Available Authorizations box to the Selected Authorizations box. Note that you can skip this step if you are using the BLAdmin role to access Live Reporting.

      Tip

      Enter AutomationPrincipal in the Type to filter field to shrink the number of roles that are displayed.

    8. Click the Users tab to ensure that the role is assigned to the user with which you plan to launch the Live reporting dashboard. For more information about assigning roles to users from the Users tab, see Role - Users.

      Restriction

      Make sure that the user name to whom the role is assigned does not exceed 20 characters. This restriction is not applicable to TrueSight Server Automation 8.9.04 or later versions.

    9. Save your changes to the role.
      For detailed information about creating a role and its authorizations, see Creating roles. For information about modifying a role and its authorizations, see Modifying Roles.

    You are now ready to use the Live reporting dashboard. For more information, see Where to go from here.

    Step 7: Populating the reports

    The first time you launch the Live Reporting dashboard from the console, no data is shown in any of reports. To populate the reports, do the following:

    Important

    You need to refresh the cached filter list to ensure that the latest values are reflected in the dashboards. Ensure that you perform this procedure at regular intervals so that latest information is disaplyed in your Live Reporting dashboard.


    1. Log on to Live Reporting using the REPORT_ADMIN user.
    2. Select Administration > Admin Console
    3. Click Schedule Management on the right of the screen.
    4. Click Select All to ensure that all filters are selected, and then click Run now.
    5. Ensure that all filters have been refreshed in the current date and time. If any filter still shows an earlier date and time in the Last Run column, select that filter and click Run Now again.
    6. The latest values of server groups, patch catalogs, and so on are now reflected in your dashboard. 

    Where to go from here

    Using the Live Reporting dashboard


    Was this page helpful? Yes No Submitting... Thank you

    Comments

    1. Drew Trachy

      This page needs to be updated to include the "Enabling HTTPS in Yellowfin before post-installation" instructions that are in the BSA 8.9.2 and lower documentation.

      Feb 19, 2019 02:08
    2. Parag Desai

      Are the steps for installation without internet access still valid? The original web.xml is missing the entry "<!DOCTYPE web-app.......". When adding this entry manually, the tomcat log throws an error. It doesn't like it. I had to revert the web.xml to original and run the postinstaller.bat. That helped. Livereporting version 8.9.04.

      Jun 23, 2019 11:19