This documentation applies to the 8.1 version of Remedy Action Request System, which is in "End of Version Support."

To view the latest version, select the version from the Product version menu.

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:

Note

If you are looking for information about the Data Management configuration check utility of BMC Remedy IT Service management, see Running the Configuration Check Utility for UDM.

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.

Note

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:

 

<param name=”targetVersion”>versionNumber</param>

For example:

<param name=”targetVersion”>8.0.00</param>

Or

<param name=”targetVersion”>7.6.04</param>

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

  1. Open the configchecker_config.xml file.
  2. Change the following parameter:

    <param name=”reportMode”>mode</param>

    For example:

    <param name=”reportMode”>error</param>

Running the BMC Remedy Configuration Check utility

Important

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.

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.

Note

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.

Tip

You can use the Configuration Check results to improve your interaction with BMC Support or other support service providers, by stating the details of the failed checks.

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:

log4j.logger.com.bmc.arsys.prechecker.framework.service.
impl.ARPrecheckerFrameworkServiceImpl=DEBUG

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments

  1. David k Hill

    I ran this utility on my 8.1.2 server and it was nice enough to display some errors in the UDM component that I've been trying to troubleshoot for quite a while now.  (DMT Jobs hanging).

    Although the report showed me the error.  I researched it and everything appears to be configured correctly.  I am not sure how this utility determined that it was in error.

    Check-Name: Check ARServer Configuration (Product: UDM)

    Message     MsgType

    The 'REMEDY.ARF.CAI' plugin is not configured in 'D:\BMC Software\ARSystem\\pluginsvr\pluginsvr_config.xml'     Error

     

    The only thing I can see with this test is the double backslashes "\\".

     

    Mar 15, 2016 07:48
    1. Poonam Morti

      Hi David,

      I will verify this with the SME and get back to you.

      Thanks,

      Poonam

      Mar 16, 2016 12:55
      1. David k Hill

        Thanks!!  (smile)

        Mar 16, 2016 01:31
    1. Poonam Morti

      Hi David,

      I have verified this with the SME. As per the SME, there may be a possibility that the configuration was not done properly. Will you please check if the issue is reproducible and share your configuration file with us.

      Thanks,

      Poonam

      Apr 04, 2016 02:48
  2. David k Hill

    Issue is reproducible. I looked at:

    ar.cfg file - looks correct.

    pluginsvr_config.xml - looks correct

    Verified that the CAI Jar file is in place - It is.

    Did the SME have anything to say about the double-slash?  "\\"?

    I tested by trying to open the directory that the error was reporting and comes back as invalid.
    D:\BMC Software\ARSystem\\pluginsvr\pluginsvr_config.xml

     

    Thanks!!

     

    -d

    Apr 25, 2016 03:48
    1. Vaijayanti Nerkar

      Hello David,

      Can you please raise a support ticket for this. The SMEs might want to look at your configuration file. Raising a help ticket will help you get a resolution faster.

      Regards,

      Vaijayanti 

      Apr 25, 2016 10:55