Définition et gestion des événements de plate-forme

En utilisant des événements de plate-forme, les éditeurs peuvent envoyer des données d’événements personnalisées via Apex, un processus, un flux, l’API Pub/Sub ou d’autres API. Les abonnés peuvent recevoir des messages d'événements personnalisés de Salesforce ou d’un système externe en utilisant Apex, des clients Pub/Sub API, des processus ou des flux. Selon les données de message des événements, les abonnés peuvent exécuter une logique métier personnalisée, par exemple envoyer un e-mail ou consigner une requête. Par exemple, un système logiciel qui surveille un imprimante peut effectuer un appel d'API afin de publier un événement lorsque le niveau d'encre est faible. L’événement d’imprimante personnalisé peut inclure des champs personnalisés qui indiquent le modèle d’imprimante, le numéro de série et le niveau d’entre. L’événement est traité dans Salesforce par un déclencheur Apex qui passe commande pour une nouvelle cartouche.

Les événements de plate-forme simplifient le processus de communication des modifications et de réponse sans écrire une logique complexe. Les éditeurs et les abonnés communiquent entre eux à travers des événements. Plusieurs abonnés peuvent écouter le même événement et exécuter des actions différentes.

Définition de votre événement de plate-forme

Pour définir un événement de plate-forme dans Salesforce Classic ou Lightning Experience :

1. Dans Configuration, saisissez Événements de plate-forme dans la case Recherche rapide, puis sélectionnez Événements de plate-forme.
2. Dans la page Événements de plate-forme, cliquez sur Nouvel événement de plate-forme.
3. Complétez les champs standards et ajoutez une description (facultative).
4. Pour Comportement de publication, choisissez quand le message d'événement est publié dans une transaction.
   • Publier après l'engagement pour publier le message d'événement uniquement lorsqu'une transaction est engagée avec succès. Sélectionnez cette option si les abonnés dépendent de données engagées par la transaction de publication. Par exemple, un processus publie un message d'événement et crée un enregistrement de tâche. Un deuxième processus abonné à l'événement est déclenché et s'attend à trouver l'enregistrement de la tâche. Vous pouvez également choisir ce scénario pour ne pas publier le message d'événement lorsque la transaction échoue.
   • Publier immédiatement pour publier le message d'événement lors de l'exécution de l'appel de publication. Sélectionnez cette option si vous souhaitez publier le message d'événement que la transaction réussisse ou non. Vous pouvez aussi choisir cette option si l'éditeur et les abonnés sont indépendants, et si les abonnés ne dépendent pas des données engagées par l'éditeur. Par exemple, le comportement de publication immédiat est disponible pour un événement utilisé à des fins de connexion. Avec cette option, un abonné peut recevoir un message d'événement avant que les données soient engagées par la transaction de l'éditeur.
5. Cliquez sur Enregistrer.
6. Pour ajouter un champ, dans la liste associée Champs personnalisés et relations, cliquez sur Nouveau.
7. Pour configurer les propriétés du champ, suivez l'assistant de champ personnalisé.

Remarque

• Si vous changez le comportement de publication, son application peut nécessiter jusqu'à cinq minutes.
• Dans Lightning Experience, les événements de plate-forme sont pas affichés dans la liste des objets standard et personnalisés du Gestionnaire d'objet et ne sont pas disponibles dans le Générateur de schéma.

Un événement de plate-forme est une entité Salesforce spéciale, similaire à bien des égards à un sObject. Un message d’événement est une instance d'un événement de plate-forme, de la même façon qu’un enregistrement est une instance d’un objet personnalisé. Contrairement aux objets personnalisés, vous ne pouvez pas mettre à jour ou supprimer des enregistrements d'événement. Vous ne pouvez pas non plus afficher les événements de plate-forme dans l’interface utilisateur de Salesforce, et les événements de plate-forme n’ont pas de présentation de page. La suppression d'une définition d'événement de plate-forme est irréversible.

Champs standard

Les événements de plate-forme comprennent des champs standard. Ces champs sont affichés dans la page Nouvel événement de plate-forme.

Champs personnalisés

En plus de champs standard, vous pouvez ajouter des champs personnalisés à votre événement personnalisé. Les champs personnalisés d'événement de plate-forme prennent en charge uniquement les types ci-dessous.

• Case à cocher
• Date
• Date/heure
• Chiffre
• Texte
• Zone de texte (longue)

Le nombre maximal de champs que vous pouvez ajouter à un événement de plate-forme est identique que pour un objet personnalisé. Consultez Allocations de fonctionnalités et d'éditions Salesforce.

Champ système ReplayId :

Un ID opaque inclus dans le champ ReplayId est attribué à chaque message d'événement. La valeur du champ ReplayId, qui est remplie par le système lors de la livraison de l'événement aux abonnés, désigne la position de l'événement dans le flux d'événements. La continuité des valeurs ID de lecture n'est pas garantie pour les événements consécutifs. Un abonné peut stocker une valeur ID de lecture et l'utiliser dans lors du réabonnement pour récupérer les événements de la période de rétention. Par exemple, un abonné peut récupérer les événements manquants suite à un échec de connexion. Les abonnés ne doivent pas calculer les nouveaux ID de lecture sur la base d'un ID de lecture stocké, pour référencer d'autres événements dans le flux.

Champ système EventUuid

Un identificateur unique universel (UUID) qui identifie un message d'événement de plate-forme. Dans les clients de l'API Pub/Sub, le champ ID d’événement contient la valeur UUID de l'événement et n'est pas suivi de version. Dans les autres clients abonnés, le champ EventUuid est disponible dans l'API version 52.0 et supérieure. La version d'API correspond à la version avec laquelle un déclencheur Apex est enregistré, ou à la version spécifiée dans un point de terminaison d'abonné CometD.

Suffixe de nom d'API pour les événements de plate-forme personnalisés

Lorsque vous créez un événement de plate-forme, le système ajoute le suffixe __e pour créer le nom d'API de l'événement. Par exemple, si vous créez un événement avec le nom d'objet Low Ink, le nom d'API est Low_Ink__e. Le nom d'API est utilisé chaque fois que vous référencez l'événement par programmation, par exemple dans Apex. Les noms d'API d'événements de plate-forme standard, tels que AssetTokenEvent, n'ont pas de suffixe.

Abonnés aux événements

La liste associée Abonnements répertorie tous les déclencheurs, les processus et les flux déclenchés par un événement de plate-forme, qui sont abonnés à un événement de plate-forme. Les abonnés CometD, tels que votre propre client CometD ou le composant Lightning empApi, ne sont pas répertoriés dans cette page.

La liste affiche l'ID de lecture du dernier événement traité par le système (champ ID dernier traité) et du dernier événement publié (champ ID dernier publié). Déterminer le dernier ID de lecture traité est utile en cas d'écart entre les événements publiés et traités, par exemple, lorsqu'un déclencheur contient une logique complexe qui entraîne un délai dans le traitement des lots importants d'événements entrants.

Remarque Pour des événements de plate-forme à haut volume, la valeur ID de dernière publication n'est pas disponible et affiche toujours Non disponible.

De plus, la liste Abonnements indique l'état de chaque abonné, comme suit :

• Running : l'abonné écoute activement les événements. Si vous modifiez l'abonné, l'abonnement continue à traiter les événements.
• Error : l'abonné a été déconnecté et ne reçoit plus les événements publiés. Un déclencheur atteint cet état lorsqu'il dépasse le nombre maximal de tentatives avec le EventBus.RetryableException. Les échecs d'assertion et les exceptions traitées de déclencheur n'entraînent pas un état d'erreur. Nous recommandons de ne pas dépasser neuf nouvelles tentatives afin d'éviter cet état. Lorsque vous corrigez et enregistrez le déclencheur, ou un déclencheur de package géré si vous redéployez le package, le déclencheur reprend automatiquement à partir du conseil, en commençant par les nouveaux événements. Vous pouvez également reprendre l'abonnement à un déclencheur dans la page de détail d'abonnement, accessible depuis la page de l'événement de plate-forme.
• Suspended : l'abonné est déconnecté et ne peut pas recevoir les événements, car un administrateur Salesforce l'a suspendu ou en raison d'une erreur interne. Vous pouvez reprendre l'abonnement à un déclencheur dans la page de détail d'abonnement, accessible depuis la page de l'événement de plate-forme. Pour reprendre un processus, désactivez-le, puis réactivez-le. Si vous modifiez l'abonné, l'abonnement reprend automatiquement à partir de conseil, en commençant par les nouveaux événements.

Remarque Un seul abonné « Process » est affiché dans la liste Abonnements de toutes les interviews de flux interrompues abonnées à l'événement de plate-forme. Les processus et les flux déclenchés par un événement de plate-forme sont répertoriés individuellement.

De plus, des informations sur les abonnés aux événements sont exposées dans l'objet EventBusSubscriber. Vous pouvez interroger cet objet pour obtenir des détails sur les abonnés.

Suspension ou reprise d'un abonnement à un déclencheur Apex :

Reprenez l'abonnement à un déclencheur suspendu à l'endroit où il s'est arrêté, en commençant par le premier message d'événement disponible stocké dans le bus d'événement. Si vous souhaitez contourner les messages d'événements qui entraînent des erreurs ou qui ne sont plus utiles, vous pouvez reprendre un abonnement de la fin, en commençant par les nouveaux messages d'événement.

Pour gérer un abonnement à un déclencheur :

1. Dans la liste associée Abonnements, cliquez sur Gérer en regard du déclencheur Apex.
2. Dans la page de détail de l'abonnement, choisissez l'action appropriée.
   • Pour suspendre un abonnement en cours, cliquez sur Suspendre.
   • Pour reprendre un abonnement suspendu, en commençant par le message d'événement le plus proche disponible dans le bus d'événement, cliquez sur Reprendre.
   • Pour reprendre un abonnement suspendu, en commençant par les nouveaux messages d'événement, cliquez sur Reprendre au début.

Vous ne pouvez pas gérer les abonnements à des flux et des processus via la liste associée Abonnements.

Remarque

• Lorsque vous modifiez un abonné, l'abonnement reprend automatiquement. Pour plus d'informations, consultez la section Abonnés aux événements.
• Si vous cliquez sur Reprendre pour un déclencheur sous un état d'erreur, le déclencheur ignore les événements réessayés avec EventBus.RetryableException. L'abonnement commence par les événements non traités envoyés après l'état d'erreur et qui correspondent à la période de rétention.

Considération relatives à l'événement de plate-forme

• Sécurité au niveau du champ : tous les champs d'événement de plate-forme sont en lecture seule par défaut et vous ne pouvez pas limiter l'accès à un champ particulier. Les autorisations de sécurité au niveau du champ ne s'appliquent pas et le message d'événement contient tous les champs.
• Application automatique des attributs de champ : les enregistrements d'événement de plate-forme sont validés pour s'assurer que les attributs de leurs champs personnalisés sont appliqués. Les attributs de champ comprennent Required et Default, la précision des champs numériques et la longueur maximale des champs de texte.
• Suppression définitive des définitions d'événements : lorsque vous supprimez une définition d'événement, elle est définitivement retirée et ne peut pas être restaurée. Avant de supprimer la définition d'événement, supprimez les déclencheurs associés. Les événements publiés qui utilisent la définition sont également supprimés.
• Renommage des objets événement : avant de renommer un événement, supprimez les déclencheurs associés. Si le nom de l'événement est modifié après l'abonnement de clients à cet événement, les clients abonnés doivent se réabonner à la rubrique mise à jour. Pour vous réabonner au nouvel événement, ajoutez votre déclencheur à l'objet d'événement renommé.
• Pas d'onglet associé : les événements de plate-forme n'ont pas d'onglet associé, car vous ne pouvez pas afficher des enregistrements d'événement dans l'interface utilisateur de Salesforce.
• Pas de prise en charge SOQL : vous ne pouvez pas interroger des messages d'événement en utilisant SOQL.
• Pas de prise en charge de pages d'enregistrement dans le générateur d'applications Lightning : lors de la création d'une page d'enregistrement dans le Générateur d'applications Lightning, les événements de plate-forme que vous définissez sont affichés dans la liste des objets de la page. Cependant, vous ne pouvez pas créer de page d'enregistrement Lightning pour des événements de plate-forme, car les enregistrements d'événements ne sont pas disponibles dans l'interface utilisateur.
• Événements de plate-forme lors de la désinstallation de package : quand un package avec l'option Enregistrer une copie des données de ce package 48 heures après la désinstallation activée est désinstallé, les événements de plate-forme ne sont pas exportés.
• Volume d'événements dans les installations et les mises à niveau de package : l'installation d'un package géré ou non géré qui contient des événements de plate-forme à haut volume peut entraîner l'enregistrement d'événements sous le type haut volume dans l'organisation abonnée. La mise à niveau d'un package géré ne change pas le volume des événements dans l'organisation abonnée.
• Pas de prise en charge des éditions Professional et Group : les événements de plate-forme ne sont pas pris en charge dans les organisations Professional et Group Edition. L'installation d'un package contenant des objets d'événement de plate-forme échoue dans ces organisations.