Article ID: 114243, created on Jun 28, 2012, last review on May 1, 2014

  • Applies to:
  • Operations Automation

The Health Check Tool allows to validate whether the Web-based Management Service and Call Reporting Tool are installed and configured properly. The tool can be used to diagnose problems with the Web-based Management Service and Call Reporting Tool.

The installed Web-based Management Service must meet the following requirements:

Web-based Management Service External WebSite

  • Site settings:
    • Bindings: The HTTPS protocol on the default port 443 and the dedicated FrontNet IP address are used.
    • Certificate: A trusted SSL certificate obtained from a well known CA (phone devices do not support self-signed SSL certificates).
    • Authentication:
      • The Anonymous Authentication is only enabled on the site root directory.
      • The Digest Authentication is only enabled on the Configs virtual directory.
    • Directory Browsing: It is disabled for the whole site.
    • Application Pool: The Hosted BroadWorks Web External Pool, which is run under the default IIS pool user (ApplicationPoolIdentity).
  • Permissions on the site's file storage: See the table below.

Path Inheritance Account Rights
Configs  Do not inherit permissions Local Administrators This folder, subfolders and files: Full control.
SYSTEM This folder, subfolders and files: Full control.
Authenticated Users This folder: Travers folder / execute file, Read attributes, Read permissions.

This folder and files: List folder / read data, Read attributes, Read extended attributes, Read permissions.
Configs\Web.config Inherit permissions Authenticated Users This object only: List folder / read data, Read attributes, Read extended attributes, Create folders / append data, Read permissions.
Configs\s00XX Inherit permissions <device user> This folder and subfolders: Traverse folder /execute file, List folder / read data, Read attributes, Read extended attributes, Read permissions.

This folder and files: List folder / read data, Read attributes, Read extended attributes, Read permissions.

Web-based Management Service Internal WebSite

  • Site settings:
    • Bindings: The HTTPS protocol on the default port 443 and the dedicated BackNet IP address are used.
    • Certificate: The self-signed SSL certificate generated during the Web-based Management Service's installation.
    • Authentication: The Windows Authentication is only enabled on the whole site.
    • .NET Authorization Rules:
      • Allow access to DOMAIN\BWAuthUser
      • Deny access to All Users
    • Application Pool: The Hosted BroadWorks Web Internal Pool, which is run under the DOMAIN\BWPoolXXXXX domain account with the privileges of the Domain Administrator account.
  • POA Public API. The POA Public API endpoint is accessible from the host.
The installed Call Reporting Tool must meet the following requirements:

CallsReporting Application

  • PBA Public API. The PBA Public API endpoint is accessible from the host.
  • EZTax API. The EZTax API endpoint is accessible from the host.
  • Permissions on the filesystem: See the table below.

Path Inheritance Account Rights
CallsReporting.exe.config
CallsReporting.exe.config.orig
Do not inherit permissions Local Administrators Full control
SYSTEM Full control
DOMAIN\BWCDRUsers Read
Data
Logs
Do not inherit permissions Local Administrators Full control
SYSTEM Full control
DOMAIN\BWCDRUsers Read, Write, Execute

CallsReporting Web Application

  • Application Pool: The Hosted BroadWorks Web Calls Reporting Pool, which is run under a domain user from the DOMAIN\BWCDRUsers domain group. The .NET Framework Version setting is set to v4.0 for the Application Pool.
  • Permissions on the filesystem: See the table below.

Path Inheritance Account Rights
Web.config.config
Web.config.orig
Do not inherit permissions Local Administrators Full control
SYSTEM Full control
DOMAIN\BWCDRUsers Read


How to use the tool:

The tool is placed in the <Web-based Management Service installation directory>\Health Check Tool directory. Typically, it is the C:\Program Files\Parallels\Hosted BroadWorks Web\Health Check Tool directory.

To run the tool, open Command Prompt and go to the tool's directory. Then, run the HealthCheckTool.exe file: HealthCheckTool.exe [path to the directory of the Web-based Management Service] [options].

Note: You must specify the path to the directory of the Web-based Management Service if you run the tool from a non-default location.

If the Web-based Management Service is installed and configured properly, the tool shows the Test OK messages. Otherwise, the tool shows the Test FAILED: <problem description> messages.

There are the following options of the tool:

  • wait-on-exit - If it is specified, the tool waits for a user input at the end of an execution.
  • loop-test - If it is specified, the tool perfroms validations in the loop.
  • port-ext - If it is specified, the tool uses the specified port to perfrom the port validation of the Web-based Management Service External WebSite. The default value is 443.
  • port-int - If it is specified, the tool uses the specified port to perfrom the port validation of the Web-based Management Service Internal WebSite. The default value is 443.
  • ignore-cert-error - If it is specified, SSL certificate validation errors are ignored.
  • help - Use this option to obtain the list of options with their descriptions.
 

5356b422f65bdad1c3e9edca5d74a1ae caea8340e2d186a540518d08602aa065 e12cea1d47a3125d335d68e6d4e15e07

Email subscription for changes to this article
Save as PDF