3.1.4 Message Processing Events and Sequencing Rules

The following table summarizes the list of operations as defined by this specification.

Operation

Description

CreateAnnotation

Used to create an Annotation on the protocol server. Specified in [MS-PPSAS].

CreateDataSource

Used to create a DataSource on the protocol server. Specified in [MS-PPSAS].

CreateNavigationMetadata

The CreateNavigationMetadata operation is used to generate a JavaScript representation of hierarchical cube metadata for a given report DataSource.

CreateReportHtml

The CreateReportHtml operation is used to generate an HTML fragment and associated JavaScript for a given list item.

DecompAutoExpand

The DecompAutoExpand operation is used to get additional node data for a specific node, where named actions are not known.

DecompCreateNavigationList

Returns a list of named actions for use with the navigationItemUniqueName element of the Expand operation, as specified in [MS-PPSDECO] section 3.1.4.2.3.1.

DecompExpand

The DecompExpand operation<4> is used to get additional node data for a specific node, using a named action.

DecompGetMemberProperties

Returns properties associated with a specified node, as specified in [MS-PPSDECO] section 3.1.4.4.3.1.

DecompStartAnalyze

The DecompStartAnalyze operation is used to perform a drilldown query on an OLAP data cell.

DeleteAnnotation

Deletes an Annotation from the protocol server. Specified in [MS-PPSAS].

DeleteDataSource

Deletes a DataSource from the protocol server. Specified in [MS-PPSAS].

ExportReport

The ExportReport operation retrieves a report formatted as specified in [MS-XLSX] or [MS-PPTX] from the protocol server.

ExportScorecard

The ExportScorecard operation retrieves a report formatted as specified in [MS-XLSX] or [MS-PPTX] from the protocol server.

GenerateView

Generates the data structure that represents a scorecard grid view based on information stored on the server. Specified in [MS-PPSAS].

GenerateViewDirect

Generates the data structure that represents a scorecard grid view using information sent from the client. Specified in [MS-PPSAS].

GetAllAnnotationsByScorecardLocation

Retrieves an array of Annotation elements associated with a scorecard. Specified in [MS-PPSAS].

GetAnalyticReportView

Retrieves a report view from the protocol server that has been created through SaveTemporaryAnalyticReport or CreateReportView. Specified in [MS-PPSAS].

GetAnnotation

Retrieves an Annotation associated with a scorecard cell from the protocol server. Specified in [MS-PPSAS].

GetAnnotationByID

Retrieves an Annotation from a specified GUID from the protocol server. Specified in [MS-PPSAS].

GetAnnotationSetting

Retrieves an AnnotationSetting object that contains the annotation settings for the protocol server. Specified in [MS-PPSAS].

GetAsKpis

Takes in an Analysis Services DataSource along with a server-relative URL to the KPI list and returns a collection of KPIs as defined in ArrayOfKpi. Specified in [MS-PPSAS].

GetCube

Takes in a RepositoryLocation object and returns the associated cube object. Specified in [MS-PPSAS].

GetCubeFromDataSource

Takes in a DataSource object and returns the associated cube object. Specified in [MS-PPSAS].

GetCubeMetaData

Takes in an Analysis Services RepositoryLocation object and returns the associated cube object. Specified in [MS-PPSAS].

GetCubeMetaDataForDataSource

Takes in an Analysis Services DataSource object and returns the associated cube object. Specified in [MS-PPSAS].

GetCubeNameInfos

Retrieves an ArraryOfNameInfo that describes the cubes of the DataSource. Specified in [MS-PPSAS].

GetDatabaseNamesFromDataSource

Retrieves an array of database names associated with the DataSource. Specified in [MS-PPSAS].

GetDataSource

Retrieves a DataSource. Specified in [MS-PPSAS].

GetDependentElements

Retrieves from the server all FirstClassElements associated with a list of repository locations. Specified in [MS-PPSAS].

GetDimensions

Retrieves an array of dimension objects. Specified in [MS-PPSAS].

GetDimensionsFromDataSource

Retrieves an array of dimension objects. Specified in [MS-PPSAS].

GetDrillThroughPreview

The GetDrillThroughPreview operation is used to perform a drill through query on an OLAP data cell.

GetFilterDependencies

The GetFilterDependencies operation retrieves the required external dependencies for rendering a filter.

GetFilterDisplayData

The GetFilterDisplayData operation retrieves a data table of filter display data from the protocol server.

GetKpisFromScorecard

Retrieves an array of Kpi objects associated with a scorecard. Specified in [MS-PPSAS].

GetLatestAnalyticReportVersion

Retrieves from the protocol server the version number for a report view that has been created through SaveTemporaryAnalyticReport. Specified in [MS-PPSAS].

GetListItems

Retrieves all FirstClassElements associated with a given repository list from the server. Specified in [MS-PPSAS].

GetMdx

Retrieves a Multidimensional Expressions (MDX) expression that can be used to query data sources for the given analytic report. Analytic Chart and Analytic Grid report view types contain custom data that is used to generate MDX queries. Specified in [MS-PPSAS].

GetParameterDisplayData

Builds a template DataTable (empty DataTable) containing all the columns produced by a specific parameter type. The referred parameter represents a specific kind of connection between two Web Parts. The resulting DataTable represents an empty sample of the information that gets passed on that connection.

GetParameterMessageData

The GetParameterMessageData operation retrieves a DataTable (as described in [DataTable]) containing all of the selected values of a parameter.

GetPreviewDataSet

Retrieves a data set from a DataSource, which is suitable for previewing results. Specified in [MS-PPSAS].

GetQueryResultMembers

Retrieves an array of members associated with the specified report. Specified in [MS-PPSAS].

GetRegisteredCustomFCOs

Retrieves custom First Class Object (FCO) definitions registered on the server. Specified in [MS-PPSAS].

GetRemainingParameterDisplayData

The GetRemainingParameterDisplayData operation<5> retrieves an object of type ParameterGetRemainingResultRecord (section 3.1.4.10.3.1) that contains the filter’s display data values beyond the limit setting imposed by the protocol server. The limit setting is specified by the TreeViewControlMaxNumRecordsToRender key in Settings (section 2.2.4.18).

GetRemainingSearchResults

The GetRemainingSearchResults operation <6> retrieves an object of type ParameterSearchResultRecord (section 2.2.4.15), which contains the search result values beyond the limit setting imposed by the protocol server. The limit setting is specified by the TreeViewControlMaxNumRecordsToRender key in Settings (section 2.2.4.18).

GetRenderControlPreview

The GetRenderControlPreview operation is used when a control is HTML rendered directly to the report preview page that is rendered within the report designer. The report control preview rendering has its own enabled feature set. Additionally, the report control preview does not accept parameters from Web Part connections.

GetReportDependencies

The GetReportDependencies operation retrieves the required external dependencies for rendering a report.

GetReportViewImageData

The GetReportViewImageData operation is a request to retrieve a report control image data. An analytic chart report is an example of where its chart view image data is retrieved from.

GetScorecardDependencies

The GetScorecardDependencies operation retrieves the required external dependencies for rendering a scorecard.

GetSetting

The GetSetting operation retrieves a configuration setting.

GetSettings

The GetSettings operation retrieves all configuration settings (section 2.2.4.18).

GetSettingValue

The GetSettingValue operation retrieves the current value of a configuration setting.

GetStrategyMapReportView

The GetStrategyMapReportView operation retrieves a report view from the server that has been created through SaveTemporaryStrategyMapReport (section 3.1.4.28).

MaintenanceJob

The MaintenanceJob operation is used to start maintenance tasks (database cleanup jobs, for example).

QueryChildMembers

Uses a DataSource for the specified member and returns a collection of members. Specified in [MS-PPSAS].

QueryChildMembersByRangeFromDataSource

Queries the DataSource and returns a collection of child members. Specified in [MS-PPSAS].

QueryChildMembersFromDataSource

Uses the DataSource to retrieve a collection of child members for the specified member name. Specified in [MS-PPSAS].

QueryDimensionRootMembers

Uses a DataSource from the repository location for the specified member and returns a collection of root members. Specified in [MS-PPSAS].

QueryDimensionRootMembersFromDataSource

Uses the DataSource to retrieve a collection of root members for the specified member name. Specified in [MS-PPSAS].

QueryNamedSets

Retrieves the named sets that are defined by a DataSource when given the RepositoryLocation of the DataSource. Specified in [MS-PPSAS].

QueryNamedSetsFromDataSource

Retrieves the named sets that are defined by the given DataSource. Specified in [MS-PPSAS].

QueryRelatedMember

Retrieves a member that is related to the specified member by the specified relationship from the DataSource at the given RepositoryLocation. Specified in [MS-PPSAS].

QueryRelatedMemberFromDataSource

Queries the given DataSource for the member that is related to the specified member by the specified relationship. Specified in [MS-PPSAS].

QueryTimeIntelligence

Queries a DataSource location for the members that are specified by a time intelligence formula. Specified in [MS-PPSAS].

QueryTimeIntelligenceDirect

Queries a DataSource location for the members that are specified by a time intelligence formula. Specified in [MS-PPSAS].

QueryTransformMembers

Transforms a collection of members into a new set of member collection based on the operation passed on the transformation type parameter. Specified in [MS-PPSAS].

RenderFilter

The RenderFilter operation generates HTML (as specified by [HTML]) for a specific filter stored on the protocol server. The protocol client specifies which filter is to be rendered, and other parameters that affect the result’s HTML content.

RenderReport

The RenderReport operation generates HTML markup for a specific report stored on the protocol server. The protocol client specifies which report is to be rendered, and other parameters that affect the result’s HTML content.

RenderScorecard

The RenderScorecard operation generates HTML markup for a specific scorecard stored on the protocol server. The protocol client specifies which scorecard is to be rendered, and other parameters that affect the result’s HTML content.

RenderScorecardAjaxControl

The RenderScorecardAjaxControl operation generates scorecard web control HTML markup for a specific list item stored on the protocol server. The client specifies which list item is to be rendered, which Web control to use to render it, and other parameters that affect the result’s HTML content.

RenderTreeMemberSelector

The RenderTreeMemberSelector operation is deprecated from the protocol and SHOULD NOT<7> be used.

ReportSupportsExportFormat

The ReportSupportsExportFormat operation determines whether a report supports the specified export format.

SaveFilterValues

The SaveFilterValues operation saves the state of selections made for a given filter.

SaveTemporaryAnalyticReport

Stores a temporary copy of a report view to the server. Specified in [MS-PPSAS].

SaveTemporaryStrategyMapReport

The SaveTemporaryStrategyMapReport operation stores a temporary copy of a report view to the server. See SaveTemporaryAnalyticReport i [MS-PPSAS] section 3.1.4.65.

ScorecardSupportsExportFormat

The ScorecardSupportsExportFormat operation checks whether a scorecard supports the specified export format.

SearchParameterDisplayData

The SearchParameterDisplayData operation <8> retrieves an object of type ParameterSearchResultRecord (section 2.2.4.15) that represents the filter’s display data values that contain the specified search term.

TestConnection

Determines whether a connection as specified by the DataSource element can be established.    Specified in [MS-PPSAS].

TrimAnnotationByOwner

Removes all the Annotations that are owned by a specific user.  Specified in [MS-PPSAS].

TrimAnnotationByScorecardLocation

Removes all the Annotations that belong to a scorecard at a specific location. Specified in [MS-PPSAS].

TrimAnnotationUntouchedSince

Removes all the Annotations that haven’t been updated since the specified date. Specified in [MS-PPSAS].

UpdateAnnotation

Updates an existing Annotation. Specified in [MS-PPSAS].

UpdateDataSource

Updates an existing DataSource. Specified in [MS-PPSAS].

UpdateSettingValue

The UpdateSettingValue operation modifies the current value of a configuration setting.

ValidateKpi

Determines whether a KPI stored on the server is valid. Specified in [MS-PPSAS].

ValidateScorecard

Determines whether a scorecard stored on the server is valid.  Specified in [MS-PPSAS].

ValidateSiteCollection

The ValidateSiteCollection operation <9> is used to check if the context site has the server feature installed.