User
Guide for
AMIS
and Enterprise Remote Site Error Reset
and
Enterprise
Diagnostic Test
This document provides the instructions for using the Error Reset and Enterprise Diagnostic Test Product Enhancement Package (PEP). This PEP provides the following functionality:
a. Reset a Site that had been put into error status
b. Initiate a diagnostic test, if the site is using the Enterprise Networking protocol
a. A new Network Status page that clearly displays any sites which are in error status. This page is accessed directly from the CallPilot menu.
b. The ability to reset sites directly from the Network Status screen.
c. The ability to run a diagnostic test either from the Network Status screen (for sites experiencing problems) or from the Server Properties page (when adding or modifying a site).
d. A new Test Results page to view the results of the diagnostic tests (instead of attempting to view them via the Event Browser screen).
e. Automatic updates on both the Error Reset and Test Results pages, allowing administrators to easily monitor error sites and diagnostic test results.
Background
CallPilot supports three networking protocols: AMIS, Enterprise and VPIM. AMIS and Enterprise are analog protocols where communication between CallPilot & Meridian Mail systems is achieved over the voice network. VPIM is an IP packet protocol carried over the data network. Because of the different natures of the voice network and the data network, the retry mechanisms between the two types of protocols are substantially different.
For the analog protocols, CallPilot attempts to send messages approximately every minute. If the connection to a remote system to which a message is destined fails in three consecutive delivery attempts, CallPilot puts the remote site into error state and stops sending messages to that site for 30 minutes. After 30 minutes, the site will be re-enabled. Again, if three consecutive delivery attempts fail, the site will be put into error state for another 30 minutes. This retry mechanism continues until either communication is re-established or all messages to the site have been staled out.
CallPilot Manager Interfaces
This section describes the new screens and interfaces for the Error Reset and Diagnostic Test.
New Network Diagnostics Link
A new Network Diagnostics link is now available under CallPilot Manager’s Main Menu – Messaging drop-down menu. This link will open the new Network Status page.
Figure 1.
Network Diagnostics Link

New
Network Status Page
After selecting the Network Diagnostics link, the Network Status page will appear. This page will display all the Enterprise remote sites. To check all disabled Enterprise and AMIS sites, click the radio button “Show disabled Enterprise and AMIS remote servers”. This Network Status page is refreshed automatically every 30 seconds in order to display the most up-to-date status.
Figure 2 shows an example of the Network Status page, when at least one site is in error (in this case, 2 sites are currently in error status).
Figure
2.
Network Status Page: Sites in Error State

As shown in figure 2, this page provides checkboxes beside every site listed as well as a checkbox to select all. Near the top, 3 buttons allow the administrator to either reset the selected sites, run a diagnostic on one site (only one must be selected or the button will be grayed out), or display the results of the diagnostic tests.
Clicking on one of the site names opens that site’s Server Properties page, providing easy access to the site’s networking properties for modification.
Figure
3.
Network
Status Page: No Sites in Error State

Figure 3 shows an example of the Network Status page, when there are no sites currently in error status. As shown, in this condition, the Network Status page only provides the administrator with the ability to view diagnostic test results.
Server Properties Page
As shown Figure 4 , a new button has been added to the server properties page allowing the administrator to save the server’s properties and run a diagnostic test. This is very useful when adding or modifying a site, since you can immediately test your changes. The button will be grayed out for non-Enterprise sites.
Figure
4.
Server Properties page with Save & Test button

Note: If an error occurs while trying to save the server’s networking properties (e.g. conflicting prefix or missing field), the diagnostic test will not be run.
Test Results Window
Whenever a diagnostic test is run, a new window will appear as shown in Figure 5 . This window is similar to the Event Browser page, except that only diagnostic events are displayed. This window refreshes automatically every 30 seconds.
Figure
5.
Test Results Window

By default, the Test Results page displays diagnostic events from the last 24 hours. A button at the top allows the administrator to view all diagnostic events in the event log. In addition to being able to review the results, this screen allows the administrator to save the results to a log file (diags.csv) to be viewed later.
Note: Each of the diagnostic events shown in this window can also be viewed from the Event Browser window. However, they are not presented as clearly in the Event Browser window.
Common Operations
This section describes common operations for the error reset and diagnostic test features.
Resetting a Site in Error State
Follow these steps to reset a site that is in error status (see Figure 6 ).
Figure
6. Resetting a site that is in Error Status.

1) Check the checkbox of the remote server you want to reset.
2) Click “Enable Selected” to reset the selected remote site. Selected remote site will be removed from site list.
Resetting
All Disabled Remote Sites
Follow these steps to reset all sites that is in error status (see Figure 7 ).
Figure
7.
Resetting all sites that are in Error Status.

1) Check the checkbox on the list header in order to check all boxes in the entire list.
2) Click “Enable Selected” to reset all disabled remote sites. ‘All remote servers are enabled.’ will be displayed.
Accessing
the Server Properties Page from the Network Status Page
Follow these steps to access the server properties page from the network status window.
1) From the Network Status page, click any error site name in the list (see Figure 2 ) and it will redirect the page to the corresponding Server Properties page.
2) The administrator can make changes for the remote site and click “save” to save the changes, or simply click “cancel”. After that, the window is redirected back to the Network Status page.
Note: that if the administrator clicks “save”, not only will the changes be saved, but the error status for that server will also be reset. As a result, the refreshed disabled site list will no longer contain this server.
Running
a Diagnostic Test
A diagnostic test can be initiated from either the Network Status page (if the site is in error state) or the Server Properties page (for any site).
Running a Diagnostic Test from the Network Status Page
Follow these steps to run a diagnostic test from the Network Status page.
Figure 8.
Running a diagnostic test from the network status page

1) Check the checkbox next to the remote site in the list (must be an Enterprise remote site) that you wish to run a diagnostic test on.
2) Click “Test Selected”. The Test Results window will pop up and a diagnostic test will be performed on the selected site.
Running
a Diagnostic Test from the Server Properties Page
Follow these steps to run a diagnostic test from the Server Properties page.
Figure 9.
Save & Test button

1) From the Server Properties page of the remote site you want to run a diagnostic test on, click “Save & Test”.
2) The Test Results window will pop up and a diagnostic test will be performed on the selected site.
Viewing
Diagnostic Results
Whenever a diagnostic test is run, the Test Results window will automatically pop up. If, however, the Test Results window has accidentally been closed, or the administrator wants to review previous diagnostic results, the Test Results window can also be launched without running a diagnostic test. This is also useful for tracking an incoming diagnostic test.
Figure 10.
Test Results button

1) Click “Test Results”. The Test Result window will pop up.
Diagnostic
Results
The following sections show what you can expect to view for a successful and unsuccessful diagnostic test.
Diagnostic Results for a
Successful Test
As shown in Figure 11 , a successful diagnostic test will display several lines in the Test Results window. It will end with a message stating that the diagnostic test completed successfully.
Note: messages are displayed in reverse chronological order so that the latest message is displayed at the top of the screen
Figure
11.
Successful Diagnostic Test

Table 1 describes in more detail each of the messages shown in a successful diagnostic test.
Table
1
Successful Test Events
|
Message |
Description |
|
Diagnostic Test queued for next session. |
A Diagnostic Test request has been recognized and queued to the scheduler. |
|
Outgoing Enterprise Diagnostic Test is starting. |
The scheduler has retrieved the Diagnostic Test request from the queue. |
|
Placing a call to the remote system. |
The local server is attempting to connect to one of the connection DNs of the remote site. |
|
Assuming the call has been answered. |
The configured delay period allowed for the remote site to answer has ended. |
|
Initiating the connection. |
C tone is sent to the remote site. |
|
The connection has been established. |
D tone was received from the remote server. |
|
Setting up the session. |
A Start Session frame is sent to the remote site. |
|
The session has been set up. |
A response frame indicating success was received. |
|
Sending the local site ID. |
A System Number frame, containing the local site ID, was sent to the remote site. |
|
The local site ID has been confirmed. |
A response frame indicating success was received. |
|
Sending the session information. |
A Protocol Extension frame, containing the remote site ID and initiating password, was sent to the remote site. |
|
Session information has been confirmed. |
A response frame indicating success and containing the responding password was received. |
|
Ending the session. |
An End of Session frame was sent to the remote site (no response frame expected). |
|
Diagnostic Test to remote system completed successfully. |
Diagnostic Test has ended successfully and the remote site is taken out of error state. |
Diagnostic Results for an
Unsuccessful Test
Figure 12 shows an example of a failed diagnostic test. In this case the initiating passwords were defined incorrectly.
Figure
12.
Failed Diagnostic Test

When a diagnostic test fails, one or more messages are displayed, ending with the failure message. The failure message will typically direct the administrator to the Event Browser to determine the fault reason. Additionally, the stage at which the fault occurred should provide the administrator with insight into how to correct the problem (see Table 2 ).
Table
2.
Miscellaneous Error Diagnostic Events
|
Message |
Description |
|
Outgoing Enterprise Networking is turned off. |
Outgoing Enterprise Networking is not enabled under Message Delivery Configuration |
|
Network messages to this site are turn off. |
Outgoing messages are turned off under either the local site’s Server Properties or the remote site’s Server Properties. |
|
No ports available for outgoing Enterprise Diagnostic Test. |
Either the system is experiencing high traffic, or the maximum number of channels for outgoing enterprise diagnostics is set too low (under SDN Details for Service DN OUTBOUND55). |
|
Enterprise Diagnostic Test already in progress. |
System is already running a diagnostic test to the selected remote site. |
|
Fault Event Code 54944 |
Call was answered but D tone was not received. Verify that connection DNs are correct. |
|
Fault Event Code 54945 |
Call was not answered. Verify that connection DNs are correct. |
|
Fault Event Code 54938 |
Local site ID was not recognized by the remote site (verify that the Site IDs match in the server properties pages at both sites). |
|
Fault Event Code 54905 |
Far end aborted session. Verify that the remote site has been configured as Enterprise in the server properties pages at the remote site. |
|
Fault Event Code 54938 |
Remote site ID sent did not match that of the remote site. Verify that the Site IDs match in the server properties pages at both sites. |
|
Fault Event Code 54906 |
Initiating password was incorrect. Verify that the Initiating Passwords match in the server properties pages at both sites. |
|
Fault Event Code 54907 |
Responding password was incorrect. Verify that the Responding Passwords match in the server properties pages at both sites. |
|
Diagnostic Test to remote system failed. |
Diagnostic Test has ended in failure and the remote site is put into error state. See Event Browser for fault details. |
Incoming Diagnostic Test
When a diagnostic test is received from a remote site, an event will be generated if it is successful (see Figure 13 ). This message can be seen from either the Test Results window or the Event Browser. Any failure messages will only show up in the Event Browser (because the receiving end has no way to determine that this is only a diagnostic test until the end of the test).
Figure
13.
Incoming Diagnostic Test
