LyncDiagnostics element (Lync SDN Interface 2.1.1)

The root element for output from the Lync SDN Manager.

Element information

Element type

MessageType

Namespace

Schema file

LyncSDNInterface.Schema.C.xsd

Definition


    <xs:element name="LyncDiagnostics"  type="MessageType">
    
    </xs:element>
  

Elements and attributes

If the schema defines specific requirements, such as sequence, minOccurs, maxOccurs, and choice, see the definition section.

Parent elements

None.

Child elements

Element

Type

Description

Bye

ByeType

Event that a Sip call has ended and all media stream terminated.

ConnectionInfo

ConnectionInfoType

Connection-related properties regardless of the media stream and end points.

Ended

EndedType

Event that a Sip call has ended and all media stream terminated.

Error

ErrorType

This event is optional. Error event that a SIP dialog has failed. Error events are also sent for SIP calls that are terminated even before a media stream is started or for failed to be updated.

InCallQuality

QualityType

Indicates that a significant quality related event occured in the client. Either the quality dropped into another level or improved. There are 3 levels: Good, Poor, Bad. The media stack determines the quality level. Furthermore, this event is also sent when a video stream is deescalated. Even in an issue free network at least one IncallQuality message is sent.

Invite

InviteType

Event that an endpoint attempts to establish a call. LDL will include this element in its output if the sendcallinvites entry is set to True (activated) in the LDL configuration file. In addition, LDL will also notifies any SIP Invite messages (re-invites), not just the first one. Following this message Earlymedia may be flowing but this element is not intended to report on early media streams.

Properties

MessageProperties

Details of the Error or reason for ending the streams.

QualityUpdate

QualityType

Specifies the event that a call has ended and contains a report of the quality metrics of individual media streams. These quality metrics for a stream may include updates provided by both endpoints which are merged.

RawSDP

xs:string

Raw Session Description Protocol (SDP) data that is included as the payload of the underlying SIP messages of the Invite, LRSInvite and StartOrUpdate type, if the sendrawsdp entry is set to True in the LDL configuration file.

Route

RouteType

Network path of the media stream only provided in Lync 2013 and when the traceRoute feature is activated in Lync.

Start

StartOrUpdateType

Event that a media stream is started. Every Start element contains a report about a particular media stream. This event is raised when the call is established, i.e., when the call is picked up and the SIP INVITE is answered with a 200 OK response.

Update

StartOrUpdateType

Event that a media stream previously started has been updated. This event is raised when an update to core parameters of call have changed and the change is established, i.e., when the request is answered with a 200 OK response.

Attributes

Attribute

Type

Required

Description

Possible values

Version

xs:string

optional

Version number of this data structure. It provides a simple distinction between LyncDiagnostics messages formats. LyncDiagnostics message matching to this xsd use Version C.

Values of the xs:string type.