Integração do chat do Salesforce

Essa integração de chat usa um componente da Web do Lightning (LWC, na sigla em inglês) do Salesforce para integrar com os módulos da interface do Agent Assist para conversas de chat.

Confira uma visão geral da integração de chat:

Arquitetura para a integração do chat do Agent Assist com o Salesforce

Antes de começar

Para integrar os módulos da interface do Agent Assist ao Salesforce, você precisa de acesso aos seguintes recursos:

  • Node.js: siga as instruções de instalação recomendadas para seu sistema operacional.

  • CLI do Salesforce: siga as instruções de instalação recomendadas para seu sistema operacional.

  • Google Cloud CLI: instale o comando gcloud conforme as instruções e faça a autenticação usando gcloud auth login.

  • Salesforce: faça login no URL da instância ou na página de login do Salesforce e observe o seguinte:

    • O URL do Meu domínio do Salesforce. Siga estas etapas para encontrar o URL do Meu domínio:
      1. Acesse a barra de menus > menu Configuração.
      2. Clique em Configuração.
      3. Na caixa Pesquisa rápida, digite Meu domínio. O nome de domínio está no seguinte formato: MY-DOMAIN-NAME.develop.my.salesforce.com.
    • O ID da sua organização do Salesforce. Siga estas etapas para encontrar o ID da organização:
      1. Acesse a barra de menus > menu Configuração.
      2. Clique em Configuração.
      3. Na caixa Pesquisa rápida, digite Informações da empresa.

  • Back-end de integração do Agent Assist:

    1. Siga as instruções para configurar a integração.
    2. Antes de executar o script de implantação, configure as seguintes variáveis de ambiente com deploy.sh ou em um arquivo .env na raiz do projeto:
      • AUTH_OPTION: defina como SalesforceLWC.
      • SALESFORCE_DOMAIN: um nome de domínio semelhante a YOUR_SUBDOMAIN.develop.lightning.force.com. Você observou esse valor no pré-requisito do Salesforce. Não inclua https://.
      • SALESFORCE_ORGANIZATION_ID: você observou esse valor no pré-requisito do Salesforce.

Etapa 1: configurar o projeto de desenvolvimento do Salesforce

Para começar a integrar os módulos da interface do Agent Assist, siga estas etapas.

  1. Execute o código a seguir para clonar o repositório de integração do Agent Assist e abrir seu projeto:

    git clone https://github.com/GoogleCloudPlatform/agent-assist-integrations
cd salesforce/aa-lwc

  2. Execute os comandos a seguir para fazer o download dos arquivos JavaScript dos módulos da interface que você vai implantar mais tarde como recursos estáticos. O Salesforce exige recursos estáticos para carregar JavaScript de terceiros. Ele também impõe um limite de 5 MB para arquivos de recursos estáticos. Portanto, os arquivos JavaScript são enviados como um arquivo zip.

    npm run generate-static-resources
npm install

Etapa 2: configurar o ambiente do Salesforce

É possível integrar os módulos da interface do Agent Assist em um ambiente específico, como produção ou desenvolvimento. O Salesforce chama esses ambientes organizações (orgs).

Configurar sua organização no console do Salesforce

No console do Salesforce, siga estas etapas para configurar sua organização para a integração do Agent Assist.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Configurações do Omni-Channel e clique em Configurações do Omni-Channel.
    1. Selecione Ativar o Omni-Channel.
    2. Selecione Fazer login automaticamente dos agentes no Omni-Channel na nova janela ou guia.
    3. Clique em Salvar.
  2. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Comunidades e clique em Experiências digitais > Configurações.
    1. Selecione Ativar espaços de trabalho de experiência.
    2. Clique em Salvar.

Configurar sua organização com a CLI do Salesforce

Siga estas etapas para usar a CLI do Salesforce para configurar sua organização para a integração do Agent Assist.

  1. Execute o código a seguir e autentique a CLI usando os dados de login do Salesforce que você usa normalmente.

    npm run login

  2. Execute o código a seguir para implantar o LWC na organização.

    npm run deploy

Etapa 3: criar um app cliente externo

O LWC do Salesforce usa o fluxo de credenciais do cliente OAuth 2.0 para autenticar você. Um app cliente externo ativa o fluxo de credenciais do cliente. Use o token do cliente e o secret do consumidor do app para configurar o LWC do Salesforce para autenticar usuários com o Salesforce.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Gerenciador de apps de clientes externos.
    1. Clique em Gerenciador de apps de clientes externos > Novo app de cliente externo > Criar e insira as seguintes informações.
      • Nome do app de cliente externo: lwc auth
      • Nome da API: lwc_auth
      • E-mail de contato: your_email@example.com
      • API (ativar configurações do OAuth) > Ativar OAuth: selecionado
      • API (ativar configurações do OAuth) > URL de callback: https://login.salesforce.com/services/oauth2/callback
      • API (ativar configurações do OAuth) > escopos do OAuth selecionados: acessar o serviço de URL de identidade
      • API (ativar configurações do OAuth) > ativar o fluxo de credenciais do cliente : selecionado
    2. Clique em Criar.
  2. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Gerenciador de apps de clientes externos.
    1. Clique no nome do app cliente externo > Editar.
    2. Acesse Políticas do OAuth > Fluxos do OAuth e melhorias do app cliente externo.
    3. Verifique se a opção Ativar o fluxo de credenciais do cliente está selecionada.
    4. Em Executar como, insira seu nome de usuário de login.
    5. Clique em Salvar.
  3. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Gerenciador de apps de clientes externos.
    1. Clique no nome do app cliente externo > Editar.
    2. Acesse Configurações do OAuth > Configurações do app > Chave e secret do consumidor.
    3. Insira o código de verificação enviado para seu e-mail.
    4. Copie o token do cliente e o secret do consumidor para um local seguro. Você vai precisar deles para uma etapa posterior.

Estabelecer políticas de segurança de conteúdo e CORS

  1. Acesse a barra de menus > menu Configuração e clique em Configuração.
  2. Na caixa Pesquisa rápida , digite CORS e clique em Editar.
    1. Selecione Ativar o CORS para endpoints OAuth.
    2. Clique em Salvar.
  3. Acesse a barra de menus > menu Configuração e clique em Configuração.
  4. Na caixa Pesquisa rápida , digite URLs confiáveis e clique em Novo URL confiável.
  5. Digite as informações a seguir:
    • Nome da API: ui_connector
    • URL: insira o URL do endpoint do serviço do conector da interface do Cloud Run que você implantou com o back-end de integração do Agent Assist. Esse URL pode ser encontrado no console do Cloud Run. Por exemplo: https://UI_CONNECTOR_SUBDOMAIN.GCP_REGION.run.app.
    • Diretivas de CSP: marque todas as caixas de seleção.
    • Clique em Salvar e novo.
  6. Digite as informações a seguir:
    • Nome da API: ui_connector_wss
    • URL: insira o URL do Secure WebSockets para o endpoint do serviço do conector da interface: wss://UI_CONNECTOR_SUBDOMAIN.GCP_REGION.run.app.
    • Diretivas de CSP: marque todas as caixas de seleção.
    • Clique em Salvar e novo.
  7. Digite as informações a seguir:
    • Nome da API: salesforce_domain
    • URL: insira o URL do seu domínio do Salesforce com o seguinte formato: https://YOUR_SUBDOMAIN.my.salesforce.com.
    • Diretivas de CSP: marque todas as caixas de seleção.
    • Clique em Salvar.

Etapa 4: configurar o cliente de chat

Para usar os módulos da interface do Agent Assist com o Salesforce, você precisa de um cliente de chat na área de trabalho do agente.

Configurar o chat aprimorado

Siga estas etapas para configurar seu messenger.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Insira uma pesquisa de Pesquisa rápida para Filas e clique em Nova.
    1. Digite as informações a seguir:
      • Rótulo: Messaging Queue
      • Nome da fila: Messaging_Queue
      • Configuração de roteamento: Messaging_Routing_Configuration
    2. Clique em Objetos compatíveis e adicione Usuário de mensagens e Sessão de mensagens.
    3. Clique em Participantes da fila e adicione Usuário: seu usuário de login.
    4. Clique em Salvar.
  2. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Conjuntos de permissões.
    1. Clique em Conjunto de permissões de agentes de mensagens.
    2. Clique em Acesso a status de presença de serviço > Editar.
    3. Selecione os status Ocupado e On-line – Mensagens.
    4. Clique em Adicionar > Salvar.
  3. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Usuários e clique em Usuários.
    1. Clique no seu nome de usuário e verifique se o Usuário do Service Cloud está ativado.
    2. Encontre Atribuições de licença do conjunto de permissões na página.
    3. Clique em Editar atribuições e selecione Enhanced Chat User.
    4. Clique em Salvar.
    5. Encontre Atribuições de conjunto de permissões na página.
    6. Clique em Editar atribuições e selecione Conjunto de permissões de agente de mensagens Set.
    7. Clique em Adicionar > Salvar.
  4. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida , digite Configurações de mensagens e clique em Novo canal.
    1. Selecione Chat aprimorado.
    2. Insira o Nome: Messaging Channel.
    3. Clique em Salvar.
    4. Defina o Tipo de roteamento como Omni-Queue e Fila como Fila de mensagens.
    5. Clique em Salvar e acesse Configurações de mensagens.
    6. Clique no nome do canal de mensagens e em Ativar.
    7. Depois de ler, aceite os Termos e condições.
  5. Acesse a barra de menus > menu Configuração e clique em Configuração. Na caixa Pesquisa rápida, digite Implantações de serviço incorporado e clique em Nova implantação.
    1. Clique em Chat aprimorado > Próxima > Web > Próxima.
    2. Preencha os seguintes detalhes:
      • Nome: Messaging Embedded Service Deployment
      • Nome do desenvolvedor: Messaging_Embedded_Service_Deployment
      • Domínio: example.com
      • Canal: Messaging Channel
    3. Clique em Salvar. Aguarde a conclusão da implantação.
    4. Nas configurações de Implantação de serviço incorporado, clique em Publicar.
    5. Clique em Atualizar e em Testar mensagens.

Testar o chat aprimorado

Siga estas etapas para testar seu messenger.

  1. Clique em Testar mensagens.
  2. Depois que a nova guia for carregada, clique no balão de diálogo para iniciar uma nova conversa de teste.
  3. Envie uma mensagem, como Teste.
  4. Acesse a guia do navegador do Salesforce.
  5. Na barra de ferramentas Configuração , clique no menu Acesso rápido aos apps e selecione Console de serviço.
  6. Clique em Omni-Channel na barra de ferramentas de utilitários.
  7. Defina seu status como On-line – Mensagens.
  8. Aceite a mensagem recebida. Isso abre uma nova guia no Console de serviço para a conversa. Não é possível ver a transcrição do chat.
  9. Acesse a barra de menus > menu Configuração.
  10. Clique em Editar página.
  11. No menu Componentes, arraste o componente Conversa aprimorada para o painel Conversa.
  12. Clique em Salvar > Ativar > Atribuir como padrão da organização > Computador > Voltar .
  13. Atualize a página.
  14. Clique em Omni-Channel na barra de ferramentas de utilitários.
  15. Defina seu status como On-line – Mensagens.
  16. Responda à mensagem Teste para validar se as mensagens estão funcionando.

Se você ficar preso e precisar de mais informações, consulte o abrangente Guia de configuração do chat aprimorado do Salesforce.

Etapa 5: instalar o componente da Web do Lightning do Salesforce

Siga estas etapas para adicionar o LWC do Salesforce a uma página de sessão de mensagens usando o editor do Lightning Experience. Continue com a conversa de teste da etapa 4.

  1. Acesse a barra de menus > menu Configuração e clique em Editar página.

  2. Na barra lateral Componentes, mova o agentAssistContainerModule para a barra lateral.

  3. Clique no componente que você colocou na etapa anterior.

  4. Preencha os campos do formulário da seguinte maneira para adicionar detalhes de configuração.

    • endpoint: o URL do conector da interface do back-UI de integração do agente, como um URL do console do Cloud Run, como: https://UI_CONNECTOR_ENDPOINT.GCP_REGION.run.app
    • recursos: recursos do Agent Assist ativados no seu perfil de conversa, como CONVERSATION_SUMMARIZATION,KNOWLEDGE_ASSIST_V2,SMART_REPLY, e AGENT_COACHING
    • channel: indica que o canal é chat.
    • platform: indica que a plataforma é messaging.
    • conversationProfile: o nome do recurso do perfil de conversa do Agent Assist (exemplo: projects/GCP_PROJECT_ID/locations/GCP_REGION/conversationProfiles/CONVERSATION_PROFILE_ID)
    • consumerKey: o token do cliente do app cliente externo da etapa 3.
    • consumerSecret: o secret do consumidor do app cliente externo da etapa 3.