Endpoint Monitor - Administration and Configuration Guide

Sangoma’s Endpoint Monitor application allows for monitoring and reporting on the status of Business Voice and Business Voice+ communication endpoints, like desktop phones, softphones, etc.

This guide is written for Endpoint Monitor administrators. It provides step-by-step instruction on how to monitor endpoints and configure alerts that will be sent out to defined contacts.

If your Business Voice + system was installed before September 21, 2021, additional initial configuration will be required for the Endpoint Monitor applications to receive events from your Starbox.

To access the Endpoint Monitor application follow these steps:

1. To open the Endpoint Monitor application Click Here.

1. Login using your Sangoma Business Voice portal credentials.

1. If you have purchased multiple applications select the Endpoint Monitor application in the Applications panel on the left side.

The dashboard is the first page that appears after logging into the Endpoint Monitor.

Validates that the selected configuration is working successfully.

1. Select the desired configuration to review.

1. Select how many days of data to display (Today, Yesterday or Last 30 days).

The following KPIs are displayed.

1. Sent Type - This graph displays how many alerts were sent by SMS or Email, for the selected configuration.

1. Alerts by Hour - This graph displays how many alerts were received by hour of the day, for the selected configuration.

1. Total Alerts - This is a graphical view of all alerts for the selected configuration.

The information below describes the different monitoring lists that can be viewed in the Endpoint Monitor application. Clicked the desired list from the side panel on the left. Each list may have multiple pages of data.

1. To display more or less rows per page, change the value of the “Rows per page” field at the bottom of the list.

1. To display different pages:
   1. |> First Page.
   1. > Next Page.
   1. < Previous Page.
   1. |< Last Page.

This option displays a list of all devices that have become unregistered based on the selected configuration. Select the desired configuration and the following list will be displayed.

Date / Time	Extension	Device Name	Location	Location Prefix	Event
June 16, 2022, 9:30 AM	1234	Joe Johnson	My Loc 1		Unregistered
June 16, 2022, 9:45 AM	1234	Joe Jones	My Loc 2		Unregistered

1. Date / Time - Date and time the event took place.

1. Extension - Extension number that had the event.

1. Device Name - Extension Name.

1. Location - The name of the location.

1. Location Prefix - The prefix for the location.

1. Event - Explanation of what happened.

This option provides a history of all notifications that have been sent out over the past 30 days.

Date	Name	Devices	Notified
June 16, 2022, 9:30 AM	Daily Summary	List Devices	List who was Notified
June 17, 2022, 9:30 AM	Daily Summary	List Devices	List who was Notified

1. Date - Date and time the event took place.

1. Name - Name of the configuration that triggered the alert.

1. Devices - Provides a link that when clicked displays the information that was sent out in the notification.

1. Notified - Provides a link that when clicked displays a list of the people that were notified.

This option provides a history of endpoint events over the past 30 days based on the selected configuration. Select the desired configuration and the following list will be displayed.

Date / Time	Extension	Device Name	Location	Location Prefix	Event
June 16, 2022, 9:30 AM	1234	Joe Jones	Sangoma HQ		Registered
June 16, 2022, 9:45 AM	1234	Joe Jones	Sangoma HQ		Unregistered

1. Date / Time - Date and time of the event.

1. Extension - Extension that had the event.

1. Device Name - Extension Name.

1. Location - The name of the location.

1. Location Prefix - The phone prefix for the location.

1. Event - Explanation of what happened.

To display the details of an Endpoint in an alert, hover over the desired Alert and click the (i) icon.

The following section explains how to configure notifications.

To add a new Configuration

1. Select the Configurations option in the Workspaces panel on the left side.

1. Click the      +  Configuration    button at the top right corner of the Configurations page.

1. Create the desired configuration using the instructions below.

1. Click the    Save    button at the bottom of the form to save the changes.

To edit an existing Configuration:

1. Select the Configurations option in the Workspaces panel on the left side.

1. From the list of configurations, hover over the configuration to be edited and click on the Pencil/Edit icon that appears on the far right side of the row.

1. Make the desired configuration changes based on the Configuration Instructions below.

1. Click the    Save    button at the bottom of the form to save the changes.

To delete an existing configuration:

1. Select the Configurations option in the Workspaces panel on the left side.

1. From the list of configurations, hover over the configuration to be deleted and Click on the Trash Can icon that appears on the far right side of the row.

1. Click    Delete    in the pop-up screen to confirm the deletion.

1. To cancel the deletion, click Cancel in the pop-up screen.

To deactivate or reactivate a configuration:

1. Select the Configurations option in the Workspaces panel on the left side.

1. From the list of configurations, hover over the configuration to be deactivated and Click on the Pencil/Edit icon that appears on the far right side of the row.

1. To deactivate a configuration, in the Status field select Inactive.

1. To reactivate a configuration, in the Status field select Active.

1. Click the    Save    button at the bottom of the form to save your changes.

The following describes how to create Endpoint activity notifications.

Note: Required fields are denoted with a red *.

1. Name * - Enter the name of the configuration.

1. Description * - Enter a description of this configuration.

1. SMS # * - This is the SMS number that will send out alerts via text message. Enter the Text messaging number that has been assigned to this license.

1. Status - Set Active or Inactive if you don’t want this configuration to be monitoring at this time.

1. What Should be monitored * - Select all endpoints or Specific locations and/or devices. If you select the later option, you will be required to add Locations and/or Extensions.
   1. Locations:(Only visible if “Specific locations and/or devices” was selected)
      1. Create an entry for each location that is to be monitored.
      1. To Add an additional Location, click the      +  Location    button.
         1. In the location dropdown field, select the location to be monitored.
         1. Click the    Add    button to save the entry.
         1. Click the    Cancel    button to back out of the changes.
   1. Extensions:(Only visible if “Specific locations and/or devices” was selected)
      1. Create an entry for each Extension that is to be monitored.
      1. To Add an additional Extension , click the      +  Extension    button.
         1. In the Extension dropdown field, select the Extension to be monitored.
         1. Click the    Add    button to save the entry.
         1. Click the    Cancel    button to back out of the changes.

1. Who to notify:
   1. Create an entry for each person that is to be sent a notification.
   1. To Add an additional Contact, click the      +  Contact    button.
      1. Name * - Enter a name for the person to be notified.
      1. Email or Phone * - If the person is to be notified via email enter the person's email address. If the person is to be notified via text enter the person's SMS number. Click the    Add    button to save the entry.
   1. Click the    Cancel    button to back out of the changes.

1. Notification Settings:
   1. Custom Notification - Select this option if the contacts are to be notified when an endpoint has been offline for more than a configured amount of time.
      1. Minutes offline - Select how long a device must be offline in order for it to be included in the report.
      1. Ignore Softphones? - Set to Yes to ignore softphones.
   1. Daily Snapshot - By selecting this option the contacts will receive a list of all endpoints that are offline/unregistered at the time the report is generated. A notification will only be sent out if there are offline endpoints in the report.
      1. Time to send report - Select or enter what time of the day a report should be sent out.the time. Note: all times use the Coordinated Universal Time (UTC) as the time zone.
      1. Ignore Softphones? - Set to Yes to ignore softphones. No to include softphones in the report.
   1. Daily Summary- By selecting this option the contacts will receive a list of all endpoint activities, including both offline/unregistered and online/registered events for each day.
      1. Time to send report - Select or enter what time of the day a report should be sent out.the time. Note: all times use the Coordinated Universal Time (UTC) as the time zone.
      1. Ignore Softphones? - Set to Yes to ignore softphones. No to include softphones in the report.

1. SMS - Enter the text message that is to be included along with the list of events that will be sent to the contacts that are to be notified.

1. Email - Enter the email subject and the email message that is to be included along with the list of events that will be sent to the contacts that are to be notified.