Microsoft.Office.Server.Search.Analytics namespace
SharePoint 2013
The Microsoft.Office.Server.Search.Analytics namespace exposes a timer job, AnalyticsJobDefinition, which is responsible for performing analysis lifecycle tasks for two analyses: SearchAnalyticsJob and SearchReportsJob. AnalyticsJobBase is the base class from which all analysis jobs inherit from, such as SearchAnalyticsJobBase; SearchAnalyticsJob and SearchReportsJob inherit from SearchAnalyticsJobBase.
Lifecycle tasks include starting, stopping, pausing and resuming an analysis job when requested. Lifecycle tasks also include clearing the analysis cache if needed as well as implementing the analysis failure model.
| Class | Description | |
|---|---|---|
 | AnalyticsJobBase | Provides a base class for analysis jobs. |
| AnalyticsJobDefinition | SharePoint timer job for handling the different analysis jobs. An instance of this class will start any registered instances of AnalyticsJobBase on a regular basis. |
| SearchAnalyticsJob | Handles the search analytics analysis. This class inherits from AnalyticsJobBase. An instance of AnalyticsJobDefinition will try to run an instance of SearchAnalyticsJob, based on a configured schedule. |
| SearchAnalyticsJobBase | Base class for analysis jobs. This base class includes some additional implementations related to AnalyticsJobBase. |
| SearchReportsJob | Handles the Search Reports analysis. Class inherits from AnalyticsJobBase. An instance of AnalyticsJobDefinition will try to run an instance of SearchReportsJob, based on a configured schedule. |
| ServiceNotFoundException | The exception that is thrown when an instance of IAnalysisEngineAgent cannot be found or resolved. |
| UsageAnalyticsJobDefinition | Handles analysis for usage analytics, which is an analysis of how users interact with search results. |
| UsageAnalyticsJobException | The exception that is thrown when an instance of UsageAnalyticsJobDefinition encounters class specific failures during its scheduled run. |
| Interface | Description | |
|---|---|---|
 | IAnalyticsServiceApplication |
| Enumeration | Description | |
|---|---|---|
 | AnalyticsEventTypes | A filter used for retrieving event types in the analytics system. |
 | SearchAnalyticsJobBase.NextAnalysisRunSchedule | Represents an enumeration that can be used to specify when to schedule the next analysis job run. |
