エンティティ メタデータのカスタマイズ
公開日: 2017年1月
対象: Dynamics 365 (online)、Dynamics 365 (on-premises)、Dynamics CRM 2016、Dynamics CRM Online
エンティティは、メタデータによって定義されます。 エンティティ メタデータを定義または変更することによって、エンティティの機能を制御できます。 組織のメタデータを表示するには、SDK パッケージ含まれているメタデータ ブラウザーを使用します。 Microsoft Dynamics CRM SDK パッケージをダウンロードします。 詳細:組織のメタデータの参照
このトピックでは、プログラムでエンティティを処理する方法について説明します。 アプリケーションでエンティティを処理する方法の詳細については、「TechNet: エンティティの作成および編集」を参照してください。
このトピックの内容
ユーザー定義エンティティの作成時に利用可能なオプション
エンティティの機能の有効化
編集可能なエンティティ プロパティ
エンティティ メタデータのメッセージ
ユーザー定義エンティティでサポートされているメッセージ
ユーザー定義エンティティの作成時に利用可能なオプション
次の表は、ユーザー定義エンティティを作成するときに使用できるオプションを示します。 ユーザー定義エンティティを作成するときにのみ、これらのプロパティを設定できます。
オプション |
説明 |
|---|---|
ユーザー定義の活動として作成 |
EntityMetadata.IsActivity プロパティを設定することによって、活動であるエンティティを作成できます。 詳細については、「ユーザー定義の活動」を参照してください。 |
エンティティ名 |
名前には 2 種類あり、どちらもカスタマイズの接頭辞が付いている必要があります。
注意 論理名がスキーマ名と異なる場合、論理名に設定した値をスキーマ名が上書きします。 特定のソリューションのコンテキスト内のアプリケーションでエンティティが作成される場合、使用されるカスタマイズの接頭辞は、ソリューションの Publisher で設定される接頭辞です。 エンティティがプログラム的に作成される場合、カスタマイズの接頭辞は、長さが 2 文字から 8 文字の間の文字列で、すべて英数文字であり、最初の 1 文字を英字にする必要があります。 接頭辞を "mscrm" で始めることはできません。 ソリューションが関連付けられている発行者が定義するカスタマイズの接頭辞を使用することをお勧めしますが、必須ではありません。 カスタマイズの接頭辞と論理名またはスキーマ名との間に、アンダースコアを使用する必要があります。 |
企業形態 |
この設定には、EntityMetadata.OwnershipType プロパティを使用します。 エンティティの所有権の種類を設定するには、OwnershipTypes 列挙体を使用します。 ユーザー定義エンティティで有効な値は、OrgOwned または UserOwned のみです。 詳細については、「8597998f-764f-4c73-b63d-9f5e02c78061#EntityOwnership」を参照してください。 |
主属性 |
この設定には、CreateEntityRequest.PrimaryAttribute を使用します。 各エンティティには、主属性として StringAttributeMetadata.StringFormat を使用する Text 属性があります。 この属性の値は、関連するエンティティの検索で表示される内容です。 このため、フィールドの値は、エンティティ レコードの名前を表す必要があります。 |
エンティティの機能の有効化
次の表にエンティティ機能の一覧を示します。 エンティティを作成するときにこれらの機能を設定することも、後で有効にすることもできます。 これらの機能は、一度有効にすると無効にすることはできません。
機能 |
説明 |
|---|---|
業務プロセス フロー |
業務プロセス フローのエンティティを有効にするには、EntityMetadata.IsBusinessProcessEnabled を true に設定します。 |
メモ |
Annotationエンティティとのエンティテ関係を作成し、エンティティ フォームの [メモ] 領域を含めることができるようにするには、CreateEntityRequestまたはUpdateEntityRequest.HasNotesプロパティを使用します。 [メモ] を含めることにより、レコードに添付ファイルを追加することもできます。 |
活動 |
ActivityPointer エンティティとのエンティティの関連付けを作成し、すべての種類の活動のエンティティをこのエンティティと関連付けることができるようにするには、CreateEntityRequest または UpdateEntityRequest.HasActivities プロパティを使用します。 |
つながり |
接続レコードの作成を有効にして、このエンティティを他のつながりエンティティと関連付けるように EntityMetadata.IsConnectionsEnabled プロパティを設定します。 |
キュー |
キューのサポートを追加するには、EntityMetadata.IsValidForQueue プロパティを使用します。 このオプションを有効にすると、この種類のレコードが作成または割り当てられたときに、レコードを所有者の既定のキューに自動的に移動するように EntityMetadata.AutoRouteToOwnerQueue プロパティを設定することもできます。 |
電子メール |
この種類のレコードの電子メール アドレスに、電子メールを送信できるように EntityMetadata.IsActivityParty プロパティを設定します。 |
編集可能なエンティティ プロパティ
次の表では、編集できるエンティティ プロパティを示します。 これらのオプションは、マネージド プロパティによって無効にしている場合を除き、いつでも更新できます。
Outlook 用 Microsoft Dynamics 365 のユーザーがこのエンティティのデータを表示できるかどうかを切り替えるには、Microsoft Outlook の閲覧ウィンドウを使用します。 このプロパティは、アプリケーションで設定する必要があります。
プロパティ |
説明 |
|---|---|
簡易作成を許可 |
エンティティの簡易作成フォームを有効にするには、EntityMetadata.IsQuickCreateEnabledを使用します。 簡易作成フォームを使用する前に、まず簡易作成フォームを作成および公開する必要があります。 注意 活動エンティティは簡易作成フォームをサポートしません。 |
アクセス チーム |
アクセス チームのエンティティを有効にするには、EntityMetadata.AutoCreateAccessTeamsを使用します。 詳細については、「ヘルプとトレーニング: チーム テンプレートについて」を参照してください。 |
プライマリ イメージ |
エンティティにイメージ属性がある場合、PrimaryImageAttributeを使用してアプリケーションへのその画像の表示を有効または無効にできます。 詳細については、「8597998f-764f-4c73-b63d-9f5e02c78061#BKMK_EntityImages」を参照してください。 |
表示テキストの変更 |
マネージド プロパティ EntityMetadata.IsRenameable のために、アプリケーションで表示名を変更できません。EntityMetadata.DisplayName および EntityMetadata.DisplayCollectionName プロパティを更新することによって、ラベルをプログラム的に変更することができます。 |
エンティティの説明の編集 |
マネージド プロパティ EntityMetadata.IsRenameable のために、アプリケーションでエンティティの説明を変更できません。EntityMetadata.Description プロパティを更新することによって、ラベルをプログラム的に変更することができます。 |
オフライン時の使用の有効化 |
オフライン アクセス対応 Microsoft Office Outlook 用 Microsoft Dynamics 365 のユーザーがオフライン時にこのエンティティのデータを取得できるかどうかを切り替えるには、EntityMetadata.IsAvailableOffline を使用します。 |
Outlook の閲覧ウィンドウの有効化 |
注意 EntityMetadata.IsReadingPaneEnabled プロパティは内部のみで使用 |
差し込み印刷の有効化 |
このエンティティからのデータを使用する Microsoft Office Word の結合された文書を生成できるかどうかを切り替えるには、EntityMetadata.IsMailMergeEnabled を使用します。 |
重複データ検出を有効にする |
エンティティの重複データ検出の有効と無効を切り替えるには、EntityMetadata.IsDuplicateDetectionEnabled を使用します。 詳細については、「重複データの検出」を参照してください。 |
SharePoint の統合の有効化 |
エンティティの SharePoint Server の統合の有効と無効を切り替えるには、EntityMetadata.IsDocumentManagementEnabled を使用します。 詳細については、「エンティティのドキュメント管理を有効にする」を参照してください。 |
電話用 Dynamics 365 の有効化 |
電話用 Microsoft Dynamics 365 のユーザーがこのエンティティのデータを表示できるかどうかを切り替えるには、EntityMetadata.IsVisibleInMobile を使用します。 |
タブレット PC 用 Dynamics 365 |
タブレット PC 用 Microsoft Dynamics 365 のユーザーがこのエンティティのデータを表示できるかどうかを切り替えるには、EntityMetadata.IsVisibleInMobileClient を使用します。 エンティティが タブレット PC 用 Dynamics 365 で利用できる場合は、レコードのデータが読み取り専用であることを指定するために、EntityMetadata.IsReadOnlyInMobileClientを使用できます。 |
監査の有効化 |
エンティティの監査の有効と無効を切り替えるには、EntityMetadata.IsAuditEnabled を使用します。 詳細については、「監査のエンティティおよび属性の構成」を参照してください。 |
エンティティが表示される領域の変更 |
アプリケーションのナビゲーション ウィンドウのエンティティ グリッドが表示される場所を制御できます。 これはサイトマップによって制御されます。 詳細については、「サイト マップの編集」を参照してください。 |
属性の追加と削除 |
マネージド プロパティ 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. All rights reserved. 著作権