Perform Bot Agent diagnostic checks

Use the Bot Agent diagnostic utility for connectivity-related issues between the Bot Runner device and Control Room. The utility helps to diagnose issues either by providing solutions or suggestions to help resolve the issues.

Prerequisites

Ensure the Bot Agent is installed on the user device.

Procedure

  1. Open the Windows command prompt.
  2. Navigate to the Bot Agent installation path.
    • Default path for Bot Agent installed at system level is C:\Program Files\Automation Anywhere\Bot Agent.
    • Default path for Bot Agent installed at local user level is %USERPROFILE%\AppData\Local\Programs\Automation Anywhere\Bot Agent.
  3. Enter AADiagnosticUtility.exe to run the Bot Agent diagnostic utility.
    Various options to perform the diagnostic check are displayed with their descriptions.
    Option Description
    -checkDownloadError <CR_URL> Check for bot dependency download errors if the bot deployment fails.
    Note: Error messages are maintained in the device memory and are removed when the Bot Agent service is restarted.

    Use this option when the Bot Runner device is connected to the Control Room but automations fail because the dependent packages are not downloaded on the Bot Runner device. In this case, the utility provides suggestions for further diagnosis.
    -checkProxy <CR_URL> Check the proxy settings on the device.

    When the Bot Runner device is unable to connect to the Control Room, use this option to verify if a proxy is available or configured for the Bot Agent to use.

    You are also provided the option to import proxy settings using the importProxy option.

    Note: Your device proxy settings for authenticated proxy can be set during the Bot Agent registration process and can be updated through the Bot Agent diagnostic utility. The same credentials are used for all users on the device.
    -checkWSError <CR_URL> Check for WebSocket connectivity and errors.
    Note: Error messages are maintained in the device memory and are removed when the Bot Agent service is restarted from Services tab of the Windows Task Manager.

    When a Bot Runner device is unable to connect to the Control Room because of WebSocket connection errors, this option provides the possible reasons for further investigation.
    -collectLogs Reduce the turnaround time for collecting information on issues by capturing multiple logs for the Bot Runner device.
    Use this option to capture and save current day node manager, bot launcher, and event viewer logs for debugging and troubleshooting in a zipped folder on the device where the utility is being run.
    • For Bot Agent installed at system level, the logs are saved in C:\ProgramData\AutomationAnywhere\BotRunner\Logs\bot_agent_logs_<datetimestamp>.zip
    • For Bot Agent installed at local-user level, the logs are saved in %USERPROFILE%\AppData\Local\AutomationAnywhere\BotRunner\Logs\bot_agent_logs_<datetimestamp>.zip
    Note:
    • To capture Windows logs for security events, run the utility with elevated privileges (run as administrator).

      If you run the utility without elevated privileges, the following error is displayed:

      Error: Unable to capture security_event_viewer_<date>.evtx
    • To save storage space, delete the file after debugging.
    -configProxy <CR_URL> Check proxy configuration and configure proxy credentials, if required.

    When the Bot Runner device is unable to connect to the Control Room because of missing credentials for an authenticated server, use this option to configure the proxy server credentials. Verify that the connectivity problem is resolved by logging in to the Control Room.

    -importProxy <CR_URL> Import the proxy settings from a logged-in user device to the system user device.
    Note: You must have administrator permission to import proxy settings.

    When the Bot Runner device is unable to connect to the Control Room because of proxy server issues, use this option to import the proxy settings from a logged-in user to the system user for the Bot Agent.

    This option provides information about the following:
    • Whether the proxy server is authenticated or not.
    • Control Room URL is added to the safe recipients list in the proxy server.
    • WebSocket connections are allowed as part of the proxy configuration.
    -importSSLCertificate path_to_ssl_certificate Import a SSL certificate into the Java credential store, if required.
    Note: You must have administrator permission to import the SSL certificate.

    When the Bot Runner device is unable to connect to the Control Room because of an invalid SSL certificate, use this option to import the SSL certificate. You must ensure a valid certificate file is available in the file location specified in the importSSLCertificatepath_to_ssl_certificate option.

    You must restart the Automation Anywhere Bot Agent service so that the imported certificate becomes effective.
    -list View active bot deployments on the local devices.

    Use this option to check and list the automation (bots) that are running.
    -ping <CR_URL> Check connectivity between the Control Room and Bot Runner devices.

    Use this option to check if a Bot Runner device can ping (reach) the Control Room.
    -validateSSLCertificate <CR_URL> Check for a valid SSL certificate and view whether the certificate is valid or invalid.
    Note: You must have read permission to perform this check.

    When the Bot Runner device is unable to connect to the Control Room because of an invalid SSL certificate, use this option to check and view if the SSL certificate is valid or not. To resolve the issue, use the importSSLCertificate option.
  4. Enter the following option in the command prompt: <filepath>\AADiagnosticUtility.exe -<option> <CR_URL>
    For example, to verify WebSocket errors, enter the following in the command prompt: AADiagnosticUtility.exe -checkWSError https://yourcrurl.com/
    The option returns the following result: Recently this device have not encountered any Web Socket errors

    Use the other options to perform further diagnostic checks.