Integração do Salesforce

Use o componente Web Lightning (LWC) do Salesforce para integrar com os módulos da IU do Agent Assist para conversas de chat.

Antes de começar

Para integrar os módulos da IU do Agent Assist com o Salesforce, precisa de acesso aos seguintes recursos:

  • Node.js

    Siga as instruções de instalação recomendadas para o seu sistema operativo.

  • CLI do Salesforce

    A instalação da CLI do Salesforce através do npm é conhecida por causar problemas de compatibilidade. Para evitar estes problemas, use uma das opções de instalação pkg (macOS), exe (Windows) ou TAR (Linux).

  • CLI gcloud

    Instale o comando gcloud conforme indicado e autentique-se através do comando gcloud auth login.

  • IU do Salesforce

    • Inicie sessão no URL da instância ou na página de início de sessão do Salesforce e tenha em atenção o seguinte:
      • O URL do Meu domínio do Salesforce. Siga estes passos para encontrar o URL do meu domínio:
        1. Navegue para a barra de menu > menu Configuração.
        2. Clique em Configurar.
        3. Introduza uma pesquisa de Localização rápida para O meu domínio. O nome do domínio está no seguinte formato: MY-DOMAIN-NAME.develop.my.salesforce.com.
      • O ID da sua organização do Salesforce. Siga estes passos para encontrar o ID da organização:
        1. Navegue para a barra de menu > menu Configuração.
        2. Clique em Configurar.
        3. Introduza uma pesquisa de Localização rápida para "Informações da empresa". Nota: estes passos de integração foram testados apenas com a Salesforce Developer Edition. Podem surgir diferenças nas licenças de funcionalidades e na interface do Salesforce se usar outra edição.
  • 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 implementação, configure as seguintes variáveis de ambiente com deploy.sh ou num ficheiro .env na raiz do projeto:
      • AUTH_OPTION: defina esta opção como SalesforceLWC.
      • SALESFORCE_DOMAIN: um nome de domínio semelhante a YOUR_SUBDOMAIN.develop.lightning.force.com. Anotou este valor no pré-requisito da IU do Salesforce. Tenha em atenção que não deve incluir https://.
      • SALESFORCE_ORGANIZATION_ID: reparou neste valor no pré-requisito da IU do Salesforce.

Passo 1: configure o seu projeto

Para começar a integrar os módulos da IU do Agent Assist, siga estes passos.

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

    git clone https://github.com/GoogleCloudPlatform/agent-assist-integrations
    cd salesforce/aa-lwc
    
  2. Transfira os ficheiros JS, que são implementados posteriormente como recursos estáticos, executando os seguintes comandos:

    npm run generate-static-resources
    npm install
    

Passo 2: configure o seu ambiente

Pode integrar módulos da IU do Agent Assist num ambiente específico, como produção ou desenvolvimento. O Salesforce chama a estes ambientes organizações.

Configure a sua organização na consola do Salesforce

Na consola do Salesforce, siga estes passos para configurar a sua organização para a integração do Agent Assist.

  1. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Definições omnicanal" e, de seguida, clique em Definições omnicanal.
    1. Selecione Ativar omnicanal.
    2. Selecione Iniciar sessão automaticamente dos agentes no omnicanal na nova janela ou separador.
    3. Clique em Guardar.
  2. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Comunidades" e, de seguida, clique em Experiências digitais > Definições.
    1. Selecione Ativar espaços de trabalho de experiências.
    2. Clique em Guardar.

Configure a sua organização com a CLI do Salesforce

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

  1. Execute o seguinte código e autentique a CLI com os detalhes de início de sessão do Salesforce que usa normalmente.

    npm run login
    
  2. Execute o seguinte código para implementar o LWC na organização.

    npm run deploy
    

Passo 3: crie uma app cliente externa

O LWC do Salesforce usa o fluxo OAuth 2.0 de credenciais de cliente para autenticar o utilizador. Uma app cliente externa ativa o fluxo de credenciais do cliente. Use a chave de consumidor e o segredo do consumidor da app para configurar o LWC do Salesforce para autenticar utilizadores com o Salesforce.

  1. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Gestor de apps de cliente externas".
    1. Clique em Gestor de apps de cliente externas > Nova app de cliente externa > Criar e, de seguida, introduza as seguintes informações.
      • Nome da app associada: lwc auth
      • Nome da API: lwc_auth
      • Email de contacto: your_email@example.com
      • API (ativar definições OAuth) > Ativar OAuth: selecionado
      • API (Enable OAuth Settings) > Callback URL: https://login.salesforce.com/services/oauth2/callback
      • API (ativar definições de OAuth) > Âmbitos de OAuth selecionados: aceder ao serviço de URL de identidade
      • API (ativar definições OAuth) > Ativar fluxo de credenciais do cliente: selecionado
    2. Clique em Criar.
  2. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Gestor de apps de cliente externas".
    1. Clique no nome da app associada > Editar.
    2. Navegue para Políticas OAuth > Fluxos OAuth e melhorias da app cliente externa.
    3. Certifique-se de que a opção Ativar fluxo de credenciais de cliente está selecionada.
    4. Em Executar como, introduza o seu nome de utilizador de início de sessão.
    5. Clique em Guardar.
  3. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Gestor de apps de cliente externas".
    1. Clique no nome da app associada > Editar.
    2. Navegue para Definições do OAuth > Definições da app > Chave e segredo do consumidor.
    3. Introduza o código de validação enviado para o seu email.
    4. Copie a chave de consumidor e o segredo do consumidor para um local seguro. Vai precisar destes elementos para um passo posterior.
  4. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "CORS" e, de seguida, clique em Editar.
    1. Selecione Ativar CORS para pontos finais OAuth.
    2. Clique em Guardar.

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

Passo 4: configure o cliente de chat

Para usar os módulos da IU do Agent Assist com o Salesforce, precisa de um cliente de chat no computador do agente.

Configure as mensagens na app e na Web

Siga estes passos para configurar o seu messenger.

  1. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "URLs fidedignos" e, de seguida, clique em Novo URL fidedigno.
    1. Introduza o nome da API: ui_connector.
    2. Introduza o URL do ponto final do serviço do Cloud Run do conetor da IU que implementou com o back-end da integração do Agent Assist. Pode encontrar este URL na consola do Cloud Run. Por exemplo: https://UI_CONNECTOR_SUBDOMAIN.us-central1.run.app.
    3. Selecione todas as opções em Diretivas CSP.
    4. Clique em Guardar e novo.
    5. Introduza o nome da API: twilio_flex.
    6. Introduza o URL https://flex.twilio.com.
    7. Selecione todas as opções em Diretivas CSP.
    8. Clique em Guardar e novo.
    9. Introduza o nome da API: salesforce_domain.
    10. Introduza 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 CSP.
    12. Clique em Guardar.
  2. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Filas" e, de seguida, clique em Novo.
    1. Introduza as seguintes informações:
      • Etiqueta: fila de mensagens
      • Nome da fila: Messaging_Queue
      • Configuração de encaminhamento: Messaging_Routing_Configuration
    2. Clique em Objetos suportados e, de seguida, adicione: "Utilizador de mensagens, sessão de mensagens".
    3. Clique em Membros da fila e, de seguida, adicione: "Utilizador: o seu utilizador de início de sessão".
    4. Clique em Guardar.
  3. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Conjuntos de autorizações".
    1. Clique em Conjunto de autorizações de agentes de mensagens.
    2. Clique em Acesso aos estados de presença do serviço > Editar.
    3. Selecione os estados Ocupado e Online – Mensagens.
    4. Clique em Adicionar > Guardar.
  4. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Utilizadores" e, de seguida, clique em Utilizadores.
    1. Clique no seu nome de utilizador e verifique se a opção Utilizador do Service Cloud está ativada.
    2. Encontre Atribuições de licenças de conjunto de autorizações na página.
    3. Clique em Editar atribuições e, de seguida, selecione Mensagens para utilizadores na app e na Web.
    4. Clique em Guardar.
    5. Encontre Permission Set Assignments na página.
    6. Clique em Editar atribuições e, de seguida, selecione Conjunto de autorizações do agente de mensagens.
    7. Clique em Adicionar > Guardar.
  5. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Definições de mensagens" e, de seguida, clique em Novo canal.
    1. Selecione Mensagens para a Web e na app.
    2. Introduza o Nome: canal de mensagens.
    3. Clique em Guardar.
    4. Defina o Tipo de encaminhamento como "Fila omnicanal" e a Fila como "Fila de mensagens".
    5. Clique em Guardar e navegue para Definições de mensagens.
    6. Clique no nome do canal de mensagens e, de seguida, clique em Ativar.
    7. Depois de ler, aceite os Termos de Utilização.
  6. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Configuração. Introduza uma pesquisa de Localização rápida para "Implementações de serviços incorporados" e, de seguida, clique em Nova implementação.
    1. Clique em Mensagens para apps e Web > Seguinte > Web > Seguinte.
    2. Preencha os seguintes detalhes:
      • Nome: implementação do serviço incorporado de mensagens
      • Nome do programador: Messaging_Embedded_Service_Deployment
      • Domínio: example.com
      • Canal: canal de mensagens
    3. Clique em Guardar. Aguarde pela conclusão da implementação.
    4. Nas definições de Implementação do serviço incorporado, clique em Publicar.
    5. Clique em Atualizar e, de seguida, em Testar mensagens.

Teste as mensagens para a Web e em apps

Siga estes passos para testar o seu messenger.

  1. Clique em Testar mensagens.
  2. Depois de carregar o novo separador, clique no balão de diálogo para iniciar uma nova conversa de teste.
  3. Envie uma mensagem, como "Test".
  4. Navegue para o separador do navegador do Salesforce.
  5. Na barra de ferramentas Configuração, clique no menu Launcher de apps e, de seguida, selecione Service Console.
  6. Clique em Omnicanal na barra de ferramentas de utilidade.
  7. Defina o seu estado como Online – Mensagens.
  8. Aceite a mensagem recebida. Esta ação abre um novo separador na consola de serviços para a conversa. Não consegue ver a transcrição do chat.
  9. Navegue para a barra de menu > menu Configuração.
  10. Clique em Editar página.
  11. No menu Components (Componentes), arraste o Enhanced Conversation para o painel Conversation.
  12. Clique em Guardar > Ativar > Atribuir como predefinição da organização > Computador > Anterior .
  13. Atualize a página.
  14. Clique em Omnicanal na barra de ferramentas de utilidade.
  15. Defina o seu estado como Online – Mensagens.
  16. Responda à mensagem "Teste" para validar se o envio de mensagens está a funcionar.

Se tiver dificuldades e precisar de mais informações, consulte o guia de configuração da Mensagens do Salesforce para apps e Web abrangente.

Passo 5: instale o LWC do Salesforce

Siga estes passos para adicionar o LWC do Salesforce a uma página de sessão de mensagens através do editor do Lightning Experience. Continue com a conversa de teste do passo 4.

  1. Navegue até à barra de menu > menu Configuração e, de seguida, clique em Editar página.
  2. Na barra lateral Componentes, mova o elemento agentAssistContainerModule para a barra lateral.

  3. Clique no componente que colocou no passo anterior.

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

    • ponto final: o URL do conector da IU do backend de integração do agente, como um URL da consola do Cloud Run, como: https://UI-CONNECTOR-ENDPOINT.GCP-REGION.run.app
    • funcionalidades: funcionalidades do Assistente do agente ativadas no seu perfil de conversa, como CONVERSATION_SUMMARIZATION,KNOWLEDGE_ASSIST_V2,SMART_REPLY e AGENT_COACHING
    • conversationProfile: o nome do recurso do seu perfil de conversa do Agent Assist (exemplo: projects/GCP-PROJECT-ID/locations/GCP-REGION/conversationProfiles/CONVERSATION-PROFILE-ID)
    • consumerKey: a chave de consumidor da app associada do passo 3
    • consumerSecret: o segredo do consumidor da app associada do passo 3