Names Used in the Metadata Web Service

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Entities, attributes, and relationships have several different names.

The following table describes the various names that are used in the metadata.

Name Description
Display Name The name that is displayed to the user.
Display Collection Name A plural version of the display name. This only applies to entities.
Logical Name The unique name of the class or property created in the Web Services Description Language (WSDL). This name is all lowercase.

The logical name is the name that is most widely used when you use the SDK.

Note that a custom entity, attribute, or relationship has a prefix in the format described following this table.

Schema Name The schema name is specified upon creation. It must be unique. It is used to create the logical name. This name should be in Pascal case.

If it is a custom entity, attribute or relationship, it has a prefix in the format described following this table.

The schema name and logical name for custom entities, attributes, relationships and for many-to-many relationship intersect tables have a maximum total length of 50 and must use the following format:


You must construct the name including the prefix to set the name values for use in the metadata create methods. For the prefix (the characters before the underscore) you can use the prefix defined in the organization.schemanameprefix property. The prefix must have between 2 and 8 characters.

The schema name should be in Pascal case. This is not enforced, but it is the convention followed by Microsoft Dynamics CRM and will make it easer to differentiate the various types of names found in the metadata. The schema name is converted to all lowercase for the logical name.

The following table shows the limits allow for the various names used in the metadata.

Property Maximum number of characters without the concatenated characters
AttributeMetadata.SchemaName 41
AttributeMetadata.SchemaName used in the CreateOneToManyRequest.Lookup property which results in the OneToManyRelationship.ReferencingAttribute property 33

The lookup attribute is created using this schema name + "yominame".

EntityMetadata.DisplayName 82

A saved query (view) is automatically created using the display name + " Advanced Find View". The limit of this saved query name is 100 characters. Be sure to use the string for the correct language.

EntityMetadata.SchemaName 39

The primary key attribute is created automatically using this schema name + "id".

EntityMetadata.SchemaName used in the CreateManyToManyRequest.IntersectEntityName property, which results in the ManyToManyMetadata.IntersectEntityName property 39

The primary key attribute for the intersect table is created automatically using this schema name + "id".

RelationshipMetadata.SchemaName 41

See Also



Other Resources

© 2010 Microsoft Corporation. All rights reserved.