Using Avaya HealthCheck Tool

October 2020
Issue 1
© 2020 Avaya Inc. Channel Partner outside of the United States and
Canada, the warranty is provided to You by said
All Rights Reserved.
Avaya Channel Partner and not by Avaya.
Notice
“Hosted Service” means an Avaya hosted service
While reasonable efforts have been made to ensure subscription that You acquire from either Avaya or
that the information in this document is complete and an authorized Avaya Channel Partner (as applicable)
accurate at the time of printing, Avaya assumes no and which is described further in Hosted SAS or
liability for any errors. Avaya reserves the right to other service description documentation regarding the
make changes and corrections to the information in applicable hosted service. If You purchase a Hosted
this document without the obligation to notify any Service subscription, the foregoing limited warranty
person or organization of such changes. may not apply but You may be entitled to support
services in connection with the Hosted Service as
Documentation disclaimer described further in your service description
“Documentation” means information published in documents for the applicable Hosted Service.
varying mediums which may include product Contact Avaya or Avaya Channel Partner (as
information, operating instructions and performance applicable) for more information.
specifications that are generally made available to Hosted Service
users of products. Documentation does not include
marketing materials. Avaya shall not be responsible THE FOLLOWING APPLIES ONLY IF YOU
for any modifications, additions, or deletions to the PURCHASE AN Avaya HOSTED SERVICE
original published version of Documentation unless SUBSCRIPTION FROM AVAYA OR AN AVAYA
such modifications, additions, or deletions were CHANNEL PARTNER (AS APPLICABLE), THE
performed by or on the express behalf of Avaya. End TERMS OF USE FOR HOSTED SERVICES ARE
User agrees to indemnify and hold harmless Avaya, AVAILABLE ON THE AVAYA WEBSITE,
Avaya's agents, servants and employees against all http://support.avaya.com/LicenseInfo under the link
claims, lawsuits, demands and judgments arising out “Avaya Terms of Use for Hosted Services” or such
of, or in connection with, subsequent modifications, successor site as designated by Avaya, AND ARE
additions or deletions to this documentation, to the APPLICABLE TO ANYONE WHO ACCESSES OR
extent made by End User. USES THE HOSTED SERVICE. BY ACCESSING
OR USING THE HOSTED SERVICE, OR
Link disclaimer AUTHORIZING OTHERS TO DO SO, YOU, ON
Avaya is not responsible for the contents or reliability BEHALF OF YOURSELF AND THE ENTITY FOR
of any linked websites referenced within this Site or WHOM YOU ARE DOING SO (HEREINAFTER
Documentation provided by Avaya. Avaya is not REFERRED TO INTERCHANGEABLY AS
responsible for the accuracy of any information, “YOU” AND “END USER”), AGREE TO THE
statement or content provided on these sites and does TERMS OF USE. IF YOU ARE ACCEPTING THE
not necessarily endorse the products, services, or TERMS OF USE ON BEHALF A COMPANY OR
information described or offered within them. Avaya OTHER LEGAL ENTITY, YOU REPRESENT
does not guarantee that these links will work all the THAT YOU HAVE THE AUTHORITY TO BIND
time and has no control over the availability of the SUCH ENTITY TO THESE TERMS OF USE. IF
linked pages. YOU DO NOT HAVE SUCH AUTHORITY, OR IF
YOU DO NOT WISH TO ACCEPT THESE TERMS
Warranty OF USE, YOU MUST NOT ACCESS OR USE THE
Avaya provides a limited warranty on Avaya HOSTED SERVICE OR AUTHORIZE ANYONE
hardware and software. Refer to your sales agreement TO ACCESS OR USE THE HOSTED SERVICE.
to establish the terms of the limited warranty. In
addition, Avaya’s standard warranty language, as
well as information regarding support for this product Licenses THE SOFTWARE LICENSE TERMS
while under warranty is available to Avaya customers AVAILABLE ON THE AVAYA WEBSITE,
and other parties through the Avaya Support website: HTTP://SUPPORT.AVAYA.COM/LICENSEINFO,
http://support.avaya.com/helpcenter/getGenericDetail UNDER THE LINK “AVAYA SOFTWARE
s?detailId=C20091120112456651010 under the link LICENSE TERMS (Avaya Products)” or such
“Warranty & Product Lifecycle” or such successor successor site as designated by Avaya, ARE
site as designated by Avaya. Please note that if You APPLICABLE TO ANYONE WHO
acquired the product(s) from an authorized Avaya DOWNLOADS, USES AND/OR INSTALLS

May 2020 HealthCheck Tool Registration Feature Description 2

AVAYA SOFTWARE, PURCHASED FROM License types:
AVAYA INC., ANY AVAYA AFFILIATE, OR AN
Designated System(s) License (DS). End User may
AVAYA CHANNEL PARTNER (AS
install and use each copy or an Instance of the
APPLICABLE) UNDER A COMMERCIAL
Software only: 1) on a number of Designated
AGREEMENT WITH AVAYA OR AN AVAYA
Processors up to the number indicated in the order; or
CHANNEL PARTNER. UNLESS OTHERWISE
2) up to the number of Instances of the Software as
AGREED TO BY AVAYA IN WRITING, AVAYA
indicated in the order, Documentation, or as
DOES NOT EXTEND THIS LICENSE IF THE
authorized by Avaya in writing. Avaya may require
SOFTWARE WAS OBTAINED FROM ANYONE
the Designated Processor(s) to be identified in the
OTHER THAN AVAYA, AN AVAYA AFFILIATE
order by type, serial number, feature key, Instance,
OR AN AVAYA CHANNEL PARTNER; AVAYA
location or other specific designation, or to be
RESERVES THE RIGHT TO TAKE LEGAL
provided by End User to Avaya through electronic
ACTION AGAINST YOU AND ANYONE ELSE
means established by Avaya specifically for this
USING OR SELLING THE SOFTWARE
purpose.
WITHOUT A LICENSE. BY INSTALLING,
DOWNLOADING OR USING THE SOFTWARE, Concurrent User License (CU). End User may
OR AUTHORIZING OTHERS TO DO SO, YOU, install and use the Software on multiple Designated
ON BEHALF OF YOURSELF AND THE ENTITY Processors or one or more Servers, so long as only
FOR WHOM YOU ARE INSTALLING, the licensed number of Units are accessing and using
DOWNLOADING OR USING THE SOFTWARE the Software at any given time. A “Unit” means the
(HEREINAFTER REFERRED TO unit on which Avaya, at its sole discretion, bases the
INTERCHANGEABLY AS “YOU” AND “END pricing of its licenses and can be, without limitation,
USER”), AGREE TO THESE TERMS AND an agent, port or user, an e-mail or voice mail
CONDITIONS AND CREATE A BINDING account in the name of a person or corporate function
CONTRACT BETWEEN YOU AND AVAYA INC. (e.g., webmaster or helpdesk), or a directory entry in
OR THE APPLICABLE AVAYA AFFILIATE the administrative database utilized by the Software
(“AVAYA”). that permits one user to interface with the Software.
Units may be linked to a specific, identified Server or
Avaya grants You a license within the scope of the
an Instance of the Software.
license types described below, with the exception of
Heritage Nortel Software, for which the scope of the Cluster License (CL). End User may install and use
license is detailed below. Where the order each copy or an Instance of the Software only up to
documentation does not expressly identify a license the number of Clusters as indicated on the order with
type, the applicable license will be a Designated a default of one (1) Cluster if not stated. “Cluster”
System License as set forth below in Section M(i)1 or means a group of Servers and other resources that act
2 as applicable. The applicable number of licenses as a single system.
and units of capacity for which the license is granted
will be one (1), unless a different number of licenses Enterprise License (EN). End User may install and
use each copy or an Instance of the Software only for
or units of capacity is specified in the documentation
or other materials available to You. “Software” enterprise-wide use of an unlimited number of
means computer programs in object code, provided Instances of the Software as indicated on the order or
by Avaya or an Avaya Channel Partner, whether as as authorized by Avaya in writing.
stand-alone products, pre-installed on hardware Named User License (NU). You may: (i) install and
products, and any upgrades, updates, patches, bug use each copy or Instance of the Software on a single
fixes, or modified versions thereto. “Designated Designated Processor or Server per authorized
Processor” means a single stand-alone computing Named User (defined below); or (ii) install and use
device. “Server” means a set of Designated each copy or Instance of the Software on a Server so
Processors that hosts (physically or virtually) a long as only authorized Named Users access and use
software application to be accessed by multiple users. the Software. “Named User,” means a user or device
“Instance” means a single copy of the Software that has been expressly authorized by Avaya to
executing at a particular time: (i) on one physical access and use the Software. At Avaya’s sole
machine; or (ii) on one deployed software virtual discretion, a “Named User” may be, without
machine (“VM”) or similar deployment. limitation, designated by name, corporate function
(e.g., webmaster or helpdesk), an e-mail or voice
mail account in the name of a person or corporate
function, or a directory entry in the administrative

May 2020 HealthCheck Tool Registration Feature Description 3

database utilized by the Software that permits one The following applies if the product is deployed on a
user to interface with the Software. virtual machine. Each product has its own ordering
code and license types. Unless otherwise stated,
Shrinkwrap License (SR). You may install and use
each Instance of a product must be separately
the Software in accordance with the terms and
licensed and ordered. For example, if the end user
conditions of the applicable license agreements, such
customer or Avaya Channel Partner would like to
as “shrinkwrap” or “clickthrough” license
install two Instances of the same type of products,
accompanying or applicable to the Software
then two products of that type must be ordered.
(“Shrinkwrap License”).
Third Party Components
“Third Party Components” mean certain software
Heritage Nortel Software
programs or portions thereof included in the Software
“Heritage Nortel Software” means the software that or Hosted Service may contain software (including
was acquired by Avaya as part of its purchase of the open source software) distributed under third party
Nortel Enterprise Solutions Business in December agreements (“Third Party Components”), which
2009. The Heritage Nortel Software is the software contain terms regarding the rights to use certain
contained within the list of Heritage Nortel Products portions of the Software (“Third Party Terms”). As
located at http://support.avaya.com/LicenseInfo/ required, information regarding distributed Linux OS
under the link “Heritage Nortel Products,” or such source code (for those products that have distributed
successor site as designated by Avaya. For Heritage Linux OS source code) and identifying the copyright
Nortel Software, Avaya grants Customer a license to holders of the Third Party Components and the Third
use Heritage Nortel Software provided hereunder Party Terms that apply is available in the products,
solely to the extent of the authorized activation or Documentation or on Avaya’s website at:
authorized usage level, solely for the purpose http://support.avaya.com/Copyright or such successor
specified in the Documentation, and solely as site as designated by Avaya. The open source
embedded in, for execution on, or for software license terms provided as Third Party Terms
communication with Avaya equipment. Charges for are consistent with the license rights granted in these
Heritage Nortel Software may be based on extent of Software License Terms, and may contain additional
activation or use authorized as specified in an order rights benefiting You, such as modification and
or invoice. distribution of the open source software. The Third
Party Terms shall take precedence over these
Software License Terms, solely with respect to the
Copyright applicable Third Party Components, to the extent that
these Software License Terms impose greater
Except where expressly stated otherwise, no use restrictions on You than the applicable Third Party
should be made of materials on this Site, the Terms.
Documentation, Software, Hosted Service, or
hardware provided by Avaya. All content on this The following applies only if the H.264 (AVC) codec
Site, the documentation, Hosted Service, and the is distributed with the product. THIS PRODUCT IS
product provided by Avaya including the selection, LICENSED UNDER THE AVC PATENT
arrangement and design of the content is owned PORTFOLIO LICENSE FOR THE PERSONAL
either by Avaya or its licensors and is protected by USE OF A CONSUMER OR OTHER USES IN
copyright and other intellectual property laws WHICH IT DOES NOT RECEIVE
including the sui generis rights relating to the REMUNERATION TO (i) ENCODE VIDEO IN
protection of databases. You may not modify, copy, COMPLIANCE WITH THE AVC STANDARD
reproduce, republish, upload, post, transmit or ("AVC VIDEO") AND/OR (ii) DECODE AVC
distribute in any way any content, in whole or in part, VIDEO THAT WAS ENCODED BY A
including any code and software unless expressly CONSUMER ENGAGED IN A PERSONAL
authorized by Avaya. Unauthorized reproduction, ACTIVITY AND/OR WAS OBTAINED FROM A
transmission, dissemination, storage, and or use VIDEO PROVIDER LICENSED TO PROVIDE
without the express written consent of Avaya can be AVC VIDEO. NO LICENSE IS GRANTED OR
a criminal, as well as a civil offense under the SHALL BE IMPLIED FOR ANY OTHER USE.
applicable law. ADDITIONAL INFORMATION MAY BE
OBTAINED FROM MPEG LA, L.L.C. SEE
Virtualization HTTP://WWW.MPEGLA.COM
Service Provider

May 2020 HealthCheck Tool Registration Feature Description 4

THE FOLLOWING APPLIES TO AVAYA intellectual property, trade secret, fraud, and music
CHANNEL PARTNER’S HOSTING OF AVAYA performance rights, in the country or territory where
PRODUCTS OR SERVICES. THE PRODUCT OR the Avaya product is used.
HOSTED SERVICE MAY USE THIRD PARTY
Preventing Toll Fraud
COMPONENTS SUBJECT TO THIRD PARTY
TERMS AND REQUIRE A SERVICE PROVIDER “Toll Fraud” is the unauthorized use of your
TO BE INDEPENDENTLY LICENSED telecommunications system by an unauthorized party
DIRECTLY FROM THE THIRD PARTY (for example, a person who is not a corporate
SUPPLIER. AN AVAYA CHANNEL PARTNER’S employee, agent, subcontractor, or is not working on
HOSTING OF AVAYA PRODUCTS MUST BE your company's behalf). Be aware that there can be a
AUTHORIZED IN WRITING BY AVAYA AND IF risk of Toll Fraud associated with your system and
THOSE HOSTED PRODUCTS USE OR EMBED that, if Toll Fraud occurs, it can result in substantial
CERTAIN THIRD PARTY SOFTWARE, additional charges for your telecommunications
INCLUDING BUT NOT LIMITED TO services.
MICROSOFT SOFTWARE OR CODECS, THE
AVAYA CHANNEL PARTNER IS REQUIRED TO Avaya Toll Fraud intervention
INDEPENDENTLY OBTAIN ANY APPLICABLE If You suspect that You are being victimized by Toll
LICENSE AGREEMENTS, AT THE AVAYA Fraud and You need technical assistance or support,
CHANNEL PARTNER’S EXPENSE, DIRECTLY call Technical Service Center Toll Fraud Intervention
FROM THE APPLICABLE THIRD PARTY Hotline at +1-800-643-2353 for the United States and
SUPPLIER. Canada. For additional support telephone numbers,
WITH RESPECT TO CODECS, IF THE AVAYA see the Avaya Support website:
CHANNEL PARTNER IS HOSTING ANY http://support.avaya.com, or such successor site as
PRODUCTS THAT USE OR EMBED THE G.729 designated by Avaya.
CODEC, H.264 CODEC, OR H.265 CODEC, THE Security Vulnerabilities
AVAYA CHANNEL PARTNER
ACKNOWLEDGES AND AGREES THE AVAYA Information about Avaya’s security support policies
CHANNEL PARTNER IS RESPONSIBLE FOR can be found in the Security Policies and Support
ANY AND ALL RELATED FEES AND/OR section of https://support.avaya.com/security
ROYALTIES. THE G.729 CODEC IS LICENSED Suspected Avaya product security vulnerabilities are
BY SIPRO LAB TELECOM INC. SEE handled per the Avaya Product Security Support
WWW.SIPRO.COM/CONTACT.HTML. THE Flow
H.264 (AVC) CODEC IS LICENSED UNDER THE (https://support.avaya.com/css/P8/documents/100161
AVC PATENT PORTFOLIO LICENSE FOR THE 515).
PERSONAL USE OF A CONSUMER OR OTHER
USES IN WHICH IT DOES NOT RECEIVE Trademarks
REMUNERATION TO: (I) ENCODE VIDEO IN The trademarks, logos and service marks (“Marks”)
COMPLIANCE WITH THE AVC STANDARD displayed in this Site, the Documentation, Hosted
("AVC VIDEO") AND/OR (II) DECODE AVC Service(s), and product(s) provided by Avaya are the
VIDEO THAT WAS ENCODED BY A registered or unregistered Marks of Avaya, its
CONSUMER ENGAGED IN A PERSONAL affiliates, its licensors, its suppliers, or other third
ACTIVITY AND/OR WAS OBTAINED FROM A parties. Users are not permitted to use such Marks
VIDEO PROVIDER LICENSED TO PROVIDE without prior written consent from Avaya or such
AVC VIDEO. NO LICENSE IS GRANTED OR third party which may own the Mark. Nothing
SHALL BE IMPLIED FOR ANY OTHER USE. contained in this Site, the Documentation, Hosted
ADDITIONAL INFORMATION FOR H.264 (AVC) Service(s) and product(s) should be construed as
AND H.265 (HEVC) CODECS MAY BE granting, by implication, estoppel, or otherwise, any
OBTAINED FROM MPEG LA, L.L.C. SEE license or right in and to the Marks without the
HTTP://WWW.MPEGLA.COM. express written permission of Avaya or the applicable
Compliance with Laws third party.

You acknowledge and agree that it is Your Avaya is a registered trademark of Avaya Inc.
responsibility for complying with any applicable laws All non-Avaya trademarks are the property of their
and regulations, including, but not limited to laws respective owners.
and regulations related to call recording, data privacy,

May 2020 HealthCheck Tool Registration Feature Description 5

Linux® is the registered trademark of Linus Torvalds
in the U.S. and other countries.
Downloading Documentation
For the most current versions of Documentation, see
the Avaya Support website: http://support.avaya.com,
or such successor site as designated by Avaya.
Contact Avaya Support
See the Avaya Support website:
http://support.avaya.com for product or Hosted
Service notices and articles, or to report a problem
with your Avaya product or Hosted Service. For a list
of support telephone numbers and contact addresses,
go to the Avaya Support website:
http://support.avaya.com (or such successor site as
designated by Avaya), scroll to the bottom of the
page, and select Contact Avaya Support.

May 2020 HealthCheck Tool Registration Feature Description 6

 Contents

Chapter 1. Introduction ............................................................................................ 8

Purpose ..................................................................................................................................................... 8
Glossary .................................................................................................................................................... 8

Chapter 2. Overview ................................................................................................. 9

HealthCheck Tool Overview...................................................................................................................... 9
HealthCheck Tool Landing page ............................................................................................................. 10
Supported Products ................................................................................................................................ 11
Sending Feedback for HealthCheck Tool ............................................................................................... 11

Chapter 3. HealthCheck Dashboard ...................................................................... 12

Viewing Site dashboard .......................................................................................................................... 12
HealthCheck dashboard field description ............................................................................................... 13
KPI Charts ...................................................................................................................................... 14
Assets............................................................................................................................................. 15

Chapter 4. HealthCheck Tests ............................................................................... 18

Creating a Test using Consolidated Dashboard ..................................................................................... 18
Creating a test ......................................................................................................................................... 19
Scheduling a test using Consolidated Dashboard .................................................................................. 20
Scheduling a test ..................................................................................................................................... 22
Managing a scheduled test ..................................................................................................................... 23

Chapter 5. HealthCheck Reports ........................................................................... 24

Viewing historical tests using SEID ......................................................................................................... 24
Viewing a detailed test report using Location ID ..................................................................................... 26
Comparing HealthCheck reports ............................................................................................................. 27

Chapter 6. Registration ............................................................................................... 28

Chapter 7. Resources ................................................................................................. 29

Documentation ........................................................................................................................................ 29
Support .................................................................................................................................................... 29
Using the Avaya InSite Knowledge Base................................................................................................ 29

May 2020 HealthCheck Tool Registration Feature Description 7

 Chapter 1. Introduction

Purpose
This document provides a high-level description of the Avaya HealthCheck Tool.
Avaya HealthCheck Tool is a Web-based tool that reduces the time required to diagnose errors
and faults in an Avaya system. HealthCheck Tool also evaluates the settings on the installed
Avaya products and reports misconfigurations.
The intended audience for this document are the Avaya customers, Business Partners, and
Avaya associates.

Glossary
Term Description
SAL Secure Access Link
TOB Technical Onboarding
ART Automatic Registration Tool
GRT Global Registration Tool
SEID Solution Element ID
FL no. Functional Location number (Location ID)
SSO Single Sign-On
SECode Solution Element Code

May 2020 HealthCheck Tool Registration Feature Description 8

 Chapter 2. Overview

HealthCheck Tool Overview

HealthCheck is a Web-based tool that you can use to validate connectivity and alarming on
certain Avaya products and run comprehensive configuration checks and assess the overall
health of a product. These checks can be done on a one-time, scheduled, or recurring basis.
The test results can be seen on the report page of the tool, and the report contains detailed
information on how to resolve the failure.
The new HealthCheck Tool Dashboard can be used to view the various KPIs related to the
functional location of a customer or Business Partner.
You can connect this tool to an Avaya product to gather configuration data and compare the
data to Avaya recommended settings. The tool then provides a structured report with
recommendations on those settings that do not match the Avaya recommended settings.
HealthCheck Tool provides the following capabilities :
• Registration: Users can get SEIDs for their products, onboard them to SAL Gateway,
and get the Connectivity/Alarming configured and tested using the Registration feature.
• Validate Connectivity: Ensures that the product can securely connect to Avaya for
remote troubleshooting and automated diagnostics.
• Validate Alarming: Tests remote monitoring to validate Avaya can receive alarms from
your product.
• Validate Configuration: Cross-checks product configuration against Avaya best
practices.
• Product Health: Executes diagnostic routines to provide a readout on overall system
health.
• Software Currency: Compares the currently installed version of the software against the
latest available
HealthCheck Tool automatically runs commands and analyzes the resulting information.
Depending on the system size, the tool takes 10 to 40 minutes to diagnose an error, while
manual checking of the same error takes up to 4 hours.

May 2020 HealthCheck Tool Registration Feature Description 9

HealthCheck Tool Landing page

Item Description
Site Dashboard
Load Consolidated Dashboard To view the KPIs, consolidated health
reports, and asset details.
View Registration by Registration ID To view the status of registration request
using the Registration ID.
View Historical Tests
View by SEID To search the tests run on a product based
on its SEID.
View by Site To search the tests run on a product based
on its Functional Location number.
My Tests
Create Test To select one or more products to run the

May 2020 HealthCheck Tool Registration Feature Description 10

 HealthCheck.
Manage Test Schedules To schedule a test to run recurringly.
View My Tests To view recent Healthcheck reports that you
have run.
Helpful Information
HealthCheck Test Guide Link to Using Avaya HealthCheck Tool KB
article.
HealthCheck Registration Guide Link to Avaya HealthCheck Tool Registration
feature description guide.
Supported Products To view the products supported by
HealthCheck Tool.
Submit HealthCheck Feedback To send feedback for HealthCheck Tool and
its functionalities.

Supported Products
The following are some of the products supported by the Avaya HealthCheck Tool for
Connectivity, Alarming, and HealthCheck functionality:
• Avaya Aura® Communication Manager
• Modular Messaging
• Call Management System
• Avaya Intuity Audix®
• Avaya Intuity Audix® LX
• Avaya Aura® Application Enablement Services
You can also use the HealthCheck Tool to resolve multiple issues simultaneously for the
following solution system settings:
• Communication Manager
• Avaya Aura® Messaging

For a complete list of supported products, log on to the HealthCheck Tool and Click Supported
Products from the Helpful Information section on the landing page.

Sending Feedback for HealthCheck Tool

To send a general feedback, query, suggestion, or complain regarding Avaya HealthCheck
Tool, follow the below procedure:
1. Log in to Avaya HealthCheck Tool using your SSO credentials.
2. On the landing page, in the Helpful Information section, click Submit HealthCheck
Feedback.
The system redirects you to your mailbox and opens a new mail addressed to the
HealthCheck administrator.

May 2020 HealthCheck Tool Registration Feature Description 11

 Chapter 3. HealthCheck Dashboard

Viewing Site dashboard

About this task

Use this task to view the performance and status of your assets.

Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure
- Go to Diagnostics & Tools menu
- Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, click Load Consolidated Dashboard from Site Dashboard.
3. On the Search Tests page, enter the Location ID (FL/Sold To number).

The system displays the HealthCheck Dashboard for the entered FL no.

May 2020 HealthCheck Tool Registration Feature Description 12

HealthCheck dashboard field description
The HealthCheck dashboard contains the following sections:

• Recommendation Section - To view the various recommendations for the user.

• KPI Chart Section - To view the various KPI charts for the assets under the Site.
• Asset Section - Assets under the Site are further categorized under Healthy, Unhealthy,
and Unregistered category. It also shows a “Product Map” section that shows a graphical
view of assets associated with the SAL Gateways under the Site.

May 2020 HealthCheck Tool Registration Feature Description 13

KPI Charts
KPI chart gives a graphical representation for the health and connectivity of the asset under the
Site.
The following charts are displayed:
Chart Description Color code
Connect Success Shows remote connectivity • Green: Success
health status of the assets • Red: Failed, Timeout
under the Site. • Black: Pending, In
Progress, All other cases
Alarm Health Shows alarming health status • Green: Success
of the assets under the Site. • Red: Failed, Timeout
• Orange: Not Entitled
• Black: Pending, In
Progress, All other cases
Health Check Shows the configuration • Green: Session
health status of the assets successful, no health
under the Site. issues found
• Purple: All other cases
• Blue: Test is not available
for the product
• Black: Duplicate Request,
Application already being
serviced
SAL Gateway Shows SAL Gateway health • Green: Healthy 3.x SAL
status of the assets under the Gateways
Site. • Red: Unhealthy SAL
Gateway
• Orange: Healthy 2.x SAL
Gateways
• Black: Not Available
Backup KPI Shows backup health status • Orange: HealthCheck
of the assets under the Site. Backup Failure
• Red: Backup Alarm
License KPI Shows license health status • Orange: HealthCheck
of the assets under the Site. License Failure
• Red: License Alarm
Entitlement KPI Shows entitlement health • Green: License expiry
status the assets under the date more than 90 days
Site. • Yellow: License expiry
date less than or equal to
90 days

May 2020 HealthCheck Tool Registration Feature Description 14

 • Orange: License expiry
date less than or equal to
60 days
• Red: License expiry date
less than 30 days
• Black: Unentitled
Software Currency Shows version health status • Green: Upto Date
of the assets under the Site. • Red: Version out of date
by 3 or more major
software releases
• Yellow: Version out of
date by 2 or fewer major
software releases
• Black: Unable to retrieve
version information
Software Support Policy Alert Shows software support • Green: Upto Date
policy alerts for the assets • Orange: Urgent upgrade
under the Site. may be needed. A link for
upgrade
• Red: Version out of date
by 3 or more major
software releases
Certificate KPI Shows certificate health • Green: Certificate expiry
status of the assets under the date for more than 90
Site. Currently covers only days
the certificate expiry of the • Yellow: Certificate expiry
web admin interface of the date less than or equal to
products. 90 days
• Orange: Certificate expiry
date less than or equal to
60 days
• Red: Certificate expiry
date less than 30 days

Assets
The asset section lists all the assets categorized into a Healthy, Unhealthy, and Unregistered
category. It also shows a Product Map, which can show a graphical view of assets associated
with the SAL Gateways under the Site.
The KPI details of the corresponding KPI chart selected are displayed under the Healthy Asset
tab. The table information changes depending on which KPI chart is selected.

May 2020 HealthCheck Tool Registration Feature Description 15

Field Description
HEALTHY ASSETS The latest test status (in the last 60 days) is
displayed for all connected products. The
status icon color codes:

• Green - Test completed successfully

• Yellow - Tests completed, but warnings
found
• Purple - One or more tests failed. Click
View for details
• Black - Test was not requested to run
• Blue - Test is not supported for the
product
• Grey - Test in progress

You can create or schedule a test for

selected assets.
UNHEALTHY ASSETS List of all unhealthy assets along with the error
code and link to the error details. You can click
ADD TO SAL to manage the device on SAL
Gateway.
You can create a test, refuse connectivity for
the asset, or mark the asset as not in service.
UNREGISTERED ASSETS List of unregistered devices under the Site.
You can also initiate the device registration.
VIEW PRODUCT MAP A graphical view of the assets associated with
the SAL Gateways under the Site.

Icon Description

May 2020 HealthCheck Tool Registration Feature Description 16

 Exports the list of assets in an excel sheet.

Edits the nickname of the asset and helps categorize the assets.
Displays detailed test report in a new screen.
Compares two or more HealthCheck reports.

Manages device administration for SAL gateway.

May 2020 HealthCheck Tool Registration Feature Description 17

 Chapter 4. HealthCheck Tests

Creating a Test using Consolidated Dashboard

About this task

Use this procedure to check your Avaya devices and generate health check reports to rectify the
errors in the devices.
You can generate a report using SEID or Location ID.
You can generate reports for single devices, multiple devices, or a list of devices exported from
a .CSV file.

Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, click Load Consolidated Dashboard from Site Dashboard.
3. On the Search Tests page, enter the Location ID (FL /Sold To number).
4. On the Site Dashboard Page, from the Healthy Assets section, select a device or
multiple devices for which you want to create a test.
5. Click Create Test.
6. On the Verify Information page, enter the Test Name and select one of the following
options:
a. Test Connectivity: To test the device connectivity
b. Test Connectivity and Alarming: To test connectivity and alarming functionalities
c. Test Connectivity, Alarming, and run a HealthCheck: To test all the functionalities
and run a health check
7. If your product supports, select the Attempt to fix test alarm failures check box. This
option initiates device onboarding to SAL Gateway again.

Note:
You can view the list of supported products using the Supported Products link

May 2020 HealthCheck Tool Registration Feature Description 18

 next to the field.

8. (Optional) You can select the Engage an Avaya engineer for failures on Connectivity
and Alarming Tests check box. This option creates a Service Request/Ticket and
assigns Avaya engineer for troubleshooting the failure.
9. Select the devices and enter the authentication credentials in either one of the following:
d. Service Login: Administrator login for ASG/EASG enabled product. This option is
disabled if you use the same credentials for the initial log in.
e. Customer credentials: Enter customer credentials for the Test to run
successfully.
10. Click Create Test.

The Test is created, and the system displays a confirmation message. You receive a
Test completion notification on the provided e-mail address within 30 minutes.
Alternatively, you can view the same in My tests menu on the home page.

Note:
1. For one asset, the Test takes approximately less than 30 minutes. The time taken for
the completion of the entire Test is based on the number of assets selected.
2. HealthCheck Tool analyzes the I/O on your server before running. If the I/O is too
high, HealthCheck aborts to prevent any performance impact.

Creating a test
Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to check your Avaya devices and generate health check reports to rectify the
errors in the devices.
You can generate a report using SEID or Location ID.
You can generate reports for single devices, multiple devices, or a list of devices exported from
a .CSV file.

Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

May 2020 HealthCheck Tool Registration Feature Description 19
 2. On the Home page, click Create Test from the My Tests section.
3. To generate a report, enter a value in one of the following fields:
a. Location ID
b. SEID
c. CSV file of SEIDs
4. Click Lookup Now.
You are navigated to the Consolidated Dashboard page.
5. From the Healthy Assets section, select a device or multiple devices for which you want
to create a test.
6. Click Create Test.
7. On the Verify Information page, enter the Test Name and select one of the following
options:
a. Test Connectivity: To test the device connectivity
b. Test Connectivity and Alarming: To test connectivity and alarming functionalities
c. Test Connectivity, Alarming, and run a HealthCheck: To test all the functionalities
and run a health check
8. If your product supports, select the Attempt to fix test alarm failures check box. This
option initiates device onboarding to SAL Gateway again.

Note:
You can view the list of supported products using the Supported Products link
next to the field.

9. (Optional) You can select the Engage an Avaya engineer for failures on Connectivity
and Alarming Tests check box. This option creates a Service Request/Ticket and
assigns Avaya engineer for troubleshooting the failure.
10. Select the devices and enter the authentication credentials in one of the following:
d. Service Login: Administrator login for ASG/EASG enabled product. This option is
disabled if you use the same credentials for the initial log in.
e. Customer credentials: Enter customer credentials for the Test to run
successfully.
11. Click Create Test.

The Test is created, and the system displays a confirmation message. You receive a
Test completion notification on the provided e-mail address within 30 minutes.
Alternatively, you can view the same in My tests menu on the home page.

Note:
1. For one asset, the Test takes approximately less than 30 minutes. The time taken for
the completion of the entire Test is based on the number of assets selected.
2. HealthCheck Tool analyzes the I/O on your server before running. If the I/O is too
high, HealthCheck aborts to prevent any performance impact.

Scheduling a test using Consolidated Dashboard

Before you begin

Ensure that you have the following:

May 2020 HealthCheck Tool Registration Feature Description 20

 • An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to schedule a recurring test at a particular interval of days and time.
Note:
The scheduled Test is automatically canceled if:
1. Asset becomes inactive.
2. Asset becomes unentitled.
3. Asset gets 5 back to back connectivity failures during the HealthCheck test.
Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, click Load Consolidated Dashboard from Site Dashboard.
3. On the Search Tests page, enter the Location ID (FL /Sold To number).
4. On the Site Dashboard Page, from the Healthy Assets section, select a device or
multiple devices to schedule a recurring test.
5. Click Create Schedule.
6. Enter a value in one of the following fields:
a. Location ID
b. SEID
c. Manage Schedules created by me
7. Click Lookup Now.
You are navigated to the Manage Schedules page.
8. Click Create New schedule. When prompted, enter a Location ID and click Lookup
Now.
9. Select a device or multiple devices for which you want to create a schedule and enter
values in the following fields:
a. Scheduled Time (GMT): Desired time for the next Test
b. Scheduled Interval: Desired number of days, weeks, or months for recurring Test
c. Enable E-mail Notification: Check box to enable e-mail notification
d. E-mail Notification: The desired e-mail address to receive notifications
e. Include HealthCheck: Check box to include a Health check
10. Click Create Schedule.
Systems display a confirmation message on your screen, and the same is notified to the
configured e-mail ID.

May 2020 HealthCheck Tool Registration Feature Description 21

Scheduling a test
Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to schedule a recurring test at a particular interval of days and time.
Note:
The scheduled Test is automatically canceled if:
1. Asset becomes inactive.
2. Asset becomes unentitled.
3. Asset gets 5 back to back connectivity failures during the HealthCheck test.
Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, click Manage Test Schedules from the My Tests section.
3. Enter a value in one of the following fields:
d. Location ID
e. SEID
f. Manage Schedules created by me
4. Click Lookup Now.
You are navigated to the Manage Schedules page.
5. Click Create New schedule. When prompted, enter a Location ID and click Lookup
Now.
6. Select a device or multiple devices for which you want to create a schedule and enter
values in the following fields:
f. Scheduled Time (GMT): Desired time for the next Test
g. Scheduled Interval: Desired number of days, weeks, or months for recurring Test
h. Enable E-mail Notification: Check box to enable e-mail notification
i. E-mail Notification: The desired e-mail address to receive notifications
j. Include HealthCheck: Check box to include a Health check
7. Click Create Schedule.
Systems display a confirmation message on your screen, and the same is notified to the
configured e-mail ID.

May 2020 HealthCheck Tool Registration Feature Description 22

Managing a scheduled test
Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to delete and edit an existing scheduled test.

Note:
The scheduled tests are automatically canceled if:
1. Asset becomes inactive.
2. Asset becomes unentitled.
3. Asset gets 5 back to back connectivity failures during the HealthCheck test.
Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, click Manage Test Schedules from the My Tests section.
3. Enter a value in one of the following fields:
a. Location ID
b. SEID
c. Manage Schedules created by me
4. Click Lookup Now.
You are navigated to the Manage Schedules page.
5. Select the schedule that you want to edit or delete.
6. (Optional) To edit the schedule, change the values of the following fields as desired and
click Update Schedule:
a. Scheduled Time (GMT)
b. Scheduled Interval
c. Enable E-mail Notification
d. Include HealthCheck?
7. (Optional) To delete the schedule, click Delete->Delete Schedules.
Systems display a confirmation message on your screen, and the same is notified to the
configured e-mail ID.

May 2020 HealthCheck Tool Registration Feature Description 23

 Chapter 5. HealthCheck Reports

Viewing historical tests using SEID

Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to view the list of all the tests and HealthCheck reports run on a device. You
can either search using SEID or Location ID.

Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
c. Go to Diagnostics & Tools menu
d. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, from the View Historical Tests section, click View by SEID.
3. Enter the SEID and click Search.
4. On the Tests with SEID Page, click the View icon to view the device detailed test
report.
The system displays the following details in the report in a new window:
• Test Information
• Connectivity test results with a description
• Alarming test results with a description
• Software version
• Configuration status with description. A link to Pass log details
• Product log and session details for Connectivity, Alarming, and HealthCheck

May 2020 HealthCheck Tool Registration Feature Description 24

 5. To download, click Download Report as PDF.
6. On the previous window, if you want to reinitiate the Test click the Test Again icon
7. Click Compare icon , if you want to compare two or more test reports.

May 2020 HealthCheck Tool Registration Feature Description 25

Viewing a detailed test report using Location ID
Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to schedule a recurring test at a particular interval of days and time.

Procedure

1. Log on to the HealthCheck Tool portal OR

Log on to the Avaya support site using the link www.support.avaya.com and follow the
below procedure:
a. Go to Diagnostics & Tools menu
b. Select HealthCheck Tool

The system directs you to the HealthCheck Tool home page.

2. On the Home page, from the Site Dashboard section, click Load Consolidated
Dashboard. OR
3. On the Home page, from the View Historical Tests section, click View by SEID.
4. On the Search Tests page, enter the Location ID (FL/Sold To number).
5. On the Site Dashboard Page, select the KPI chart for which you want to view the report.
6. From the Healthy Assets section, select a device.

Note:
To export the list of devices, click the Export file icon:
7. Click the view icon:

The system displays the following details in the report in a new window:
• Test Information
• Connectivity test results with a description
• Alarming test results with a description
• Software version
• Configuration status with description. A link to Pass log details
• Product log and session details for Connectivity, Alarming, and HealthCheck
8. (Optional) To download, click Download Report as PDF.
9. (Optional) On the previous window, click the Test Again icon to reinitiate the Test.
10. (Optional) Click the Compare icon , to compare two or more test reports.

May 2020 HealthCheck Tool Registration Feature Description 26

Comparing HealthCheck reports
Before you begin

Ensure that you have the following:

• An SSO account with a valid user ID and password registered with Avaya to log in.
• A Location ID (FL Number) of the device that you want to register.

About this task

Use this procedure to compare one or more Test

Procedure

1. Follow the Viewing historical tests using SEID or Viewing a detailed test report using
Location ID procedure to search and view the test reports.
2. On My Tests page, click Compare icon against the device SEID.
3. On the Compare HealthCheck Reports page, select the reports you want to compare
from the Report-1 and Report-2 drop-down field.
4. Click Show Difference.
The system displays the reports in two sections next to each other. The differences are
highlighted.
5. (Optional) Select Inline Diff. to view the differences in an inline view.

May 2020 HealthCheck Tool Registration Feature Description 27

Chapter 6. Registration

Please refer Avaya HealthCheck Tool Registration Feature Description guide for a detailed
description and instructions for registering devices, enabling SAL administration, and
connectivity/alarm testing functionality for Avaya HealthCheck Tool.

May 2020 HealthCheck Tool Registration Feature Description 28

 Chapter 7. Resources

Documentation
See Using HealthCheck Tool KB article, Avaya HealthCheck Tool Registration Feature
Description guide, and https://youtu.be/8SX3Dqk5ZKk for more details on Avaya HealthCheck
Tool.

Support
Go to the Avaya Support website at http://support.avaya.com for the most up-to-date
documentation, product notices, and knowledge articles. You can also search for release notes,
downloads, and resolutions to issues. Use the online service request system to create a service
request. Chat with live agents to get answers to questions, or request an agent to connect you
to a support team if an issue requires additional expertise.

Using the Avaya InSite Knowledge Base

The Avaya InSite Knowledge Base is a Web-based search engine that provides:
• Up-to-date troubleshooting procedures and technical tips
• Information about service packs
• Access to customer and technical documentation
• Information about training and certification programs
• Links to other pertinent information

If you are an authorized Avaya Partner or a current Avaya customer with a support contract, you
can access the Knowledge Base without extra cost. You must have a login account and a valid
Sold-To number.

Use the Avaya InSite Knowledge Base for any potential solutions to problems.

1. Go to http://www.avaya.com/support.
2. Log on to the Avaya website with a valid Avaya user ID and password.
The system displays the Avaya Support page.
3. Click Support by Product > Product Specific Support.
4. In Enter Product Name, enter the product, and press Enter.
5. Select the product from the list, and select a release.
6. Click the Technical Solutions tab to see articles.
7. Select relevant articles.

May 2020 HealthCheck Tool Registration Feature Description 29