É possível configurar o Google Cloud Search para retornar resultados do conteúdo do SharePoint Online da sua organização, além do conteúdo do Google Workspace. Você usa o conector do SharePoint Online com o Google Cloud Search e o configura para acessar uma fonte de dados específica do SharePoint Online.
Considerações importantes
Configurações do SharePoint reconhecidas
O conector do SharePoint Online com o Cloud Search sempre respeita a configuração Visibilidade da pesquisa no SharePoint, que não pode ser substituída. Para documentos de rascunho, as permissões na conta de usuário (que o conector usa para acessar o SharePoint Online) controlam quais documentos de rascunho são indexados e retornados. Se a conta tiver apenas permissões de "Leitura completa", o conector respeitará as configurações de "Visibilidade do item de rascunho" no SharePoint.
O conector também pode ser configurado para limitar os resultados com base no acesso à conta de usuário. Para aplicar o corte de segurança ao conteúdo do SharePoint, sincronize as seguintes identidades externas com o diretório do Google:
- Usuários do Office 365/Azure AD
- Grupos de segurança do Office 365/Azure AD
- Grupos do SharePoint (com usuários e grupos do Office 365 como membros)
Otimização de pesquisa
Para melhorar a experiência dos usuários, configure o conector para retornar resultados de pesquisa mais relevantes.
Para usar a API, defina valores para parâmetros de geração de HTML no arquivo de configuração do conector do SharePoint Online. Esses parâmetros permitem definir quais campos têm maior ou menor impacto nas correspondências.
Para configurar um esquema, siga as instruções em Criar e registrar um esquema. Ao configurar um esquema:
Para mapear os nomes dos tipos de conteúdo do SharePoint para definições de objeto correspondentes, o conector normaliza os nomes de tipo de conteúdo excluindo caracteres não suportados. Para definições de objetos, a API Cloud Search aceita apenas caracteres válidos com A-Z, a-z e 0-9. Por exemplo, o tipo de conteúdo "Anúncios" é mapeado para a definição de objeto "Anúncios". O tipo de conteúdo "Artigo de notícias" é mapeado para "NewsArticle" (sem espaço).
Quando o conector não consegue corresponder uma definição de objeto a uma definição de objeto, ele usa o tipo de objeto substituto (
itemMetadata.objectType
). Saiba mais sobre os parâmetros de configuração de metadados.O conector mapeia nomes de propriedades do SharePoint nas definições de propriedade.
Quando o conector encontra arquivos .msg do Microsoft Outlook ao indexar o conteúdo, ele substitui o tipo de conteúdo dos arquivos e os indexa como
application/vnd.ms-outlook.
.
Limitações conhecidas do conector
- Cada instância do conector só pode indexar conteúdo de um único conjunto de sites. Para indexar vários conjuntos de sites, configure instâncias adicionais do conector.
- O consumo de memória aumenta com o número de usuários e grupos únicos usados nas ACLs de cada conjunto de sites.
- As notificações de exclusão não são instantâneas. Pode levar mais de quatro horas para um conector reconhecer que um usuário excluiu conteúdo do repositório de origem.
Requisitos do sistema
Requisitos do sistema | |
---|---|
Sistema operacional |
|
Autenticação |
|
Software |
|
Implantar o conector
Pré-requisitos
Crie uma chave privada do Google Workspace que contenha o ID da sua conta de serviço. Para saber como conseguir uma chave privada, acesse Configurar o acesso à API Google Cloud Search.
O administrador do Google Workspace precisa adicionar uma origem de dados para pesquisar. Registre o ID da fonte de dados.
Se o conector retornar resultados com base nas ACLs (e não são públicos), o administrador do Google Workspace precisará criar duas origens de identidade e fornecer os IDs delas:
- uma para usuários e grupos do Office 365
- uma para grupos do SharePoint
O administrador também precisa receber e informar o ID de cliente do Google Workspace da sua organização.
Saiba como buscar esses valores em Mapear identidades de usuários no Cloud Search.
Configure uma conta de usuário para o conector que tenha privilégios de administrador do conjunto de sites do SharePoint Online.
Se o conector retornar resultados com base nas ACLs (os resultados não são públicos), crie credenciais para ler usuários e grupos da conta do Office 365. Siga as instruções da Microsoft para criar um aplicativo do Azure Active Directory. Ao configurar o aplicativo, siga as etapas a seguir:
- Dê um nome descritivo a ele, como "gcs-o365-identity-connector".
- Adicione permissões. O app precisa de "Group.Read.All" e "User.Read.All".
- Registre as seguintes informações para usar na configuração do conector:
- ID do aplicativo
- Locatário
- Chave secreta do cliente
Etapa 1. Instalar o software do conector do SharePoint Online
Clone o repositório do conector que está no GitHub.
$ git clone https://github.com/google-cloudsearch/sharepoint-connector.git $ cd sharepoint-connector
Confira se é a versão desejada do conector:
$ git checkout tags/v1-0.0.3
Crie o conector.
$ mvn package
Para pular testes ao criar o conector, execute
mvn package -DskipTests
em vez demvn package
.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
Etapa 2: Criar o arquivo de configuração do conector do SharePoint Online
No mesmo diretório da instalação do conector, crie um novo arquivo e dê a ele o nome
sharepoint-online-connector.config
. Se você planeja executar muitas instâncias de conector, adicione mais detalhes ao nome para diferenciá-lo.Adicione parâmetros como pares de chave-valor ao conteúdo do arquivo, como no exemplo abaixo:
### SharePoint Online connector configuration ### # Required parameters for data source access api.sourceId=08ef8becd116faa4546b8ca2c84b2879 api.serviceAccountPrivateKeyFile=service_account.json # Required parameters for SharePoint Online access 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 # SharePoint identity mapping parameters api.identitySourceId=08ef8becd116faa475de26d9b291fed9 api.referenceIdentitySources=defaultIdentitySource api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa # Optional SharePoint List Item metadata parameters contentTemplate.sharepointItem.title=Title contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
Para descrições detalhadas de cada parâmetro, acesse a referência de parâmetros de configuração.
(Opcional) Configure parâmetros adicionais do conector, conforme necessário. Para mais detalhes, acesse Parâmetros do conector fornecidos pelo Google.
Etapa 3. Configurar a geração de registros do conector do SharePoint Online
Crie uma pasta chamada logs no mesmo diretório que contém o binário do conector.
Crie um arquivo codificado em Latin-1 chamado logging.properties no mesmo diretório e adicione 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
Etapa 4. Configurar o conector de identidade do SharePoint Online
Esta etapa é necessária para aplicar as ACLs baseadas em identidade do SharePoint Online com os resultados de pesquisa. Se você configurou o conector usando ACLs públicas, pule esta etapa.
No mesmo diretório da instalação do conector do SharePoint Online, crie um novo arquivo e dê a ele o nome
sharepoint-online-identity-connector.config
.Adicione parâmetros como pares de chave-valor ao conteúdo do arquivo, como no exemplo abaixo:
### SharePoint Online identity connector configuration ### # Required parameters for data source access api.customerId=C05d3djk8 api.serviceAccountPrivateKeyFile=service_account.json # Required parameters for SharePoint Online access 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 # SharePoint identity mapping parameters api.identitySourceId=08ef8becd116faa475de26d9b291fed9 api.referenceIdentitySources=defaultIdentitySource api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa
Os valores são quase os mesmos do conector do SharePoint Online, exceto que, em vez de
api.sourceId
, o parâmetro éapi.customerId
. O valor deapi.customerId
é o ID de cliente informado pelo administrador do Google Workspace.
Etapa 5. Instalar o conector de identidade do Office 365
Esta etapa é necessária para aplicar as ACLs baseadas em identidade do SharePoint Online com os resultados de pesquisa. Se você configurou o conector usando ACLs públicas, pule esta etapa.
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
Confira se é a versão desejada do conector:
$ git checkout tags/v1-0.0.3
Crie o conector.
$ mvn package
Para pular testes ao criar o conector, execute
mvn package -DskipTests
em vez demvn package
.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
Etapa 6. Configurar o conector de identidade do Office 365 e a geração de registros
No mesmo diretório da instalação do conector de identidade, crie um novo arquivo e dê a ele o nome
o365-identity-connector.config
.Adicione parâmetros como pares de chave-valor ao conteúdo do arquivo, como no exemplo abaixo. Observação: todos os parâmetros são obrigatórios.
### Office 365 Identity connector configuration ###
api.identitySourceId=12345abcde api.customerId=abcde12345 o365.clientId=a63c6eb3-29e7-486 o365.tenant=185ef9ed-29e7-486 o365.clientSecret=raHJN15vRLBKsPara descrições detalhadas de cada parâmetro, acesse a referência de configuração do conector de identidade do Office 365.
Crie uma pasta chamada logs no mesmo diretório que contém o binário do conector.
Crie um arquivo ASCII ou UTF-8 chamado 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 Office 365 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
Etapa 7. Iniciar o conector do SharePoint Online
Nas etapas a seguir, você vai mapear os principais no conjunto de sites do Office 365 e do SharePoint para identidades no serviço Cloud Identity. Essa sincronização é feita com os conectores de identidade do Office 365 e do SharePoint Online.
Depois que o conector do Office 365 sincronizar os usuários e grupos, execute o conector de identidade do SharePoint Online para sincronizar os grupos de conjuntos de sites do SharePoint. Em seguida, execute o conector do SharePoint Online para indexar e exibir resultados para seus usuários do Cloud Search.
Execute o conector de identidade do Office 365:
$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-office-365-connector-v1-0.0.3.jar -Dconfig=o365-identity-connector.config
Execute o conector de identidade do SharePoint Online:
$ java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-v1-0.0.3.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector -Dconfig=sharepoint-online-identity-connector.config
Execute o conector do SharePoint Online:
$ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -Dconfig=sharepoint-online-connector.config
Referência dos parâmetros de configuração
Acesso à fonte de dados
Configuração | Parâmetro |
ID da origem de dados | api.sourceId=1234567890abcdef
Obrigatório. O ID da origem de dados 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 caminho para o arquivo de chave da conta de serviço do Google Cloud Search. |
Acesso ao SharePoint Online
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 de domínio não for totalmente qualificado, defina a substituição de DNS no host do conector. |
Modo "Somente conjunto de sites" | sharepoint.siteCollectionOnly=true
Obrigatório. Para o SharePoint Online, defina o valor |
Nome de usuário do SharePoint | sharepoint.username=username
Obrigatório. O nome de usuário da conta usado para acessar o SharePoint Online. |
Senha do SharePoint | sharepoint.password=user_password
Obrigatório. A senha da conta usada para acessar o SharePoint Online. |
Modo de autenticação | sharepoint.formsAuthenticationMode=LIVE
Obrigatório. Para o SharePoint Online, o valor é sempre "LIVE". |
Tipo de implantação | sharepoint.deploymentType=ONLINE
Obrigatório. Para o SharePoint Online, o valor é sempre "ONLINE". |
Mapeamento de identidade do SharePoint
Configuração | Parâmetro |
ID da origem de identidade | api.identitySourceId=1234567890abcdef
Obrigatório. O ID da origem de identidade do Cloud Search para a origem de identidade dos grupos do SharePoint. |
Origens de identidade de referência | api.referenceIdentitySources=defaultIdentitySource
Obrigatório. Para o sharePoint Online, o valor é sempre "defaultIdentitySource". |
IDs da origem de identidade de referência | api.referenceIdentitySource.defaultIdentitySource.id=112233abcd
Obrigatório. O ID da origem de identidade do Cloud Search para a origem de identidade de usuários e grupos do Office 365. |
Geração de conteúdo HTML
Configuração | Parâmetro |
Campo de título do modelo HTML | contentTemplate.sharePointItem.title=Title
O campo do SharePoint a ser usado como o título do modelo HTML para o HTML gerado. |
Campos de alta qualidade de pesquisa de conteúdo HTML | contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]
Uma lista de campos separados por vírgula para incluir no HTML gerado como campos de alta qualidade. Quando os termos da consulta de pesquisa correspondem a esses campos, os resultados têm uma classificação mais alta. |
Campos de média qualidade de pesquisa de conteúdo HTML | contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]
Uma lista de campos separados por vírgulas para incluir no HTML gerado como campos de média qualidade. |
Campos de baixa qualidade de pesquisa de conteúdo HTML | contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]
Uma lista separada por vírgulas de campos para incluir no HTML gerado como campos de baixa qualidade. |
Colunas não mapeadas de conteúdo HTML | contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
Como o conector lida com colunas não mapeadas. O valor é APPEND (padrão) ou IGNORE.
|
Configuração do conector de identidade do Office 365
Configuração | Parâmetro |
ID da origem de identidade | api.identitySourceId=1234567890abcdef
Obrigatório. O ID da origem de identidade do Office 365. Esse valor precisa corresponder ao valor de "api.referenceIdentitySource.defaultIdentitySource.id" na configuração do conector do SharePoint Online. |
ID de cliente do Google | api.customerId=c1b1d1e1
Obrigatório. ID de cliente do Google Workspace da sua organização. |
ID do aplicativo Office 365 | o365.clientId=a63c6eb3-29e7-486
Obrigatório. O ID do aplicativo na configuração do Office 365. |
Locatário do Office 365 | o365.tenant=185ef9ed-29e7-486
Obrigatório. O locatário da sua conta do Office 365 (o app Azure Activity Directory) |
Chave secreta do cliente do Office 365 | o365.clientSecret=raHJN15vRLBKs
Obrigatório. Secret de credencial da configuração do aplicativo Office 365 |