GroupBy Schema
GroupByHeader Element
GroupBy Schema : GroupByHeader Element

Glossary Item Box

Namespace (none)

Diagram

GroupByHeader Element Sequence GroupByHeader Element

Overview

GroupByHeader
Name required xs:string
The name of the field on which the entities are grouped.
Value required
The value of the field for this group. If the group-by field is a reference to another entity, this is the ID of the referenced entity.
Expression required
An expression that can be used in a filter.
ReferenceValue optional
If the group-by field is a reference to data from another entity, this is a value of the referenced field. For group-by fields that contain data of this entity, this attribute is meaningless.
size required xs:integer
The number of entities in the group.
Sequence
GroupByHeader optional

Attributes

NameTypeUseDefaultFixedDescription
Namexs:stringrequired  The name of the field on which the entities are grouped.
Value required  The value of the field for this group. If the group-by field is a reference to another entity, this is the ID of the referenced entity.
Expression required  An expression that can be used in a filter.
ReferenceValue optional  If the group-by field is a reference to data from another entity, this is a value of the referenced field. For group-by fields that contain data of this entity, this attribute is meaningless.
sizexs:integerrequired  The number of entities in the group.

Source

<xs:element name="GroupByHeader" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="GroupByHeader" minOccurs="0">
        <xs:annotation>
          <xs:documentation>
                A group header.
            </xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="Name" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
              The name of the field on which the entities are grouped.
          </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Value" use="required">
      <xs:annotation>
        <xs:documentation>
              The value of the field for this group. If the group-by field is a reference to another entity, this is the ID of the referenced entity.
          </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Expression" use="required">
      <xs:annotation>
        <xs:documentation>
                   An expression that can be used in a filter. 
                   </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="ReferenceValue">
      <xs:annotation>
        <xs:documentation>
            If the group-by field is a reference to data from another entity, this is a value of the referenced field. For group-by fields that contain data of this entity, this attribute is meaningless.
        </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="size" type="xs:integer" use="required">
      <xs:annotation>
        <xs:documentation>
              The number of entities in the group.
          </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

See Also