Implantar o conector do Microsoft SharePoint Online

Este guia se destina aos administradores do conector do SharePoint Online com o Google Cloud Search, ou seja, qualquer pessoa responsável por fazer o download, configurar, executar e monitorar o conector.

Ele inclui instruções para executar as principais tarefas relativas à implantação do conector do SharePoint Online:

  • Fazer o download do software do conector do SharePoint Online com o Google Cloud Search.
  • Configurar o conector para uso com uma origem de dados específica do SharePoint Online.
  • Implantar e executar o conector.

Para entender os conceitos deste documento, é preciso estar familiarizado com os fundamentos do Google Workspace e do SharePoint Online.

Visão geral do conector do SharePoint Online com o Google Cloud Search

Por padrão, o Google Cloud Search pode detectar, indexar e exibir conteúdo com base nos dados do Google Workspace, como o Documentos Google e o Gmail. É possível estender o Google Cloud Search para exibir conteúdo do SharePoint Online para seus usuários usando o conector do SharePoint Online.

Arquivos de propriedades de configuração

Para permitir que o conector descubra conteúdos do SharePoint Online e os carregue na API Indexing, é preciso que você, como administrador do conector, crie um arquivo de configuração para fornecer configurações ao conector do SharePoint Online. Para fazer isso, use as etapas descritas em Etapas da implantação.

Além dos parâmetros do conector do SharePoint Online descritos neste documento, existem parâmetros de configuração usados por todos os conectores do Cloud Search. Para informações detalhadas, consulte Parâmetros do conector fornecidos pelo Google.

Sistemas operacionais compatíveis

  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bits)

Como indexar documentos não publicados

O conector do SharePoint Online com o Cloud Search sempre respeita a configuração "Visibilidade da pesquisa" no SharePoint. Não é possível substituir isso. Para documentos de rascunho, a indexação depende das permissões fornecidas à conta de usuário do conector. Se o usuário tiver apenas permissões do tipo "Acesso completo de leitura", o conector honrará todas as configurações de "Visibilidade do item de rascunho" no SharePoint.

Mecanismos de autenticação compatíveis

O conector do SharePoint Online com o Cloud Search oferece suporte à Autenticação em tempo real.

Limitações conhecidas do conector

  • A instância do conector só pode indexar conteúdo de um único conjunto de sites. São necessárias instâncias do conector separadas para indexar vários conjuntos de sites.
  • O número de usuários e grupos exclusivos usados em ACLs para cada conjunto de sites afeta o consumo de memória.
  • A versão atual do conector não gera notificações de exclusão instantâneas.
  • O conector depende da reindexação do conteúdo para identificar exclusões do repositório de origem. Para conteúdo indexado anteriormente, a latência de detecção de exclusão pode ser superior a quatro horas.

Pré-requisitos

O conector do SharePoint Online do Google Cloud Search pode ser instalado no Linux ou Windows. Antes de implantar o conector do SharePoint Online com o Google Cloud Search, verifique se você tem os seguintes componentes necessários:

  • Ambiente do SharePoint Online.
  • Java JRE 1.8 instalado em um computador que executa o conector do SharePoint Online com o Google Cloud Search.

  • Informações do Google Workspace necessárias para estabelecer relações entre o Google Cloud Search e a origem de dados:

    Normalmente, o administrador do Google Workspace no domínio pode fornecer essas credenciais para você.

  • Conta de usuário para o conector. Essa conta precisa ter privilégios de administrador do conjunto de sites.

Etapas da implantação

Para implantar o conector do SharePoint Online com o Google Cloud Search, siga estas etapas:

  1. Instale o software do conector do SharePoint Online com o Google Cloud Search.
  2. Especificar a configuração do conector do SharePoint Online.
  3. Configurar o acesso à origem de dados do Google Cloud Search.
  4. Configurar o acesso ao SharePoint Online
  5. Configure o mapeamento de identidade do SharePoint com o Google Cloud Search.
  6. Configure a geração de conteúdo HTML e o suporte a dados estruturados para itens de lista do SharePoint.
  7. Configure o mapeamento de identidade do O365 com o Google Cloud Search.
  8. Ativar a geração de registros.

1. Instale o software do conector do SharePoint Online com o Google Cloud Search

  1. Clone o repositório do conector que está no GitHub.

    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector

  2. Confira se é a versão desejada do conector:

    git checkout tags/v1-0.0.3

  3. Crie o conector.

    mvn package

    Para ignorar testes ao criar o conector, execute mvn package -DskipTests em vez de mvn package.

  4. Copie o arquivo ZIP do conector para o diretório de instalação local:

    $ cp target/google-cloudsearch-sharepoint-connector-v1-0.0.3.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-sharepoint-connector-v1-0.0.3.zip
    $ cd google-cloudsearch-sharepoint-connector-v1-0.0.3

2. Especifique a configuração do conector do SharePoint Online

Para que o conector possa acessar corretamente o SharePoint Online e o conteúdo de índice, é preciso primeiro criar o arquivo de configuração. Para controlar o comportamento e os atributos do conector do SharePoint Online, defina parâmetros no arquivo de configuração do conector. Os parâmetros configuráveis controlam o seguinte:

  • Acesso a uma origem de dados
  • Acesso ao SharePoint Online

Para criar um arquivo de configuração, execute estas ações:

  1. Abra o editor de texto da sua preferência e adicione pares de chave=valor no conteúdo do arquivo, conforme descrito nas seções a seguir.
  2. Salve e nomeie o arquivo de configuração. O Google recomenda que você nomeie o arquivo de configuração como connector-config.properties. Assim, nenhum outro parâmetro de linha de comando será necessário para executar o conector.

3. Configure o acesso à origem de dados do Google Cloud Search

Os primeiros parâmetros que cada arquivo de configuração precisa especificar são os necessários para acessar a origem de dados do Cloud Search, conforme mostrado na tabela a seguir. Normalmente, serão necessários o ID da origem de dados, o ID da origem de identidade e o caminho para o arquivo de chave privada da conta de serviço para configurar o acesso do conector ao Cloud Search. As etapas necessárias para configurar uma origem de dados são descritas em Adicionar uma origem de dados à pesquisa.

Configuração Parâmetro
ID da origem de dados api.sourceId=1234567890abcdef
Obrigatório. O código da origem do Google Cloud Search configurado pelo administrador do Google Workspace.
Caminho para o arquivo de chave privada da conta de serviço api.serviceAccountPrivateKeyFile=./PrivateKey.json
Obrigatório. O arquivo de chave da conta de serviço do Google Cloud Search para acessibilidade do conector do SharePoint Online com o Google Cloud Search.
ID da origem de identidade api.identitySourceId=x0987654321
Obrigatório. O ID da origem de identidade do Cloud Search configurado pelo administrador do Google Workspace.

4. Configure o acesso ao SharePoint Online

Para que o conector possa acessar o SharePoint Online e extrair dados dele para indexação, é preciso configurar o acesso ao sistema de arquivos de origem. Use os parâmetros a seguir para adicionar informações de acesso ao arquivo de configuração.

Configuração Parâmetro
Nome de domínio totalmente qualificado para o conjunto de sites do SharePoint sharepoint.server=http://yoursharepoint.example.com/
Obrigatório. Se o nome do domínio não for totalmente qualificado, será preciso definir a modificação do DNS no host do conector.
Modo "Somente conjunto de sites" sharepoint.siteCollectionOnly=true
Obrigatório. Para o SharePoint Online, defina sempre como verdadeiro.
Nome de usuário do SharePoint sharepoint.username=username
 Obrigatório. Nome de usuário da conta usada para acessar o SharePoint Online.
Senha do SharePoint sharepoint.password=user_password
Obrigatório. Senha da conta usada para acessar o SharePoint Online.
Modo de autenticação sharepoint.formsAuthenticationMode=LIVE
Obrigatório. Para o SharePoint Online, defina como LIVE.
Tipo de implantação sharepoint.deploymentType=ONLINE
Obrigatório. Para o SharePoint Online, defina como ONLINE.

5. Configure o mapeamento de identidade do SharePoint com o Google Cloud Search

Os clientes do Google Cloud Search podem aplicar cortes de ACL aos resultados de pesquisa. Essas ACLs podem ser definidas usando principais do Google, bem como principais externos.

O conector do SharePoint Online é compatível com as seguintes identidades:

  • Usuários do Office 365/Azure AD
  • Grupos de segurança do Office 365/Azure AD
  • Grupos Locais do SharePoint (com usuários e grupos do O365 como membros)

Para aplicar os cortes de segurança apropriados ao conteúdo do SharePoint, também é preciso sincronizar as seguintes identidades externas com o Google:

  • Usar o conector de identidade do SharePoint para sincronizar os grupos locais do SharePoint.
  • Usar o conector de identidade do O365 para sincronizar as identidades do O365.

Para dar suporte a essa configuração, você precisa criar duas origens de identidade.

  • Uma origem de identidade para sincronizar usuários e grupos do O365.
  • Uma origem de identidade para grupos locais do SharePoint.
Configuração Parâmetro
ID da origem de identidade api.identitySourceId=1234567890abcdef
ID da origem de identidade para sincronizar os grupos locais do SharePoint.

Obrigatório. O ID da origem do Google Cloud Search configurado pelo administrador do Google Workspace, conforme descrito em Adicionar uma origem de dados para pesquisa.

Origens de identidade de referência api.referenceIdentitySources=defaultIdentitySource
Obrigatório. Para o SharePoint Online, use o valor fixo defaultIdentitySource
IDs da origem de identidade de referência api.referenceIdentitySource.defaultIdentitySource.id=112233abcd
Obrigatório. ID da origem de identidade para sincronizar as identidades do O365.

6. Configure a geração de conteúdo HTML e o suporte a dados estruturados para itens de lista do SharePoint

Para indexar outros metadados para itens de lista do SharePoint, configure o conector para aceitar a geração de conteúdo HTML e/ou dados estruturados.

Geração de conteúdo HTML

Use os parâmetros da tabela a seguir para configurar a geração de conteúdo HTML.

Configuração Parâmetro
Campo de título do modelo HTML contentTemplate.sharePointItem.title=Title
Campo do SharePoint usado como "Título" para o HTML gerado.
Campos de alta qualidade de pesquisa de conteúdo HTML contentTemplate.sharePointItem.quality.high=highField1,highField2
Campos para incluir no HTML gerado como campos de alta qualidade. A correspondência dos termos da consulta de pesquisa nesses campos terá uma classificação mais alta.
Campos de média qualidade de pesquisa de conteúdo HTML contentTemplate.sharePointItem.quality.medium=mediumField1,mediumField2
Campos para incluir no HTML gerado como campos de qualidade média.
Campos de baixa qualidade de pesquisa de conteúdo HTML contentTemplate.sharePointItem.quality.low=lowField1,lowField2
Campos para incluir no HTML gerado como campos de baixa qualidade.
Colunas não mapeadas de conteúdo HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
O padrão é APPEND. Se definido como IGNORE, o conector gerará HTML apenas usando colunas mapeadas. Defina-o como APPEND para incluir campos não mapeados (que não fazem parte das configurações alta, média e baixa) no conteúdo HTML gerado.

Suporte a dados estruturados

Se o esquema para a origem de dados for definido usando as diretrizes a seguir, o conector preencherá dados estruturados para itens de lista do SharePoint:

  • O conector mapeia nomes de tipo de conteúdo do SharePoint para definições de objetos correspondentes, normalizando o nome do tipo de conteúdo do SharePoint de acordo com as especificações definidas pela API do Cloud Search. A do API Cloud Search aceita apenas caracteres A-Z, a-z e 0-9 como válidos para definições de objetos. O conector normaliza os nomes de tipo de conteúdo excluindo caracteres não aceitos. Por exemplo, o tipo de conteúdo "Anúncios" é mapeado na definição de objeto "Announcements", enquanto o tipo de conteúdo "Artigo de notícias" é mapeado em "NewsArticle".

  • O conector também oferece suporte para a configuração de um tipo de objeto de fallback por meio da configuração itemMetadata.objectType. Se nenhuma definição de objeto correspondente ao tipo de conteúdo do SharePoint estiver disponível no esquema, o conector usará o tipo de objeto de fallback.

  • O conector mapeia nomes de propriedades do SharePoint nas definições de propriedade.

7. Configure o mapeamento de identidade do O365 com o Google Cloud Search

Para aplicar os cortes de segurança adequados ao conteúdo do SharePoint com base nas identidades do O365, é necessário configurar o conector de identidade do O365 incluído no pacote do conector do SharePoint Online.

Criar o conector de identidade do Office 365

Instale o SDK no repositório Maven local, caso você ainda não tenha feito isso:

  1. Clone o repositório do SDK que está no GitHub:

    $ git clone https://github.com/google-cloudsearch/connector-sdk.git
    $ cd connector-sdk

  2. Confira se é a versão desejada do SDK:

    git checkout tags/v1-0.0.3

  3. Instale os componentes do SDK:

    mvn install

Crie o conector:

  1. Clone o repositório do conector que está no GitHub.

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector

  2. Confira se é a versão desejada do conector:

    git checkout tags/v1-0.0.3

  3. Crie o conector.

    mvn package

    Para ignorar testes ao criar o conector, execute mvn package -DskipTests em vez de mvn package.

  4. Copie o arquivo ZIP do conector para o diretório de instalação local:

    $ cp target/google-cloudsearch-office-365-connector-v1-0.0.3.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-office-365-connector-v1-0.0.3.zip
    $ cd google-cloudsearch-office-365-connector-v1-0.0.3

Receber as credenciais do O365

Para usar o conector de identidade do O365, você precisa configurá-lo com credenciais para ler usuários e grupos da conta do O365.

Siga as instruções da Microsoft para criar um aplicativo do Azure Active Directory para a conexão de identidade do O365. Ao configurar o aplicativo, siga as etapas a seguir:

  1. Dê um nome descritivo a ele, como "gcs-o365-identity-connector".
  2. Adicione permissões. "Group.Read.All" e "User.Read.All" são necessárias.
  3. Registre as seguintes informações para usar na próxima etapa:
    • ID do aplicativo
    • Locatário
    • Chave secreta do cliente

Configuração do conector

Configuração Parâmetro
ID da origem de identidade api.identitySourceId=1234567890abcdef
Obrigatório. ID da origem de identidade para sincronizar as identidades do O365.

O código da origem do Google Cloud Search configurado pelo administrador do Google Workspace, conforme descrito em Adicionar uma origem de dados para pesquisa. Esse valor precisa corresponder à configuração "defaultIdentitySource" no conector do SharePoint Online.

ID de cliente do Google api.customerId=c1b1d1e1
Obrigatório. ID do cliente associado ao seu domínio do Google

Para conseguir o ID do cliente, siga as instruções neste link.

ID do aplicativo O365 o365.clientId=a63c6eb3-29e7-486

Obrigatório. ID do aplicativo para a configuração do aplicativo O365.

Locatário do O365 o365.tenant=185ef9ed-29e7-486

Obrigatório. Locatário da sua conta do O365

Chave secreta do cliente do O365 o365.clientSecret=raHJN15vRLBKs

Obrigatório. Chave secreta de credencial da configuração do aplicativo O365

Registros de conectores

Crie uma pasta chamada logs no mesmo diretório que contém o binário do conector.

Crie um arquivo ASCII ou UTF-8 denominado logging.properties no mesmo diretório e inclua o seguinte conteúdo:

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
    # Default log level
    .level = INFO
    # uncomment line below to increase logging level for O365 APIs
    #com.google.enterprise.cloudsearch.o365.level=FINE

    # uncomment line below to increase logging level to enable Google API traces
    #com.google.api.client.http.level = FINE
    java.util.logging.ConsoleHandler.level = INFO
    java.util.logging.FileHandler.pattern=logs/connector-o365.%g.log
    java.util.logging.FileHandler.limit=10485760
    java.util.logging.FileHandler.count=10
    java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Execute o conector de identidade do O365

Para executar o conector, digite o seguinte comando:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-office-365-connector-v1-0.0.3.jar

8. Ative a geração de registros

Crie uma pasta chamada logs no mesmo diretório que contém o binário do conector.

Crie um arquivo ASCII ou UTF-8 denominado logging.properties no mesmo diretório e inclua o seguinte conteúdo:

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
    # Default log level
    .level = INFO
    # uncomment line below to increase logging level for SharePoint APIsa
    #com.google.enterprise.cloudsearch.sharepoint.level=FINE

    # uncomment line below to increase logging level to enable API trace
    #com.google.api.client.http.level = FINE
    java.util.logging.ConsoleHandler.level = INFO
    java.util.logging.FileHandler.pattern=logs/connector-sharepoint.%g.log
    java.util.logging.FileHandler.limit=10485760
    java.util.logging.FileHandler.count=10
    java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Exemplo: arquivo de configuração

O arquivo de configuração de exemplo a seguir mostra os pares de chave=valor de parâmetro que definem o comportamento de um conector de exemplo.

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9

    # Optional
    contentTemplate.sharepointItem.title=Title
    contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

    sharepoint.server=https://mydomain.onmicrosoft.com
    sharepoint.siteCollectionOnly=true
    sharepoint.username=admin@mydomain.onmicrosoft.com
    sharepoint.password=pa$sw0rd
    sharepoint.formsAuthenticationMode=LIVE
    sharepoint.deploymentType=ONLINE

    api.referenceIdentitySources=defaultIdentitySource
    api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Executar o conector de identidade do SharePoint Online

Para que os usuários tenham resultados no Cloud Search de conteúdos do SharePoint a que eles têm acesso, é necessário primeiro mapear os principais nos conjuntos de sites do O365 e do SharePoint nas identidades no serviço do Google Cloud Identity. Essa sincronização é feita pelos conectores de identidade do O365 e do SharePoint Online. Depois que o conector do O365 tiver sincronizado os usuários e grupos, execute o conector de identidade do SharePoint Online, conforme explicado abaixo, para sincronizar os grupos de conjuntos de sites do SharePoint.

O conector de identidade usa um arquivo de configuração semelhante ao que indexa o conteúdo. Veja um exemplo abaixo.

api.customerId=C05d3djk8
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9

    sharepoint.server=https://mydomain.onmicrosoft.com
    sharepoint.siteCollectionOnly=true
    sharepoint.username=admin@mydomain.onmicrosoft.com
    sharepoint.password=pa$sw0rd
    sharepoint.formsAuthenticationMode=LIVE
    sharepoint.deploymentType=ONLINE

    api.referenceIdentitySources=defaultIdentitySource
    api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Observe que a propriedade api.customerId foi adicionada. Para conseguir o customerId, siga as instruções neste link.

O mesmo arquivo JAR usado para indexar conteúdo contém também o conector de identidade. Para executá-lo, insira o comando a seguir no diretório que contém o arquivo de configuração. Em lugar de version, use o número de versão atual, presente na página de versões do GitHub (em inglês).

java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-version.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector

Executar o conector do SharePoint Online

Para executar o conector do SharePoint Online, digite o seguinte comando:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar

Tópico avançado

As informações nesta seção se estendem além da configuração básica do conector do SharePoint.

Modificar Content-Type para arquivos .msg do Microsoft Outlook

Se o conector encontrar arquivos .msg do Outlook ao rastrear conteúdo, ele modificará o Content-Type dos arquivos e os indexará como application/vnd.ms-outlook..