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 ai contenuti di Google Workspace. Utilizza il connettore Cloud Search SharePoint Online e configurarlo per accedere a un'origine dati di SharePoint Online specifica.

Considerazioni importanti

Prima di eseguire il deployment del connettore SharePoint Online, tieni presente le seguenti considerazioni.

Impostazioni di SharePoint rispettate

Il connettore rispetta sempre l'impostazione Visibilità della ricerca su SharePoint. Per i documenti in bozza, le autorizzazioni sull'account utente utilizzato dal connettore per accedere a SharePoint Online controllano quali documenti in bozza vengono indicizzati e restituiti. Se l'account dispone solo delle autorizzazioni "Lettura completa", il connettore rispetta le impostazioni di "Visibilità dell'elemento in bozza".

Puoi anche configurare il connettore in modo da limitare i risultati in base all'accesso all'account utente. Per applicare il troncamento della sicurezza, sincronizza queste identità esterne con la directory Google Cloud:

  • 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

Migliora l'esperienza di ricerca configurando il connettore in modo che restituisca risultati pertinenti. Utilizza i parametri di generazione HTML nel file di configurazione per impostare i livelli di impatto dei campi.

Per configurare uno schema, vedi Creare e registrare uno schema. Quando configuri uno schema:

  • Il connettore normalizza i tipi di contenuti di SharePoint in nomi di definizione di oggetti validi (A-Z, a-z, 0-9). Ad esempio, "Articolo di notizie" diventa "NewsArticle".
  • Se il connettore non riesce a trovare una definizione di oggetto, utilizza il tipo di oggetto di riserva (itemMetadata.objectType). Vedi Parametri di configurazione dei metadati.
  • Il connettore mappa i nomi delle proprietà di SharePoint alle definizioni delle proprietà.
  • Il connettore esegue l'override del tipo di contenuti per i file .msg di Microsoft Outlook e li indicizza come application/vnd.ms-outlook.

Limitazioni note del connettore

  • Ogni istanza del connettore indicizza i contenuti di una sola raccolta siti. Per indicizzare più raccolte siti, configura istanze aggiuntive.
  • Il consumo di memoria aumenta con il numero di utenti e gruppi unici negli ACL.
  • La propagazione delle notifiche di eliminazione può richiedere più di 4 ore.

Requisiti di sistema

Requisiti di sistema
Sistema operativo Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 o SUSE Enterprise Linux 10 (64 bit).
Autenticazione Autenticazione in tempo reale.
Software Ambiente SharePoint Online; Java JRE 1.8.

Eseguire il deployment del connettore

Segui questi passaggi per eseguire il deployment del connettore SharePoint Online.

Prerequisiti

  1. Crea una chiave privata di Google Workspace. Vedi Configurare l'accesso all'API Cloud Search.
  2. Aggiungi un'origine dati per la ricerca e annota il relativo ID. Vedi Aggiungere un'origine dati per la ricerca.
  3. Per i risultati basati su ACL, l'amministratore deve creare due origini identità (una per Office 365 e una per i gruppi di SharePoint) e fornire l'ID cliente di Google Workspace. Vedi Mappare le identità degli utenti.
  4. Configura un account utente per il connettore con privilegi di amministratore della raccolta siti di SharePoint Online.
  5. Crea le credenziali dell'applicazione Azure Active Directory con le autorizzazioni Group.Read.All e User.Read.All. Prendi nota dell'ID applicazione, del tenant e del client secret.

Passaggio 1. Installa il software del connettore

  1. Clona il repository:
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. Estrai la versione selezionata (ad es. v1-0.0.3):
    $ git checkout tags/v1-0.0.3
  3. Crea il connettore:
    $ mvn package
    Per saltare i test, utilizza mvn package -DskipTests.
  4. Estrai il file ZIP nella directory di installazione.

Passaggio 2. Crea il file di configurazione

Crea sharepoint-online-connector.config nella directory di installazione. Aggiungi i parametri come coppie chiave-valore, come mostrato nell'esempio seguente:

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
sharepoint.server=https://mydomain.onmicrosoft.com
sharepoint.siteCollectionOnly=true
sharepoint.username=admin@mydomain.onmicrosoft.com
sharepoint.password=password
sharepoint.formsAuthenticationMode=LIVE
sharepoint.deploymentType=ONLINE
api.identitySourceId=08ef8becd116faa475de26d9b291fed9
api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Per maggiori dettagli, consulta il riferimento o i parametri forniti da Google.

Passaggio 3. Configura il logging

Crea una cartella logs e un file logging.properties con questi contenuti:

   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. Configura il connettore di identità di SharePoint

Per applicare gli ACL basati sull'identità, crea sharepoint-online-identity-connector.config con api.customerId e altri parametri di connessione, come nell'esempio seguente:

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

Passaggio 5. Installa il connettore di identità di Office 365

Se utilizzi gli ACL basati sull'identità di SharePoint Online, esegui questo passaggio. Se utilizzi gli ACL pubblici, salta questo passaggio.

  1. Clona il repository di Office 365:

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector
    
  2. Estrai e crea il connettore utilizzando mvn package.

  3. Estrai il file ZIP nella directory di installazione.

Passaggio 6. Configura il connettore di identità di Office 365

  1. Nella stessa directory dell'installazione del connettore di identità, crea un file denominato o365-identity-connector.config e aggiungi i parametri come coppie chiave-valore:

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

    Per le descrizioni dei parametri, vedi Connettore di identità di Office 365.

  2. Nella stessa directory, crea una cartella denominata logs.

  3. Nella stessa directory, crea un file denominato logging.properties con questi contenuti:

       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

Dopo aver configurato i connettori, eseguili per avviare la sincronizzazione e l'indicizzazione. Esegui ogni comando nella relativa finestra del terminale.

  1. Esegui il connettore di identità di Office 365 per sincronizzare utenti e gruppi:

    $ 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 per sincronizzare i gruppi di raccolte siti:

    $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -Dconfig=sharepoint-online-identity-connector.config
    
  3. Esegui il connettore SharePoint Online per indicizzare i contenuti:

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

Riferimento per i parametri di configurazione

Le sezioni seguenti elencano i parametri di configurazione utilizzati per configurare il connettore SharePoint Online.

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 di 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à di 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à di utenti e gruppi di Office 365.

Generazione di contenuti HTML

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

Il campo di SharePoint da utilizzare come titolo del modello HTML per l'HTML generato.

Campi di contenuti HTML di alta qualità di ricerca contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Un elenco di campi separato da virgole 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 più in alto.

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

Un elenco di campi separato da virgole da includere nell'HTML generato come campi di media qualità.

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

Un elenco di campi separato da virgole 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 (impostazione predefinita) o IGNORE.

  • APPEND: il connettore genera contenuti HTML con tutti i campi, inclusi quelli non impostati con un livello qualitativo (alto, medio o basso).
  • IGNORE: il connettore genera contenuti HTML solo con 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 di Google Workspace della tua organizzazione.

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

Obbligatorio. L'ID applicazione della 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. Il secret delle credenziali della configurazione dell'applicazione Office 365