Souscription à des événements de plate-forme

• Expliquer comment souscrire à des messages d'événements de plate-forme.
• Vous abonner à un événement à partir de la plate-forme et d’applications externes
• Tester des événements de plate-forme dans une méthode de test Apex
• Souscription à des événements de plate-forme via CometD.

Remarque

Vous souhaitez apprendre en français ? Dans ce badge, les validations de défi pratique Trailhead se font en anglais. Les traductions sont fournies entre parenthèses à titre de référence. Dans votre Trailhead Playground, veillez (1) à définir les États-Unis comme région, (2) à sélectionner l’anglais comme langue, et (3) à copier et coller uniquement les valeurs en anglais. Suivez les instructions ici.

Consultez le badge Trailhead dans votre langue pour découvrir comment profiter de l’expérience Trailhead traduite.

// Trigger for listening to Cloud_News events.
trigger CloudNewsTrigger on Cloud_News__e (after insert) {
    // List to hold all cases to be created.
    List<Case> cases = new List<Case>();
    // Get queue Id for case owner
    Group queue = [SELECT Id FROM Group WHERE Name='Regional Dispatch' AND Type='Queue'];
    // Iterate through each notification.
    for (Cloud_News__e event : Trigger.New) {
        if (event.Urgent__c == true) {
            // Create Case to dispatch new team.
            Case cs = new Case();
            cs.Priority = 'High';
            cs.Subject = 'News team dispatch to ' +
                event.Location__c;
            cs.OwnerId = queue.Id;
            cases.add(cs);
        }
   }
    // Insert all cases corresponding to events received.
    insert cases;
}

Configurer la journalisation de débogage

Contrairement aux déclencheurs portant sur des objets standard ou personnalisés, les déclencheurs portant sur des événements de plate-forme ne s’exécutent pas dans la transaction Apex qui a publié l’événement. Le déclencheur exécute son propre processus sous l'entité Processus automatisé, qui est un utilisateur système. Par conséquent, les journaux de débogage correspondant à l’exécution du déclencheur sont créés par l’entité Processus automatisé et ne sont pas disponibles dans la Developer Console. Pour recueillir les journaux des déclencheurs des événements de plate-forme, ajoutez un marqueur de suivi pour l’entité Processus automatisé dans Configuration.

1. Dans Configuration, saisissez Journaux de débogage dans la zone Recherche rapide, puis cliquez sur Journaux de débogage.
2. Cliquez sur Nouveau.
3. Sélectionnez Processus automatisé comme Type d'entité suivie.
4. Sélectionnez la date de début et la date d'expiration des journaux que vous voulez recueillir.
5. Dans Niveau de débogage, saisissez * et cliquez sur Rechercher.
6. Sélectionnez un niveau de débogage prédéfini comme SFDC_DevConsole, ou cliquez sur Nouveau pour créer le vôtre.
7. Cliquez sur Enregistrer.

Les journaux de débogage des tests Apex sont une exception. Ils consignent les déclencheurs d'événements dans le même journal d’exécution de test.

À savoir sur les déclencheurs d’événements de plate-forme

Liste associée de souscriptions sur la page de définition d’événement

Vous pouvez consulter l'état de tous les déclencheurs d’événements sur la page Détails de définition d'événement de plate-forme, dans Configuration. Sous Souscriptions, chaque déclencheur actif est indiqué avec ses informations d’exécution et son état. Les informations incluent l’ID de relecture des derniers événements publiés et traités. L’état indique si le déclencheur est en cours d’exécution ou s'il est déconnecté de la souscription en raison d’erreurs irrécupérables ou d'autorisations insuffisantes. L'état d’erreur n’est atteint que lorsque le nombre maximal de tentatives autorisées pour le déclencheur a été dépassé. La capture d'écran montre la liste associée de souscriptions sur la page de détails de l'événement Cloud News.

• La liste associée Abonnements répertorie également les flux et les processus qui sont abonnés à l’événement.
• La liste associée Abonnements n’inclut pas les abonnés qui utilisent CometD, l’API Pub/Sub ou le composant Lightning empApi. Nous reviendrons plus loin dans cette unité sur les autres types d’abonnés.
• Pour les événements de plate-forme haut volume, la valeur de l’ID de dernier publié n’est pas disponible et est toujours affichée comme Non disponible.

Gestion des abonnés au déclencheur Apex d’un événement

Reprenez un abonnement suspendu là où il s’était arrêté, en commençant par le premier message d’événement disponible dans le bus d’événements. Si vous souhaitez contourner des messages d’événement qui provoquent des erreurs ou qui ne sont plus nécessaires, vous pouvez reprendre l’abonnement par la fin, en commençant par les nouveaux messages d’événement.

Pour gérer un abonnement au déclencheur, dans la liste associée Abonnements, cliquez sur Gérer à côté du déclencheur Apex.

• Pour suspendre un abonnement en cours, cliquez sur Suspendre.
  
  
• Pour reprendre un abonnement suspendu, en commençant par le premier message d’événement disponible dans le bus d’événements, cliquez sur Reprendre.
• Pour reprendre un abonnement suspendu, en commençant par les nouveaux messages d’événement, cliquez sur Reprendre par la fin.
  
  

Lorsque vous enregistrez un déclencheur, l’abonnement au déclencheur reprend automatiquement. Pour plus d’informations, consultez la page Affichage et gestion des abonnés à un événement sur la page de détail de l’événement de plate-forme dans le Guide du développeur d’événements de plate-forme.

// Create test events
Test.startTest();
// Publish events
Test.stopTest();
// Perform validation here

@isTest
public class PlatformEventTest {
    @isTest static void test1() {
        // Create test event instance
        Cloud_News__e newsEvent = new Cloud_News__e(
            Location__c='Mountain City',
            Urgent__c=true,
            News_Content__c='Test message.');
        Test.startTest();
        // Call method to publish events
        Database.SaveResult sr = EventBus.publish(newsEvent);
        Test.stopTest();
        // Perform validation here
        // Verify that the publish was successful
        System.assertEquals(true, sr.isSuccess());
        // Check that the case that the trigger created is present.
        List<Case> cases = [SELECT Id FROM Case];
        // Validate that this case was found.
        // There is only one test case in test context.
        System.assertEquals(1, cases.size());
    }
}

Abonnement dans un composant Lightning Web

Pour utiliser les méthodes empApi dans votre composant Lightning Web, importez-les à partir du module lightning/empApi en écrivant le code suivant.

import { subscribe, unsubscribe, onError, setDebugFlag, isEmpEnabled }
    from 'lightning/empApi';

Appelez ensuite les méthodes importées dans votre code JavaScript.

Pour consulter un exemple d’utilisation du module lightning/empApi et obtenir la référence complète, reportez-vous à la documentation de lightning-emp-api dans la Bibliothèque de composants Lightning.

Abonnement dans un composant Aura

<lightning:empApi aura:id="empApi"/>

/event/<EventName>__e

/event/Cloud_News__e

// Connect to the CometD endpoint
    cometd.configure({
               url: 'https://<Salesforce_URL>/cometd/48.0/',
               requestHeaders: { Authorization: 'OAuth <Session_ID>'}
    });

Abonnements à des notifications d’événements de plate-forme avec une API Pub/Sub

L’API Pub/Sub fournit une interface unique pour la publication et l’abonnement à des événements de plate-forme. Basée sur l’API gRPC et HTTP/2, l’API Pub/Sub publie et diffuse efficacement des messages d’événement binaires au format Apache Avro. gRPC est une infrastructure d’appel de procédure à distance (RPC) open source qui permet de connecter des appareils, des applications mobiles et des navigateurs à des services back-end. Pour en savoir plus, consultez la Documentation gRPC. Apache Avro est un système de sérialisation des données. Pour plus d’informations, reportez-vous à Apache Avro.

L’API Pub/Sub utilise un modèle d’abonnement pull dans lequel le client demande un certain nombre d’événements au serveur en fonction de sa capacité de traitement. Contrairement aux abonnements push, avec lesquels un client attend de recevoir automatiquement de nouveaux événements depuis le serveur, avec un abonnement pull, un client demande de manière proactive de recevoir des événements depuis le serveur. Ce contrôle de flux d’événements garantit que le client ne soit pas submergé par plus d’événements qu’il ne peut gérer en cas de pic de publication d’événements.

Voici quelques avantages offerts par l’API Pub/Sub :

• Une seule API rassemble la publication, la souscription et la récupération de schéma d’événement.
• Les résultats des opérations de publication sont définitifs (et non les résultats de mise en file d’attente intermédiaires).
• Un contrôle de flux qui vous permet de spécifier le nombre d’événements à recevoir dans un appel d’abonnement en fonction de la vitesse de traitement des événements du client.
• Un flux de données en temps réel et très performant qui utilise la compression via HTTP/2.
• La prise en charge de 11 langages de programmation dans le client proposés par l’API gRPC, tels que Python, Java, Node et C++. Pour connaître tous les langages pris en charge, voir https://grpc.io/docs/languages/.

Comme avec les clients CometD, vous pouvez souscrire aux événements de plate-forme en spécifiant un canal d’événement ou un canal personnalisé.

Message d’événement de plate-forme au format JSON dans un client CometD

Le message d'un événement de plate-forme délivré est semblable à l'exemple suivant d'événement Cloud News.

{
  "data": {
    "schema": "_2DBiqh-utQNAjUH78FdbQ",
    "payload": {
      "CreatedDate": "2017-04-27T16:50:40Z",
      "CreatedById": "005D0000001cSZs",
      "Location__c": "San Francisco",
      "Urgent__c": true,
      "News_Content__c": "Large highway is closed due to asteroid collision."
    },
    "event": {
      "replayId": 2
    }
  },
  "channel": "/event/Cloud_News__e"
}

Le champ de schéma du message d’événement contient l’ID du schéma d’événement de plate-forme (dans cet exemple, il s’agit de "schema":"_2DBiqh-utQNAjUH78FdbQ"). Les versions du schéma sont gérées : quand le schéma change, l'ID de schéma change également.

Pour déterminer si le schéma d'un événement a changé, récupérez le schéma via l'API REST. Utilisez l'ID de schéma en effectuant une requête GET sur cette ressource API REST : /vXX.X/event/eventSchema/Schema_ID. Vous avez aussi la possibilité de récupérer le schéma d'événement en fournissant le nom de l'événement à ce terminal : /vXX.X/sobjects/Platform_Event_Name__e/eventSchema. Pour plus d’informations, reportez-vous au guide du développeur d’API REST.

Maintenant que vous avez vu comment utiliser les événements de plate-forme dans Salesforce et dans des applications externes, les possibilités sont infinies ! Utilisez les événements de plate-forme pour tous types d'applications et d'intégrations : traitement de transactions commerciales, opérations de service client proactives. Avec les événements de plate-forme, vous pouvez adopter un modèle de programmation orienté événement et profiter de tous les avantages d'une architecture logicielle basée sur les événements.