This documentation supports the 9.0 version of BMC Remedy ITSM Deployment.

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

Running the Configuration Check utility in GUI mode

This mode provides an interactive way through which you can set your configuration check preferences, select components and checks, run the checks, and view the result as an HTML Report.

The following topics are provided:

To run the BMC Remedy Configuration Check utility in GUI mode

  1. Run the following file from the configchecker folder:

    • (Microsoft Windows) configchecker-ui.bat

    • (UNIX) configchecker-ui.sh

      Note

      For UNIX, provide executable permissions to configchecker-ui.sh. Use any X-Server utility (for example, MobaXterm) to start the configuration check GUI.


      The following window is displayed:

  2. Complete the fields that require inputs.

     Click here for a list of fields and their descriptions

    Field Name

    Description

    Select Categories

    All checks are classified into two categories that indicate when a particular check must be run:

    • Pre-upgrade checks
    • Configuration checks

    Select the appropriate option button to select the category.

    Select Products

    Displays a list of products for which the utility performs the checks.

    Click Select Products to open the Configuration-Check Product List window, where you can edit the default product list. Ensure that at least one product is selected. By default, all products except SSI (the BMC Remedy ITSM Preconfigured Stack Installer) are selected.:

    • ARS — BMC Remedy AR System
    • CMDB — BMC Atrium Core
    • ITSM — BMC Remedy IT Service Management Suite
    • SLM — Service Level Management
    • SRM — Service Request Management
    • SSI — BMC Remedy ITSM Preconfigured Stack Installer
    • UDM — Unified Data Management
    • PD — BMC Remedy ITSM Process Designer

    DB Host

    The BMC Remedy AR System database host name.

    DB Type

    The BMC Remedy AR System database type.

    Click Edit to open the DB Configuration window, where you can change the values of the DB Host and DB Type fields. These field values are required for the database compatibility check, which is optional. These values are not validated in this window, but they are validated during the database compatibility check.

    The following fields are displayed in the DB Configuration window:

    • Oracle or MS-SQL — Select the required database from these options.
    • Unicode — Select this option for a unicode database.
    • Windows Authentication or SQL Authentication — Select either of these options for authentication.
    • Host Name — The database host name.
    • Port — The port number for the database server.
    • DB Instance Name — The name of the database instance.
    • AR System DB Name — The BMC Remedy AR System database name.
    • User — The database server user name.
    • Password — The database server password.

    AR Server

    The BMC Remedy AR System server name.

    AR User

    The BMC Remedy AR System server user name.

    Click Edit to open the AR Server Configuration window, where you can change the values of the AR Server and AR User fields.

    Note: You must have Administrator credentials to log on.

    The following fields are displayed in the AR Server Configuration window:

    • AR Server — The BMC Remedy AR System server name.
    • Port — The port number for the BMC Remedy AR System server.
    • User — The BMC Remedy AR System server user name.
    • Password — The BMC Remedy AR System server password.
    • Auth String — The authentication string for BMC Remedy AR System server.

    AR Install Dir

    The BMC Remedy AR System installation directory. Note the following information:

    • For a fresh installation, you must specify this path.
    • For an upgrade, specifying this path is optional. The utility automatically finds this path by querying the BMC Remedy AR System server.

    Temp Dir

    Location of the temporary directory.

    This input is mandatory for the BMC Remedy IT Service Management (ITSM) Suite and BMC Service Level Management. If you do not provide this path, the Temp Dir Check for both products fails.

    Load Pre-Check Config File

    Name and location of the input configuration file that contains the framework configuration and information about the BMC Remedy Configuration Check utility plug-ins. By default, the value of this field is the name and location of the out-of-the-box (OOTB) configuration file.

    Recommendation: Run the utility with the default configuration file.

    Click Browse to change the file name and location.

    Load Existing Result File

    The location at which the result file is created.

    Note: You can view the status of the last run by loading the existing result file.

    Click Browse to change the default location of the result file.

    The configuration is saved in the configchecker_config.xml file. If you change the configuration, the configuration file is saved as a new file, and subsequent changes are made to that file. (The original configuration file that is shipped with BMC Remedy AR System is backed up as a separate file.)
  3. Click Next to open a window that displays all available checks based on the inputs that you provided in the previous window.

    Some of the inputs are displayed in read-only mode at the top of this window. The Summary tab displays the precheck name, the product for which the check will be run, and the status of the check.

    Note

     When you click Next, the AR Server, Temp Dir, and AR Install Dir fields are validated. If an error occurs, you must resolve it before going to the next window.

    The following window is displayed:

  4. Select the required prechecks, and click Run to execute the selected checks.

    After the checks are executed:

    • If all checks pass, no messages are displayed on the Errors/Warnings tab.

    • If errors or warnings are present, they are displayed in detail on the Errors/Warnings tab.

    • For failed checks, in the GUI mode a Hints column is displayed, containing information about errors that occur.

    For example, the OS Compatibility Check error is displayed as shown in the following image:


In the GUI mode, hint messages are displayed when the check condition fails. However, hint messages are not displayed when the initialization of check fails. For example, in a database-related check, if a database login fails, the intended condition cannot be checked. In such a case, a hint message is not displayed.

From Version 9.0 SP 1, the detailed report generated after running the checks can be viewed in the HTML format by clicking the HTML Report button. The Configuration Check HTML Report displays the Pre Check Summary and Errors/Warnings tabs. 

  • The Pre Check Summary tab displays the summary of all the checks that were run.
  • The Errors/Warnings tab displays a detailed description of errors or warnings encountered while running the checks. Clicking Click Here For Help redirects you to a detailed description of the check available in BMC Remedy ITSM Suite 9.0 Deployment online documentation.

From Version 9.0 SP 1, the detailed report generated after running the checks can be viewed in the HTML format by clicking the HTML Report button. The Configuration Check HTML Report displays the Pre Check Summary and Errors/Warnings tabs. 

  • The Pre Check Summary tab displays the summary of all the checks that were run.
  • The Errors/Warnings tab displays a detailed description of errors or warnings encountered while running the checks. Clicking Click Here For Help redirects you to a detailed description of the check available in BMC Remedy ITSM Suite 9.0 Deployment online documentation. 

The results are also stored in an XML file (configcheckResult.xml) in the configchecker folder. The result file in is either newly created, overwritten, or backed up, depending on how you run the utility:

  • If you close the GUI session or restart the system, you can still view the status of the last run by loading this XML file.
  • If you immediately re-run the utility, the configcheckResult.xml file is overwritten.

  • If you re-run the checks after you click Prev, or if you close the utility and reopen it, the existing result file is backed up by appending the time stamp to the name, and the new result file is created with the updated time stamp.

Where to go from here

Viewing configuration check reports

Viewing configuration check log files and changing logging level

Related Topics

Running the Configuration Check utility in interactive command-line mode

Running the Configuration Check utility in silent mode

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. David k Hill

    An issue that I ran into while running the configchecker-ui.bat batch file stemmed from our configuration of the Java JDK.  The Java JDK in our environment is setup as:
    "C:\Program Files\Java\jdk"  (Notice no version specified in directory name)

    for the JRE it is:

    "C:\Program Files\Java\jre"

    With Environment Variables set as:

      JAVA_HOME=C:\Program Files\Java\jdk

      JRE_HOME=C:\Program Files\Java\jre

    This is configured per BMC support to reduce issues when upgrading the JDK/JRE binaries.

    However, when this script is run it looks for a version in the name by checking the version with:
    Turnning off @ECHO OFF I get:

    R:\AR System\configchecker>"C:\Program Files\Java\jdk"\bin\java -version:1.7 -version  1>nul 2>&1

    The script is wrapping the full path and appending a double quote " before the \bin.  This is what's causing the version check to fail.  Not sure how this got past QA.

    This configuration although is not written eloquently, fails when the environment is using 1.8.

    I added one more check for the 1.8 version.

    Also, keep in mind that the argument "-version:(version)" is a deprecated switch.

    Here's an edited BATCH file:

    @ECHO OFF

    IF "%JAVA_HOME%" == "" GOTO NO_JAVA

     

    FOR /f TOKENS^=2-5^ DELIMS^=.-_^" %%j IN ('%JAVA_HOME%\bin\java.exe -fullversion 2^>^&1') DO SET "jver=%%j.%%k"

     

    IF "%jver%" GEQ "1.6" (

        ECHO Java version is greater than 1.6.  Good

        "%JAVA_HOME%\bin\java.exe" -Xmx512m -classpath ".;./lib/arapi81_build001.jar;./lib/arconfigcheckerframework81_build001.jar;./lib/arconfigcheckerdriver81_build001.jar;./lib/framework-base-SNAPSHOT.jar;./lib/jaxb-api.jar;./lib/jaxb-xjc.jar;./lib/saxon9he.jar;./lib/log4j-1.2.14.jar;./lib/configcheckui81_build001.jar;./lib/bmccui-2.0.jar;./plugin/lib/arsinstalldbLibs.jar;" com.bmc.arsys.prechecker.ui.MainFrame %*

        GOTO END

    ) ELSE (

        ECHO Pre-Checker requires Java version 1.6 or Greater...

        GOTO END

    )

     

    :NO_JAVA

    ECHO JAVA_HOME Environment Variable is not set or java is not installed on this system...

     

    :END

     

     

    Mar 16, 2016 11:54
    1. Amit Durgapal

      Hello David,

      Sorry about the delay in acknowledging your query. I am looking into this and will update you on this asap.

      Sorry again!

      Regards,

      Amit

       

       

      Apr 21, 2016 12:40
      1. Amit Durgapal

        Hello David,

        I have discussed this with the SME. The SME has indicated that it's a defect with the product. The defect has been created and will be tracked to completion in the upcoming releases.

        Thanks for bringing this to our notice.

        Regards,

        Amit

        May 10, 2016 04:24
        1. David k Hill

          You betcha...  Anything to help you help me.... (smile)

          May 10, 2016 10:31