SharePoint conector V1.0 - Amazon Kendra
Atributos compatíveisPré-requisitosInstruções de conexãoSaiba mais

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

SharePoint conector V1.0

SharePoint é um serviço colaborativo de criação de sites que você pode usar para personalizar o conteúdo da Web e criar páginas, sites, bibliotecas de documentos e listas. Se você é um SharePoint usuário, você pode usar Amazon Kendra para indexar sua fonte SharePoint de dados.

nota

O suporte para o SharePoint conector V1.0/ SharePointConfiguration APIestá programado para terminar em 2023. Recomendamos migrar para ou usar o SharePoint conector V2.0/. TemplateConfiguration API

Para solucionar problemas em seu Amazon Kendra SharePoint conector de fonte de dados, consulteSolucionar problemas de origens de dados.

Atributos compatíveis

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Log de alterações

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes que você possa usar Amazon Kendra para indexar sua fonte de SharePoint dados, faça essas alterações em seu SharePoint e AWS contas.

É necessário fornecer credenciais de autenticação, que você armazena com segurança em um AWS Secrets Manager 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).

Em SharePoint, verifique se você tem:

  • Anote URL os SharePoint sites que você deseja indexar.

  • Para SharePoint online:

    • Anotou as credenciais de autenticação básicas, que incluem um nome de usuário e uma senha com no mínimo permissão de administrador

    • Opcional: Credenciais OAuth 2.0 geradas contendo nome de usuário, senha, ID do cliente e segredo do cliente.

    • Padrões de segurança desativados no portal do Azure usando um usuário administrativo. Para obter mais informações sobre como gerenciar as configurações padrão de segurança no portal do Azure, consulte a documentação da Microsoft sobre como habilitar/desabilitar padrões de segurança.

  • Para SharePoint servidor:

    • Anote o nome de domínio do SharePoint servidor (o BIOS nome da rede no Active Directory). Você usa isso, junto com seu nome de usuário e senha de autenticação SharePoint básica, para conectar o SharePoint Servidor ao Amazon Kendra.

    nota

    Se você usa o SharePoint Servidor e precisa converter sua Lista de Controle de Acesso (ACL) para o formato de e-mail para filtragem no contexto do usuário, forneça o LDAP servidor URL e a base de LDAP pesquisa. Ou você pode usar a substituição de domínio do diretório. O LDAP servidor URL é o nome completo do domínio e o número da porta (por exemplo, ldap: //example.com:389). A base LDAP de pesquisa são os controladores de domínio 'example' e 'com'. Com a substituição do domínio do diretório, você pode usar o domínio de e-mail em vez de usar o LDAP servidor URL e a base de LDAP pesquisa. Por exemplo, o domínio do e-mail de username@example.com é “exemplo.com”. Você pode usar essa substituição se não estiver preocupado em validar o domínio e simplesmente quiser usar seu domínio de e-mail.

  • As seguintes permissões foram adicionadas à sua SharePoint conta:

    Para SharePoint listas

    • Itens abertos: visualize a origem dos documentos com manipuladores de arquivos do lado do servidor.

    • Exibir páginas do aplicativo: visualize formulários, visualizações e páginas do aplicativo. Enumere as listas.

    • Exibir itens: visualize itens em listas e documentos na bibliotecas de documentos.

    • Exibir versões: visualize versões anteriores de um item de lista ou documento.

    Para SharePoint sites

    • Procurar diretórios — Enumere arquivos e pastas em um site usando o Designer e a interface da Web. SharePoint DAV

    • Procurar informações do usuário: visualize informações sobre os usuários do site.

    • Enumerar permissões: enumere as permissões no site, na lista, na pasta, no documento ou no item da lista.

    • Abrir: abra um site, lista ou pasta para acessar itens dentro do contêiner.

    • Use os recursos de integração do cliente — UseSOAP, WebDAV, o modelo de objeto do cliente ou as interfaces do SharePoint Designer para acessar o site.

    • Use interfaces remotas: use recursos que iniciam aplicativos cliente.

    • Exibir páginas: exibir páginas em um site.

  • Verifique se cada documento é exclusivo em SharePoint e entre 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.

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

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

  • Criou um IAM função para sua fonte de dados e, se estiver usando oAPI, anotou a ARN do IAM papel.

    nota

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

  • Armazenou suas credenciais de SharePoint autenticação em um AWS Secrets Manager segredo e, se estiver usando oAPI, anote o ARN do 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 tem um IAM função ou segredo, você pode usar o console para criar um novo IAM papel e Secrets Manager segredo quando você conecta sua fonte SharePoint de dados ao Amazon Kendra. Se você estiver usando oAPI, deverá fornecer o ARN de um existente IAM papel e Secrets Manager segredo e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra para sua fonte SharePoint de dados, você deve fornecer detalhes de suas SharePoint credenciais para que Amazon Kendra pode acessar seus dados. Se você ainda não configurou SharePoint para Amazon Kendra verPré-requisitos.

Console

Para se conectar Amazon Kendra para SharePoint

  1. Faça login no AWS Console de gerenciamento 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 SharePoint conector v1.0 e, em seguida, escolha Adicionar fonte de dados.

  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, para Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou rastrear seus AWS custos.

    5. Escolha Próximo.

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

    1. Para o método de hospedagem — Escolha entre SharePoint Online e SharePointServidor.

      1. Para SharePointOnline — Entre no site URLs específico do seu SharePoint repositório.

      2. Para SharePointServidor — Escolha sua SharePoint versão, insira Site URLs específico para seu SharePoint repositório e insira a Amazon S3 caminho para a localização SSL do seu certificado.

    2. (Somente SharePoint servidor) Para proxy da Web — insira o nome do host e o número da porta da sua SharePoint instância interna. O número da porta deve ser um valor numérico entre 0 e 65535.

    3. Para autenticação, escolha entre as seguintes opções com base no caso de uso:

      1. Para SharePoint on-line — Escolha entre a autenticação básica e OAuth a autenticação 2.0.

      2. Para SharePoint Servidor — Escolha entre Nenhum e Manual LDAP.

    4. Para AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais SharePoint de autenticação. Se você optar por criar um novo segredo, um AWS Secrets Manager uma janela secreta se abre. Você deve inserir uma Senha. O prefixo 'AmazonKendra- SharePoint -' é adicionado automaticamente ao seu nome secreto.

    5. Insira as outras informações a seguir no campo Criar um AWS Secrets Manager janela secreta:

      1. Escolha entre as seguintes opções de autenticação SharePoint na nuvem, com base no seu caso de uso:

        1. Autenticação básica — insira o nome de usuário SharePoint da sua conta como Nome de usuário e a senha SharePoint da conta como Senha.

        2. OAuthAutenticação 2.0 — Insira o nome de usuário da sua SharePoint conta como Nome de usuário, a senha da SharePoint conta como Senha, seu SharePoint ID exclusivo gerado automaticamente como ID do cliente e a string secreta compartilhada usada por ambos e SharePoint Amazon Kendra como segredo do cliente.

      2. Escolha entre as seguintes opções de autenticação SharePoint do servidor, com base no seu caso de uso:

        1. Nenhuma — Insira o nome de usuário SharePoint da sua conta como Nome de usuário, a senha SharePoint da sua conta como Senha e o nome de domínio do servidor.

        2. LDAP—Insira o nome de usuário SharePoint da sua conta como nome de usuário, a senha SharePoint da conta como senha, o endpoint LDAP do servidor (incluindo protocolo e número da porta, por exemplo) ldap://example.com:389) e sua Base LDAP de Pesquisa (por exemplo, dc=example, dc=com).

        3. Manual — Insira o nome de usuário da SharePoint conta como nome de usuário, a senha SharePoint da conta como senha e a substituição do domínio de e-mail (domínio de e-mail do usuário ou grupo do diretório).

      3. Escolha Salvar.

    6. Virtual Private Cloud (VPC) — Você também deve adicionar sub-redes e grupos de VPCsegurança.

      nota

      Você deve usar um VPC se você usar o SharePoint Server. Amazon VPC é opcional para outras SharePoint versões.

    7. IAM função — Escolha uma existente IAM função ou criar uma nova IAM função para acessar suas 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.

    8. Escolha Próximo.

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

    1. Usar log de alterações: selecione para atualizar o índice em vez de sincronizar todos os arquivos.

    2. Rastrear anexos: selecione para rastrear anexos.

    3. Usar mapeamentos de grupos locais: selecione para garantir que os documentos sejam filtrados adequadamente.

    4. Configuração adicional: adicione padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.

    5. Programação de execução In Sync para frequência — com que frequência Amazon Kendra será sincronizado com sua fonte de dados.

    6. Escolha Próximo.

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

    1. Amazon Kendra mapeamentos de campo padrão — Selecione a partir da Amazon Kendra campos de fonte de dados padrão gerados que você deseja mapear para seu índice.

    2. Para Mapeamentos de campo personalizados, adicione 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 se conectar Amazon Kendra para SharePoint

Você deve especificar o seguinte usando SharePointConfigurationAPI:

  • SharePointVersão — especifique a SharePoint versão que você usa ao configurar SharePoint. Esse é o caso, não importa se você usa o SharePoint Server 2013, o SharePoint Server 2016, o SharePoint Server 2019 ou o SharePoint Online.

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

    Para a autenticação básica SharePoint on-line, a seguinte é a JSON estrutura mínima que deve estar em seu segredo:

    {
    "userName": "user name",
    "password": "password"
}

    Para a autenticação SharePoint Online OAuth 2.0, a seguinte é a JSON estrutura mínima que deve estar em seu segredo:

    {
    "userName": "SharePoint account user name"",
    "password": "SharePoint account password",
    "clientId": "SharePoint auto-generated unique client id",
    "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications"
}

    Para a autenticação básica do SharePoint servidor, a seguinte é a JSON estrutura mínima que deve estar em seu segredo:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
}

    Para LDAPautenticação SharePoint do servidor (se você precisar converter sua lista de controle de acesso (ACL) para o formato de e-mail para filtrar no contexto do usuário, você pode incluir o LDAP servidor URL e a base de LDAP pesquisa em seu segredo), a seguinte é a JSON estrutura mínima que deve estar em seu segredo:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name"
    "ldapServerUrl": "ldap://example.com:389",
    "ldapSearchBase": "dc=example,dc=com"
}

    Para a autenticação manual do SharePoint servidor, a seguinte é a JSON estrutura mínima que deve estar em seu segredo:

    {
    "userName": "user name",
    "password": "password",
    "domain": "server domain name",
    "emailDomainOverride": "example.com"
}

  • IAM role — Especifique RoleArn quando você liga CreateDataSource para fornecer um IAM função com permissões para acessar sua Secrets Manager secreto e chamar o público necessário APIs para o SharePoint conector e Amazon Kendra. Para obter mais informações, consulte IAM funções para fontes SharePoint de dados.

  • Amazon VPC—Se você usa o SharePoint Server, especifique VpcConfiguration como parte da configuração da fonte de dados. Consulte Configuração Amazon Kendra para usar um VPC.

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

  • Proxy da Web — Se você deve se conectar ao seu SharePoint site URLs por meio de um proxy da Web. Você pode usar essa opção somente para SharePoint Servidor.

  • Listas de indexação — Se Amazon Kendra deve indexar o conteúdo dos anexos aos itens da SharePoint lista.

  • Registro de alterações — Se Amazon Kendra deve usar o mecanismo de registro de alterações da fonte de SharePoint dados para determinar se um documento deve ser atualizado no índice.

    nota

    Use o registro de alterações se não quiser Amazon Kendra para digitalizar todos os documentos. Se o seu registro de alterações for grande, pode demorar Amazon Kendra menos tempo para digitalizar os documentos na fonte de SharePoint dados do que para processar o registro de alterações. Se você estiver sincronizando sua fonte de SharePoint dados com seu índice pela primeira vez, todos os documentos serão digitalizados.

  • Filtros de inclusão e exclusão: especifique se deseja incluir ou excluir determinados tipos de conteúdo.

    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 — Opte por mapear os campos da fonte de SharePoint dados para o Amazon Kendra campos de índice. 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 para 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.

  • Filtragem de contexto do usuário e controle de acesso —Amazon Kendra rastreia a lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL para seus documentos. 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.

Saiba mais

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