Esegui il deployment del connettore Microsoft SharePoint on-prem

Puoi configurare Google Cloud Search in modo che restituisca risultati dai contenuti on-premise di SharePoint della tua organizzazione, oltre ai contenuti di Google Workspace. Utilizzi il connettore Google Cloud Search SharePoint On-Prem e lo configuri per accedere a un'origine dati SharePoint specifica.

Considerazioni importanti

Impostazioni di SharePoint rispettate

Il connettore SharePoint on-prem di Cloud Search rispetta sempre l'impostazione Visibilità della ricerca su SharePoint, che non può essere ignorata. Per i documenti in bozza, le autorizzazioni sull'account utente (che il connettore utilizza per accedere a SharePoint Online) controllano quali bozze vengono indicizzate e restituite. Se l'account dispone solo delle autorizzazioni "Lettura completa", il connettore rispetta le impostazioni di "Visibilità elemento bozza" su SharePoint.

Puoi anche configurare il connettore per limitare i risultati in base all'accesso all'account utente. Puoi utilizzare i principal Google e i principal esterni per definire gli elenchi di controllo degli accessi. Per applicare il troncamento della sicurezza ai contenuti di SharePoint, sincronizza le seguenti identità esterne con la directory Google:

  • Utenti Active Directory
  • Gruppi Active Directory
  • Gruppi locali di SharePoint (con utenti e gruppi di Active Directory come membri)

Per sincronizzare utenti e gruppi di AD, utilizza Google Cloud Directory Sync, che consente i gruppi con identità mappate. Per sincronizzare i gruppi locali di SharePoint, utilizza SharePoint Identity Connector.

Il connettore deve anche eseguire la ricerca con AD per recuperare informazioni aggiuntive per sincronizzare le entità. Ad esempio, la ricerca con AD consente al connettore di eseguire le seguenti operazioni:

  • Mappa il SID di un gruppo di domini al valore sAMAccountName corrispondente.
  • Mappa un sAMAccountName utente all'indirizzo email per le appartenenze ai gruppi locali di SharePoint.

Ottimizzazione per la ricerca

Puoi migliorare l'esperienza degli utenti configurando il connettore in modo che restituisca risultati di ricerca più pertinenti.

Per utilizzare l'API, imposta i valori per i parametri di generazione HTML nel file di configurazione del connettore SharePoint Online. Questi parametri ti consentono di impostare i campi che hanno un impatto maggiore o minore sulle corrispondenze.

Per configurare uno schema, segui le istruzioni riportate in Creare e registrare uno schema. Quando configuri uno schema:

  • Per mappare i nomi dei tipi di contenuti di SharePoint alle definizioni degli oggetti corrispondenti, il connettore normalizza i nomi dei tipi di contenuti escludendo i caratteri non supportati. Per le definizioni degli oggetti, l'API Cloud Search supporta solo i caratteri A-Z, a-z e 0-9 come caratteri validi. Ad esempio, il tipo di contenuto "Annunci" viene mappato alla definizione dell'oggetto "Annunci". Il tipo di contenuti "Articolo di notizie" corrisponde a "NewsArticle" (senza spazio).

  • Quando il connettore non riesce a trovare una corrispondenza tra una definizione di oggetto e un'altra, utilizza il tipo di oggetto di riserva (itemMetadata.objectType). Scopri di più sui parametri di configurazione dei metadati.

  • Per mappare i nomi delle proprietà di SharePoint alle definizioni delle proprietà, il connettore normalizza i nomi delle proprietà decodificando i caratteri codificati in esadecimale e rimuovendo i prefissi "ows_", quindi escludendo i caratteri non supportati (tutti i caratteri tranne A-Z, a-z e 0-9 come caratteri validi).

Gestione dei messaggi di Microsoft Outlook

Quando il connettore rileva file .msg di Microsoft Outlook durante l'indicizzazione dei contenuti, esegue l'override del tipo di media per i file e li indicizza come application/vnd.ms-outlook.

Configurazioni multi-tenant

Se il tuo SharePoint è un deployment multi-tenant, in cui più siti di clienti sono ospitati nella stessa applicazione web, devi configurare la modalità raccolta siti nel file di configurazione. Nelle implementazioni multi-tenant, ottieni le autorizzazioni solo per la tua raccolta siti e non puoi ottenere le autorizzazioni Lettura completa, come richiesto dal connettore SharePoint on-premise.

Per attivare la modalità raccolta siti:

  • Concedi all'account utente del connettore le autorizzazioni di amministratore della raccolta siti.
  • Imposta sharepoint.server nel file di configurazione del connettore sull'URL della raccolta siti, ad esempio http://sharepoint.example.com/sites/sitecollection. L'URL non deve utilizzare esattamente lo stesso case di SharePoint.
  • Imposta sharepoint.siteCollectionOnly nel file di configurazione del connettore su true.

Se hai più raccolte di siti da indicizzare in un ambiente multi-tenant, devi configurare un'istanza del connettore per ciascuna raccolta di siti.

Limitazioni note del connettore

  • Il tempo necessario al connettore per rilevare le modifiche agli elementi nei database aumenta con il numero di database monitorati dal connettore.
  • Il consumo di memoria aumenta con il numero di utenti e gruppi unici che utilizzi negli elenchi di controllo dell'accesso per ogni raccolta siti.
  • Puoi configurare il connettore con le identità di un solo dominio Active Directory.
  • Alcuni principal comuni di Active Directory e Windows, come Everyone, BUILTIN\Users e All Authenticated Users, non sono supportati.
  • Le notifiche di eliminazione non sono immediate e possono essere necessarie più di 4 ore prima che un connettore riconosca che un utente ha eliminato contenuti dal repository di origine.

Requisiti di sistema

Requisiti di sistema
Sistema operativo
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64 bit)
Software
  • SharePoint Server
    • SharePoint Server 2016
    • SharePoint Server 2013
  • Java JRE 1.8 installato sul computer che eseguirà il connettore Google Cloud Search SharePoint On-Prem
Autenticazione
  • NTLM
  • Kerberos
  • HTTP di base
  • ADFS

Esegui il deployment del connettore

Prerequisiti

  1. Crea una chiave privata Google Workspace, che contiene l'ID del tuo service account. Per scoprire come ottenere una chiave privata, vai a Configurare l'accesso all'API Google Cloud Search.

  2. Il tuo amministratore di Google Workspace deve aggiungere un'origine dati per la ricerca. Registra l'ID origine dati.

  3. Se il connettore restituisce risultati basati su ACL (i risultati non sono pubblici), l'amministratore di Google Workspace deve creare due origini identità e fornirti i relativi ID:

    • Un'origine identità per la sincronizzazione di utenti e gruppi di Active Directory.
    • Un'origine identità per i gruppi locali di SharePoint

    L'amministratore deve anche recuperare l'ID cliente Google Workspace della tua organizzazione e comunicartelo.

    Scopri come ottenere questi valori in Mappare le identità degli utenti in Cloud Search.

  4. Configura un account utente per il connettore con autorizzazioni di lettura completa per l'applicazione web SharePoint nel criterio utente.

  5. Se l'applicazione web SharePoint non ha una raccolta siti radice, creane una.

  6. Se alcune raccolte di siti sono protette da scrittura, accedi a SharePoint Server con un account con privilegi amministrativi ed esegui lo script PrepareWriteLockedSites.ps1.

  7. Per ottenere metriche dell'origine dati che ti aiutino a configurare il connettore, accedi a SharePoint Server con un account che disponga dei privilegi di amministrazione della farm ed esegui diagnose_sp.ps1.

    L'output riporta il numero di applicazioni web, documenti e appartenenze ai gruppi di utenti. Utilizza queste informazioni per stimare il numero di istanze del connettore necessarie, i requisiti di memoria e il conteggio dei documenti.

Passaggio 1: Installa il software del connettore Google Cloud Search SharePoint On-Prem.

  1. Clona il repository del connettore da GitHub.

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

  2. Controlla la versione desiderata del connettore:

    $ git checkout tags/latest_version

    Dove: latest_version = un valore come v1-0.0.5

  3. Crea il connettore.

    $ mvn package

    Per ignorare i test durante la creazione del connettore, esegui mvn package -DskipTests anziché mvn package.

  4. Copia il file ZIP del connettore nella directory di installazione locale:

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

Passaggio 2: Crea il file di configurazione del connettore SharePoint On-Prem

  1. Nella stessa directory dell'installazione del connettore, crea un file. Google consiglia di denominare il file connector-config.properties in modo che non siano necessari parametri della riga di comando aggiuntivi per eseguire il connettore. Se prevedi di eseguire molte istanze del connettore, aggiungi dettagli al nome per distinguerle.

  2. Aggiungi i parametri come coppie chiave/valore ai contenuti del file, come nell'esempio seguente:

    ### Sharepoint On-Prem Connector configuration ###

# Required parameters for data source access
api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

# Required parameters for SharePoint on-premises access
sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
sharepoint.siteCollectionOnly=true
sharepoint.username=contoso\\admin
sharepoint.password=pa$sw0rd
sharepoint.stripDomainInUserPrincipals=true

# Required parameters for AD lookup
adLookup.host=dc.contoso.com
adLookup.username=contoso\\admin
adLookup.password=pa$sw0rd
api.referenceIdentitySources=CONTOSO,contoso
api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa

# Optional parameters for schema mapping
contentTemplate.sharepointItem.title=Title
contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

    Per descrizioni dettagliate di ciascun parametro, consulta il riferimento ai parametri di configurazione.

  3. (Facoltativo) Configura parametri aggiuntivi del connettore, se necessario. Per maggiori dettagli, vai a Parametri del connettore forniti da Google.

Passaggio 3: Per HTTPS, aggiungi SharePoint come host attendibile

Se SharePoint è configurato per l'utilizzo di HTTPS, ottieni un certificato SharePoint per aggiungerlo come host attendibile per il connettore.

  1. Sul computer che eseguirà il connettore, apri un browser e vai a SharePoint.

  2. Nella pagina di avviso che si apre, fai clic su Comprendo i rischi e Aggiungi eccezione. La pagina mostra un messaggio come "Questa connessione non è attendibile" perché il certificato è autofirmato e non firmato da un'autorità di certificazione attendibile.

  3. Quando il pulsante Visualizza è disponibile, fai clic.

  4. Vai alla scheda Dettagli e fai clic su Esporta.

  5. Salva il certificato nella directory del connettore con il nome sharepoint.crt.

  6. Fai clic su Chiudi e poi su Annulla per chiudere le finestre.

  7. Apri un prompt dei comandi e inserisci il comando seguente:

    $ keytool -importcert -keystore cacerts.jks -storepass changeit -file sharepoint.crt -alias sharepoint

    Quando ti viene chiesto "Consideri attendibile questo certificato?", rispondi sì.

Passaggio 4: Configura il logging

  1. Nella directory contenente il file binario del connettore, crea una cartella denominata logs.

  2. Nella stessa directory (non logs), crea un file con codifica Latin1 denominato logging.properties.

  3. Aggiungi il seguente testo a logging.properties:

    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

Passaggio 5: Configurare il connettore di identità SharePoint on-prem

Questo passaggio è necessario per applicare gli elenchi di controllo degli accessi basati sull'identità di SharePoint On-Prem ai risultati di ricerca. Se hai configurato il connettore con ACL pubblici, puoi saltare questo passaggio.

  1. Nella stessa directory dell'installazione del connettore SharePoint Online, crea un file e chiamalo sharepoint-onprem-identity-connector.config.

  2. Aggiungi i parametri come coppie chiave/valore ai contenuti del file, come nell'esempio seguente:

    ### SharePoint On-prem identity connector configuration ###

# Required parameters for data source access
api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

# Required parameters for SharePoint access
sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
sharepoint.siteCollectionOnly=true
sharepoint.username=contoso\\admin
sharepoint.password=pa$sw0rd
sharepoint.stripDomainInUserPrincipals=true

# Required parameters for AD lookup
adLookup.host=dc.contoso.com
adLookup.username=contoso\\admin
adLookup.password=pa$sw0rd
api.referenceIdentitySources=CONTOSO,contoso
api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa

    I valori sono quasi gli stessi del connettore SharePoint On-Prem, tranne che al posto di api.sourceId il parametro è api.customerId. Il valore di api.customerId è l'ID cliente che hai ricevuto dall'amministratore di Google Workspace.

Passaggio 6: Avvia il connettore SharePoint on-prem

Nei passaggi successivi, mappa le entità sia in Active Directory on-premise sia nella raccolta di siti SharePoint alle identità nel servizio Cloud Identity. Questa sincronizzazione viene eseguita con Google Cloud Directory Sync (GCDS) e il connettore di identità SharePoint on-premise.

Dopo che GCDS sincronizza utenti e gruppi, per sincronizzare i gruppi della raccolta di siti SharePoint, esegui il connettore di identità SharePoint On-Prem. Infine, esegui il connettore SharePoint on-premise per indicizzare e fornire i risultati agli utenti di Cloud Search.

  1. Se non l'hai ancora fatto, configura ed esegui GCDS. Assicurati di attivare i gruppi con mappatura delle identità.

  2. Esegui il connettore di identità SharePoint on-premise:

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

  3. Esegui il connettore SharePoint on-prem. Utilizza la sintassi del comando per la sicurezza del tuo sito SharePoint:

    • HTTP (non è richiesto alcun host attendibile):

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

    • HTTPS (aggiungi SharePoint come host attendibile):

      $ java -Djavax.net.ssl.trustStore=cacerts.jks -Djavax.net.ssl.trustStoreType=jks -Djavax.net.ssl.trustStorePassword=changeit -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar

Riferimento ai parametri di configurazione

Accesso a origine dati

Impostazione Parametro
ID origine dati api.sourceId=1234567890abcdef

Obbligatorio. L'ID origine dati di Google Cloud Search configurato dall'amministratore di Google Workspace.
Percorso del file della chiave privata del service account api.serviceAccountPrivateKeyFile=PrivateKey.json

Obbligatorio. Il percorso del file della chiave del service account Google Cloud Search.

Accesso on-premise a SharePoint

Impostazione Parametro
URL del server SharePoint sharepoint.server=http://yoursharepoint.example.com/

Obbligatorio. L'URL del server SharePoint come nome host completo, ad esempio http://yoursharepoint.example.com/. Se il nome host non è completo, devi impostare l'override DNS sull'host del connettore.
Nome utente SharePoint sharepoint.username=YOURDOMAIN\\ConnectorUser

Obbligatorio quando esegui il connettore su Linux o su un computer Windows che non fa parte del dominio AD di SharePoint Server.
Password di SharePoint sharepoint.password=user_password

Obbligatorio quando esegui il connettore su Linux o su un computer Windows che non fa parte del dominio AD di SharePoint Server.
Utilizzare l'autenticazione live per connettersi a SharePoint sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE
Utilizzare l'autenticazione ADFS per connettersi a SharePoint sharepoint.username=AdaptorUser@yourdomain.com

sharepoint.password=uS3R_passWoRD

sharepoint.sts.endpoint=https://adfs.example.com/adfs/services/trust/2005/usernamemixed

sharepoint.sts.realm=urn:myserver:sharepoint o https://yoursharepoint.example.com/_trust

sharepoint.formsAuthenticationMode=ADFS

Indicizzazione della raccolta siti

Impostazione Parametro
Tipo di indice sharepoint.siteCollectionOnly=boolean

Facoltativo, tranne per le implementazioni SharePoint multi-tenant (scopri di più). Imposta su true per fare in modo che l'indice del connettore sharepoint.server venga considerato una raccolta siti anziché un server virtuale. Il valore predefinito è null (rilevamento automatico).

Mappatura delle identità di SharePoint

Impostazione Parametro
ID origine identità api.identitySourceId=1234567890abcdef

Obbligatorio. ID origine identità per la sincronizzazione dei gruppi locali di SharePoint.L'ID origine di Google Cloud Search configurato dall'amministratore di Google Workspace, come descritto in Aggiungere un'origine dati per la ricerca.
Origini identità di riferimento api.referenceIdentitySources=CONTOSO,contoso

Un elenco delimitato da virgole di origini identità di riferimento per le entità di Active Directory. Il valore corrisponde al nome NetBIOS di Active Directory delle entità di Active Directory di riferimento.
ID origine identità di riferimento api.referenceIdentitySource.DOMAIN.id=identity-source-id

Obbligatorio. L'ID origine identità per la sincronizzazione delle entità di Active Directory.

Ricerca Active Directory

Impostazione Parametro
Host Active Directory adLookup.host=host

Obbligatorio. Nome host Active Directory, ad esempio dc.contoso.com, o indirizzo IP.
Porta di ricerca di Active Directory adLookup.port=port

(Facoltativo) Il valore predefinito è 389. Utilizza 686 per SSL.
Metodo di ricerca di Active Directory adLookup.method=value

(Facoltativo) Il valore predefinito è "standard". Per le connessioni HTTPS, impostalo su "ssl".
Utente di ricerca Active Directory adLookup.username=CONTOSO\user1

Obbligatorio. Utente autorizzato a eseguire ricerche in Active Directory.
Password di ricerca di Active Directory adLookup.password=password123

Obbligatorio. Password per l'utente specificato da adLookup.user.

Generazione di contenuti HTML

Impostazione Parametro
Campo del titolo del modello HTML contentTemplate.sharePointItem.title=Title

Il campo SharePoint da utilizzare come titolo del modello HTML per l'HTML generato.
Campi di alta qualità della ricerca dei contenuti HTML contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Un elenco separato da virgole dei campi da includere nell'HTML generato come campi di alta qualità. Quando i termini della query di ricerca corrispondono a questi campi, i risultati vengono classificati in una posizione più alta.
Campi di qualità della ricerca media dei contenuti HTML contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Un elenco separato da virgole dei campi da includere nell'HTML generato come campi di media qualità.
Campi di bassa qualità della ricerca dei contenuti HTML contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Un elenco separato da virgole dei campi da includere nell'HTML generato come campi di bassa qualità.
Colonne non mappate dei contenuti HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Come il connettore gestisce le colonne non mappate. Il valore è APPEND (aggiungi, predefinito) o IGNORE (ignora).

  • APPEND: il connettore genera contenuti HTML con tutti i campi, inclusi quelli per cui non è impostato un livello qualitativo (alto, medio o basso).
  • IGNORE: il connettore genera contenuti HTML solo con i campi mappati.