Deployment del connettore Microsoft SharePoint Online

Puoi configurare Google Cloud Search in modo che restituisca i risultati dei contenuti di SharePoint Online della tua organizzazione, oltre a quelli di Google Workspace. Puoi utilizzare il connettore SharePoint Online di Google Cloud Search e configurarlo per accedere a un'origine dati SharePoint Online specifica.

Considerazioni importanti

Impostazioni di SharePoint rispettate

Il connettore Cloud Search per SharePoint Online rispetta sempre l'impostazione Visibilità ricerca in SharePoint, che non può essere sostituita. Per i documenti di bozza, le autorizzazioni dell'account utente (utilizzate dal connettore per accedere a SharePoint Online) controllano quali documenti di bozza vengono indicizzati e restituiti. Se l'account dispone solo delle autorizzazioni "Lettura completa", il connettore rispetta le impostazioni "Visibilità degli elementi di bozza" su SharePoint.

Inoltre, puoi configurare il connettore per limitare i risultati in base all'accesso all'account utente. Per applicare il taglio per la sicurezza ai contenuti di SharePoint, sincronizza le seguenti identità esterne con la directory Google:

  • Utenti di Office 365 / Azure AD
  • Gruppi di sicurezza di Office 365 / Azure AD
  • Gruppi di SharePoint (con utenti e gruppi di Office 365 come membri)

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 di 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. Ad esempio, il tipo di contenuto "Annunci" corrisponde alla definizione dell'oggetto "Annunci". Il tipo di contenuto "Articolo di notizie" viene mappato a "NewsArticle" (senza spazi).

  • 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.

  • Il connettore mappa i nomi delle proprietà di SharePoint alle relative definizioni.

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

Limitazioni note dei connettori

  • Ogni istanza del connettore può indicizzare i contenuti di una sola raccolta siti. Per indicizzare più raccolte di siti, configura istanze aggiuntive del connettore.
  • Il consumo di memoria aumenta con il numero di utenti e gruppi univoci che utilizzi nelle ACL per ogni raccolta di siti.
  • Le notifiche di eliminazione non sono istantanee e possono essere necessarie più di 4 ore prima che un connettore riconosca che un utente ha eliminato dei 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)
Autenticazione
  • Autenticazione in tempo reale
Software
  • Ambiente SharePoint Online
  • Java JRE 1.8 installato sul computer su cui verrà eseguito il connettore SharePoint Online di Google Cloud Search

Esegui il deployment del connettore

Prerequisiti

  1. Crea una chiave privata Google Workspace contenente l'ID account di servizio. Per scoprire come ottenere una chiave privata, vai a Configurare l'accesso all'API Google Cloud Search.

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

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

    • uno per gli utenti e i gruppi di Office 365
    • uno per i gruppi di SharePoint

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

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

  4. Configura un account utente per il connettore con i privilegi di amministratore della raccolta di siti SharePoint Online.

  5. Se il connettore restituisce risultati in base alle ACL (i risultati non sono pubblici), crea le credenziali per leggere gli utenti e i gruppi dal tuo account Office 365. Segui le istruzioni di Microsoft per creare un'applicazione Azure Active Directory. Durante la configurazione dell'app:

    1. Assegna all'app un nome descrittivo, ad esempio "gcs-o365-identity-connector".
    2. Aggiungi le autorizzazioni. L'app ha bisogno di "Group.Read.All" e "User.Read.All".
    3. Registra le seguenti informazioni da utilizzare nella configurazione del connettore:
      • ID applicazione
      • Tenant
      • Client secret

Passaggio 1: Installa il software del connettore SharePoint Online

  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 del connettore che ti interessa:

    $ git checkout tags/v1-0.0.3
  3. Crea il connettore.

    $ mvn package

    Per saltare 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-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

Passaggio 2: Crea il file di configurazione del connettore SharePoint Online

  1. Nella stessa directory dell'installazione del connettore, crea un nuovo file e assegnagli il nome sharepoint-online-connector.config. Se prevedi di eseguire molte istanze del connettore, aggiungi ulteriori dettagli al nome per distinguerlo.

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

    ### 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
    

    Per descrizioni dettagliate di ciascun parametro, consulta le informazioni di riferimento sui 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: Configurare il logging per il connettore SharePoint Online

  1. Crea una cartella denominata logs nella stessa directory contenente il file binario del connettore.

  2. Crea un file con codifica Latin-1 denominato logging.properties nella stessa directory e aggiungi il seguente contenuto:

    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 4: Configurare il connettore di identità di SharePoint Online

Questo passaggio è necessario per applicare le ACL basate sull'identità di SharePoint Online ai risultati di ricerca. Se configuri il connettore con ACL pubblici, puoi saltare questo passaggio.

  1. Nella stessa directory dell'installazione del connettore SharePoint Online, crea un nuovo file e assegnagli il nome sharepoint-online-identity-connector.config.

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

    ### 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
    

    I valori sono quasi gli stessi del connettore SharePoint Online, tranne per il fatto che, anziché api.sourceId, il parametro è api.customerId. Il valore di api.customerId è l'ID cliente che hai ricevuto dall'amministratore di Google Workspace.

Passaggio 5: Installare il connettore di identità di Office 365

Questo passaggio è necessario per applicare le ACL basate sulle identità di SharePoint Online ai risultati di ricerca. Se configuri il connettore con ACL pubblici, puoi saltare questo passaggio.

  1. Clona il repository del connettore da GitHub.

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector
  2. Controlla la versione del connettore che ti interessa:

    $ git checkout tags/v1-0.0.3
  3. Crea il connettore.

    $ mvn package

    Per saltare 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-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

Passaggio 6: Configura il connettore di identità di Office 365 e imposta la registrazione

  1. Nella stessa directory dell'installazione del connettore di identità, crea un nuovo file e assegnagli il nome o365-identity-connector.config.

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

    ### Office 365 Identity connector configuration ###
    api.identitySourceId=12345abcde api.customerId=abcde12345 o365.clientId=a63c6eb3-29e7-486 o365.tenant=185ef9ed-29e7-486 o365.clientSecret=raHJN15vRLBKs

    Per descrizioni dettagliate di ciascun parametro, consulta le informazioni di riferimento sulla configurazione del connettore di identità di Office 365.

  3. Crea una cartella denominata logs nella stessa directory contenente il file binario del connettore.

  4. Crea un file ASCII o UTF-8 denominato logging.properties nella stessa directory e aggiungi il seguente contenuto:

    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
    

Passaggio 7: Avvia il connettore SharePoint Online

Nei passaggi seguenti, mapperai le entità in Office 365 e nella raccolta di siti SharePoint alle identità nel servizio Cloud Identity. Questa sincronizzazione viene eseguita con il connettore di identità di Office 365 e il connettore di identità di SharePoint Online.

Dopo che il connettore di Office 365 ha sincronizzato gli utenti e i gruppi, esegui il connettore delle identità di SharePoint Online per sincronizzare i gruppi di raccolte di siti di SharePoint. Quindi esegui il connettore SharePoint Online per indicizzare e pubblicare i risultati per gli utenti di Cloud Search.

  1. Esegui il connettore di identità di 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
  2. Esegui il connettore di identità di 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
  3. Esegui il connettore 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

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 dell'account di servizio api.serviceAccountPrivateKeyFile=PrivateKey.json

Obbligatorio. Il percorso del file della chiave dell'account di servizio Google Cloud Search.

Accesso a SharePoint Online

Impostazione Parametro
Nome di dominio completo per la raccolta siti di SharePoint sharepoint.server=http://yoursharepoint.example.com/

Obbligatorio. Se il nome di dominio non è completo, imposta l'override DNS sull'host del connettore.

Modalità Solo raccolta siti sharepoint.siteCollectionOnly=true

Obbligatorio. Per SharePoint Online, imposta il valore true.

Nome utente di SharePoint sharepoint.username=username

Obbligatorio. Il nome utente dell'account utilizzato per accedere a SharePoint Online.

Password di SharePoint sharepoint.password=user_password

Obbligatorio. La password dell'account utilizzato per accedere a SharePoint Online.

Modalità di autenticazione sharepoint.formsAuthenticationMode=LIVE

Obbligatorio. Per SharePoint Online, il valore è sempre "LIVE".

Tipo di deployment sharepoint.deploymentType=ONLINE

Obbligatorio. Per SharePoint Online, il valore è sempre "ONLINE".

Mappatura delle identità di SharePoint

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

Obbligatorio. L'ID origine identità Cloud Search per l'origine identità dei gruppi di SharePoint.

Origini identità di riferimento api.referenceIdentitySources=defaultIdentitySource

Obbligatorio. Per SharePoint Online, il valore è sempre "defaultIdentitySource".

ID origine identità di riferimento api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Obbligatorio. L'ID origine identità di Cloud Search per l'origine identità Utenti e gruppi di Office 365.

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 per la qualità di ricerca elevata dei contenuti HTML contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Un elenco separato da virgole di campi da includere nel codice HTML generato come campi di alta qualità. Quando i termini della query di ricerca corrispondono a questi campi, i risultati hanno un ranking più elevato.

Campi della qualità della ricerca per contenuti HTML di media dimensione contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Un elenco separato da virgole di campi da includere nel codice HTML generato come campi di media qualità.

Campi della qualità di ricerca bassa dei contenuti HTML contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Un elenco di campi separati da virgole da includere nel codice 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 (predefinito) o IGNORE.

  • APPEND: il connettore genera contenuti HTML con tutti i campi, inclusi quelli non impostati con un livello di qualità (alto, medio o basso).
  • IGNORE: il connettore genera contenuti HTML con solo i campi mappati.

Configurazione del connettore di identità di Office 365

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

Obbligatorio. L'ID origine identità di Office 365. Questo valore deve corrispondere al valore di "api.referenceIdentitySource.defaultIdentitySource.id" nella configurazione del connettore SharePoint Online.

ID cliente Google api.customerId=c1b1d1e1

Obbligatorio. L'ID cliente Google Workspace della tua organizzazione.

ID applicazione Office 365 o365.clientId=a63c6eb3-29e7-486

Obbligatorio. L'ID applicazione dalla configurazione dell'applicazione Office 365.

Tenant di Office 365 o365.tenant=185ef9ed-29e7-486

Obbligatorio. Il tenant per il tuo account Office 365 (la tua app Azure Activity Directory)

Client secret di Office 365 o365.clientSecret=raHJN15vRLBKs

Obbligatorio. Secret delle credenziali dalla configurazione dell'applicazione Office 365