2.2.4.18 Annotation

  • Article

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

The Annotation complex type associates a collection of comments to a cell in a particular slice of a scorecard. An annotation is created using CreateAnnotation operation (section 3.1.4.1), and updated using the UpdateAnnotation operation (section 3.1.4.70).

 <xs:complexType name="Annotation" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="Comments" type="tns:ArrayOfAnnotationComment"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Properties" type="tns:ArrayOfBpmProperty"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Owner" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="LastUpdatedBy" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Slice" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="CreatedOn" type="xs:dateTime"/>
     <xs:element minOccurs="1" maxOccurs="1" name="LastUpdatedOn" type="xs:dateTime"/>
     <xs:element minOccurs="0" maxOccurs="1" name="ScorecardLocation" type="tns:RepositoryLocation"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ConfiguredViewID" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Guid" xmlns:s1="http://microsoft.com/wsdl/types/" type="s1:guid"/>
     <xs:element minOccurs="0" maxOccurs="1" name="CellpathCoordinates" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Version" type="tns:AnnotationVersions"/>
   </xs:sequence>
 </xs:complexType>

Comments: Specifies the comment collection contained by the annotation. This element MUST conform to the schema of the ArrayOfAnnotationComment complex type (section 2.2.4.21).

Properties: Specifies the properties of the annotation. This element MUST conform to the schema of the ArrayOfBpmProperty complex type (section 2.2.4.23).

Owner: Specifies the identity of the person responsible for the creation of the annotation. This element MUST be present. The value MUST NOT be empty, and MUST NOT consist of only whitespace characters.

LastUpdatedBy: Specifies the last person to update the annotation. This element MUST be present.

Slice: Specifies an aggregation context of the PageFilters element as defined in the GridViewData complex type (section 2.2.4.121) corresponding to the cell or cells in the scorecard for which this annotation is applicable. The value MUST be a sorted string of page filter member names, where each member name in the string is separated by a comma. The page filter member names are sorted using the current UI culture.

CreatedOn: Specifies the dateTime at which this annotation instance was created.

LastUpdatedOn: Specifies the dateTime at which this annotation was last updated.

ScorecardLocation: Specifies the location of the scorecard referenced by this annotation. This element MUST be present. This element MUST conform to the schema of the RepositoryLocation complex type (section 2.2.4.161).

ConfiguredViewID: Specifies the identity of the ConfiguredView complex type (section 2.2.4.77) for this annotation. This element MUST be formatted as a GUID and its value MUST NOT be {00000000000-0000000-00000-0000000}.

Guid: Specifies the identity for this annotation. This element MUST be formatted as a GUID and its value MUST NOT be {00000000000-0000000-00000-0000000}.

CellpathCoordinates: Specifies the coordinates of the scorecard cell that this annotation is associated with. The value MUST be the MD5 hash of the dimension values of all the headers of a cell, sorted by their dimension names. This value MUST NOT be null or empty. The header cells MUST conform to the schema of GridHeaderItem complex type (section 2.2.4.116). This value for the checked cell in the following example scorecard is calculated as follows:

All Geographies

Oregon

Washington

Actual

Target

Actual

Target

Actual

Target

Internet Order Quantity

Accessories

X

Bikes

Clothing

  • The column and row headers for the cell are extracted and are used to compute the CellPathCoordinates for the cell. The CellPathCoordinates is a collection of headers of the cell and is computed as follows:

    1. For each row and column header of the cell its parent path is computed and represented as a collection of headers.

    2. The corresponding path is then reversed and appended to the CellPathCoordinates.

    3. The CellPathCoordinates for the checked cell is shown in the following table. The DimensionValue, DimensionName and DisplayText values of the GridHeaderItem complex type (section 2.2.4.116) for each header cell in the CellPathCoordinates are also listed in the table.

    GridHeaderItem

    DimensionValue

    DimensionName

    DisplayText

    Row Header Parent

    "/PerformancePoint/Lists/PerformancePoint Content/10_.000"

    "Scorecard_"

    "Internet Order Quantity"

    Row Header

    "[Product].[Category].&[4]"

    "Product.Category"

    "Accessories"

    Column Header Parent’s Parent

    "[Geography].[State-Province].[All Geographies]"

    "Geography.State-Province"

    "All Geographies"

    Column Header Parent

    "[Geography].[State-Province].[All Geographies]"

    "Geography.State-Province"

    ""

    Column Header

    "Actual"

    "Scorecard_Measures_"

    "Actual"

  • A sorted dictionary containing one entry per element in the CellPathCoordinates is then created.

  • The sorted dictionary key is the header.DimensionName concatenated with header.Guid. The corresponding value in the dictionary is the header.DimensionValue.

  • The dictionary keys MUST be sorted alphabetically in ascending order.

  • The string representation of the coordinates of the path is then created by concatenating each of the values in the dictionary. This value for the example is:

    • "[Geography].[State-Province].[All Geographies][Geography].[State-Province].[All Geographies][Product].[Category].&[4]/PerformancePoint/Lists/PerformancePoint Content/10_.000Actual"

  • A MD5 hash value (128-bit number) represented as a 32-digit hexadecimal number. The final output is the string "2BB92D0CE8F91E3E5FA5FB402EEE0E5C".

Version: Specifies the product version used to create this annotation. This element MUST conform to the schema of the AnnotationVersions simple type (section 2.2.5.6).