自訂實體中繼資料
發行︰ 2017年1月
適用於： Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online
實體是由中繼資料定義。 透過定義或變更實體中繼資料，控制實體的功能。 若要檢視組織的中繼資料，請使用在 SDK 套件中提供的中繼資料瀏覽器。 下載 Microsoft Dynamics CRM SDK 套件。 其他資訊：瀏覽組織的中繼資料
本主題有關如何以程式設計方式使用實體。 如需在應用程式中使用實體的資訊，請參閱 TechNet：建立及編輯實體。
本主題內容
當您建立自訂實體時可用的選項
啟用實體功能
可編輯的實體屬性
實體中繼資料訊息
自訂實體支援的訊息
當您建立自訂實體時可用的選項
下表列出當您建立自訂實體時可用的選項。 當您建立自訂實體時，才能設定這些屬性。
選項 |
描述 |
|---|---|
建立為自訂活動 |
您可以透過設定 EntityMetadata.IsActivity 屬性建立活動實體。 如需詳細資訊，請參閱自訂活動。 |
實體名稱 |
名稱有兩種類型，兩者都必須有自訂首碼：
注意 如果邏輯名稱與結構描述名稱不同，結構描述名稱會覆寫您為邏輯名稱設定的值。 在特定解決方案內容中，於應用程式建立實體時記錄，使用的自訂首碼是解決方案的 Publisher 設定值。 以程式設計方式建立實體時，您可以將自訂首碼設定為介於兩個到八個字元之間的字串長度，全部都是英數字元，且必須以字母開始。 它不能以 "mscrm" 開頭。 最佳作法是使用解決方案關聯之發行者定義的自訂首碼，但是這並非必要條件。 自訂首碼及邏輯或結構描述名稱之間必須包含底線字元。 |
擁有權 |
使用 EntityMetadata.OwnershipType 屬性設定此選項。 使用 OwnershipTypes 列舉來設定實體擁有權類型。 自訂實體的唯一有效值為 OrgOwned 或 UserOwned。 如需詳細資訊，請參閱8597998f-764f-4c73-b63d-9f5e02c78061#EntityOwnership。 |
主要屬性 |
使用 CreateEntityRequest.PrimaryAttribute 設定此選項。 每個實體都有一個使用 StringFormat.Text 做為主要屬性的 StringAttributeMetadata 屬性。 此屬性值就是在相關實體查詢中顯示的值。 因此，欄位的值應該代表實體記錄的名稱。 |
啟用實體功能
下表列出實體功能。 您可以在建立實體時設定下列功能，或日後啟用它們。 一旦啟用，這些功能無法停用。
功能 |
描述 |
|---|---|
商務程序流程 |
將 EntityMetadata.IsBusinessProcessEnabled 設定為 true，以啟用商務程序流程的實體。 |
附註 |
使用 CreateEntityRequest 或 UpdateEntityRequest.HasNotes 屬性建立和 Annotation 實體的實體關聯，並啟用 [附註] 區域包含在實體表單中。 透過包含 [附註]，您也可以將附件新增到記錄。 |
活動 |
使用 CreateEntityRequest 或 UpdateEntityRequest.HasActivities 屬性建立和 ActivityPointer 實體的實體關聯，讓所有活動類型實體可與此實體關聯。 |
人脈 |
設定 EntityMetadata.IsConnectionsEnabled 屬性啟用關係記錄建立，以將此實體與其他關係實體關聯。 |
待辦事項 |
使用 EntityMetadata.IsValidForQueue 屬性新增佇列支援。 當您啟用此選項時，也可以設定 EntityMetadata.AutoRouteToOwnerQueue 屬性，在此類型記錄建立或指派時，自動將記錄移至負責人的預設佇列。 |
電子郵件 |
設定 EntityMetadata.IsActivityParty 屬性，以便傳送電子郵件給此記錄類型的電子郵件地址。 |
可編輯的實體屬性
下表列出可編輯的實體屬性。 除非受管理屬性不允許這些選項，否則您可隨時更新它們。
屬性 |
描述 |
|---|---|
允許快速建立 |
使用 EntityMetadata.IsQuickCreateEnabled 啟用實體的快速建立表單。 使用快速建立表單前，必須先建立表單並發行快速建立表單。 注意 活動實體不支援快速建立表單。 |
存取團隊 |
使用 EntityMetadata.AutoCreateAccessTeams 針對存取團隊啟用實體。 如需詳細資訊，請參閱說明及訓練：關於團隊範本。 |
主要影像 |
如果實體具有影像屬性，使用 PrimaryImageAttribute，可以在應用程式中啟用或停用該影像顯示。 如需詳細資訊，請參閱8597998f-764f-4c73-b63d-9f5e02c78061#BKMK_EntityImages。 |
變更顯示文字 |
受管理屬性 EntityMetadata.IsRenameable 會防止應用程式中的顯示名稱變更。 您仍然可以藉由更新 EntityMetadata.DisplayName 和 EntityMetadata.DisplayCollectionName 屬性，以程式設計方式變更標籤。 |
編輯實體描述 |
受管理屬性 EntityMetadata.IsRenameable 會防止應用程式中的實體描述變更。 您仍然可以藉由更新 EntityMetadata.Description 屬性，以程式設計方式變更標籤。 |
在離線時啟用使用 |
使用 EntityMetadata.IsAvailableOffline 啟用或停用 Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access 使用者將此實體資料離線的能力。 |
啟用 Outlook 讀取窗格 |
注意 EntityMetadata.IsReadingPaneEnabled 屬性僅供內部使用。 若要啟用或停用 Microsoft Dynamics 365 for Outlook 使用者檢視實體資料的能力，請使用 Microsoft Outlook 讀取窗格。 您必須在應用程式中設定此屬性。 |
啟用合併列印 |
使用 EntityMetadata.IsMailMergeEnabled 啟用或停用產生 Microsoft Office Word 合併文件 (使用此實體資料) 的能力。 |
啟用重複資料偵測 |
使用 EntityMetadata.IsDuplicateDetectionEnabled 啟用或停用實體的重複資料偵測。 如需詳細資訊，請參閱偵測重複資料。 |
啟用 SharePoint 整合 |
使用 EntityMetadata.IsDocumentManagementEnabled 啟用或停用實體的 SharePoint Server 整合。 如需詳細資訊，請參閱啟用實體的文件管理。 |
啟用 行動電話用 Dynamics 365 |
使用 EntityMetadata.IsVisibleInMobile 啟用或停用 手機專用 Microsoft Dynamics 365 使用者看到此實體資料的能力。 |
平板電腦用 Dynamics 365 |
使用 EntityMetadata.IsVisibleInMobileClient 啟用或停用 平板電腦專用 Microsoft Dynamics 365 使用者看到此實體資料的能力。 若實體可用於 平板電腦用 Dynamics 365，您可以使用 EntityMetadata.IsReadOnlyInMobileClient 指定資料記錄為唯讀。 |
啟用稽核 |
使用 EntityMetadata.IsAuditEnabled 啟用或停用實體的稽核。 如需詳細資訊，請參閱針對稽核設定實體和屬性。 |
變更顯示實體的區域 |
您可以控制實體格線會顯示在應用程式導覽窗格中的位置。 這是由 SiteMap 控制。 如需詳細資訊，請參閱編輯網站地圖。 |
新增或移除屬性 |
只要受管理屬性 EntityMetadata.CanCreateAttributes 允許建立屬性，您可以使用 CreateAttributeRequest 訊息新增屬性。 如需詳細資訊，請參閱自訂實體屬性中繼資料。 |
新增或移除檢視表 |
只要受管理屬性 EntityMetadata.CanCreateViews 允許建立檢視表，您可以使用 SavedQuery 實體建立實體檢視表。 |
新增或移除圖表 |
只要受管理屬性 EntityMetadata.CanCreateCharts 允許建立圖表，而且 EntityMetadata.IsEnabledForCharts 實體屬性為 true，您可以使用 SavedQueryVisualization 建立實體的圖表。 如需詳細資訊，請參閱檢視具有視覺效果 (圖表) 的資料。 |
新增或移除實體關聯 |
有數個受管理屬性控制可為實體建立的實體關聯類型。 如需詳細資訊，請參閱自訂實體關聯中繼資料。 |
變更圖示 |
您可以變更用於自訂實體的圖示。 如需詳細資訊，請參閱修改實體的圖示。 |
使用自訂說明 |
EntityMetadata.EntityHelpUrlEnabled 控制是否針對實體啟用自訂說明。其他資訊：新增自訂說明內容。 |
說明 URL |
EntityMetadata.EntityHelpUrl 控制哪些資源針對實體的說明內容顯示，如果自訂說明啟用。其他資訊：新增自訂說明內容。 |
可變更階層式關聯 |
EntityMetadata.CanChangeHierarchicalRelationship 控制受管理解決方案的實體關聯的階層式狀態是否可以變更。其他資訊： |
實體中繼資料訊息
下表列出您可以用來建立、擷取、更新或刪除實體中繼資料的訊息。
訊息名稱 |
描述 |
|---|---|
建立自訂實體。 |
|
刪除自訂實體。 |
|
擷取所有實體的中繼資料。 |
|
擷取實體的中繼資料。 |
|
更新實體的中繼資料。 |
|
與 Microsoft.Xrm.Sdk.Metadata.Query 命名空間中的物件一起使用，建立查詢，有效率地取得和偵測特定中繼資料的變更。其他資訊：擷取並偵測到中繼資料的變更。 |
自訂實體支援的訊息
自訂實體與系統實體支援相同的基礎訊息。 可用的訊息集合取決於自訂實體是使用者擁有的或組織擁有的自訂實體。 如需詳細資訊，請參閱8597998f-764f-4c73-b63d-9f5e02c78061#ActionsOnEntityRecords。
另請參閱
搭配使用組織服務與 Dynamics 365 中繼資料
Microsoft Dynamics 365 中實體的簡介
瀏覽組織的中繼資料
自訂實體屬性中繼資料
自訂實體關聯中繼資料
偵測重複資料
啟用實體的文件管理
針對稽核設定實體和屬性
編輯網站地圖
檢視具有視覺效果 (圖表) 的資料
可自訂哪些實體？
建立自訂實體
擷取、更新和刪除實體
建立和更新可郵寄實體
建立自訂活動實體
修改實體的圖示
修改實體的訊息
範例：建立和更新實體中繼資料
範例：建立自訂活動實體
範例：建立和更新可郵寄實體
範例：將實體中繼資料加入檔案
範例：將實體權限資訊傾印至檔案
Microsoft Dynamics 365
© 2017 Microsoft. 著作權所有，並保留一切權利。 著作權