Configuring TrueSight Operations Management Report Engine

Perform the following procedures to configure TrueSight Operations Management Report Engine:

Configuring TrueSight Operations Management Report Engine for performance reports

Perform the following configurations for proper operation of the performance reports.

Creating an External Report attribute set

An External Report attribute set enables the following:

• Filtering capabilities — performance data is transferred from TrueSight Infrastructure Management Server to the report engine, and performance reports are generated only on those attributes you have selected.
• Normalization of attributes across platforms — you can group similar attributes across platforms in one attribute set. For example, the "% CPU Utilization In System Mode (%)" attribute is used for UNIX, while the "System CPU Utilization (%)" is used for Windows monitors. You can group both attributes under one "CPU" attribute and generate performance reports using the "CPU" attribute set.

To create an External Report attribute set:

1. On the TrueSight Infrastructure Management operational console, go to Options > Administration > Attribute Sets > Edit.
2. Click the relevant option:
   • For a new Attribute Set, click Add in the AttributeSet Administration screen.
   • To edit an existing Attribute Set, click Edit. Click Add Attributes to add more attributes.
3. On the Add Attribute Set screen, select the Attribute Set type External Report.
4. Select the Monitor Type. Select all monitor types corresponding to the attributes to be grouped.
   Use the Shift and Ctrl keys to make multiple selections. To locate a specific monitor, use the Search For field.
5. Click Next.
6. Select the attributes to be grouped from under each of the monitor types in the Attributes section.
   Use the Shift and Ctrl keys to make multiple selections. To locate a specific attribute, use the Search For field.
7. Click Next.
8. Specify a name for the attribute set.
9. Select the attributes to be included by selecting the corresponding check boxes in the Select column.
10. Click Finish. The new External Report attribute set is available for use.

To create a non-super admin user to create attribute sets with monitors that have instances

After you create attribute sets, external attribute set displays monitor types that do not contain any instances. To display the monitor types which have instances only, perform the following steps:

1. In the TrueSight Infrastructure Management Administration Console, select the Administration > General Administration tab.
2. Expand the Advanced Options folder.
3. Select and right-click the Role folder and select Add Role.
4. In the Add Roles and Permissions dialog box, enter the Name of the new role.
5. Select Limited Access option to select from the permissions in the Permissions List.
6. From the Permissions List, select all permissions and click Finish.
7. Expand the Advanced Options folder, to create a new user group.
8. Select and right-click the User Group folder and select Add User Group.
9. In the User Group dialog box, enter the Name of the user group.

10. Select the Roles/Users tab, and select the newly add role from the Available Roles list to assign to the user group.

11. Select the following other permissions:
    1. Views
    2. Monitor Groups
    3. CIs
    4. SLOs
    5. Reports
    6. Folders
12. To display all devices and its monitors, in CIs tab, select All Components.
13. Create a new user, highlight and right-click User and select Add User. 
14. In the Add User dialog box, enter all required fields and select the newly created user group from Available User Groups. Click Add.
15. Log on to TrueSight Infrastructure Management Operations Console by using the newly created user.
16. Create attribute set for External Report. For more information, see To create an External Report attribute set.

Configuring the Report Engine properties 

Changing the report engine properties is not required. If you must change the report engine properties, the properties are located in the perfsladatatransfer.properties file, located in the appropriate directory for your operating system:

• For Windows: reportEngineInstallDirectory\ReportEngine\conf\properties
  \perfsladatatransfer
• For Linux: ReportEngine/conf/properties/perfsladatatransfer

To change the Report Engine properties:

1. Open the perfsladatatransfer.properties file using a text editor. The following properties are included in the file:

   Property type	Parameter	Description
   Data transfer schedule	reportengine.datatransfer. schedule.interval	Schedule interval in seconds of the performance data transfer job. Valid values are positive whole numbers. Default value (recommended): 3600
   	reportengine.configjob .schedule.interval	Schedule interval in seconds for configuration job which transfers configuration data. Valid values are positive whole numbers. Default value (recommended): 3600 BMC recommends to set config job schedule to be equal or in multiple of the main data transfer job.
   	reportengine.deleteconfigjob .schedule.interval	Schedule interval for Delete job. Default value (recommended): 3.00 AM UTC/GMT
   	reportengine.datagapfillerjob .schedule.interval	Schedule interval for Delete job. Default value (recommended): 1.00 AM UTC/GMT
   	reportengine.datatransfer. pentaho.job.thread.count	Defines the number of threads to read data from the TrueSight Infrastructure Management database. Default value (recommended): 10
   Maximum history	reportengine.datatransfer. maxhistoryretrieval.statdata.days	Maximum stats history data in days to be transferred from TrueSight Infrastructure Management server to report engine. Valid values are positive whole numbers. Default value (recommended): 0
   	reportengine.datatransfer .maxhistoryretrieval.ratedata.days	Maximum rate history data in days to be transferred from TrueSight Infrastructure Management server to report engine. Valid values are positive whole numbers. Default value (recommended): 90
   Chunk size	reportengine.datatransfer .ratestat.chunksize	Stats and rate data in hours that is transferred in one data transfer job cycle. To collect history, the chunk size must be greater than the job schedule interval. Valid values are positive whole numbers. Default value (recommended): 3
   CSV file generation	reportengine.csvfilegeneration .enable	Generates .csv files in case of a data gap. If you do not want the Report Engine to generate .csv files during a data gap, set this parameter to false. Default value: true
   Collection of rate data	reportengine.ratedatatransfer .enable	Collects the rate data. If you want the Report Engine to collect rate data, set this parameter to true. Default value: false
   Boolean	reportengine.pentaho.logging.level	Indicates the value for default logging for performance data transfer in reportengine.log file. Default is ERROR. Recommended value is ERROR. If this is upgraded setup, change the value to ERROR

   
   

   Note

   To change the Retention Age property, use the ConfigureRetention CLI command.

2. Save the perfsladatatransfer.properties file.
3. Restart the TrueSight Operations Management Report Engine service. See, Starting and Stopping the Report Engine service.

Configuring maximum history of performance data

This section describes the configuration for transferring performance data from TrueSight Infrastructure Management database to reporting engine database. Reporting Engine can be configured to transfer history data present in TrueSight Infrastructure Management Server before it has been registered with reporting engine.

You can configure the maximum history of performance data to be retrieved from TrueSight Infrastructure Management server over multiple cycles by modifying the following parameters. See Configuring BMC TrueSight Operations Management Report Engine for performance reports for more information.

reportengine.datatransfer.maxhistoryretention.statdata.days=0
   reportengine.datatransfer.maxhistoryretention.ratedata.days=90

Maximum history is relative to current time. Default is set to 30 days.

Configuring TrueSight Operations Management Report Engine for Oracle Real Application Cluster

After the Report Engine installation is finished, complete the following procedure to update the Oracle Real Application Cluster (RAC) JDBC URL:

1. In a text editor, create an URL based on the number of host names and instances.
   
   The syntax is:

   jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=fullyQua
   lifiedHostName1)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=
   fullyQualifiedHostName2)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=
   fullyQualifiedHostName3)(PORT=1521))(LOAD_BALANCE=OFF)(FAILOVER=ON)(
   CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=serviceName)(FAILOVER_M
   ODE=(TYPE=SELECT)(METHOD=BASIC)(RETRIES=10)(DELAY=10))))

   
   where, 
   fullyQualifiedHostName1 is the full name of node1 in the Oracle RAC.
   
   fullyQualifiedHostName2 is the full name of node2 in the Oracle RAC.
   
   fullyQualifiedHostName3 is the full name of node3 in the Oracle RAC.
   
   serviceName is the connector to one or more instances.
   
   

   Note

   The URL must be a single string and should not contain any new line characters in between the URL. The number of node entries can be modified based on the number of nodes in the RAC.

   You can also provide virtual IP in the RAC URL.

   Example:

   (DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=rac112-scan1.bmc.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=ORA95NEW)))

   where, rac112-scan1.bmc.com is the virtual IP.

2. Stop the TrueSight Operations Management Report Engine service. For details, see Starting/Stopping of the BMC TrueSight Operations Management Report Engine service.
3. Create a backup of the following files:
   • database_config.xml file located at ReportEngineInstallDir\ReportEngine\bin\reportsCLI
   • websdk-ds.xml file located at ReportEngineInstallDir\ReportEngine\tools\jboss\server\all\deploy

   • smsConsoleServer-ds.xml file located at ReportEngineInstallDir\ReportEngine\tools\jboss\server\all\modules
       

     Note

     If you create the backup files in the same directory, ensure the backup files do not have the .xml extension. Create the back up outside the BMC_PROACTIVENET_REPORTENGINE_HOME directory.

4. Using a text editor, open database_config.xml, and search for the <url> tag.

5. Update the following value with the URL that you created in step 3.
   
   

   jdbc:oracle:thin:@hostName:1521:instanceName

6. Save and close the file.

7. Using a text editor, open websdk-ds.xml and smsConsoleServer-ds.xml files, and search for the <xa-datasource-property name="URL"> tag.

8. Update the following value with the URL that you created in step 3.
   
   

   jdbc:oracle:thin:@hostName:1521:instanceName

9. Save and close the files.
10. Start the TrueSight Operations Management Report Engine service. For details, see Stopping and starting the Report Engine Service.