Connector V2.0 do Salesforce

O Salesforce é uma ferramenta de gerenciamento de relacionamento com o cliente (CRM) para gerenciar equipes de suporte, vendas e marketing. Você pode usar Amazon Kendra para indexar seus objetos padrão do Salesforce e até mesmo objetos personalizados.

O conector da fonte de dados Amazon Kendra do Salesforce é compatível com as seguintes edições do Salesforce: Developer Edition e Enterprise Edition.

nota

O conector Salesforce V1.0/ SalesforceConfiguration APIterminou em 2023. Recomendamos migrar para ou usar o conector Salesforce V2.0/. TemplateConfiguration API

Para solucionar problemas do conector da fonte de dados Amazon Kendra do Salesforce, consulte. Solucionar problemas de origens de dados

Atributos compatíveis

Amazon Kendra O conector de fonte de dados do Salesforce oferece suporte aos seguintes recursos:

• Mapeamentos de campos

• Controle de acesso do usuário

• Filtros de inclusão/exclusão

• Sincronizações de conteúdo completas e incrementais

• Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Salesforce, faça essas alterações em seu Salesforce e em suas contas. AWS

No Salesforce, verifique se você:

• Criou uma conta administrativa do Salesforce e anotou o nome de usuário e a senha que você usa para se conectar ao Salesforce.

• Copiou o token de segurança do Salesforce associado à conta usada para se conectar ao Salesforce.

• Criou uma conta do Salesforce Connected App com a chave do consumidor OAuth ativada e copiada (ID do cliente) e o segredo do consumidor (segredo do cliente) atribuídos ao seu aplicativo Salesforce Connected. O ID do cliente e o segredo do cliente são usados como suas credenciais de autenticação armazenadas em um AWS Secrets Manager segredo. Consulte a Documentação do Salesforce sobre aplicativos conectados para obter mais informações.

  nota

  Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

• Copiou a instância URL do Salesforce que você deseja indexar. Normalmente, isso é https://<company>.salesforce.com/. O servidor deve estar executando um aplicativo conectado ao Salesforce.

• Adicionou credenciais ao seu servidor Salesforce para um usuário com acesso somente de leitura ao Salesforce clonando o ReadOnly perfil e adicionando as permissões Exibir todos os dados e Gerenciar artigos. Essas credenciais identificam o usuário que está fazendo a conexão e o aplicativo conectado ao Salesforce ao qual Amazon Kendra se conecta.

• Verifique se cada documento é exclusivo no Salesforce e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. IDsOs documentos são globais para um índice e devem ser exclusivos por índice.

No seu Conta da AWS, verifique se você tem:

• Criou um Amazon Kendra índice e, se estiver usando oAPI, anotou o ID do índice.

• Criou uma IAM função para sua fonte de dados e, se estiver usando aAPI, ARN anotei a IAM função.

  nota

  Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.

• Armazenou suas credenciais de autenticação do Salesforce em um AWS Secrets Manager segredo e, se estiver usando oAPI, anotou o ARN segredo.

  nota

  Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Salesforce a. Amazon Kendra Se você estiver usando oAPI, deverá fornecer uma IAM função e um Secrets Manager segredo existentes e um ID de índice. ARN

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Salesforce, você deve fornecer os detalhes necessários da sua fonte de dados do Salesforce para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Salesforce para Amazon Kendra ver. Pré-requisitos

Console

Para se conectar Amazon Kendra ao Salesforce:

1. Faça login no AWS Management Console e abra o Amazon Kendra console.

2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

   nota

   Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

3. Na página Introdução, escolha Adicionar fonte de dados.

4. Na página Adicionar fonte de dados, escolha Conector Salesforce e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Salesforce com a tag “V2.0".

5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

   1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

   2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

   3. Em Idioma padrão — Escolha um idioma para filtrar seus documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

   4. Em Tags, em Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

   5. Escolha Próximo.

6. Na página Definir seção e segurança, insira as informações a seguir:

   1. Salesforce URL — Insira a instância URL do site do Salesforce que você deseja indexar.

   2. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. ACLEspecifica quais documentos os usuários e grupos podem acessar. As ACL informações são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

   3. Insira uma senha existente ou, se você criar uma nova senha, uma janela secreta da AWS Secrets Manager será aberta.

      1. Autenticação — insira as seguintes informações na janela Criar um AWS Secrets Manager segredo:

         1. Senha: um nome para sua senha. O prefixo 'AmazonKendra-Salesforce-' é adicionado automaticamente ao seu nome secreto.

         2. Para Nome de usuário, senha, token de segurança, chave do consumidor, segredo do consumidor e autenticação, URL insira os valores da credencial de autenticação que você gerou e baixou da sua conta do Salesforce.

            nota

            Se você usa o Salesforce Developer Edition, use https://login.salesforce.com/services/oauth2/token o login do Meu domínio URL (por exemplo, https://MyCompany.my.salesforce.com) como a Autenticação URL. Se você usa o Salesforce Sandbox Edition, use https://test.salesforce.com/services/oauth2/token o login do Meu domínio URL (por exemplo, MyDomainName--SandboxName.sandbox.my.salesforce.com) como a Autenticação URL.

         3. Escolha Salvar autenticação.

   4. Virtual Private Cloud (VPC) — Você pode escolher usar umVPC. Nesse caso, você deve adicionar sub-redes e grupos de VPCsegurança.

   5. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver um ACL para seus documentos e optar por usar o seuACL, também poderá optar por ativar o rastreador Amazon Kendra de identidade para configurar a filtragem de contexto do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar o PutPrincipalMappingAPIpara carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

   6. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ouFAQ, escolha Criar uma nova função para evitar erros.

   7. Escolha Próximo.

7. Na página Configurações de sincronização, insira as seguintes informações:

   1. Para Rastrear anexos: selecione para rastrear todos os objetos do Salesforce.

   2. Para Objetos padrão, Objetos padrão com anexo e Objeto padrão sem anexo e Artigos de conhecimento, selecione entidades do Salesforce ou tipos de conteúdo que você deseja rastrear.

   3. Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter. Se você optar por rastrear Artigos de conhecimento, deverá especificar os tipos de artigos de conhecimento a serem indexados. Você pode escolher textos publicados, arquivados, rascunhos e anexos.

      Filtro Regex: especifique um padrão regex para incluir itens específicos do catálogo.

8. Para Configuração adicional:

   • ACLinformações Todas as listas de controle de acesso são incluídas por padrão. Desmarcar uma lista de controle de acesso tornará públicos todos os arquivos dessa categoria.

   • Padrões Regex: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.

   Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização.

   • Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.

   • Sincronização nova e modificada: indexe somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

   • Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

9. Escolha Próximo.

10. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Para artigos de conhecimento padrão, anexos de objetos padrão e mapeamentos de campo adicionais sugeridos, selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu índice.

       nota

       É necessário um mapeamento de _document_body. Você não pode alterar o mapeamento entre o campo Salesforce ID e o campo Amazon Kendra _document_id . Você pode mapear qualquer campo do Salesforce para os campos de índice reservados/padrão do título ou corpo do documento Amazon Kendra.

       Se você mapear qualquer campo do Salesforce para os campos de título e corpo do documento do Amazon Kendra, o Amazon Kendra usará dados dos campos de título e corpo do documento nas respostas de pesquisa.

    2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    3. Escolha Próximo.

11. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra ao Salesforce

Você deve especificar um esquema JSON da fonte de dados usando o. TemplateConfigurationAPI Você deve fornecer as seguintes informações:

• Fonte de dados — especifique o tipo de fonte de dados como SALESFORCEV2 quando você usa o TemplateConfigurationJSONesquema. Além disso, especifique a fonte de dados como TEMPLATE quando você chama o CreateDataSource API.

• Host URL — especifique o host da instância do Salesforce. URL

• Modo de sincronização — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

• Nome secreto do recurso da Amazon (ARN) — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação da sua conta do Salesforce. O segredo é armazenado em uma JSON estrutura com as seguintes chaves:

  {
      "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
      "consumerKey": "Application public key generated when you created your Salesforce application",
      "consumerSecret": "Application private key generated when you created your Salesforce application",
      "password": "Password associated with the user logging in to the Salesforce instance",
      "securityToken": "Token associated with the user account logging in to the Salesforce instance",
      "username": "User name of the user logging in to the Salesforce instance"
  }

• IAM função — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar o público necessário APIs para o conector do Salesforce e. Amazon Kendra Para obter mais informações, consulte Funções do IAM para as fontes de dados do Salesforce.

Você também pode adicionar os seguintes recursos opcionais:

• Virtual Private Cloud (VPC) — Especifique VpcConfiguration quando você ligaCreateDataSource. Para obter mais informações, consulte Configurando Amazon Kendra para usar um Amazon VPC.

• Filtros de inclusão e exclusão — você pode especificar se deseja incluir ou excluir determinados documentos, contas, campanhas, casos, contatos, leads, oportunidades, soluções, tarefas, grupos, conversas e arquivos de entidades personalizadas.

  nota

  A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

• Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver um ACL para seus documentos e optar por usar o seuACL, também poderá optar por ativar o rastreador Amazon Kendra de identidade para configurar a filtragem de contexto do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar o PutPrincipalMappingAPIpara carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

• Mapeamentos de campo: escolha mapear os campos de fonte de dados do Salesforce para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

  nota

  O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

  nota

  É necessário um mapeamento de _document_body. Você não pode alterar o mapeamento entre o campo Salesforce ID e o campo Amazon Kendra _document_id . Você pode mapear qualquer campo do Salesforce para os campos de índice reservados/padrão do título ou corpo do documento Amazon Kendra.

  Se você mapear qualquer campo do Salesforce para os campos de título e corpo do documento do Amazon Kendra, o Amazon Kendra usará dados dos campos de título e corpo do documento nas respostas de pesquisa.

Para obter uma lista de outras JSON chaves importantes a serem configuradas, consulte Esquema de modelos do Salesforce.

Saiba mais

Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Salesforce, consulte:

• Anunciando o conector Salesforce atualizado (V2) para Amazon Kendra