Generating an upgrade timing report
You can generate a detailed report of the time taken (in minutes) by the BMC Remedy ITSM installer to perform the installation or upgrade of the applications in the suite. The BMCAPPLogReportUtility utility parses the log files, which are created during the installation, and obtains the total time taken by each module to run several commands, tasks, and utilities to complete the installation. With this report, you can determine the installation and upgrade time for the products, components, and modules in the suite.
The following topics are covered in this section:
Overview of the utility
During installation or upgrade, log files are generated for all modules and are located at <BMC Remedy ITSM_Installation directory>/logs folder. Running the BMCAPPLogReportUtility utility scans all available log files and, for each .log file in the Remedy Installation kit (RIK) logs folder, creates a time report in .csv format in the output directory. For example, the InstallRAFReport.csv file is created for the InstallRAF.log file. Additionally, the utility generates a LogTimingSummary.csv summary file. The report records the time taken by each application or module to install, listing the entries in descending order.
Applications and modules compatible with upgrade timing report
The following table lists the applications or modules for which the reports are generated:
Application/Module name | Report generated | Description |
|---|---|---|
Atrium Foundation-Remedy Installation Kit | AtriumFoundation-RIK_PreInstallReport | This report displays the overall time taken by different operations and commands to run. Additionally, the report also lists the files associated with the command and the DEF and DATA time taken to run those commands
|
BMC Remedy Asset Management | BMCRemedyAssetManagementReport | |
BMC Remedy Change Management | BMCRemedyChangeManagementReport | |
BMC Remedy Incident Management | BMCRemedyIncidentManagementReport | |
BMC Remedy ITSM Suite PostInstallation Tasks | BMCRemedyITSMSuitePostInstallTaskReport | |
BMC Remedy ITSM Suite PreInstallation Tasks | BMCRemedyITSMSuitePreInstallTaskReport | |
BMC Remedy Knowledge Management | BMCRemedyKnowledgeManagementReport | |
BMC Remedy Problem Management | BMCRemedyProblemManagementReport | |
Bmc Remedy Knowledge Management PostInstallation Task | BmcRkmPostInstallInstallationTaskReport | |
Extension Loader - Remedy Installation Kit | ExtLoader-RIK_LogReport | |
Install Remedy Applications Foundation | InstallRAFReport | |
Install Remedy Configuration Foundation | InstallRCFReport | |
ITSM Java Plugin Registration Tasks | ITSMJavaPluginRegistrationTaskReport | |
Remedy Application | RemedyApplicationReport | |
Requester Console Object | RequesterConsoleObjectReport | |
Log Timing Summary | LogTimingSummary | This report displays the overall summary of the time taken by different operations and commands to execute. The first section in the summary file displays the total time, time taken to run the .Def and .Data commands. You can refer to the corresponding .csv file for the specific command. |
| UtilitiesReport | This report displays the summary of the time taken by the utilities to execute the .Def and .Data commands. The report displays the command name and the corresponding file associated with it. The total time taken by the commands is displayed in descending order. The total time taken by the utilities to run is shown at the end. |
Running the utility
When you run the BMCAPPLogReportUtility utility, you are prompted to enter the input and output folders respectively. Perform the following steps to run the utility:
If you have not already done so, set the JAVA_HOME environment variable on your computer to the location where your JDK is installed, for example,
C:\Program Files\Java\<jdk_version>. If you do not set the JAVA_HOME environment variable, you may not able to run the BMCAPPLogReportUtility.
- Navigate to the <BMCRemedyITSMSuite directory>/Utilities directory.
- At the command prompt, type one of the following commands based on your platform and press Enter:
- (Windows) BMCAPPLogReportUtility.bat
- (UNIX) BMCAPPLogReportUtility.sh
The BMCAPPLogReportUtility utility is started.
- At the input folder prompt, type the path for your input folder and press Enter.
The input folder is where your log files are stored on your computer. - At the output folder prompt, type the path for your output folder and press Enter.
The output folder is a directory on your system where you want to save the generated reports. The output file is created in the LogTimingReport folder of the output directory.
Example report generated by the utility
Several files are generated in the report based on the commands and operations that are run for each application and module. For an example of the report that is generated, download the file, extract the contents, and view.