entity-descriptors Schema
EntityDescriptor Element
entity-descriptors Schema : EntityDescriptor Element

Glossary Item Box

Description

The metadata on an entity type.
Namespace (none)

Diagram

TablePrefix Element Attributes Element IsSiteEntity Element ExtensionName Element HierarchicalRootId Element SupportsStorage Element SupportsTextSearch Element SupportsSubtypes Element SupportsVC Element SupportsDataHidingFilter Element SupportsWorkflow Element SupportsMultiValue Element SupportsHistory Element Label Element Name Element Table Element Sequence EntityDescriptor Element

Overview

EntityDescriptor
The metadata on an entity type.
Sequence
Table xs:string
The name of the database table containing the entity.
Name xs:string
The logical name of the entity.
Label xs:string
The display name. The display name can be customized and localized.
SupportsHistory xs:boolean
A value of Y indicates that this entity's fields can be customized in the user interface to support history.
SupportsMultiValue xs:boolean
A value of Y indicates that this entity's fields can be customized in the user interface to support multiple values.
SupportsWorkflow xs:boolean
A value of Y indicates that events on this entity can be handled in the workflow module.
SupportsDataHidingFilter xs:boolean
A value of Y indicates that this entity's fields can be part of a data hiding filter.
SupportsVC xs:boolean
A value of Y indicates that versions of this entity can be saved if version control is enabled for the project.
SupportsSubtypes xs:boolean
A value of Y indicates that there can be subtypes of this entity.
SupportsTextSearch xs:boolean
A value of Y indicates that this entity's fields are support text search.
SupportsStorage xs:boolean
A value of Y indicates that this entity supports storage.
HierarchicalRootId optional xs:int
The ID of the root element for hierarchical Entities
ExtensionName optional xs:string
The name of the extension if the descriptor applies to an extension.
IsSiteEntity xs:boolean
A value of Y indicates that the entity can be shared between projects.
Attributes
A collection of attributes primarily for use by extensions. ALM does not use values created by extension.
TablePrefix xs:string
The prefix for database table containing the entity.

Source

<xs:element name="EntityDescriptor" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
                The metadata on an entity type.
            </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="Table" />
      <xs:element ref="Name" />
      <xs:element ref="Label" />
      <xs:element ref="SupportsHistory" />
      <xs:element ref="SupportsMultiValue" />
      <xs:element ref="SupportsWorkflow" />
      <xs:element ref="SupportsDataHidingFilter" />
      <xs:element ref="SupportsVC" />
      <xs:element ref="SupportsSubtypes" />
      <xs:element ref="SupportsTextSearch" />
      <xs:element ref="SupportsStorage" />
      <xs:element ref="HierarchicalRootId" minOccurs="0" />
      <xs:element ref="ExtensionName" minOccurs="0" />
      <xs:element ref="IsSiteEntity" />
      <xs:element ref="Attributes" />
      <xs:element ref="TablePrefix" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

See Also