Microsoft SharePoint Online
Rastrear documentos armazenados em uma fonte de dados on-line do Microsoft SharePoint.
IBM Cloud Pak for Data IBM Software Hub
Essas informações se aplicam apenas a implementações instaladas. Para obter mais informações sobre como se conectar a um site online do SharePoint a partir de uma implantação gerenciada, consulte SharePoint Online.
Quais documentos são rastreados
- Durante o rastreamento inicial do conteúdo, os documentos de todos os objetos que podem ser acessados a partir do caminho da coleção de sites que você especificar são rastreados e adicionados à sua coleção. Os metadados personalizados que estão associados ao conteúdo do SharePoint também são rastreados.
- Você pode rastrear um caminho de coleção de sites por coleção.
- Somente os documentos compatíveis com o site Discovery são rastreados; todos os outros são ignorados. Para obter mais informações, consulte Tipos de arquivos suportados.
- Há suporte para segurança em nível de documento. Quando essa opção está ativada, seus usuários podem rastrear e consultar o mesmo conteúdo que eles podem acessar quando estão conectados ao SharePoint. Para obter mais informações, consulte Suporte à segurança em nível de documento.
- Quando uma fonte é rastreada novamente, novos documentos são adicionados, documentos atualizados são modificados para a versão atual e documentos excluídos são excluídos do índice da coleção.
- Todos os Discovery conectores de fonte de dados são somente leitura. Independentemente das permissões concedidas à conta de rastreamento, Discovery nunca grava, atualiza ou exclui qualquer conteúdo na fonte de dados original.
Discovery pode rastrear os seguintes objetos:
- Coleções de sites
- Sites
- SubSites
- Listas
- Itens da lista
- Bibliotecas de documentos
- Anexos de itens de lista
Requisitos da origem de dados
Além dos requisitos da fonte de dados para todas as implantações instaladas, sua fonte de dados do SharePoint Online deve atender aos seguintes requisitos:
-
A Site Collection à qual você se conecta deve ser uma que tenha sido criada com um plano Enterprise. Não pode ser uma coleção criada com um plano de trabalhadores da linha de frente.
-
O suporte à autenticação difere com base no tipo de principal que você especifica ao configurar o método de autenticação. Determine o tipo de principal que deseja usar antes de criar a coleção; não é possível alterar o tipo de principal posteriormente. As opções a seguir estão disponíveis:
-
Usuário: os seguintes requisitos devem ser atendidos pela conta de usuário crawl:
-
A conta deve ter um Azure Active Directory ID de usuário com permissão para acessar todos os objetos que você deseja rastrear. Por exemplo,
admin_user@company.onmicrosoft.com
. O ID do usuário deve ter a permissãoSite Collection Administrator
. -
A conta deve ter a autenticação herdada ativada. Para ativar a autenticação herdada, acesse o portal Azure ou entre em contato com o administrador do Azure Active Directory.
O conector é compatível com o método
Password hash synchronization (PHS)
para habilitar somente a identidade híbrida. Use qualquer outro tipo (como autenticação de passagem ou federação) por sua própria conta e risco. 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.
-
-
Serviço: Quando você se conecta aos seus dados como um Azure Active Directory service principal, pode usar a autenticação multifator.
-
Para obter mais informações sobre o SharePoint Online, consulte a documentação do desenvolvedor do Microsoft SharePoint.
Etapas de pré-requisito ao usar uma entidade de usuário
Se quiser ativar a segurança em nível de documento, você deverá tomar algumas medidas para configurá-la. Para obter mais informações, consulte Sobre a segurança de nível de documento.
A tabela a seguir lista as permissões a serem definidas para um método de autenticação principal do usuário.
-
Registre seu aplicativo.
Para obter mais informações, consulte a Documentação da Microsoft.
-
Configurar permissões de API.
API | Permissões | Tipo |
---|---|---|
Microsoft Graph (Grupos) | Group.Read.All ou Group.ReadWrite.All |
Delegado |
Microsoft Graph (Diretórios) | Directory.AccessAsUser.All ou Directory.Read.All ou Directory.ReadWrite.All |
Delegado |
SharePoint Online | User.Read.All ou User.ReadWrite.All |
Delegado |
Etapas de pré-requisito ao usar uma entidade de serviço
Uma entidade de serviço é uma identidade de segurança usada por aplicativos, serviços e ferramentas de automação criados pelo usuário para acessar recursos específicos do Azure. É como uma identidade de usuário (verificada com um certificado) que tem uma função específica e permissões rigidamente controladas. Se você se conectar ao SharePoint Online como um usuário principal de serviço, poderá acessar seus dados sem desativar a autenticação multifator.
Para se preparar para se conectar como um diretor de serviço, conclua as etapas a seguir:
- Crie um arquivo de certificação.
- Registre um aplicativo no SharePoint.
- Adicionar um certificado.
- Configurar permissões de API.
- Ative o Azure.
- Criar uma permissão de site.
Criar um arquivo de certificação
O rastreador suporta os seguintes formatos para uma chave privada:
- PKCS #1
- PKCS #1 com senha
- PKCS #8
- PKCS #8 com senha
O procedimento a seguir mostra como criar uma chave privada com o formato PKCS #1 sem uma senha.
-
Crie uma chave privada.
openssl genrsa 2048 > spo-private.key
-
Crie uma chave pública.
openssl rsa -in spo-private.key -pubout -out spo-public.key
-
Crie um arquivo CSR (Certificate Signing Request, solicitação de assinatura de certificado).
openssl req -new -key spo-private.key > spo-request.csr
-
Criar um arquivo de certificação.
openssl x509 -req -in spo-request.csr -signkey spo-private.key -out spo.crt -days 3650
Registre um aplicativo no SharePoint Online
Siga as instruções da documentação da Microsoft para registrar um aplicativo Azure AD.
Faça as seguintes escolhas:
- Escolha a opção Accounts in this organizational directory only (Contas somente neste diretório organizacional).
- Defina o tipo de cliente como um cliente público.
- Anote o ID do aplicativo (cliente) Azure que é atribuído ao seu aplicativo quando você o registra.
Quando você registra um aplicativo no portal, um objeto de aplicativo e um objeto principal de serviço são criados automaticamente em seu locatário inicial.
Incluir um certificado
Faça upload do certificado que você criou anteriormente.
Configurar permissões de API
Siga a Documentação da Microsoft para adicionar permissões de API.
A tabela a seguir lista as permissões a serem definidas para um método de autenticação principal de serviço e a segurança em nível de documento está ativada.
API | Permissões | Tipo |
---|---|---|
Microsoft Graph (Grupos) | Group.Read.All |
Aplicativo |
Microsoft Graph (Diretórios) | Directory.Read.All |
Aplicativo |
SharePoint | Sites.FullControl.All |
Aplicativo |
A tabela a seguir lista as permissões a serem definidas para um método de autenticação principal de serviço e a segurança em nível de documento está desativada.
API | Permissões | Tipo |
---|---|---|
Microsoft Graph | Sites.Read.All |
Aplicativo |
SharePoint | Sites.Read.All |
Aplicativo |
- Depois de configurar as permissões de API, clique em Grant admin consent for {tenant-name}.
Habilite o Azure serviço de controle de acesso (ACS)
Esse procedimento é necessário somente se você quiser configurar as permissões de aplicativos para cada coleção de sites.
-
Abra um shell de gerenciamento on-line do SharePoint.
Para obter mais informações, consulte Comece a usar o SharePoint Online Management Shell.
-
Ative a autenticação somente de aplicativo baseada em ACS executando o seguinte comando:
Set-PnPTenant -DisableCustomAppAuthentication $false
Para obter mais informações, consulte Set-PnPTenant.
-
Siga as etapas na documentação da Microsoft para Conceder acesso usando SharePoint App-Only.
-
Copie os valores de Client ID e Client Secret.
-
Defina a solicitação de permissão apropriada para sua implantação.
Vá para https://{tenant-name}.sharepoint.com/sites/{site}/_layouts/15/AppInv.aspx.
Se a segurança em nível de documento estiver ativada, especifique a seguinte solicitação XML:
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" /> </AppPermissionRequests>
Se a segurança em nível de documento estiver desativada, especifique a seguinte solicitação XML:
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="Read" /> </AppPermissionRequests>
-
Confirme que você confia no aplicativo.
Criar uma permissão de site
Adicione uma permissão Sites.Selected
para a API do Microsoft Graph. Exigir Sites.FullControl.All
permissão para chamar a seguinte API:
curl -s -XPOST -H "Authorization: ${access_token}" -H "Content-Type: application/json" \
https://graph.microsoft.com/v1.0/sites/{site}/permissions -d '{
"roles": ["read"],
"grantedToIdentities": [{
"application": {
"id": "{azure_ad_app_id}",
"displayName": "{display_name}"
}
}]
}'
Para obter mais informações, consulte a Documentação da Microsoft.
Conectando-se a uma fonte de dados do SharePoint Online
Em seu projeto Discovery, conclua as seguintes etapas:
-
No painel de navegação, escolha Gerenciar coleções.
-
Clique em New collection (Nova coleção ).
-
Clique em SharePoint Online e, em seguida, clique em Next.
-
Dê um nome à coleção.
-
Se o idioma dos documentos no SharePoint não for o inglês, selecione o idioma apropriado.
Para obter uma lista de idiomas suportados, consulte Suporte ao idioma.
-
Opcional: Alterar o cronograma de sincronização.
Para obter mais informações, consulte Opções de agendamento de rastreamento.
-
Na seção Método de autenticação, especifique o tipo de principal que deseja usar ao se autenticar com o SharePoint entre as seguintes opções:
-
Usuário: Um usuário em sua Active Directory.
Na seção Enter suas credenciais, preencha os seguintes campos:
- Nome do usuário
- O nome de usuário do usuário SharePoint com acesso a todos os sites e listas que precisam ser rastreados e indexados, por exemplo,
crawl_username@company.onmicrosoft.com
. - Senha
- A senha do usuário SharePoint.
Esse valor nunca é retornado e é usado somente quando você cria ou modifica credenciais.
-
Serviço: Uma identidade de segurança usada por aplicativos, serviços e ferramentas de automação criados pelo usuário para acessar recursos específicos do Azure. É como uma identidade de usuário (verificada com um certificado) que tem uma função específica e permissões rigidamente controladas.
O suporte ao uso de uma entidade de serviço foi adicionado à versão 4.0.3.
Na seção Enter suas credenciais, preencha os seguintes campos:
- Nome do locatário
-
O locatário onde os dados residem. Por exemplo,
ibm.onmicrosoft.com
. - ID do Aplicativo
-
O ID do seu aplicativo. Por exemplo,
19ce9f74-cd14-4b68-8dfc-4bcc75ed2fe9
. Faça upload dos seguintes arquivos: - Arquivo de certificação
-
O arquivo de certificação que você criou em SharePoint. Por exemplo,
myinfo.crt
. - Arquivo de chave privado
-
O arquivo de chave privada que você criou no SharePoint. Por exemplo,
private.app.key
.Se for necessária uma senha de chave privada, especifique a senha. Se esse rastreador tiver permissões para acessar somente a coleção de sites especificada, defina a chave Azure Access Control Service como
On
e, em seguida, forneça os seguintes valores:
- ID do cliente
- Segredo do cliente
-
-
Na seção Especifique o que você deseja rastrear, adicione valores aos seguintes campos:
- URL da coleção de sites
- O serviço da Web SharePoint URL. Por exemplo,
https://organization_name.com
. - Somente usuário principal
- No campo Nome da coleção de sites, especifique o nome que a coleção de sites usa. Obtenha o nome nas configurações da coleção de sites.
-
Opcional: se estiver usando um servidor proxy para acessar o servidor da fonte de dados, na seção Configurações de proxy, defina a chave Habilitar configurações de proxy como
On
. Adicione valores aos seguintes campos:- Nome do usuário
- Opcional. O nome de usuário do servidor proxy a ser autenticado, se o servidor proxy exigir autenticação. Se você não souber o nome do usuário, será possível obtê-lo junto ao administrador do servidor proxy.
- Senha
- Opcional. A senha do servidor proxy para autenticação, se o servidor proxy exigir autenticação. Se você não souber a senha, será possível obtê-la junto ao administrador do servidor proxy.
- Nome do host ou endereço IP do servidor proxy
- O nome do host ou o endereço IP do servidor proxy.
- Número da porta do servidor proxy
- A porta de rede à qual você deseja se conectar no servidor proxy.
-
Opcional: se quiser ativar a segurança no nível do documento, na seção Segurança, defina a chave Ativar segurança no nível do documento como
On
.Quando essa opção está ativada, seus usuários podem rastrear e consultar o mesmo conteúdo que eles podem acessar quando estão conectados ao SharePoint. Para obter mais informações, consulte Suporte à segurança em nível de documento.
Somente usuário principal: Ao ativar essa opção, você deve adicionar a Azure que foi atribuída ao aplicativo no momento do registro ao campo ID do aplicativo.
Para habilitar a segurança no nível do documento, você deve registrar seu aplicativo no SharePoint. Para obter mais informações, consulte as etapas de pré-requisito para o tipo de principal que você está usando.
-
Se quiser que o rastreador extraia texto de imagens no site, expanda Mais configurações de processamento e defina Aplicar reconhecimento óptico de caracteres (OCR) como
On
.Quando o OCR está ativado e seus documentos contêm imagens, o processamento demora mais. Para obter mais informações, consulte Reconhecimento óptico de caracteres.
-
Clique em Finish.
A coleção é criada rapidamente. Leva mais tempo para os dados serem processados à medida que são adicionados à coleção.
Se quiser verificar o progresso, vá para a página Activity (Atividade). No painel de navegação, clique em Gerenciar coleções e, em seguida, clique para abrir a coleção.