IBM Cloud Docs
Microsoft SharePoint Online

Microsoft SharePoint Online

Efetuar crawl de documentos que são armazenados em uma origem de dados Microsoft SharePoint Online.

IBM Cloud IBM Cloud somente

Essas informações se aplicam apenas a implementações gerenciadas. Para obter mais informações sobre a conexão com o SharePoint Online a partir de uma implementação instalada, consulte SharePoint Online.

Quais documentos estão engatinados

Durante o crawl inicial do conteúdo, documentos de todos os objetos que podem ser acessados a partir do caminho de coleta do site que você especificar são engatinhado e adicionados à sua coleção. Não é possível limitar o crawl a uma biblioteca dentro de uma coleção de sites, por exemplo. Todos os objetos no caminho de coleta do Site especificado são rasteados. Os metadados personalizados que estão associados ao conteúdo do SharePoint é engatinhado também. Você pode engatinhar um caminho de coleta de sites por coleção. Não é possível engatinhar Personal SiteCollections.

Durante os recritos programados subsequentes, apenas documentos novos e modificados são engatinados e quaisquer alterações são refletidas em sua coleção. Os documentos que são excluídos da fonte de dados externos não são excluídos da coleção.

Todos os conectores de origem de dados Discovery são de leitura. Independentemente das permissões que são concedidas à conta de crawl, Discovery nunca grava, atualiza ou exclui qualquer conteúdo na origem de dados original.

Discovery pode engatinhar os seguintes objetos:

  • SiteCollections
  • Sites
  • SubSites
  • Listas
  • Listar Itens
  • Bibliotecas De Documentos
  • Listar Anexos de Item

Requisitos da origem de dados

Além dos requisitos de origem de dados para todas as implementações gerenciadas, sua origem de dados do SharePoint Online deve atender aos seguintes requisitos:

  • A Coleção do Site que você se conecta deve ser uma que foi criada com um plano Enterprise. Não pode ser uma coleção que foi criada com um plano de trabalhador frontline.
  • Você deve ter um ID de usuário Azure Active Directory com permissão para ler todos os objetos que você deseja engatinhar. Por exemplo, <admin_user>@.onmicrosoft.com. O ID do usuário não precisa de permissão SiteCollection Administrator.

Você pode escolher como se autenticar com a conta do Microsoft SharePoint a partir das seguintes opções:

Autenticação aberta (OAuth v2)

Autenticar com a fonte de dados externa usando um token para que suas credenciais do usuário não precisem ser compartilhadas. Com este método de autenticação, você pode fazer login na sua conta da Microsoft diretamente para gerar um token que é usado por Discovery para conectar-se aos seus dados.

A opção Sign in with Microsoft que usa Open Authentication v2 para autenticar com a fonte de dados externa é um recurso beta.

Antes que qualquer um possa criar conectores que usem esse método de autenticação, um usuário com a função Administrador Global deve completar uma única etapas de pré-requisito para autorizar a conexão para todos os projetos na instância de serviço Discovery.

SAML (Security Assertion Markup Language)

Um mecanismo mais antigo para autenticação e autorização que exige que as credenciais do usuário sejam compartilhadas com o serviço Discovery.

Se você optar por usar este método de autenticação, a sua conta Microsoft SharePoint deve atender aos seguintes requisitos:

  • A menos que você tenha criado sua conta SharePoint Online antes de janeiro de 2020, a autenticação de dois fatores está ativada para a conta por padrão. Você deve desativar a autenticação de dois fatores.

    Para visualizar e alterar o status da autenticação multifator, consulte Visualizar o status de um usuário ou Alterar o status de um usuário.

  • A conta do usuário do crawl deve ter autenticação de legado e permissões de nível Contribute ativadas.

    Para ativar a autenticação de legado, acesse o portal Azure ou entre em contato com o administrador do SharePoint.

  • O conector suporta o método Password hash synchronization (PHS) para ativar a identidade híbrida apenas. Use qualquer outro tipo (como autenticação de Passe ou Federação) a seu próprio risco.

  • Você deve saber as seguintes informações:

    Nome do usuário

    O nome de usuário da conta de usuário a usar para se conectar ao SharePoint Online SiteCollection que você deseja engatinhar.

    Por exemplo, <janedoe>@exampledomain.onmicrosoft.com.

    Senha

    A senha para se conectar ao site SharePoint Online SiteCollection que você deseja rastrear.

    Esse valor nunca é retornado e só é usado quando as credenciais são criadas ou modificadas.

O que você precisa antes de começar

Você deve ter as seguintes informações prontas. Se você não conhece, peça ao seu administrador do SharePoint para fornecer as informações ou consultar a documentação do desenvolvedor Microsoft SharePoint:

URL da organização

A raiz URL da fonte que você deseja rastrear. Especifique o nome de domínio do URL, por exemplo, https://<company>.<domain>.com.

Caminho de coleta do site

O site_collection_path para a seção do site onde você deseja iniciar o crawl.

Por exemplo, se o conteúdo que você deseja rastrear estiver disponível em https://<company>.<domain>.com/sites/test, você poderá especificar https://<company>.<domain>.com como a Organização URL e /sites/test como o caminho da coleção de sites.

  • Não é possível especificar caminhos da pasta como entrada.
  • Não é possível especificar um caminho para um arquivo Active Server Page Extended (ASPX), como URLs para documentar bibliotecas, listas e subsites.
  • Se você não especificar um caminho, o valor padrão de / é usado e a coleta do site raiz é engatinhado.
  • ID do aplicativo: ID da fonte de dados que você deseja engatinhar. Essas informações são necessárias apenas se você quiser armazenar informações da ACL que estão associadas aos documentos de origem.

Etapa de pré-requisito para OAuth

Antes que qualquer um possa configurar o conector para usar o método de autenticação OAuth v2, um usuário com a função Administrador Global em Microsoft Azure Directory onde a origem de dados está localizada deve concluir etapas para registrar o aplicativo da empresa Discovery em Microsoft Azure. Esta etapa deve ser concluída uma vez por Discovery instância de serviço.

O administrador não precisa criar o aplicativo em Azure. Quando eles escolhem o SharePoint Online como a fonte de dados, o serviço Discovery gera o app automaticamente. Conforme descrito no procedimento a seguir, durante o set up do conector, o administrador deve fazer login na Microsoft com credenciais para um usuário com a função Administrador Global em Microsoft Azure Directory e permitir que o aplicativo corporativo seja registrado.

As etapas a seguir devem ser concluídas por um administrador global uma vez somente por instância de serviço:

  1. Revise as configurações de acesso do usuário padrão que serão aplicadas no aplicativo corporativo no Microsoft Azure.

    Os aplicativos corporativos podem manipular o acesso do usuário de muitas maneiras. Verifique as configurações padrão para garantir que elas sejam apropriadas para a sua implementação, concluindo as seguintes etapas:

    1. Faça login no Microsoft Azure.
    2. A partir da página Aplicativos corporativos em Azure Active Directory, clique em Consent and permissões.

    Azure Enterprise App Permissions user interface
    Microsoft Azure Enterprise application permissions user interface

    1. Execute um dos procedimentos a seguir:

      • Se Permitir que o consentimento do usuário para apps seja selecionado, não será necessária mais ação.

      • Se Permitir que o consentimento do usuário para apps de publishers verificados, para permissões selecionadas seja selecionado, então complete as seguintes etapas:

        Clique em classificações de Permissões link e, em seguida, certise-se de que as permissões a seguir estão configuradas no mínimo:

        • Office 365 SharePoint Online: MyFiles.Leia
        • Office 365 SharePoint Online: AllSites.Leia
        • Microsoft Graph: offline_access
        • Microsoft Graph: perfil

      A opção Não permitir a opção de consentimento do usuário não é suportada.

      As configurações que você especificar serão aplicadas no aplicativo corporativo que é criado por Discovery em etapas subsequentes.

  2. A partir da pane de navegação de Discovery, escolha Gerenciar coleções.

  3. Clique em New collection (Nova coleção ).

  4. Clique em SharePoint Online e, em seguida, clique em Avançar.

  5. Adicione um URL ao campo Organization URL.

  6. Clique em Entrar com a Microsoft.

    Os pop-ups devem estar habilitados para este site em seu navegador web.

    A opção Sign in with Microsoft que usa Open Authentication para autenticar com a fonte de dados externa é um recurso beta.

    Faça login na sua conta do Microsoft SharePoint com seu nome de usuário e senha e, em seguida, complete a autenticação de dois fatores, se necessário.

    Lembre-se, as credenciais que você usa devem ter a função Administrador Global no diretório Microsoft Azure. Se você não for solicitado para um nome de usuário e senha, tome nota. Você pode estar logado em uma conta do Microsoft Sharepoint já. Se você estiver logado em uma conta que você não deseja usar para este conector, pare aqui. (Qualquer conta em que você estiver logado será usada automaticamente. E você não pode alterar a configuração da conta posteriormente) Abra um navegador web em modo incognito e inicie este procedimento a partir da etapa 1.

    A descoberta gera um aplicativo corporativo que ele registrará com a organização SharePoint que você especificar. O nome do aplicativo corporativo tem o formato IBM App Connect_{unique name}.

  7. Revise as permissões que estão associadas ao aplicativo corporativo que Discovery irá registrar e, em seguida, selecione Consent em nome de sua organização.

    Permissão de solicitação de permissão que pede que você consente em nome de sua organização para permitir o app a 1. Ler arquivos do usuário. 2. Leia itens em todas as coleções do site. 3. Mantenha o acesso aos dados que lhe deram acesso. 4. Visualizar o perfil básico dos usuários.
    Discovery permission request dialog

  8. Clique em Accept (Aceitar ).

  9. Se você deseja criar uma coleção, você pode nomear a coleção e, em seguida, clicar em Concluir.

    Caso contrário, você pode clicar em Voltar para sair do processo de criação da coleção.

Agora, qualquer pessoa da sua organização que trabalhe em um projeto que é hospedado pela mesma instância de serviço Discovery pode criar uma coleção usando o conector SharePoint Online.

Revisões de suporte OAuth

O suporte para o método OAuth de autenticação foi adicionado com uma atualização de software em fevereiro de 2022. Se você deseja atualizar um conector existente para usar OAuth em vez de SAML, deve-se recriar o conector. Não é possível alterar o mecanismo de autenticação para um conector existente.

O método OAuth de autenticação foi atualizado em janeiro de 2023. O aplicativo corporativo que é registrado com o Microsoft Azure agora requer o acesso Leia apenas. Anteriormente, o aplicativo corporativo exigia o acesso Gravar. Se você quiser aproveitar esta mudança, exclua o seu aplicativo corporativo atual e recrie o conector. Para obter mais informações sobre como excluir um aplicativo corporativo, consulte a documentação da Microsoft.

Conectando-se à fonte de dados

Para configurar a origem de dados Microsoft SharePoint Online, conclua as etapas a seguir em Discovery:

  1. A partir da pane de navegação, escolha Gerenciar coleções.

  2. Clique em New collection (Nova coleção ).

  3. Clique no link próximo a Necessidade de se conectar a uma origem de dados? clique em SharePoint Online e, em seguida, clique em Avançar.

  4. Adicione um URL ao campo Organization URL.

  5. Para ativar o acesso à sua fonte de dados externa, escolha o método que deseja utilizar para autenticar com a fonte de dados a partir das seguintes opções:

    Autenticação aberta (OAuth v2)

    Clique em Entrar com a Microsoft.

    Os pop-ups devem estar habilitados para este site em seu navegador web.

    A opção Sign in with Microsoft que usa Open Authentication para autenticar com a fonte de dados externa é um recurso beta.

    Faça login na sua conta do Microsoft SharePoint com seu nome de usuário e senha e, em seguida, complete a autenticação de dois fatores, se necessário.

    SAML (Security Assertion Markup Language)

    Especifique um nome de usuário e senha para um usuário que esteja autorizado a acessar o site que deseja engatinhar e, em seguida, clique em Avançar.

  6. Especifique o caminho que deseja engatinhar no campo Caminho da coleta do site.

  7. Nomeia a coleção.

  8. Se a linguagem dos documentos no site não for o inglês, selecione a linguagem apropriada.

    Para obter uma lista de idiomas suportados, consulte Suporte ao idioma.

  9. Opcional: Alterar o cronograma de sincronização.

    Para obter mais informações, consulte Opções de planejamento de Crawl.

  10. Opcional: Se você deseja armazenar qualquer informação de controle de acesso que existe nos documentos do SharePoint que você rasteja, na seção Segurança, configure a comutação Include Access Control List para On.

    Ao ativar esta opção, as informações sobre as regras de acesso do SharePoint que são armazenadas em documentos de origem do SharePoint são retidas e armazenadas como metadados nos documentos que são adicionados à sua coleção.

    Esse recurso não é o mesmo que ativar a segurança de nível de documento para a coleta. As regras de acesso nos metadados do documento não são usadas pela pesquisa Discovery. A ativação desse recurso meramente armazena as informações para que você possa alavancar as regras de acesso ao construir uma solução de busca personalizada.

    O uso desse recurso aumenta o tamanho dos documentos que são gerados na coleta e aumenta o tempo de crawl. Apenas ative o recurso se o seu caso de uso exigir que você armazene as informações de ACL do documento SharePoint.

    Se você ativar esse recurso, alguém com a função de administrador no Microsoft SharePoint deve tomar medidas extras para garantir que os usuários que rastejam o site tenham as permissões certas para acessar metadados ACL.

    Um administrador deve concluir as seguintes etapas:

    1. Faça login no Microsoft SharePoint.

    2. Abra a página para o seu site SharePoint.

    3. No menu de configurações, escolha permissões do site.

    4. Clique em Configurações avançadas de permissão.

    5. Certise-se de que as pessoas que desejam coletar informações de controle de acesso durante um crawl têm ou são membros de um grupo que possui a permissão Controle Completo para o site.

      Mostra a interface de usuário do SharePoint onde você define permissões para usuários e grupos.
      Microsoft SharePoint permissions user interface

      Quando a informação da lista de controle de acesso não for extraída, a permissão Leia é suficiente para todos os usuários que engatinhar o conteúdo.

  11. Se você deseja limitar os tipos de arquivos a serem incluídos na coleção, é possível listar as extensões de arquivo para os tipos de arquivo a serem incluídos ou excluídos

    Ao escolher listar extensões para tipos de arquivo a serem excluídos, deve-se incluir pelo menos uma extensão de arquivo. Por padrão, o Filtro de extensão é aplicável apenas a objetos SharePoint Bibliotecas de documentos e Anexos de item de lista. Para aplicar o filtro a todos os tipos de objeto SharePoint, configure Aplicar filtro de extensão a todos os tipos de objeto SharePoint como Ativado na interface com o usuário

    Para obter uma lista de tipos de arquivos suportados, consulte Tipos de Arquivos Suportados

  12. Se você deseja que o crawler extraia texto a partir de imagens no site, expanda Mais configurações de processamentoe configure Aplicar reconhecimento de caracteres ópticos (OCR) a On.

    Quando o OCR é ativado e seus documentos contêm imagens, o processamento demora mais. Para obter mais informações, consulte Reconhecimento de caracteres Ópticos.

  13. Clique em Finish.

A coleção é criada rapidamente. É preciso mais tempo para que os dados sejam processados conforme ele é adicionado à coleção.

Se você quiser verificar o progresso, acesse a página Atividade. A partir da pane de navegação, clique em Gerenciar coleções e, em seguida, clique para abrir a coleção.

Atualmente não é possível alterar a conta de usuário que está associada com a configuração do OAuth posteriormente, nem qualquer um dos detalhes da conta de usuário existente que o conector está configurado para usar. Por exemplo, não é possível atualizar a senha que foi usada para configurar a conexão após uma alteração de senha no SharePoint.

Informações da lista de controle de acesso a

A captura de tela a seguir ilustra o tipo de informação ACL que é armazenada no documento quando você inclui a lista de controle de acesso.

Mostra as informações da Microsoft ACL armazenadas no objeto de origem nos metadados do documento.
Representation of ACL information in document metadata