Inscrever-se em eventos de plataforma

• Descrever como se inscrever para receber mensagens de eventos de plataforma.
• Inscreva-se em um evento na plataforma e em aplicativos externos.
• Testar eventos de plataforma em um método de teste do Apex.
• Inscrever-se em eventos de plataforma por meio do CometD.

Nota

O desafio prático para esse emblema está traduzido para japonês, espanhol (América Latina) e português (Brasil). Para definir o idioma do seu Trailhead Playground, siga essas instruções. A tradução pode estar desatualizada. Se você não conseguir passar no desafio usando as instruções traduzidas, defina o idioma para inglês e a localidade para Estados Unidos. Em seguida, tente novamente.

Consulte o emblema Trailhead no seu idioma para saber mais sobre como aproveitar a experiência de Trailhead em outros 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 registro de depuração

Diferentemente do que acontece com acionadores em objetos padrão ou personalizados, os acionadores em eventos de plataforma não são executados na mesma transação do Apex que aquela que publicou o evento. O acionador é executado em seu próprio processo sob a entidade de Processo automatizado, que é um usuário do sistema. Como resultado, os registros de depuração correspondentes à execução do acionador são criados pela entidade de Processo automatizado e não estão disponíveis no Console do desenvolvedor. Para coletar registros de acionador de evento de plataforma, adicione uma entrada de sinalizador de rastreio para a entidade de Processo automatizado em Setup (Configuração).

1. Em Setup (Configuração), digite Debug Logs (Registros de depuração) na caixa Quick Find (Busca rápida) e depois clique em Debug Logs (Registros de depuração).
2. Clique em Novo.
3. Em Traced Entity Type (Tipo de entidade rastreada), selecione Automated Process (Processo automatizado).
4. Selecione a data de início e a data de expiração para os registros que deseja coletar.
5. Em Debug Level (Nível de depuração), digite * e clique em Search (Pesquisar).
6. Selecione um nível de depuração predefinido, como SFDC_DevConsole, ou clique em New (Novo) para criar seu próprio nível de depuração.
7. Clique em Salvar.

Registros de depuração para testes do Apex são uma exceção. Eles incluem registros para acionadores de evento no mesmo registro de execução de teste.

Coisas a se observar sobre acionadores de evento de plataforma

Lista relacionada de Inscrições na página de definição de evento

Você pode visualizar o estado de todos os acionadores de evento na página Platform Event Definition Detail (Detalhes de definição de evento de plataforma) em Setup (Configuração). Em Subscriptions (Inscrições), cada acionador ativo é listado juntamente com as informações de execução e o estado. As informações incluem a ID de reprodução dos últimos eventos publicados e processados. O estado indica se o acionador está sendo executado ou se está desconectado da inscrição devido a erros irrecuperáveis ou a permissões insuficientes. O estado Error (Erro) é alcançado apenas quando um acionador foi experimentado o número máximo de vezes. O instantâneo abaixo mostra a lista relacionada de Inscrições na página de detalhes do evento Cloud News.

• A lista relacionada de Assinaturas também lista fluxos e processos que estão inscritos no evento.
• A lista relacionada de Assinaturas não inclui assinantes que usam CometD, API Pub/Sub ou o componente empApi do Lightning. Você aprenderá sobre os outros tipos de assinantes mais adiante nesta unidade.
• Para eventos de plataforma de alto volume, o valor do Último ID publicado não está disponível e é sempre mostrado como Não disponível.

Gerenciar assinantes do acionador do Apex de um evento

Retome uma assinatura suspensa de onde parou, começando do mensagem de evento mais antigo que está disponível no barramento de eventos. Se você quiser ignorar mensagens de evento que estão causando erros ou que não são mais necessárias, você pode retomar a assinatura a partir da dica, começando das mensagens de novos eventos.

Para gerenciar uma assinatura de acionador, nas listas relacionadas de Assinaturas, clique em Gerenciar ao lado do acionador do Apex.

• Para suspender uma assinatura em execução, clique em Suspend (Suspender).
  
  
• Para retomar uma assinatura suspensa, a partir da mensagem de evento mais antiga disponível no barramento de eventos, clique em Retomar.
• Para retomar uma assinatura suspensa, a partir das mensagens de novos eventos, clique em Resume from Tip (Retomar da dica).
  
  

Quando você salva um acionador, a assinatura do acionador é retomada automaticamente. Para saber mais, consulte Exibir e gerenciar assinantes de um evento na página de detalhes do evento de plataforma no Guia do desenvolvedor 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());
    }
}

Inscrever-se em um Componente Web do Lightning

Para usar os métodos empApi em seu componente Web do Lightning, importe os métodos do módulo lightning/empApi conforme abaixo.

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

Em seguida, chame os métodos importados em seu código JavaScript.

Para obter um exemplo de como usar o módulo lightning/empApi e uma referência completa, consulte a documentação lightning-emp-api na Biblioteca de Componentes do Lightning.

Inscrever-se em um 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>'}
    });

Inscrever-se em notificações de eventos de plataforma com a API Pub/Sub

A API Pub/Sub fornece uma interface única para publicação e inscrição em eventos de plataforma. Baseada na API gRPC e em HTTP/2, a API Pub/Sub publica e entrega com eficácia mensagens de evento binárias no formato Apache Avro. A gRPC é uma estrutura RPC (Remote Procedure Call) de código aberto que permite a conexão de dispositivos, aplicativos móveis e navegadores a serviços back-end. Para obter mais informações, consulte a Documentação sobre gRPC. O Apache Avro é um sistema de serialização de dados. Para obter mais informações, consulte Apache Avro.

A API Pub/Sub usa um modelo de assinatura por demanda no qual o cliente requisita uma quantidade de eventos do servidor baseado em sua capacidade de processamento. Diferente das assinaturas baseadas em notificações, nas quais o cliente espera para receber novos eventos enviados pelo servidor, com uma assinatura por demanda o cliente requisita eventos proativamente do servidor. Este controle de fluxo de eventos garante que o cliente não fique sobrecarregado com mais eventos do que ele pode tratar se houver um pico na publicação de eventos.

Alguns dos benefícios que a API Pub/Sub fornece incluem:

• Publicação, assinatura e recuperação de esquema de evento em apenas uma API.
• Publicação final de resultados de operações de publicação, em vez de resultados intermediários de enfileiramento.
• Controle de fluxo que permite especificar quantos eventos receber em uma chamada de assinatura baseada em velocidade de processamento de eventos no cliente.
• Transmissão de dados em tempo real de alto desempenho que usa compressão através de HTTP/2.
• Compatibilidade com 11 linguagens de programação no cliente, oferecidas pela API gRPC, como Python, Java, Node e C++. Para conhecer todas as linguagens compatíveis, consulte https://grpc.io/docs/languages/.

Semelhante aos clientes CometD, você pode se inscrever em eventos de plataforma especificando um canal de evento ou um canal personalizado.

Mensagem de evento de plataforma em formato JSON em um cliente CometD

A mensagem de um evento de plataforma entregue se parece com o exemplo abaixo para um 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"
}

O campo de esquema na mensagem de evento contém a ID do esquema de evento de plataforma (neste exemplo, é "schema":"_2DBiqh-utQNAjUH78FdbQ"). O esquema é compatível com versões – quando o esquema muda, a ID do esquema também muda.

Para determinar se o esquema de um evento foi alterado, recupere o esquema por meio da API REST. Use a ID do esquema executando uma solicitação GET para este recurso API REST: /vXX.X/event/eventSchema/Schema_ID. Ou então você pode recuperar o esquema do evento fornecendo o nome do evento a este ponto de extremidade: /vXX.X/sobjects/Platform_Event_Name__e/eventSchema. Para obter mais informações, consulte o Guia do desenvolvedor da API REST.

Agora que você viu como usar eventos de plataforma na Salesforce Platform e em aplicativos externos, as possibilidades são infinitas! Use eventos de plataforma para diversas aplicações e integrações, como o processamento de transações comerciais ou a participação em um serviço de atendimento ao cliente proativo. Com os eventos de plataforma, você adota um modelo de programação baseado em eventos e aproveita os benefícios da arquitetura de software baseada em eventos.