Troubleshooting Media Connectivity Issues
Several classes have been added for Microsoft Unified Communications Managed API (UCMA) 3.0 that can be used to provide information on call failures due to media connectivity errors. These classes can help to alert administrators of potential deployment problems.
MediaTroubleshootingDataReportedEventArgs Class
The MediaTroubleshootingDataReportedEventArgs class provides troubleshooting data to the application, regarding a media connectivity error that involves a remote, external Microsoft Lync 2010 call (a corporate user who is not logged into the corporate network).
An application can register a handler for the MediaTroubleshootingDataReported event on the AudioVideoCall class. The second parameter of the handler is of type MediaTroubleshootingDataReportedEventArgs.
The MediaChannelEstablishmentDataCollection property on a MediaTroubleshootingDataReportedEventArgs instance returns a list of MediaChannelEstablishmentData instances.
Media Connectivity Troubleshooting
After the call terminates, determine whether there was a media connectivity problem by checking the EstablishmentStatus property on a MediaChannelEstablishmentData object. An EstablishmentStatus value of Failed indicates there was a problem, while a value of Succeeded indicates that media establishment occurred successfully.
If the value of the EstablishmentStatus property is Failed, the application can call the GetDiagnosticsReason method to obtain diagnostics information. The GetDiagnostics method returns a value of the MediaChannelEstablishmentDiagnosticsReason enumeration.
If the value returned by GetDiagnosticsReason is either MediaEdgeAuthenticationServiceDiscoveryFailed or MediaEdgeAuthenticationServiceCredentialsAquisitionFail, raise “Alert 1”.
If the value returned by GetDiagnosticsReason is MediaEdgeResourceAllocationFailed, raise “Alert 2”.
The following are suggested alert messages for these two alerts.
Alert 1: “Lync Server 2010 calls involving remote users (located outside the Enterprise) might be failing using the current Lync Server 2010 Audio/Video Edge resources. Please contact the appropriate administrator and verify that the Lync Server 2010 Audio/Video Authentication Service is properly configured and operational.”
Alert 2: “Lync Server 2010 calls involving remote users (located outside the Enterprise) might be failing using the current Lync Server 2010 Audio/Video Edge resources. Please contact the appropriate administrator and verify that the Lync Server 2010 Audio/Video Edge is properly configured and operational.
Note
An application should implement a throttling mechanism based on specific alert keys so that warnings do not flood the system.