Microsoft SharePoint Online-Connector bereitstellen

Sie können Google Cloud Search so einrichten, dass zusätzlich zu den Google Workspace-Inhalten auch Ergebnisse aus den SharePoint Online-Inhalten Ihrer Organisation zurückgegeben werden. Verwenden Sie den SharePoint Online-Connector für Cloud Search und konfigurieren Sie ihn für den Zugriff auf eine bestimmte SharePoint Online-Datenquelle.

Wichtige Hinweise

Beachten Sie vor der Bereitstellung des SharePoint Online-Connectors die folgenden Hinweise.

Berücksichtigte SharePoint-Einstellungen

Der Connector berücksichtigt immer die SharePoint-Einstellung Suchbarkeit. Bei Entwürfen wird über die Berechtigungen für das Nutzerkonto, mit dem der Connector auf SharePoint Online zugreift, gesteuert, welche Dokumente indexiert und zurückgegeben werden. Wenn das Konto nur eine Leseberechtigung hat („Alles lesen“), werden alle SharePoint-Einstellungen unter „Entwurfselementsicherheit“ beibehalten.

Sie können den Connector auch so konfigurieren, dass die Ergebnisse basierend auf dem Zugriff des Nutzerkontos eingeschränkt werden. Wenn Sie das Sicherheits-Trimming anwenden möchten, synchronisieren Sie diese externen Identitäten mit dem Google Cloud-Verzeichnis:

  • Office 365-/Azure AD-Nutzer
  • Office 365-/Azure AD-Sicherheitsgruppen
  • SharePoint-Gruppen (mit Office 365-Nutzern und ‑Gruppen als Mitglieder)

Suchmaschinenoptimierung

Sie können die Suchfunktionen verbessern, indem Sie den Connector so konfigurieren, dass relevante Ergebnisse zurückgegeben werden. Verwenden Sie in der Konfigurationsdatei Parameter zur HTML-Generierung, um die Auswirkungen der Felder festzulegen.

Informationen zum Einrichten eines Schemas finden Sie unter Schema erstellen und registrieren. Beachten Sie beim Einrichten Folgendes:

  • Der Connector normalisiert SharePoint-Inhaltstypen zu gültigen Objektdefinitionen (A–Z, a–z, 0–9). Beispiel: „News Article“ wird zu „NewsArticle“.
  • Wenn der Connector keine Objektdefinition zuordnen kann, verwendet er den Fallback Objekttyp (itemMetadata.objectType). Siehe Konfigurationsparameter für Metadaten.
  • Der Connector ordnet die Namen von SharePoint-Attributen entsprechenden Attributdefinitionen zu.
  • Der Connector überschreibt den Medientyp für Microsoft Outlook-Dateien im Format .msg und indexiert sie als application/vnd.ms-outlook.

Bekannte Einschränkungen des Connectors

  • Eine Connectorinstanz indexiert jeweils nur Inhalte aus einer einzelnen Websitesammlung. Wenn Sie mehrere Websitesammlungen indexieren möchten, richten Sie zusätzliche Instanzen ein.
  • Der Speicherverbrauch erhöht sich mit der Anzahl der einzelnen Nutzer und Gruppen in ACLs.
  • Es kann mehr als vier Stunden dauern, bis Löschbenachrichtigungen weitergegeben werden.

Systemanforderungen

Systemanforderungen
Betriebssystem Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 oder SUSE Enterprise Linux 10 (64 Bit).
Authentifizierung Live-Authentifizierung.
Software SharePoint Online-Umgebung; Java JRE 1.8.

Connector bereitstellen

Führen Sie die folgenden Schritte aus, um den SharePoint Online-Connector bereitzustellen.

Vorbereitung

  1. Erstellen Sie einen privaten Google Workspace-Schlüssel. Weitere Informationen finden Sie unter Zugriff auf die Cloud Search API konfigurieren.
  2. Fügen Sie eine Datenquelle für die Suche hinzu und notieren Sie die ID. Weitere Informationen finden Sie unter Datenquelle für die Suche hinzufügen.
  3. Für ACL-basierte Ergebnisse muss Ihr Administrator zwei Identitätsquellen erstellen (eine für Office 365 und eine für SharePoint-Gruppen) und die Google Workspace-Kundennummer angeben. Weitere Informationen finden Sie unter Nutzeridentitäten zuordnen.
  4. Richten Sie ein Nutzerkonto für den Connector ein, der die Administratorberechtigungen für die SharePoint Online-Websitesammlung hat.
  5. Erstellen Sie Anmeldedaten für die Azure Active Directory-Anwendung mit den Berechtigungen Group.Read.All und User.Read.All. Notieren Sie sich die Anwendungs-ID, den Mandanten und den Clientschlüssel.

Schritt 1: Connector-Software installieren

  1. Klonen Sie das Repository:
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. Checken Sie die ausgewählte Version aus (z.B. v1-0.0.3):
    $ git checkout tags/v1-0.0.3
  3. Erstellen Sie den Connector:
    $ mvn package
    Wenn Sie Tests überspringen möchten, verwenden Sie mvn package -DskipTests.
  4. Extrahieren Sie die ZIP-Datei in Ihr Installationsverzeichnis.

Schritt 2: Konfigurationsdatei erstellen

Erstellen Sie im Installationsverzeichnis die Datei sharepoint-online-connector.config. Fügen Sie Parameter als Schlüssel/Wert-Paare hinzu, wie im folgenden Beispiel gezeigt:

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

Weitere Informationen finden Sie in der Referenz oder unter Von Google bereitgestellte Parameter.

Schritt 3: Logging einrichten

Erstellen Sie einen Ordner logs und eine Datei logging.properties mit diesem Inhalt:

   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

Schritt 4: SharePoint-Identitätsconnector konfigurieren

Wenn Sie identitätsbasierte ACLs anwenden möchten, erstellen Sie sharepoint-online-identity-connector.config mit Ihrer api.customerId und anderen Verbindungsparametern, wie im folgenden Beispiel gezeigt:

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

Schritt 5: Office 365-Identitätsconnector installieren

Führen Sie diesen Schritt aus, wenn Sie identitätsbasierte SharePoint Online-ACLs verwenden. Wenn Sie öffentliche ACLs verwenden, überspringen Sie diesen Schritt.

  1. Klonen Sie das Office 365-Repository:

    $ git clone https://github.com/google-cloudsearch/office-365-connector.git
    $ cd office-365-connector
    
  2. Checken Sie den Connector aus und erstellen Sie ihn mit mvn package.

  3. Extrahieren Sie die ZIP-Datei in Ihr Installationsverzeichnis.

Schritt 6: Office 365-Identitätsconnector konfigurieren

  1. Erstellen Sie im selben Verzeichnis wie die Connector-Installation eine Datei namens o365-identity-connector.config und fügen Sie Parameter als Schlüssel/Wert-Paare hinzu:

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

    Beschreibungen der Parameter finden Sie unter Office 365-Identitätsconnector.

  2. Erstellen Sie im selben Verzeichnis einen Ordner namens logs.

  3. Erstellen Sie im selben Verzeichnis eine Datei namens logging.properties mit diesem Inhalt:

       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
    

Schritt 7: Connector starten

Nachdem Sie die Connectors konfiguriert haben, führen Sie sie aus, um die Synchronisierung und Indexierung zu starten. Führen Sie jeden Befehl in einem eigenen Terminalfenster aus.

  1. Führen Sie den Office 365-Identitätsconnector aus, um Nutzer und Gruppen zu synchronisieren:

    $ 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. Führen Sie den SharePoint Online-Identitätsconnector aus, um die Gruppen der Websitesammlung zu synchronisieren:

    $ 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. Führen Sie den SharePoint Online-Connector aus, um Inhalte zu indexieren:

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

Konfigurationsparameter

In den folgenden Abschnitten sind die Konfigurationsparameter aufgeführt, die zum Konfigurieren des SharePoint Online-Connectors verwendet werden.

Zugriff auf Datenquellen

Einstellung Parameter
ID der Datenquelle api.sourceId=1234567890abcdef

Erforderlich. Die ID der Google Cloud Search-Datenquelle, die vom Google Workspace-Administrator eingerichtet wurde.

Pfad zur privaten Schlüsseldatei des Dienstkontos api.serviceAccountPrivateKeyFile=PrivateKey.json

Erforderlich. Der Pfad zur Schlüsseldatei des Google Cloud Search-Dienstkontos.

SharePoint-Onlinezugriff

Einstellung Parameter
Voll qualifizierter Domainname der SharePoint-Websitesammlung sharepoint.server=http://yoursharepoint.example.com/

Erforderlich. Wenn der Domainname nicht voll qualifiziert ist, aktivieren Sie die DNS-Überschreibung auf dem Connectorhost.

Modus „Nur Websitesammlung“ sharepoint.siteCollectionOnly=true

Erforderlich. Legen Sie für SharePoint Online den Wert true fest.

SharePoint-Nutzername sharepoint.username=username

Erforderlich. Der Nutzername für das Konto, das für den Zugriff auf SharePoint Online verwendet wird.

SharePoint-Passwort sharepoint.password=user_password

Erforderlich. Das Passwort für das Konto, das für den Zugriff auf SharePoint Online verwendet wird.

Authentifizierungsmodus sharepoint.formsAuthenticationMode=LIVE

Erforderlich. Für SharePoint Online lautet der Wert immer `LIVE`.

Bereitstellungstyp sharepoint.deploymentType=ONLINE

Erforderlich. Für SharePoint Online lautet der Wert immer `ONLINE`.

SharePoint-Identitätszuordnung

Einstellung Parameter
ID der Identitätsquelle api.identitySourceId=1234567890abcdef

Erforderlich. Die ID der Cloud Search-Identitätsquelle für die Identitätsquelle der SharePoint-Gruppen.

Verwendete Identitätsquellen api.referenceIdentitySources=defaultIdentitySource

Erforderlich. Für SharePoint Online lautet der Wert immer `defaultIdentitySource`.

IDs der verwendeten Identitätsquellen api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Erforderlich. Die ID der Cloud Search-Identitätsquelle für die Identitätsquelle der Office 365-Nutzer und ‑Gruppen.

HTML-Inhalt generieren

Einstellung Parameter
Titelfeld für HTML-Vorlage contentTemplate.sharePointItem.title=Title

Das SharePoint-Feld, das als Titel der HTML-Vorlage für den generierten HTML-Inhalt verwendet werden soll.

Felder, die im HTML-Inhalt eine hohe Suchqualität haben sollen contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Eine durch Kommas getrennte Liste der Felder, die im generierten HTML-Inhalt als Felder mit hoher Suchqualität enthalten sein sollen. Wenn die Suchbegriffe mit diesen Feldern übereinstimmen, werden die Ergebnisse höher eingestuft.

Felder, die im HTML-Inhalt eine mittlere Suchqualität haben sollen contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Eine durch Kommas getrennte Liste der Felder, die im generierten HTML-Inhalt als Felder mit mittlerer Suchqualität enthalten sein sollen.

Felder, die im HTML-Inhalt eine niedrige Suchqualität haben sollen contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Eine durch Kommas getrennte Liste der Felder, die im generierten HTML-Inhalt als Felder mit niedriger Suchqualität enthalten sein sollen.

Nicht zugeordnete Spalten im HTML-Inhalt contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Vorgehensweise des Connectors bei der Verarbeitung nicht zugeordneter Spalten. Mögliche Werte sind APPEND (Standardeinstellung) oder IGNORE.

  • APPEND: Der Connector generiert HTML-Inhalte mit allen Feldern, einschließlich derjenigen, für die keine bestimmte Suchqualität (hoch, mittel, niedrig) konfiguriert wurde.
  • IGNORE: Der Connector generiert HTML-Inhalte nur mit den zugeordneten Feldern.

Konfiguration des Office 365-Identitätsconnectors

Einstellung Parameter
ID der Identitätsquelle api.identitySourceId=1234567890abcdef

Erforderlich. Die ID der Office 365-Identitätsquelle. Dieser Wert sollte mit dem Wert von `api.referenceIdentitySource.defaultIdentitySource.id` in der Konfiguration des SharePoint Online-Connectors übereinstimmen.

Google-Kundennummer api.customerId=c1b1d1e1

Erforderlich. Die Google Workspace-Kundennummer Ihrer Organisation.

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

Erforderlich. Die Anwendungs-ID aus der Office 365-Anwendungseinrichtung.

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

Erforderlich. Der Mandant für Ihr Office 365-Konto (Ihre Azure Activity Directory App)

Office 365-Clientschlüssel o365.clientSecret=raHJN15vRLBKs

Erforderlich. Anmeldedatenschlüssel aus der Einrichtung der Office 365-Anwendung