Share via


Entity Element in Entities (BDCMetadata Schema)

Applies to: SharePoint Server 2010

Specifies an external content type.

Namespace: https://schemas.microsoft.com/windows/2007/BusinessDataCatalog

Schema: BDCMetadata

<Entity Namespace = "String" Version = "String" EstimatedInstanceCount = "Integer" DefaultOperationMode = "String" Name = "String" DefaultDisplayName = "String" IsCached = "Boolean"> </Entity>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute

Description

Namespace

Required.

The namespace that this external content type belongs to.

Attribute type: String

Note

The namespace should not contain the special character "*".

Version

Required.

The version number of this external content type.

Attribute type: String

Warning

When the BDC model changes, you must increase the version number of the external content type. If the structure of an external content type changes, you should increase the major number. Examples of structural changes include adding a field to a SpecificFinder or changing an identifier field. If the change does not affect the structure of the external content type, for example, when adding a creator method, changing connection information, or when changing names of LobSystems and type descriptors, you should change the build number and revision number.

EstimatedInstanceCount

Optional.

The estimated number of external items contained by the external system.

Default value: 10000

Attribute type: Integer

DefaultOperationMode

Optional.

Specifies the default behavior when interacting with the external system while creating, deleting, updating, or reading external items.

Default value: Default

The following table lists the possible values for this attribute.

Value

Description

Online

Bypass the cached external items for all operations and interact with the external system directly.

Cached

Perform Create, Read, Update, and Delete operations directly against the cached external items. For Read operations, if the requested external items are available in the cache, use the external items in the cache. Otherwise, bypass the cache to obtain the external items from the external system, and put it in the cache for later use.

Offline

Perform Create, Read, Update, and Delete operations against only the cached external items.

Default

Use the System default behavior. This uses Cached mode if the environment supports caching external items.

Name

Required.

The name of the external content type.

Attribute type: String

Note

The name of an external content type should not contain the asterisk special character "*".

DefaultDisplayName

Optional.

The default display name of the external content type.

Attribute type: String

IsCached

Optional.

Specifies whether this external content type will be frequently used. If set to true, Business Data Connectivity (BDC) service will cache this external content type in memory.

Default value: true

Attribute type: Boolean

Child Elements

Element

Description

LocalizedDisplayNames Element in MetadataObject (BDCMetadata Schema)

The localized display names of this external content type.

Properties Element in MetadataObject (BDCMetadata Schema)

The properties of this external content type.

AccessControlList Element (BDCMetadata Schema)

The access control list (ACL) of this external content type.

Identifiers Element in Entity (BDCMetadata Schema)

The identifiers of the external content type.

Methods Element in Entity (BDCMetadata Schema)

The methods of the external content type.

AssociationGroups Element in Entity (BDCMetadata Schema)

The association groups of the external content type.

Actions Element in Entity (BDCMetadata Schema)

The actions of the external content type.

Parent Elements

Element

Description

Entities Element in LobSystem (BDCMetadata Schema)

The list of external content types in this external system.

See Also

Concepts

What Are External Content Types?