2.2.4.121 GridViewData

Namespace: http://www.microsoft.com/performancepoint/scorecards

The GridViewData complex type specifies the data structure that represents the scorecard view.

The following diagram illustrates the scorecard view representation:

Figure 4: GridViewData

The GridViewData is mainly composed of two tree data structures representing all the row and column headers and a two dimensional array representing every possible interception between elements of those two trees.

The row and column header trees MUST be accessed by the properties RootRowHeader and RootColumnHeader respectively. The two dimensional array MUST be accessed by the Cells property.

 <xs:complexType name="GridViewData" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Cells" type="tns:GridCellSet"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RootRowHeader" type="tns:GridHeaderItem"/>
     <xs:element minOccurs="0" maxOccurs="1" name="RootColumnHeader" type="tns:GridHeaderItem"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ScorecardLocation" type="tns:RepositoryLocation"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DefaultRollupIndicatorLocation" type="tns:RepositoryLocation"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PreQueryTransforms" type="tns:ArrayOfGridViewTransformReference"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PostQueryTransforms" type="tns:ArrayOfGridViewTransformReference"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PreRenderTransforms" type="tns:ArrayOfGridViewTransformReference"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PerUserTransforms" type="tns:ArrayOfGridViewTransformReference"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PageFilters" type="tns:ArrayOfMember"/>
   </xs:sequence>
   <xs:attribute name="ScorecardViewId" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid" use="required"/>
   <xs:attribute name="Cached" type="xs:boolean" use="required"/>
   <xs:attribute name="CacheExpiration" type="xs:dateTime" use="required"/>
   <xs:attribute name="DefaultRollupIndicatorId" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid" use="required"/>
   <xs:attribute name="EmptyCell" type="xs:string"/>
   <xs:attribute name="InvalidCell" type="xs:string"/>
   <xs:attribute name="TIFormula" type="xs:string"/>
   <xs:attribute name="TICurrentDateTime" type="xs:string"/>
 </xs:complexType>

Cells: This is a two dimensional array as defined in the complex type GridCellSet (section 2.2.4.101). The array is indexed by two GridHeaderItem complex type objects (section 2.2.4.116). One representing a row header and one representing a column header. This element MUST contain one GridCell complex type object (section 2.2.4.100) for each possible intersection of a row header and a leaf column header.

RootRowHeader: Specifies the root element for the row header tree, as defined in GridHeaderItem.

RootColumnHeader: Specifies the root element for the column header tree, as defined in GridHeaderItem.

ScorecardLocation: Points to the scorecard object for which the GridViewData was created, as defined in the RepositoryLocation complex type (section 2.2.4.161).

DefaultRollupIndicatorLocation: Points to the default indicator for rollup calculated cells, as defined in RepositoryLocation.

PreQueryTransforms: Specifies a set of transform operations that are applied to the GridViewData just before getting data from the data sources (1) (see GridViewTransformReference section 2.2.4.123).

PostQueryTransforms: Specifies a set of transform operations that are applied to the GridViewData after getting data from the data sources(1) (see GridViewTransformReference).

PreRenderTransforms: Specifies a set of transform operations that are applied to the GridViewData prior to rendering the scorecard (see GridviewTransformReference). While all the other types of transform operations are applied once when the GridViewData is generated, the pre-render and per-user transforms are applied every time the scorecard is rendered, even if the GridViewData object is not new.

PerUserTransforms: This element is deprecated and MUST NOT be used.

PageFilters: Specifies a collection of members used to slice the scorecard values, as defined in ArrayOfMember (section 2.2.4.45).

ScorecardViewId: GUID that identifies the ConfiguredView complex type (section 2.2.4.77) instance associated with the scorecard pointed to by ScorecardLocation.

Cached: This attribute MUST be FALSE if the GridViewData is new, or TRUE if it was retrieved from a caching mechanism.

CacheExpiration: Specifies when the GridViewData object becomes invalid.

DefaultRollupIndicatorId: GUID used as the identifier for the indicator that is used by default for rollup calculated cells.

EmptyCell: Specifies the default text used as the display test for empty cells.

InvalidCell: Specifies the default text used as the display test for invalid cells.

TIFormula: Specifies the value passed from an external time intelligence filter connected to the scorecard TI Formula endpoint (see Scorecard.EndPoints section 2.2.4.162). If set, it represents the Simple Time Period Specification formula that is used by the scorecard query engine to filter KpiMeasure complex types (section 2.2.4.129) uniformly independent of data source. If it is null or empty, the default time intelligence filter of the KPI is applied, if one is defined.

TICurrentDateTime: Specifies the value passed from an external time intelligence filter connected to the scorecard Current Date Time endpoint (see Scorecard.EndPoints). If set, it represents the Simple Time Period Specification (STPS) dateTime that is used by the scorecard query engine to evaluate KpiMeasures that contain a time intelligence filter. If not set, the current date time of the server (2) is used by the scorecard query engine to evaluate KpiMeasures if a time intelligence filter is defined.