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:
Before you begin
Ensure that the value of JAVA_HOME is set correctly. If you do not set the JAVA_HOME correctly, you may not be able to run the BMC Remedy Configuration Check utility outside of the installer to perform pre-upgrade and configuration checks.
Use Java 8 update 45 or later.
- Extract the configcheckerversionNumber_buildNumber.zip file before running the utility.
- Run the pre-upgrade checks by using the same version of Configuration Check utility as that of BMC Remedy AR System server to which you want to upgrade.
To run the BMC Remedy Configuration Check utility in GUI mode
Run the following file from the configchecker folder:
(Microsoft Windows) configchecker-ui.bat
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:
Complete the fields that require inputs.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.)Click here for a list of fields and their descriptions
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.
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
The BMC Remedy AR System database host name.
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.
The BMC Remedy AR System server name.
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.
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.
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.
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:
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 Details tab.
If errors or warnings are present, they are displayed in detail on the Details tab.
For failed checks, in the GUI mode a Hints column is displayed, containing information about errors that occur.
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.
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 Details tabs. For details, see Viewing configuration check reports.