CommonEvent Class

  • Article

CommonEvent Class

Abstract:  Yes
Raised by:  Not applicable
Base Class:  BaseEvent
Derived Classes:   AdministrativeEvent, DeveloperMessageEvent, HttpCacheHitEvent, DiagnosticEvent, LatencyEvent, SaltInterpreterEvent, TIMEvent 

The abstract CommonEvent class defines the core set of properties for classes implemented by the Microsoft Speech Server event log schema.

Note  Of particular interest is the SpeechContext property, and the information about the ApplicationInstance, PageUri, and RequestID that it contains. For more information, see the section following this table.

CommonEvent implements the following properties:

Property

Type

Description

AppDomainName

String

The friendly name for the application domain.

EventLogEntryTypeID

Integer

A Windows event log type identifier. (Error = 1, Warning = 2, Information = 4, SuccessAudit = 8, or FailureAudit = 16).

EventSchemaVersion

String

Version information for the event schema assembly.

EventSequenceNumber

Long

An incrementing sequence number for each event raised from a specific event source instance. Use this field in combination with the EventSourceInstance property, to uniquely identify an event.

EventSourceInstance

String

A GUID that represents a unique identifier for each event source instance.

EventSourceName

String

The name of the event source where the event was raised.

MachineName

String

The name of the computer where the event was raised.

ServiceProvider

IServiceProvider

A string identifying the internal MSS component that logged the event.

SpeechContext

SpeechContext

Contains the ApplicationInstance, RequestID and PageUri, if implemented in the derived class.

TimeStamp

DateTime

The event timestamp (date and time information for when the event was raised).

SpeechContext

The SpeechContext property contains several fields that are relevant when analyzing a user session, that is, the results of a particular telephone call to the SALT application.

  • ApplicationInstance

    This field consists of a unique string (generally a GUID) identifying the application session. A session begins when a SALT interpreter instance is assigned to the incoming (or outgoing) telephone call, and ends generally when the call does. All events generated in handling that call have the same ApplicationInstance.

    (One exception to this is the AudioLogEvent, which is not derived from CommonEvent. AudioLogEvent implements an ID property that corresponds to the RequestID field of SpeechContext.)

  • RequestID

    Again, this field is of type string, but generally contains a GUID. When Speech Engine Services (SES) makes a speech recognition or output request, it generates a RequestID that Telephony Application Services (TAS) then uses to populate this field. RequestID is therefore useful for tracing individual requests from SES; for instance, the MSSContentExtract tool uses the value for RequestID in the SALT Listen element to associate a recorded audio file with the phone call during which it was created.

  • PageUri

    PageUri is the URL of the application web page currently being processed by the SALT interpreter. This field is populated by SES when possible, and for all events raised by TAS that pertain directly to call handling.

See Also

Event Logging Class Hierarchy | Logging and Analyzing Events