Connector V1.0 do Salesforce - Amazon Kendra
Recursos compatíveisPré-requisitosInstruções de conexão

Connector V1.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 o Amazon Kendra para indexar objetos padrão do Salesforce e até mesmo objetos personalizados.

Importante

O Amazon Kendra usa a API do Salesforce versão 48. A API do Salesforce limita o número de solicitações que podem ser feitas por dia. Se o Salesforce exceder essas solicitações, ele tentará novamente até conseguir continuar.

nota

O conector V1.0 do Salesforce/a API SalesforceConfiguration foram encerrados em 2023. Recomendamos migrar ou usar o conector V2.0/API TemplateConfiguration do Salesforce.

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

Recursos compatíveis

Amazon KendraO conector da fonte de dados do Salesforce e do oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

Pré-requisitos

Antes que você possa usar o Amazon Kendra para indexar a fonte de dados da , faça essas alterações no Salesforce e nas contas do AWS.

No Salesforce, verifique se você:

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

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

    nota

    É recomendável atualizar ou alternar regularmente suas credenciais e 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 o token de segurança do Salesforce associado à conta usada para se conectar ao Salesforce.

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

  • Adicionou credenciais ao servidor do Salesforce para um usuário com acesso somente leitura ao Salesforce clonando o perfil ReadOnly 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 o 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. Os IDs de documentos são globais para um índice e devem ser exclusivos por índice.

No Conta da AWS, verifique se você:

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

  • Criou uma função do IAM para a fonte de dados e, se estiver usando a API, anotou o ARN da função do IAM.

    nota

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

  • Armazenou suas credenciais de autenticação do Salesforce em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    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 função ou senha existente do IAM, poderá usar o console para criar uma nova função do IAM e um nova senha do Secrets Manager ao conectar a fonte de dados do Salesforce ao Amazon Kendra. Se você estiver usando a API, deverá fornecer o ARN de uma função da IAM e a senha Secrets Manager existentes e um ID de índice.

Instruções de conexão

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

Console

Para conectar Amazon Kendra ao Salesforce

  1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon Kendra.

  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 o Conector do Salesforce V1.0 e, em seguida, escolha Adicionar conector.

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

    1. Nome da fonte de dados: digite um nome para sua 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. Idioma padrão: um idioma para filtrar os 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. Adicionar nova tag: tags para pesquisar e filtrar os recursos ou monitorar os custos compartilhados.

    5. Escolha Próximo.

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

    1. URL do Salesforce: insira o URL da instância do site do Salesforce que você deseja indexar.

    2. Em Tipo de autenticação, escolha entre Existente e Novo para armazenar as credenciais de autenticação do Salesforce. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.

      1. Insira as seguintes informações em Criar uma janela de senha do AWS Secrets Manager:

        1. Senha: um nome para sua senha. O prefixo “AmazonKendra-Salesforce-” é adicionado automaticamente à senha.

        2. Em Nome de usuário, Senha, Token de segurança, Chave do consumidor, Segredo do consumidor e URL de autenticação, insira os valores da credencial de autenticação criados na conta do Salesforce.

        3. Escolha Salvar autenticação.

    3. Função do IAM: escolha uma função do IAM existente ou crie uma nova função do IAM para acessar as credenciais do repositório e indexar o conteúdo.

      nota

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

    4. 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, os artigos e os feeds anexados.

    2. Para Objetos padrão, Artigos do conhecimento e Feeds do Chatter, selecione as entidades do Salesforce ou tipos de conteúdo que deseja rastrear.

      nota

      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 optar por rastrear Artigos de conhecimento, especifique os tipos de artigos de conhecimento a serem indexados, o nome dos artigos e se deseja indexar os campos padrão de todos os artigos de conhecimento ou somente os campos de um tipo de artigo personalizado. Se optar por indexar artigos personalizados, deverá especificar o nome interno do tipo de artigo. Você pode especificar até 10 tipos de artigos.

    3. Frequência: escolha com que frequência o Amazon Kendra será sincronizado com a fonte de dados.

    4. Escolha Próximo.

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

    1. Em Artigos de conhecimento padrão, Anexos de objetos padrão e Mapeamentos de campos adicionais sugeridos: selecione campos de fonte de dados padrão gerados pelo Amazon Kendra que você deseja mapear para o í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 .

    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.

  9. 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 conectar Amazon Kendra ao Salesforce

Você deve especificar o seguinte na API SalesforceConfiguration:

  • URL do servidor: o URL da instância do site do Salesforce que você deseja indexar.

  • Nome do recurso da Amazon (ARN) do segredo: forneça o nome do recurso da Amazon (ARN) de um segredo do Secrets Manager que contenha as credenciais de autenticação criadas na conta do Salesforce. A senha deve conter uma estrutura JSON 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"
}

  • Função do IAM: especifique o RoleArn ao chamar o CreateDataSource para fornecer uma função do IAM com permissões para acessar a senha do Secrets Manager e chamar as APIs públicas necessárias para o conector do Salesforce e o Amazon Kendra. Para obter mais informações, consulte Funções do IAM para as fontes de dados do Salesforce.

  • Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter.

    • Objetos padrão: se você optar por rastrear Objetos padrão, deverá especificar o nome do objeto padrão e o nome do campo na tabela de objetos padrão que contém o conteúdo do documento.

    • Artigos de conhecimento: se optar por rastrear Artigos de conhecimento, especifique os tipos de artigos de conhecimento a serem indexados, os estados dos artigos de conhecimento a serem indexados e se deseja indexar os campos padrão de todos os artigos de conhecimento ou somente os campos de um tipo de artigo personalizado.

    • Feeds do Chatter: se você optar por rastrear feeds do Chatter, deverá especificar o nome da coluna na tabela do Salesforce FeedItem que contém o conteúdo a ser indexado.

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

  • Filtros de inclusão e exclusão: especifique se deseja incluir ou excluir determinados anexos de arquivos.

    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.

  • 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

    É obrigatório definir o campo de corpo do documento ou equivalente para que o Amazon Kendra possa pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice _document_body. Todos os demais campos são opcionais.

  • Filtragem de contexto do usuário e controle de acesso: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. As informações da ACL 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.