BMC Remedy Configuration Check utility
The BMC Remedy Configuration Check utility is a centralized framework utility that validates the environment for BMC Remedy AR System, AR System server configuration and customization, and generates a consolidated report.
This topic covers:
Obtaining the BMC Remedy Configuration Check utility
The configcheckerversionNumber_buildNumber.zip is bundled with the BMC Remedy AR System Server installation zip. For information about how to obtain the files that you need for installation, see Downloading the installation files.
Make sure that the value of JAVA_HOME is set correctly. Use Java 1.6 or above.
Before you begin
(Optional) Set the target release for the Configuration Check utility
By default, the BMC Remedy Configuration Check Utility is configured to run a check for the 8.1 version installation or upgrade. You can run the Configuration Check utility for a version prior to 8.1.
To change the version, change the following option in the ./configchecker/config/configchecker_config.xml file:
If this parameter is missing, the Configuration Check utility checks for the default 8.1.00 version.
If you set a lower version and then run the utility, it skips checks that are specific to version 8.1.00. The version-dependent checks are listed in the PreCheckerMisc.doc file in ./configchecker/doc.
(Optional) Set the report mode
The reports that the BMC Remedy Configuration Check utility generates have these modes:
info– Displays all messages (informational, warnings, and errors) in the report
warn(the default) – Displays errors and warning in the report.
error– Displays only errors, but not warnings, in the report
To change the mode for a report
- Open the configchecker_config.xml file.
Change the following parameter:
Running the BMC Remedy Configuration Check utility
For the BMC Atrium Core checks, the Configuration Check utility has a dependency on the CDMChecker utility. For the checks to generate correct results, ensure the following:
- Run the BMC Remedy Configuration Check utility on the machine where BMC Atrium Core is installed. Do not run the utility on a remote machine.
- Make sure that you deploy CDMChecker 8.1.02 or Hotfix provided in version 8.1.01 as documented here.
Use either of the following interfaces to run the utility locally on a computer where BMC Remedy AR System is installed. You should not run the utility remotely.
- Graphical User Interface (GUI) — Run configchecker-ui.bat (for Microsoft Windows) or configchecker-ui.sh (for UNIX) to launch the Configuration Check GUI. See, To run the BMC Remedy Configuration Check utility through the GUI.
Command line interface — Run configchecker.bat (for Microsoft Windows) or configchecker.sh (for UNIX) to launch the Configuration Check command line. See, To run the BMC Remedy Configuration Check utility through the command-line interface.
- Silent mode — Run the utility through the command line, by providing at least one argument to the command. See, Running the BMC Remedy Configuration Check utility in the silent mode.
Viewing BMC Remedy Configuration Check utility report
When you run the BMC Remedy Configuration Check utility, an HTML report is generated from the configuration check result file (configcheckResult.xml) and placed in the ./configchecker/result folder. You must open the HTML report from the ./configchecker/result folder because the report has a dependency on the ./configchecker/etc folder.
Unlike the configcheckResult.xml file, the HTML report is not backed up. You can generate an HTML report with the configcheckResult.xml file through the command-line interface. Use the Show Result [res] command.
This report has the following tabs:
- Summary — This tab displays the plug-in name, the product that the plug-in belongs to, and the status of the plug-in execution.
- Errors/Warnings — This tab displays the error or warning details.
Generating log files
A log file is generated and placed in ./configchecker/Logs. By default, logs are generated at the INFO level.
To change the level to DEBUG, set the following line in the ./configchecker/log4j.properties file: