Integração com Salesforce

Use o componente da Web do Salesforce Lightning (LWC, na sigla em inglês) para integrar aos módulos da interface do Agent Assist em conversas por chat.

Antes de começar

Para integrar os módulos da interface da Assistente de IA 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

    A instalação da CLI do Salesforce usando npm causa problemas de compatibilidade. Para evitar esses problemas, use uma das opções de instalação do pkg (macOS), exe (Windows) ou TAR (Linux).

  • CLI gcloud

    Instale o comando gcloud conforme as instruções e faça a autenticação usando gcloud auth login.

  • Interface do Salesforce

    • Faça login no URL da sua 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. Navegue até a barra de menus > menu Configuração.
        2. Clique em Configurar.
        3. Faça uma pesquisa rápida por Meu domínio. O nome de domínio está no seguinte formato: MY-DOMAIN-NAME.develop.my.salesforce.com.
      • Seu ID da organização do Salesforce. Siga estas etapas para encontrar o ID da organização:
        1. Navegue até a barra de menus > menu Configuração.
        2. Clique em Configurar.
        3. Faça uma pesquisa Pesquisa rápida por "Informações da empresa". Observação: essas etapas de integração foram testadas apenas com a edição para desenvolvedores do Salesforce. Se você usar outra edição, poderá haver diferenças nas licenças de recursos e na interface do Salesforce.

  • 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ê anotou esse valor no pré-requisito da interface do Salesforce. Não inclua https://.
      • SALESFORCE_ORGANIZATION_ID: você anotou esse valor no pré-requisito da interface do Salesforce.

Etapa 1: configurar seu projeto

Para começar a integrar módulos da interface da Assistente de agente, 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. Faça o download dos arquivos JS, que serão implantados mais tarde como recursos estáticos, executando os seguintes comandos:

    npm run generate-static-resources
npm install

Etapa 2: configurar seu ambiente

É possível integrar módulos da interface da Assistente de IA em um ambiente específico, como produção ou desenvolvimento. O Salesforce chama esses ambientes de organizações.

Configurar sua organização no console do Salesforce

No console do Salesforce, siga estas etapas para configurar sua organização para a integração com o Assistente de agente.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Insira uma pesquisa de Localização rápida por "Configurações omnicanal" e clique em Configurações omnicanal.
    1. Marque a opção Ativar omnicanal.
    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. Faça uma pesquisa em Localização rápida por "Comunidades" e clique em Experiências digitais > Configurações.
    1. Marque 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 e configurar sua organização para a integração com o Assistente de agente.

  1. Execute o código a seguir e autentique a CLI usando os detalhes 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 permite o fluxo de credenciais do cliente. Use a chave e o segredo do consumidor do app para configurar o LWC do Salesforce e autenticar usuários com o Salesforce.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa em Pesquisa rápida por "Gerenciador de apps de clientes externos".
    1. Clique em Gerenciador de apps clientes externos > Novo app cliente externo > Criar e insira as seguintes informações:
      • Nome do app conectado: 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 retorno de chamada: https://login.salesforce.com/services/oauth2/callback
      • API (ativar configurações do OAuth) > Escopos do OAuth selecionados: acesse o serviço de URL de identidade.
      • API (ativar configurações do OAuth) > Ativar fluxo de credenciais do cliente: selecionado
    2. Clique em Criar.
  2. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa em Pesquisa rápida por "Gerenciador de apps de clientes externos".
    1. Clique no nome do app conectado > Editar.
    2. Acesse Políticas do OAuth > Fluxos do OAuth e melhorias no 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. Faça uma pesquisa em Pesquisa rápida por "Gerenciador de apps de clientes externos".
    1. Clique no nome do app conectado > Editar.
    2. Acesse Configurações do OAuth > Configurações do app > Chave e segredo do consumidor.
    3. Digite o código de verificação enviado para seu e-mail.
    4. Copie a chave e o secret do consumidor em um lugar seguro. Você vai precisar deles em uma etapa posterior.
  4. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa de Pesquisa rápida por "CORS" e clique em Editar.
    1. Confira Ativar o CORS para endpoints OAuth.
    2. Clique em Salvar.

Para mais informações sobre apps conectados, consulte os seguintes recursos do Salesforce.

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 mensagens no app e na Web

Siga estas etapas para configurar seu messenger.

  1. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa em Pesquisa rápida por "URLs confiáveis" e clique em Novo URL confiável.
    1. Insira o nome da API: ui_connector.
    2. Insira o URL do endpoint do serviço do Cloud Run do conector de interface que você implantou com o back-end de integração do Assistente do agente. O URL está no console do Cloud Run. Por exemplo, https://UI_CONNECTOR_SUBDOMAIN.us-central1.run.app.
    3. Selecione todas as opções em Diretivas da CSP.
    4. Clique em Salvar e novo.
    5. Insira o nome da API: twilio_flex.
    6. Digite o URL https://flex.twilio.com.
    7. Selecione todas as opções em Diretivas da CSP.
    8. Clique em Salvar e novo.
    9. Insira o nome da API: salesforce_domain.
    10. Insira o URL do seu domínio do Salesforce no seguinte formato: https://YOUR_SUBDOMAIN.my.salesforce.com.
    11. Selecione todas as opções em Diretivas da CSP.
    12. Clique em Salvar.
  2. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa de Pesquisa rápida por "Filas" e clique em Nova.
    1. Digite as informações a seguir:
      • Rótulo: fila de mensagens
      • Nome da fila: Messaging_Queue
      • Configuração de roteamento: Messaging_Routing_Configuration
    2. Clique em Objetos compatíveis e adicione: "Usuário de mensagens, Sessão de mensagens".
    3. Clique em Membros da fila e adicione: "Usuário: seu usuário de login".
    4. Clique em Salvar.
  3. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa Quick Find por "Conjuntos de permissões".
    1. Clique em Conjunto de permissões de agentes de mensagens.
    2. Clique em Acesso aos status de presença no serviço > Editar.
    3. Selecione os status Ocupado e On-line - Mensagens.
    4. Clique em Adicionar > Salvar.
  4. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa de Pesquisa rápida por "Usuários" e clique em Usuários.
    1. Clique no seu nome de usuário e verifique se a opção Usuário do Service Cloud está ativada.
    2. Encontre Atribuições de licença do conjunto de permissões na página.
    3. Clique em Editar atribuições e marque Mensagens para usuários de apps e da Web.
    4. Clique em Salvar.
    5. Encontre Atribuições de conjuntos de permissões na página.
    6. Clique em Editar atribuições e selecione Conjunto de permissões do agente de mensagens.
    7. Clique em Adicionar > Salvar.
  5. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa em Pesquisa rápida por "Configurações de mensagens" e clique em Novo canal.
    1. Selecione Mensagens no app e na Web.
    2. Insira o Nome: canal do Messaging.
    3. Clique em Salvar.
    4. Defina o Tipo de encaminhamento como "Omni-Queue" e a Fila como "Fila de mensagens".
    5. Clique em Salvar e acesse Configurações de mensagens.
    6. Clique no nome do seu canal de mensagens e em Ativar.
    7. Depois de ler, aceite os Termos e Condições.
  6. Acesse a barra de menus > menu Configuração e clique em Configuração. Faça uma pesquisa em Quick Find por "Implantações de serviço incorporado" e clique em Nova implantação.
    1. Clique em Mensagens no app e na Web > Próxima > Web > Próxima.
    2. Preencha os seguintes detalhes:
      • Nome: implantação do serviço incorporado de mensagens
      • Nome do desenvolvedor: Messaging_Embedded_Service_Deployment
      • Domínio: example.com
      • Canal: canal de mensagens
    3. Clique em Salvar. Aguarde a conclusão da implantação.
    4. Nas configurações de Implantação do serviço incorporado, clique em Publicar.
    5. Clique em Atualizar e em Teste de mensagens.

Testar mensagens no app e na Web

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 fala para iniciar uma nova conversa de teste.
  3. Envie uma mensagem, como "Test".
  4. Acesse a guia do navegador do Salesforce.
  5. Na barra de ferramentas Configuração, clique no menu Iniciador de apps e selecione Console de serviços.
  6. Clique em Omnichannel 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ços para a conversa. Não é possível ver a transcrição do chat.
  9. Navegue até a barra de menus > menu Configuração.
  10. Clique em Editar página.
  11. No menu "Componentes", arraste a Conversa otimizada 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 Omnichannel 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ê tiver dúvidas e precisar de mais informações, consulte o Guia de configuração abrangente do Salesforce Messaging para apps e Web.

Etapa 5: instalar o LWC 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 forma para adicionar detalhes de configuração.

    • endpoint: o URL do conector de interface do backend de integração do agente, como um URL do console do Cloud Run, por exemplo: 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
    • conversationProfile: o nome do recurso do perfil de conversa do Assistente de IA (exemplo: projects/GCP-PROJECT-ID/locations/GCP-REGION/conversationProfiles/CONVERSATION-PROFILE-ID)
    • consumerKey: a chave do cliente do app conectado da etapa 3
    • consumerSecret: a chave secreta do consumidor do app conectado da etapa 3.