3.1.4 Message Processing Events and Sequencing Rules

This section specifies the server (2) operations.

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

Operation

Description

CreateAnnotation

The CreateAnnotation operation is used to create an Annotation complex type (section 2.2.4.18) on the server (2).

CreateDashboard

The CreateDashboard operation is used to create a Dashboard complex type (section 2.2.4.79) on the server (2).

CreateDataSource

The CreateDataSource operation is used to create a DataSource complex type (section 2.2.4.85) on the server (2).

CreateFilter

The CreateFilter operation is used to create a Filter complex type (section 2.2.4.98) on the server (2).

CreateIndicator

The CreateIndicator operation is used to create an Indicator complex type (section 2.2.4.125) on the server (2).

CreateKpi

The CreateKpi operation is used to create a Kpi complex type (section 2.2.4.128) on the server (2).

CreateReportView

The CreateReportView operation creates a ReportView complex type (section 2.2.4.160) on the server (2).

CreateScorecard

The CreateScorecard operation creates a Scorecard complex type (section 2.2.4.162) on the server (2).

DeleteAnnotation

The DeleteAnnotation operation deletes an Annotation complex type (section 2.2.4.18) from the server (2).

DeleteDashboard

The DeleteDashboard operation deletes a Dashboard complex type (section 2.2.4.79) from the server (2).

DeleteDataSource

The DeleteDataSource operation deletes a DataSource complex type (section 2.2.4.85) from the server (2).

DeleteFilter

The DeleteFilter operation deletes a Filter complex type (section 2.2.4.98) from the server (2).

DeleteIndicator

The DeleteIndicator operation deletes an Indicator complex type (section 2.2.4.125) from the server (2).

DeleteKpi

The DeleteKpi operation deletes a Kpi complex type (section 2.2.4.128) from the server (2).

DeleteReportView

The DeleteReportView operation deletes a ReportView complex type (section 2.2.4.160) from the server (2).

DeleteScorecard

The DeleteScorecard operation deletes a Scorecard complex type (section 2.2.4.162) from the server (2).

ExportDashboard

The ExportDashboard operation<23> is used to export dashboard pages and their associated content from the server (2) into a specified Deployment Package ([MS-PRIMEPF]).

GenerateView

The GenerateView operation generates the data structure that represents a scorecard grid view, the GridViewData complex type (section 2.2.4.121), based on information stored on the server (2).

GenerateViewDirect

The GenerateViewDirect operation generates the data structure that represents a scorecard grid view (see GridViewData complex type, section 2.2.4.121), using information sent from the client.

GetAllAnnotationsByScorecardLocation

The GetAllAnnotationsByScorecardLocation operation retrieves an array of Annotation complex type elements (section 2.2.4.18) associated with a scorecard.

GetAnalyticReportView

The GetAnalyticReportView operation retrieves a report view from the server (2) that has been created through the SaveTemporaryAnalyticReport (section 3.1.4.65) or CreateReportView (section 3.1.4.7) operation.

GetAnnotation

The GetAnnotation operation retrieves an Annotation complex type (section 2.2.4.18) associated with a scorecard cell from the server (2).

GetAnnotationByID

The GetAnnotationByID operation retrieves an Annotation complex type (section 2.2.4.18) from a specified GUID from the server (2).

GetAnnotationSetting

The Attribute Groups operation retrieves an AnnotationSetting complex type object (section 3.1.4.24.3.1) that contains the annotation settings for the server (2).

GetAsKpis

The GetAsKpis operation takes in an Analysis Services data source along with a server-relative URL to a Kpi complex type (section 2.2.4.128) list (1), and returns a collection of Kpis as defined in the ArrayOfKpi complex type (see section 2.2.4.41).

GetCube

The GetCube operation takes in a RepositoryLocation complex type object (section 2.2.4.161), and returns the associated Cube complex type object (section 2.2.4.78).

GetCubeFromDataSource

The GetCubeFromDataSource operation takes in a data source object and returns the associated Cube complex type object section 2.2.4.78().

GetCubeMetaData

The GetCubeMetaData operation takes in an Analysis Services RepositoryLocation complex type object (section 2.2.4.161) and returns the associated Cube complex type object (section 2.2.4.78).

GetCubeMetaDataForDataSource

The GetCubeMetaDataForDataSource operation takes in an Analysis Services data source object and returns the associated Cube complex type object (section 2.2.4.78). This operation is valid for Analysis Services data sources only.

GetCubeNameInfos

The GetCubeNameInfos operation retrieves an ArrayOfNameInfo complex type (section 2.2.4.48) that describes the cubes of the data source (1).

GetCurrentCultureLcid

The GetCurrentCultureLcid operation retrieves the current culture locale identifier.

GetCurrentUserInfo

The GetCurrentUserInfo operation retrieves the user name and display name information of the current user.

GetDashboard

The GetDashboard operation retrieves a dashboard.

GetDatabaseNamesFromDataSource

The GetDatabaseNamesFromDataSource operation retrieves an array of database names associated with the data source (1).

GetDataSource

The GetDataSource operation retrieves a data source (1).

GetDependentElements

The GetDependentElements operation retrieves from the server (2) all FirstClassElement complex types (section 2.2.4.99) associated with a list (1) of repository locations. In addition, all FirstClassElements that are related by reference are also included in the response. For example, for a requested scorecard, all Kpis, Indicators, and DataSources that the scorecard depends on will also be retrieved.

GetDimensions

The GetDimensions operation retrieves an array of dimension objects.

GetDimensionsFromDataSource

The GetDimensionsFromDataSource operation retrieves an array of dimension objects (see section 2.2.4.90).

GetFilter

The GetFilter operation retrieves a Filter complex type (section 2.2.4.98).

GetIndicator

The GetIndicator operation retrieves an Indicator complex type (section 2.2.4.125) from the server (2).

GetKpi

The GetKpi operation retrieves a Kpi complex type object (section 2.2.4.128).

GetKpisFromScorecard

The GetKpisFromScorecard operation retrieves an array of Kpi complex type objects (section 2.2.4.128) associated with a scorecard.

GetLatestAnalyticReportVersion

The GetLatestAnalyticReportVersion operation retrieves from the server (2) the version number for a report view that has been created through SaveTemporaryAnalyticReport operation (section 3.1.4.65).

GetListItems

The GetListItems operation retrieves all FirstClassElements complex types (section 2.2.4.99) associated with a given repository list (1) from the server (2).

GetMdx

The GetMdx operation retrieves an MDX that can be used to query data sources for the given analytic report. The Analytic Chart and Analytic Grid report view types contain custom data that is used to generate MDX queries. See the ReportView complex type (section 2.2.4.160) for more detail.

GetParameterDisplayData

The GetParameterDisplayData operation builds a template data table containing only the columns produced by a specific parameter type. The referred parameter represents a specific kind of connection between two Web Parts. The resulting DataTable (as described in [DataTable]) represents an empty sample of the information that gets passed on that connection.

GetPreviewDataSet

The GetPreviewDataSet method retrieves a data set from a data source, which is suitable for previewing results.

GetQueryResultMembers

The GetQueryResultMembers operation retrieves an array of members (2) associated with the specified report.

GetRegisteredCustomFCOs

The GetRegisteredCustomFCOs operation retrieves custom object definitions registered on the server (2).

GetReportView

The GetReportView operation retrieves a ReportView complex type (section 2.2.4.160) from the server (2).

GetScorecard

The GetScorecard operation retrieves a Scorecard complex type (section 2.2.4.162).

ImportDashboard

The ImportDashboard operation<24> is used to import content from a specified Deployment Package ([MS-PRIMEPF]) to the server (2).

QueryChildMembers

The QueryChildMembers operation uses a data source for the specified member, and returns a collection of members.

QueryChildMembersByRangeFromDataSource

The QueryChildMembersByRangeFromDataSource operation queries the DataSource complex type (section 2.2.4.85), and returns a collection of child members.

QueryChildMembersFromDataSource

The QueryChildMembersFromDataSource operation uses the data source to retrieve a collection of child members for the specified member name.

QueryDimensionRootMembers

The QueryDimensionRootMembers operation uses a data source (1) from the repository location for the specified member, and returns a collection of root members.

QueryDimensionRootMembersFromDataSource

The QueryDimensionRootMembersFromDataSource method uses the data source to retrieve a collection of root members for the specified member name.

QueryNamedSets

The QueryNamedSets operation is used to retrieve the named sets that are defined by a data source (1) when given the RepositoryLocation complex type (section 2.2.4.161) of the data source (1).

QueryNamedSetsFromDataSource

The QueryNamedSetsFromDataSource operation is used to retrieve the named sets that are defined by the given data source (1).

QueryRelatedMember

The QueryRelatedMember operation is used to retrieve a member (2) having the specified relationship to the specified member from the data source (1) at the given RepositoryLocation complex type (section 2.2.4.161).

QueryRelatedMemberFromDataSource

The QueryRelatedMemberFromDataSource operation queries the given data source (1) for the member (2) having the specified relationship to the specified member.

QueryTimeIntelligence

The QueryTimeIntelligence operation queries a data source (1) location for the members (2) that are specified by a time intelligence formula.

QueryTimeIntelligenceDirect

The QueryTimeIntelligenceDirect operation queries the provided data source (1) for the members (2) that are specified by a time intelligence formula.

QueryTransformMembers

The QueryTransformMembers method transforms any collection of Member complex types (section 2.2.4.134) into a new member collection based on the operation passed on the transformType parameter of the QueryTransformMembers element (section 3.1.4.64.2.1) as specified in section 3.1.4.64.4.1.

SaveTemporaryAnalyticReport

The SaveTemporaryAnalyticReport operation stores a temporary copy of a ReportView complex type (section 2.2.4.160) to the server (2).

TestConnection

The TestConnection operation is used to determine whether a connection as specified by the dataSource element can be established.

TrimAnnotationByOwner

The TrimAnnotationByOwner operation removes all the Annotation complex types (section 2.2.4.18) that are owned by a specific user.

TrimAnnotationByScorecardLocation

The TrimAnnotationByScorecardLocation operation removes all the annotations that belong to a scorecard at a specific location.

TrimAnnotationUntouchedSince

The TrimAnnotationUntouchedSince operation removes all the Annotation complex types (section 2.2.4.18) that haven’t been updated since the specified date.

UpdateAnnotation

The UpdateAnnotation operation updates an existing Annotation complex type (section 2.2.4.18).

UpdateDashboard

The UpdateDashboard operation updates an existing Dashboard complex type (section 2.2.4.79).

UpdateDataSource

The UpdateDataSource operation updates an existing DataSource complex type (section 2.2.4.85).

UpdateFilter

The UpdateFilter operation is used to update the existing filter as specified by the Filter complex type object (section 2.2.4.98) in the UpdateFilter input element (section 3.1.4.73.2.1).

UpdateIndicator

The UpdateIndicator operation is used to update the existing Indicator as specified by the Indicator complex type object (section 2.2.4.125) in the UpdateIndicator input element (section 3.1.4.74.2.1).

UpdateKpi

The UpdateKpi operation is used to update the existing KPI as specified by the Kpi complex type object (section 2.2.4.128) in the UpdateKpi input element (section 3.1.4.75.2.1).

UpdateReportView

The UpdateReportView operation is used to update the existing report view as specified by the ReportView complex type object (section 2.2.4.160) in the UpdateReportView input element (section 3.1.4.76.2.1).

UpdateScorecard

The UpdateScorecard operation is used to update the existing scorecard as specified by the Scorecard complex type object (section 2.2.4.162) in the UpdateScorecard input element (section 3.1.4.77.2.1).

ValidateKpi

The ValidateKpi operation checks whether a KPI stored on the server (2) is valid.

ValidateScorecard

The ValidateScorecard operation checks if a scorecard stored on the server (2) is valid.

ValidateSiteCollection

The ValidateSiteCollection operation is used to check if the context site has the server (2) feature installed.