自定义实体元数据 

发布日期： 2016年11月

适用于： Dynamics CRM 2015

实体由元数据定义。 通过定义或更改实体元数据，可以控制实体的功能。 若要查看组织的元数据，请使用 SDK 包中提供的元数据浏览器。下载 Microsoft Dynamics CRM SDK 包。 详细信息：浏览组织的元数据

本主题介绍如何以编程方式处理实体。 有关在应用程序中使用实体的信息，请参阅创建和编辑实体。

本主题内容

创建自定义实体时可用的选项

启用实体功能

可编辑实体属性

实体元数据消息

自定义实体支持的消息

创建自定义实体时可用的选项

下表列出当您创建自定义实体时可用的选项。 在创建自定义实体时只能设置这些属性。

选项	说明
创建为自定义活动	通过设置 EntityMetadata.IsActivity 属性，可以创建作为活动的实体。 有关详细信息，请参阅自定义活动。
实体名称	有两种类型的名称，二者都必须具有自定义前缀： EntityMetadata.LogicalName：全部用小写字母设置的实体名称版本。 EntityMetadata.SchemaName：将用于为实体创建数据库表的名称。 该名称可以混合大小写。 您使用的大小写用于设置为使用强类型编程生成的或您使用 REST 端点时生成的对象的名称。 备注 如果逻辑名称不同于架构名称，则架构名称将覆盖您为逻辑名称设置的值。 在特定解决方案上下文中的应用程序中创建实体时，使用的自定义前缀是为解决方案的 Publisher 设置的前缀。 当以编程方式创建实体时，可以将自定义前缀设置为长度介于两个和八个字符之间并且全部是字母数字字符的字符串，并且它必须以字母开头， 而不能以“mscrm”开头。 最好使用与解决方案关联的发布商定义的自定义前缀，但这不是必须的。 必须在自定义前缀和逻辑或架构名称之间包括下划线字符。
所有权	请使用 EntityMetadata.OwnershipType 属性设置此项。 可以使用 OwnershipTypes 枚举设置实体所有权的类型。 自定义实体的唯一有效值是 OrgOwned 或 UserOwned。 有关详细信息，请参阅实体所有权。
主属性	请使用 CreateEntityRequest.PrimaryAttribute 设置此项。 每个实体都具有将 StringAttributeMetadata.StringFormat 用作主属性的 Text 属性。 此属性的值是查找任何相关实体时显示的内容。 因此，字段的值应表示实体记录的名称。

启用实体功能

下表列出实体功能。 可以在创建实体时设置这些功能，也可以稍后启用它们。 这些功能一旦启用便无法禁用。

功能	说明
业务流程	设置 EntityMetadata。 将 IsBusinessProcessEnabled 设置为 true 可启用业务流程流的实体。
注释​​	使用 CreateEntityRequest 或 UpdateEntityRequest.HasNotes 属性可创建与 Annotation 实体的实体关系，并能够在窗体中包括“注释”区域。 通过包括“注释”，您还可以向记录中添加附件。
活动	使用 CreateEntityRequest 或 UpdateEntityRequest.HasActivities 属性可创建与 ActivityPointer 实体的实体关系，以便所有活动类型实体都可以与此实体相关联。
连接	设置 EntityMetadata.IsConnectionsEnabled 属性可允许创建连接记录以将此实体与其他连接实体相关联。
队列	使用 EntityMetadata.IsValidForQueue 属性可添加对队列的支持。 启用此选项后，您还可以设置 EntityMetadata.AutoRouteToOwnerQueue 属性以便在创建或分派此类型的记录时自动将记录移动到负责人的默认队列中。
电子邮件	设置 EntityMetadata.IsActivityParty 属性可以将电子邮件发送到此类型的记录中的电子邮件地址。

可编辑实体属性

下表列出可编辑的实体属性。 除非托管属性不允许这些选项，否则您可以随时更新它们。

若要禁止或允许 Microsoft Dynamics CRM for Outlook 用户查看此实体的数据，请使用 Microsoft Outlook 阅读窗格。 必须在应用程序中设置此属性。

属性	说明
允许快速创建	使用 EntityMetadata.IsQuickCreateEnabled 可启用实体的快速创建窗体。 使用快速创建窗体之前，必须先创建和发布快速创建窗体。 备注 活动实体不支持快速创建窗体。
访问团队	使用 EntityMetadata.AutoCreateAccessTeams 可启用访问团队的实体。 有关详细信息，请参阅帮助和培训：关于团队模板。
主要图像	如果实体具有图像属性，您可以使用 PrimaryImageAttribute 在应用程序中允许或禁止显示该图像。 有关详细信息，请参阅实体图像。
更改显示文本	托管属性 EntityMetadata.IsRenameable 阻止在应用程序中更改显示名称。 您仍可以通过更新 EntityMetadata.DisplayName 和 EntityMetadata.DisplayCollectionName 属性来以编程方式更改标签。
编辑实体说明	托管属性 EntityMetadata.IsRenameable 阻止在应用程序中更改实体说明。 您仍可以通过更新 EntityMetadata.Description 属性来以编程方式更改标签。
允许脱机时使用	使用 EntityMetadata.IsAvailableOffline 允许或禁止 Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access 用户使此实体的数据脱机。
启用 Outlook 阅读窗格	备注 EntityMetadata.IsReadingPaneEnabled 属性仅供内部使用。
启用邮件合并	使用 EntityMetadata.IsMailMergeEnabled 可允许或禁止生成使用此实体中数据的 Microsoft Office Word 合并文档。
启用重复检测	使用 EntityMetadata.IsDuplicateDetectionEnabled 可允许或禁止对实体进行重复检测。 有关详细信息，请参阅检测重复数据。
启用 SharePoint 集成	使用 EntityMetadata.IsDocumentManagementEnabled 可启用或禁用实体的 SharePoint Server 集成。 有关详细信息，请参阅对实体启用文档管理。
启用 适用于手机的 CRM	使用 EntityMetadata.IsVisibleInMobile 可允许或禁止 适用于手机的 Microsoft Dynamics CRM 用户查看此实体的数据。
适用于平板电脑的 CRM	使用 EntityMetadata.IsVisibleInMobileClient 可允许或禁止 适用于平板电脑的 Microsoft Dynamics CRM 用户查看此实体的数据。 如果实体可用于 适用于平板电脑的 CRM，您可以使用 EntityMetadata.IsReadOnlyInMobileClient 指定记录数据是只读的。
启用审核	使用 EntityMetadata.IsAuditEnabled 可允许或禁止对实体进行审核。 有关详细信息，请参阅配置要审核的实体和属性。
更改显示实体的区域	可以控制实体网格在应用程序导航窗格中的显示位置。 此操作由站点地图控制。 有关详细信息，请参阅编辑站点地图。
添加或移除属性	只要托管属性 (property) EntityMetadata.CanCreateAttributes 允许创建属性 (attribute)，您就可以使用 CreateAttributeRequest 消息添加属性 (attribute)。 有关详细信息，请参阅自定义实体属性元数据。
添加或移除视图	只要托管属性 EntityMetadata.CanCreateViews 允许创建视图，您就可以使用 SavedQuery 实体为实体创建视图。
添加或移除图表	只要托管属性 EntityMetadata.CanCreateCharts 允许创建图表，并且 EntityMetadata.IsEnabledForCharts 实体属性为 true，您就可以使用 SavedQueryVisualization 为实体创建图表。 有关详细信息，请参阅使用可视化项（图表）查看数据。
添加或移除实体关系	有多个托管属性控制您可以为实体创建的实体关系的类型。 有关详细信息，请参阅自定义实体关系元数据。
更改图标	可以更改用于自定义实体的图标。 有关详细信息，请参阅修改实体的图标。
使用自定义帮助	EntityMetadata.EntityHelpUrlEnabled 控制是否为实体启用自定义帮助。详细信息：添加自定义帮助内容。
帮助 URL	EntityMetadata.EntityHelpUrl 控制在启用自定义帮助时为实体的帮助内容显示的资源。详细信息：添加自定义帮助内容。
可以更改分层关系	EntityMetadata。CanChangeHierarchicalRelationship 控制是否可以更改托管解决方案中包含的实体关系的层次结构状态。详细信息：

实体元数据消息

下表列出可用于创建、检索、更新和删除实体元数据的消息。

消息名称	说明
CreateEntityRequest	创建自定义实体。
DeleteEntityRequest	删除自定义实体。
RetrieveAllEntitiesRequest	检索所有实体的元数据。
RetrieveEntityRequest	检索实体的元数据。
UpdateEntityRequest	更新实体的元数据。
RetrieveMetadataChangesRequest	联用 Microsoft.Xrm.Sdk.Metadata.Query 命名空间中的对象来创建查询，以有效地检索和检测特定元数据的更改。详细信息：检索并检测元数据更改。

自定义实体支持的消息

自定义实体与系统实体支持相同的基本消息。 可用消息集取决于自定义实体是由用户负责还是由组织负责。 有关详细信息，请参阅对实体记录执行的操作。

另请参阅

扩展元数据模型
Microsoft Dynamics CRM 2015 中的实体简介
浏览组织的元数据
自定义实体属性元数据
自定义实体关系元数据
检测重复数据
对实体启用文档管理
配置要审核的实体和属性
编辑站点地图
使用可视化项（图表）查看数据
可自定义哪些实体？
创建自定义实体。
检索、更新和删除实体
创建和更新可通过电子邮件发送的实体
创建自定义活动实体
修改实体的图标
修改实体的消息
示例：创建和更新实体元数据
示例：创建自定义活动实体。
示例：创建和更新可通过电子邮件发送的实体
示例：将实体元数据转储到文件
示例：将实体权限信息转储到文件

© 2017 Microsoft。 保留所有权利。 版权