Suscribirse a eventos de plataforma

• Describir cómo suscribirse a mensajes de eventos de plataforma.
• Suscribirse a un evento en la plataforma y en aplicaciones externas.
• Probar eventos de plataforma en un método de prueba de Apex.
• Suscribirse a eventos de plataforma mediante CometD.

Nota

El reto práctico para esta insignia está localizado al japonés, español (LATAM) y portugués (Brasil). Para cambiar el idioma de su Trailhead Playground, siga estas instrucciones. Puede que la localización esté desactualizada. Si no aprueba el reto con las instrucciones localizadas, cambie el idioma a inglés y la configuración local a Estados Unidos, y vuelva a intentarlo.

Consulte la insignia Trailhead en su idioma para obtener más información sobre cómo aprovechar la experiencia de Trailhead en otros idiomas.

// 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;
}

Configurar los registros de depuración

A diferencia de los desencadenadores de los objetos estándar o personalizados, los desencadenadores de los eventos de plataforma no se ejecutan en la transacción de Apex usada para la publicación de eventos. El desencadenador se ejecuta en su propio proceso debajo de la entidad Proceso automatizado, la cual se corresponde con un usuario del sistema. Por consiguiente, los registros de depuración resultantes para la ejecución del desencadenador se crean mediante la entidad Proceso automatizado y no están disponibles en Developer Console. Para recopilar los registros de un desencadenador de eventos de plataforma, agregue una entrada de indicador de rastreo para la entidad Proceso automatizado en Configuración.

1. En Configuración, ingrese Registros de depuración en el cuadro Búsqueda rápida y, a continuación, haga clic en Registros de depuración.
2. Haga clic en Nuevo.
3. Para Tipo de entidad rastreada, seleccione Proceso automatizado.
4. Seleccione la fecha de inicio y la fecha de caducidad para los registros que desee recopilar.
5. Para Nivel de depuración, ingrese * y haga clic en Buscar.
6. Seleccione un nivel de depuración predefinido, como SFDC_DevConsole, o haga clic en Nuevo para crear su propio nivel de depuración.
7. Haga clic en Guardar.

Los registros de depuración para las pruebas de Apex son una excepción. Se incluyen registros para desencadenadores de eventos en el mismo registro de ejecución de las pruebas.

Consideraciones sobre los desencadenadores de eventos de plataforma

Lista relacionada Suscripciones en la página de definición de eventos

Puede ver el estado de todos los desencadenadores de eventos en la página de detalles de definición de eventos de plataforma de Configuración. Debajo de Suscripciones, se indica cada desencadenador activo junto con la información de ejecución y el estado. Esta información incluye el Id. de reproducción de los últimos eventos publicados y procesados. El estado indica si el desencadenador está en ejecución o desconectado de la suscripción debido a errores sin solución o permisos insuficientes. El estado Error solo se alcanza cuando un desencadenador supera el número máximo de reintentos. En la siguiente captura de pantalla se muestra la lista relacionada Suscripciones de la página de detalles del evento Cloud News.

• La lista relacionada Suscripciones también enumera flujos y procesos suscritos al evento.
• La lista relacionada Suscripciones no incluye los suscriptores que utilizan CometD, el modelo de publicación y suscripción de la API o el componente Lightning empApi. Obtiene información acerca de los otros tipos de suscriptores más adelante en esta unidad.
• Para eventos de plataforma de alto volumen, el valor Último Id. publicado no está disponible y siempre se muestra como No disponible.

Gestionar suscriptores de desencadenador de Apex de un evento

Reanude una suscripción suspendida donde se dejó, comenzando desde el mensaje de evento más temprano que está disponible en el bus de eventos. Si desea omitir mensajes de eventos que están causando errores o ya no son necesarios, puede reanudar la suscripción desde el extremo, comenzando desde nuevos mensajes de eventos.

Para gestionar una suscripción de desencadenador, en la lista relacionada Suscripciones, haga clic en Gestionar junto al desencadenador de Apex.

• Para suspender una suscripción en ejecución, haga clic en Suspend (Suspender).
  
  
• Para reanudar una suscripción suspendida, comenzando desde el primer mensaje de evento disponible en el bus de eventos, haga clic en Reanudar.
• Para reanudar una suscripción suspendida, a partir de nuevos mensajes de eventos, haga clic en Resume from Tip (Reanudar desde extremo).
  
  

Cuando guarda un desencadenador, la suscripción de desencadenador se reanuda automáticamente. Para más información, consulte Ver y gestionar suscriptores de un evento en la página de detalles del evento de plataforma en la Guía del desarrollador de eventos de plataforma.

// 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());
    }
}

Suscribirse a un componente web Lightning

Para utilizar los métodos empApi en su componente web Lightning, importe los métodos desde el módulo lightning/empApi de la manera siguiente.

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

Luego llame a los métodos importados en su código JavaScript.

Para consultar un ejemplo de cómo utilizar el módulo lightning/empApi y una referencia completa, consulte la documentación lightning-emp-api en la Biblioteca de componentes Lightning.

Suscribirse a un componente 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>'}
    });

Suscribirse a notificaciones de eventos de plataforma con el modelo de publicación y suscripción de la API

El modelo de publicación y suscripción de la API proporciona una única interfaz para publicar y suscribirse a los eventos de plataforma. Basada en la API gRPC y HTTP/2, el modelo de publicación y suscripción de la API publica y entrega de forma eficiente mensajes de eventos binarios en formato Apache Avro. gRPC es un marco de trabajo de código abierto de llamada a procedimientos remotos (RPC) que permite conectar dispositivos, aplicaciones móviles y navegadores a servicios de backend. Para obtener más información, consulte la Documentación de gRPC. Apache Avro es un sistema de serialización de datos. Para obtener más información, consulte Apache Avro.

El modelo de publicación y suscripción de la API utiliza un modelo de suscripciones basadas en extracción, en el que el cliente solicita un número de eventos al servidor según su capacidad de procesamiento. A diferencia de las suscripciones basadas en distribución, en las que un cliente espera recibir nuevos eventos distribuidos desde el servidor, con una suscripción basada en extracción, un cliente solicita eventos al servidor de manera proactiva. Este control de flujo de eventos asegura que el cliente no se abrume con más eventos de los que puede manejar si hay un pico de publicación de eventos.

Algunos de los beneficios que ofrece el modelo de publicación y suscripción de la API son los siguientes:

• Publicación, suscripción y recuperación de esquemas de eventos, todo en una sola API.
• Resultados publicados finales de las operaciones de publicación, no los resultados intermedios de las colas.
• Control de flujo que permite especificar cuántos eventos recibir en una llamada de suscripción según la velocidad de procesamiento de eventos del cliente.
• Transmisión de datos en tiempo real y de alto desempeño que utiliza la compresión a través de HTTP/2.
• Soporte para 11 idiomas de programación en el cliente que ofrece la API gRPC, como Python, Java, Node y C++. Para conocer todos los idiomas admitidos, consulte https://grpc.io/docs/languages/.

Al igual que con los clientes de CometD, puede suscribirse a eventos de plataforma al especificar un canal de evento o un canal personalizado.

Mensaje de evento de plataforma en formato JSON en un cliente de CometD

El mensaje de un evento de plataforma enviado es similar al siguiente ejemplo de un evento 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"
}

El campo de esquema del mensaje de evento contiene el Id. del esquema de evento de plataforma (en este ejemplo, "schema":"_2DBiqh-utQNAjUH78FdbQ"). Dado que hay varias versiones del esquema, cuando cambia el esquema, también cambia el Id. del esquema.

Para determinar si el esquema de un evento ha cambiado, recupere el esquema mediante la API de REST. Para usar el Id. del esquema, envíe una solicitud GET a este recurso de la API de REST: /vXX.X/event/eventSchema/Schema_ID. Una alternativa es recuperar el esquema del evento mediante la especificación del nombre del evento en este extremo: /vXX.X/sobjects/Platform_Event_Name__e/eventSchema. Para obtener más información, consulte la guía del desarrollador de la API de REST.

Ahora que ya sabe cómo usar los eventos de plataforma en aplicaciones de la plataforma de Salesforce y en aplicaciones externas, ¡las posibilidades son infinitas! Use los eventos de plataforma para cualquier número de aplicaciones e integraciones, como el procesamiento de transacciones de negocio o la asistencia al cliente proactiva. Los eventos de plataforma le permiten adoptar un modelo de programación basado en eventos y disfrutar de las ventajas de una arquitectura de software basada en eventos.