Personnaliser les métadonnées d’entité
Les entités sont définies par les métadonnées. En définissant ou en modifiant les métadonnées d’entité, vous pouvez contrôler les fonctionnalités d’une entité. Pour afficher les métadonnées de votre organisation, utilisez le navigateur de métadonnées. Téléchargez le navigateur de métadonnées.
Pour plus d’informations : Parcourir les métadonnées de votre organisation
Cette rubrique traite du mode d’utilisation des entités par programme. Voir Créer ou modifier des entités (types d’enregistrements) pour plus d’informations sur l’utilisation des entités dans l’application.
Les entités peuvent être créées à partir du service d’organisation ou de l’API web. Les informations suivantes peuvent être appliquées aux deux.
- Avec le service d’organisation, vous utilisez la classe EntityMetadata. Pour plus d’informations, voir Créer une entité personnalisée et Récupérer, mettre à jour et supprimer les entités
- Avec l’API web, vous utilisez la classe EntityMetadata EntityType. Pour plus d’informations, voir Créer et mettre à jour les définitions d’entité à l’aide de l’API web.
Opérations de métadonnées d’entité
L’utilisation des métadonnées d’entité dépend du service que vous utilisez.
Comme l’API web est un point de terminaison RESTful, elle utilise une méthode différente pour créer, récupérer, mettre à jour et supprimer les métadonnées. Utilisez les verbes HTTP POST, GET, PUT et DELETE avec les types d’entités de métadonnées. Pour plus d’informations, voir Créer et mettre à jour les définitions d’entité à l’aide de l’API web.
Une exception à cette règle est que la fonction RetrieveMetadataChanges permet de composer une requête de métadonnées et d’assurer le suivi des modifications dans le temps.
Avec le service d’organisation, utilisez la classe RetrieveMetadataChangesRequest. Cette classe contient les données nécessaires pour récupérer une collection d’enregistrements de métadonnées répondant aux critères définis. La classe RetrieveMetadataChangesResponse renvoie une valeur d’horodatage qui peut être utilisée ultérieurement avec cette demande pour renvoyer des informations sur les modifications des métadonnées depuis la dernière demande.
| Message | API web | Assembly du SDK |
|---|---|---|
| CreateEntity | Utilisez une demande POST pour envoyer des données pour créer une entité. | CreateEntityRequest |
| DeleteEntity | Utilisez une demande DELETE pour supprimer une entité. | DeleteEntityRequest |
| RetrieveAllEntities | Utilisez une demande GET pour récupérer des données d’entité. | RetrieveAllEntitiesRequest |
| RetrieveEntity | Fonction RetrieveEntity | RetrieveEntityRequest |
| UpdateEntity | Utilisez une demande PUT pour mettre à jour une entité. | UpdateEntityRequest |
| RetrieveMetadataChanges Utilisé avec les objets de l’espace de noms Microsoft.Xrm.Sdk.Metadata.Query pour créer une requête visant à récupérer et détecter de manière efficace les modifications apportées à des métadonnées spécifiques. Pour plus d’informations : Récupérer et détecter les modifications apportées aux métadonnées. |
Fonction RetrieveMetadataChanges | RetrieveMetadataChangesRequest |
Options disponibles lorsque vous créez une entité personnalisée
Le tableau suivant répertorie les options qui sont disponibles lorsque vous créez une entité personnalisée. Vous pouvez uniquement définir les propriétés lorsque vous créez une entité personnalisée.
| Option | Description |
|---|---|
| Créer en tant qu’activité personnalisée | Vous pouvez créer une entité qui est une activité en définissant la propriété IsActivity lorsque vous utilisez le service d’organisation ou l’API client, respectivement. Pour plus d’informations, voir Activités personnalisées dans Dynamics 365 Customer Engagement (on-premises). |
| Noms des entités | Il existe deux types de noms, et les deux doivent avoir un préfixe de personnalisation :LogicalName : Version du nom de l’entité qui est défini en lettres minuscules.SchemaName: Nom utilisé pour créer les tables de base de données de l’entité. La casse du nom peut être mixte. La casse que vous utilisez définit le nom de l’objet généré pour effectuer une programmation avec des types forts ou lorsque vous utilisez le point de terminaison REST.Remarque : si le nom logique diffère du nom de schéma, le nom de schéma remplacera la valeur que vous définissez pour le nom logique. Lorsqu’une entité est créée dans l’application dans le contexte d’une solution spécifique, le préfixe de personnalisation utilisé est un ensemble pour l’ Publisher de la solution. Lorsqu’une entité est créée par programme, vous pouvez définir le préfixe de personnalisation en chaîne contenant entre deux et huit caractères, tous les caractères alphanumériques, et devant commencer par une lettre. Elle ne peut pas commencer par « mscrm ». La meilleure méthode consiste à utiliser le préfixe de personnalisation défini par l’éditeur auquel la solution est associée, mais ce n’est pas une obligation. Un caractère de soulignement doit être compris entre le préfixe de personnalisation et le nom logique ou de schéma. |
| Propriété | Utilisez la propriété OwnershipType pour définir ce paramètre. Utilisez l’énumération OwnershipTypes ou OwnershipTypes EnumType pour définir le type de propriété d’entité. Les seules valeurs possibles pour les entités personnalisées sont OrgOwned ou UserOwned. Pour plus d’informations, voir Propriété de l’entité. |
| Attribut principal | Avec le service d’organisation, utilisez la propriété CreateEntityRequest.PrimaryAttribute pour le définir. Avec l’API web, le JSON définissant l’entité doit inclure un StringAttributeMetadata avec la propriété IsPrimaryName définie sur true.Dans les deux cas, l’attribut de chaîne doit être mis en forme en tant que Text. La valeur de cet attribut est celle qui est contenue dans une recherche de toutes les entités associées. Par conséquent, la valeur du champ doit représenter le nom de l’enregistrement d’entité. |
Activer les fonctionnalités d’entité
Le tableau suivant répertorie les fonctionnalités d’entité. Vous pouvez définir ces fonctionnalités lorsque vous créez une entité ou vous pouvez les activer ultérieurement. Une fois activées, elles ne peuvent pas être désactivées.
| Fonctionnalité | Description |
|---|---|
| Flux des processus d’entreprise | Définissez IsBusinessProcessEnabled sur true pour activer l’entité pour les flux de processus d’entreprise. |
| Remarques | Pour créer une relation d’entités avec l’entité Annotation et pour activer l’inclusion d’une zone Notes dans le formulaire d’entité. En ajoutant Notes, vous pouvez également ajouter des pièces jointes aux enregistrements. Avec le service d’organisation, utilisez la propriété CreateEntityRequest ou UpdateEntityRequest HasNotes Avec l’API web, définissez la propriété EntityMetadata. HasNotes propriété. |
| Activités | Pour créer une relation d’entités avec l’entité ActivityPointer afin que toutes les entités de type d’activité puissent être associées à cette entité.Avec le service d’organisation, utilisez la propriété CreateEntityRequest ou UpdateEntityRequest HasActivities. Avec l’API web, définissez la propriété EntityMetadata. HasActivities propriété. |
| Connexions | Pour créer des enregistrements de connexion pour associer cette entité à d’autres entités de connexion, définissez la valeur de la propriété IsConnectionsEnabled.Value sur true. |
| Files d’attente | Utilisez la propriété IsValidForQueue pour ajouter la prise en charge des files d’attente. Lorsque vous activez cette option, vous pouvez définir la propriété AutoRouteToOwnerQueue pour déplacer des enregistrements automatiquement vers la file d’attente par défaut du propriétaire lorsqu’un enregistrement de ce type est créé ou attribué. |
| Courrier électronique | Définissez la propriété IsActivityParty. pour pouvoir envoyer un courrier électronique à l’adresse de messagerie avec ce type d’enregistrement. |
Propriétés d’entité modifiables
Le tableau suivant répertorie les propriétés d’entité que vous pouvez modifier. À moins qu’une propriété gérée désactive ces options, vous pouvez les mettre à jour à tout moment.
| Propriété | Description |
|---|---|
| Autoriser la création rapide | Utilisez IsQuickCreateEnabled pour activer les formulaires de création rapide pour l’entité. Avant de pouvoir utiliser les formulaires de création rapide, vous devez au préalable créer et publier un formulaire de création rapide.Remarque : Les entités d’activité ne sont pas compatibles avec les formulaires de création rapide. |
| Équipes d’accès | Utilisez AutoCreateAccessTeams pour activer l’entité pour les équipes d’accès. Voir À propos des modèles d’équipe pour plus d’informations. |
| Image principale | Si une entité possède un attribut d’image, vous pouvez activer ou désactiver l’affichage de cette image dans l’application avec PrimaryImageAttribute. Pour plus d’informations, voir Images d’entité. |
| Modifier le texte d’affichage | La propriété gérée IsRenameable empêche la modification du nom complet dans l’application. Vous pouvez toutefois modifier par programme les étiquettes en mettant à jour les propriétés DisplayName et DisplayCollectionName. |
| Modifier la description des entités | La propriété gérée IsRenameable empêche la modification de la description de l’entité dans l’application. Vous pouvez toutefois modifier par programme les étiquettes en mettant à jour la propriété Description. |
| Activer pour l’utilisation en mode hors connexion | Utilisez IsAvailableOffline pour activer ou désactiver la fonctionnalité permettant aux utilisateurs Dynamics 365 for Microsoft Office Outlook avec accès hors connexion d’exploiter les données de cette entité hors connexion. |
| Activer le volet de lecture Outlook |
Remarque : La propriété IsReadingPaneEnabled est à usage interne uniquement.Pour activer ou désactiver la fonctionnalité permettant aux utilisateurs Dynamics 365 for Outlook de consulter les données de cette entité, utilisez le volet de lecture Outlook. Vous devez définir cette propriété dans l’application. |
| Activer (la fusion et) le publipostage | Utilisez IsMailMergeEnabled pour activer ou désactiver la fonctionnalité permettant de générer des documents fusionnés Office Word qui utilisent les données de cette entité. |
| Activer la détection des doublons | Utilisez IsDuplicateDetectionEnabled pour activer ou désactiver la détection des doublons pour l’entité. Pour plus d’informations, voir Détection de données dupliquées dans Dynamics 365 Customer Engagement (on-premises). |
| Activer l’intégration de SharePoint | Utilisez IsDocumentManagementEnabled pour activer ou désactiver l’intégration du serveur SharePoint pour l’entité. Pour plus d’informations, voir Activer la gestion des documents pour les entités. |
| Activer Dynamics 365 for phones | Utilisez IsVisibleInMobile pour activer ou désactiver la fonctionnalité permettant aux utilisateurs Dynamics 365 for phones de consulter les données de cette entité. |
| Dynamics 365 for tablets | Utilisez IsVisibleInMobileClient pour activer ou désactiver la fonctionnalité permettant aux utilisateurs Dynamics 365 for tablets de consulter les données de cette entité.Si l’entité est disponible pour Dynamics 365 for tablets, vous pourrez utiliser IsReadOnlyInMobileClient pour spécifier que les données de l’enregistrement sont en lecture seule. |
| Activer l’audit | Utilisez IsAuditEnabled pour activer ou désactiver l’audit pour l’entité. Pour plus d’informations, voir Configurer les entités et les attributs pour l’audit. |
| Modifier les zones affichant l’entité | Vous pouvez contrôler la position des grilles d’entités dans le volet de navigation de l’application. Ceci est contrôlé par Plan de site. |
| Ajouter ou supprimer des attributs | Tant que la propriété gérée CanCreateAttributes.Value permet de créer des attributs, vous pouvez ajouter des attributs à l’entité. Pour plus d’informations, voir Personnaliser des métadonnées d’attribut d’entité. |
| Ajouter ou supprimer des vues | Tant que la propriété gérée CanCreateViews.Value permet de créer des vues, vous pouvez utiliser l’entité SavedQuery pour créer les vues d’une entité. |
| Ajouter ou supprimer des graphiques | Tant que la propriété gérée CanCreateCharts.Value permet de créer des graphiques et que la propriété d’entité IsEnabledForCharts a la valeur true, vous pouvez utiliser l’Entité SavedQueryVisualization pour créer les graphiques d’une entité. Pour plus d’informations, voir Afficher des données avec les visualisations (graphiques). |
| Ajouter ou supprimer des relations d’entités | Il existe plusieurs propriétés gérées qui contrôlent les types de relations d’entité que vous pouvez créer pour une entité. Pour plus d’informations, voir Personnaliser des métadonnées de relation d’entité. |
| Modifier les icônes | Vous pouvez modifier les icônes utilisées pour les entités personnalisées. Pour plus d’informations, voir Modifier les icônes d’entité. |
| Peut changer la relation hiérarchique |
CanChangeHierarchicalRelationship.Value contrôle si l’état hiérarchique des entités-relations inclus dans vos solutions gérées peut être modifié. Pour plus d’informations : |
Messages pris en charge par des entités personnalisées
Les entités personnalisées prennent en charge les mêmes messages de base que les entités système. L’ensemble des messages disponibles dépend de si l’entité personnalisée appartient à l’utilisateur ou à l’organisation. Pour plus d’informations, consultez Opérations sur les enregistrements d’entité.
Voir aussi
Étendre le modèle de métadonnées pour Dynamics 365 Customer Engagement (on-premises)
Présentation des entités dans Dynamics 365 Customer Engagement (on-premises)
Parcourir les métadonnées de votre organisation
Personnaliser les métadonnées d’attribut d’entité
Métadonnées de relation d’entité
Détecter les données dupliquées dans Dynamics 365 Customer Engagement (on-premises)
Activer la gestion des documents pour les entités
Configurer les entités et les attributs pour l’audit
Afficher des données à l’aide de graphiques (visualisations)
Quelles sont les entités personnalisables ?
Créer une entité personnalisée
Récupérer, mettre à jour et supprimer les entités
Créer et mettre à jour une entité pouvant recevoir du courrier
Créer une entité d’activité personnalisée
Modifier les icônes d’entité
Modifier les messages d’entité
Exemple : créer et mettre à jour des métadonnées d’entité
Exemple : Créer une entité d’activité personnalisée
Exemple : Créer et mettre à jour une entité pouvant recevoir du courrier
Exemple : Vider les métadonnées d’entité dans un fichier
Exemple : vider les informations de privilège d’entité dans un fichier