summarize_flag command

By default, data for reports is collected, summarized, and stored in the Oracle database for all components and for all report types. The summarize_flag command enables you to prevent the summarization of report data for all the components, all the report types, or just the selected components or report types. Reducing the volume of summarization data reduces the time required for report generation. This reduction is especially useful in environments with large service models.

The syntax is: 

summarize_flag [-h] [-enable|-disable] [-f fileName] [-t type]

You can specify the setting for all components of a report type by using the -t option again or you can specify the setting for selected components by using the -f option. When you use the -t option, the new setting is applied to all components within that report type, including those components that you had previously set with the -f option. You can enter only one report type per command.

If you have set data summarization for a component and then removed that component from the service model, or if you remove the cell containing the service model, the summarization setting is lost. If you later add the component back into the service model or register the cell again, the report settings for the component are set to the default values for each report type.

For example, if the report's setting is to collect summary data for its components, then summary data is collected for the component. If summarization is disabled for the report, summary data is not collected for the component that you added back to the service model. If you want a different setting for the component, you must set it again with the -f option.

To stop the collection of all summary data

1. At the command line, change the current directory path:
   • For Windows: ReportEngineInstallDirectory\bin\reportsCLI
   • For Linux: ReportEngineInstallationDirectory/bin/reportsCLI
2. Run the following command:
   • For Windows: summarize_flag -disable
   • For Linux: ./summarize_flag.sh -disable
3. Review the command line warning message, and type y to continue.
    Summarization is turned off, and no summary data is collected.

To collect summary data for a report type

1. At the command line, change the current directory path:
   • For Windows: ReportEngineInstallDirectory\bin\reportsCLI
   • For Linux:  ReportEngineInstallDirectory/bin/reportsCLI

2. Run the following command:

   • For Windows: summarize_flag -enable -t type
   • For Linux: ./summarize_flag.sh -enable -t type

   For Windows: summarize_flag -enable -t AVAIL

   For Linux: ./summarize_flag.sh -enable -t AVAIL

   You can enter only one report type per command.

3. Review the command line warning message, and type y to continue.
   
    Summarization is turned on for all the components included in the Availability reports, and the summary data is collected for Availability reports.

 To collect summary data for specific components and all report types 

These instructions assume that all report summarization has previously been disabled. Collecting summary data for specific components and all report types is a two-step process. First, you create a file that contains the mc_udids for the specific components and second, you run the summarize_flag command.

1. At the command line, change the current directory path:
   • For Windows: %mcell_home%\bin
   • For Linux: %mcell_home%/bin

2. Execute the mquery command that retrieves objects from a cell.

   mquery -n cellName -d -f baroc -a BMC_ApplicationService -s mc_udid > mc_udids.txt 

   cellName parameter represents the name of the cell that you are querying.

   For information about the mquery command, see mquery.

   Sample information in the mc_udids.txt file is as follows:

   BMC_ApplicationService; 
   mc_udid='OI-2A6392D4B10E4B04B85641B1317A64AA';
   mc_udid='OI-3B6782E2C12F3A03A91323C1216B54AA';
   END
3. At the command line, run the following command:
   • For Windows: summarize_flag -enable -f fileName

   • For Linux: ./summarize_flag.sh -enable -f fileName
     fileName represents the complete path of the file that contains the component identifiers.

     Example

     For Windows: summarize_flag -enable -f mc_udids.txt

     For Linux: ./summarize_flag.sh -enable -f mc_udids.txt

4. Review the command line warning message, and type y to continue.
    Summarization is turned on for the BMC_ApplicationService components listed in the file, and the summary data is collected.