This documentation supports the 20.08 version of BMC Digital Workplace Advanced, which is available only to BMC Helix subscribers (SaaS). To view an earlier version, select the version from the Product Version menu.

Identifying connectivity and configuration issues by running health checks

A BMC Digital Workplace environment contains components such as Apache Tomcat. BMC Digital Workplace can be integrated with BMC Digital Workplace Catalog and other BMC products such as BMC Cloud Lifecycle Management and BMC HR Case Management. Occasionally, connectivity or configuration issues can affect accessibility of BMC Digital Workplace or other integrated products.

You can identify connectivity or configuration issues in your BMC Digital Workplace environment by running health checks through the BMC Digital Workplace Health Check utility.

Related topics

Identifying-the-origin-of-environmental-issues-by-running-diagnostic-checks

Troubleshooting

Solution offered by the BMC Digital Workplace Health Check utility

By using the BMC Digital Workplace Health Check utility, you can narrow down the possible causes for connectivity or configuration issues and check the overall health of your BMC Digital Workplace environment. You can run the utility in clustered and non-clustered BMC Digital Workplace environments.

The following table provides details about the utility regarding when it is run by using the web interface, script, or CLI.

Best practice
To proactively identify issues in your working BMC Digital Workplace environment, we recommend that you run the BMC Digital Workplace Health Check utility periodically.

Permissions required to run the utility

To run the utility, you must belong to the MyIT Super Admin permission group.

Video assistance

Important

The following videos show an older version of BMC Digital Workplace. The previous product name was MyIT. Although there might be minor changes in the UI, the overall functionality remains the same.

Running the BMC Digital Workplace Health Check utility

This section provides procedures to run the utility using different interfaces. The following information is provided:

Before you begin

  • Ensure that you have MyIT Super Admin permission.
  • Ensure that the BMC Digital Workplace server is running, and is accessible via http or https.
  • (For running the script or running the utility using CLI) Ensure the following points:
    • You can access the computer where BMC Digital Workplace is installed.
    • The DigitalWorkplaceHome\DWP\health-check directory is available and accessible.
      Here DigitalWorkplaceHome is the directory where BMC Digital Workplace is installed.The default BMC Digital Workplace installation location is as follows:
      • (Windows) C:\Program Files\BMC Software\DWP\
      • (Linux) /opt/bmc/DWP/
    • The health-check directory contains the following utility files:
      • health-runner-version.jar, where version is BMC Digital Workplace version
      • healthcheck.bat
      • healthcheck.sh
    • The computer on which you run the utility has Oracle JDK or OpenJDK version 11.
    • JAVA_HOME or Java bin directory is present in the executable file path. Run the java -version command to verify if Java is configured correctly.

To run the BMC Digital Workplace Health Check utility from the web interface

  1. Enter the URL in a web browser. Use the appropriate URL format:
    • (Non-clustered environment) http://DigitalWorkplaceHostName:port/dwp/healthcheck/
    • (Clustered environment) http://loadBalancerHostName:port/dwp/healthcheck/
  2. Enter your BMC Digital Workplace credentials, and click Log in.
    The utility runs the checks and presents the results.

Example and output of running the utility from the web interface

To run the BMC Digital Workplace Health Check utility from CLI

  1. (When running the utility from a non-host computer) Copy the health-check directory to the non-host computer.
  2. At the command prompt on the computer where you are running the utility, navigate to the health-check directory.
  3. Run the utility by using the appropriate command.
    The command is the same for Windows and Linux computers. For details about the parameters, see Parameters for running the utility from CLI (below).

    • Use the following command when running the utility directly on a BMC Digital Workplace host:

      java -jar health-runner-<version>.jar -s http://localhost:9000/dwp -u <userName> -p <password>

    • Use the following command when running the utility from a non-host computer, for a BMC Digital Workplace host:

      java -jar health-runner-<version>.jar -s http://<bmcMyITHostName>:9000/dwp -u <userName> -p <password>

    • Use the following command when running the utility for a load balancer host:

       java -jar health-runner-<version>.jar -s http://<loadBalancerHostName>:9000/dwp -u <userName> -p <password>

Parameters for running the utility from CLI

All parameters in the command are mandatory. The following table describes the parameters:


Example and output of running the utility from CLI


To run the BMC Digital Workplace Health Check utility script

Warning

Do not update any code in the script, other than the specified parameters. Doing so might result in script failure. 

  1. (When running the utility from a non-host computer) Copy the health-check directory to the non-host computer.
  2. On the computer where you are running the utility, navigate to the health-check directory and edit the healthcheck.bat file (Windows) or healthcheck.sh file (Linux) by using a text editor such as Notepad.
  3. Define values for the server_url, username, and password parameters, which are mandatory. Optionally, define the value for use_untrusted_cert parameter.
    For details about these parameters, see Parameters for running the utility script.
  4. Save and close the file.
  5. Double-click the script file to run the utility.

Parameters for running the utility script

The following table describes the parameters you must define:


Examples and output of running utility by using a script


Interpretation of health check results

This section provides information about the checks run by the utility, result statuses, and a description of each check. The section also provides information about corrective actions in case of failures. The section includes:

Health check statuses

The result of each health check shows one of the following statuses:

  • PASSED—When no connectivity or configuration issues with the integrated application are found.
  • FAILED—When there is a connectivity or configuration issue with an integrated application, or if BMC Digital Workplace is not integrated with an application.
  • UNKNOWN—When BMC Digital Workplace is integrated with a particular application, but the service is disabled.

Health check descriptions and corrective actions

The following table lists the checks that the BMC Digital Workplace Health Check utility runs. The table lists possible reasons of failure and the corrective actions.

Caution

Use the corrective actions with caution. This is not an exhaustive list of causes of failure, and there might be other reasons of failure that require in-depth analysis. For further help, contact BMC Support.

Troubleshooting

When you run the BMC Digital Workplace Health check utility scripts or run the utility from CLI, the utility records information in the debug.log file located in the DigitalWorkplaceHome\DWP\health-check directory. See that file for detailed information about errors that might occur while running the utility and the associated checks and results.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*