Microsoft SharePoint Online-Connector bereitstellen

Dieser Leitfaden richtet sich an Administratoren, die mit dem SharePoint Online-Connector für Google Cloud Search arbeiten und für das Herunterladen, Konfigurieren, Ausführen und Überwachen des Connectors verantwortlich sind.

Sie finden hier Anleitungen für wichtige Aufgaben im Zusammenhang mit dem Deployment des SharePoint Online-Connectors:

  • Den SharePoint Online-Connector für Google Cloud Search herunterladen
  • Den Connector für eine bestimmte SharePoint Online-Datenquelle konfigurieren
  • Connector bereitstellen und ausführen

Sie sollten mit den Grundlagen der G Suite und von SharePoint On-Premises vertraut sein.

Der SharePoint Online-Connector für Google Cloud Search

Standardmäßig können Sie mit Google Cloud Search in Anwendungen wie Google Docs und Gmail nach G Suite-Daten suchen und diese indexieren und bereitstellen. Mithilfe des SharePoint Online-Connectors lässt sich die Reichweite von Google Cloud Search auf SharePoint Online-Inhalte erweitern.

Datei mit Konfigurationseigenschaften

Damit über den Connector Inhalte in SharePoint Online ermittelt und in die API für die Indexierung hochgeladen werden können, müssen Sie eine Konfigurationsdatei erstellen und darin bestimmte Einstellungen für den Connector angeben. Eine Anleitung dafür finden Sie unter diesem Link.

Neben den Parametern des SharePoint Online-Connectors, die in diesem Artikel beschrieben werden, gibt es auch Konfigurationsparameter, die von allen Cloud Search-Connectors verwendet werden. Weitere Informationen zu den von Google bereitgestellten Connectorparametern

Unterstützte Betriebssysteme

Der SharePoint Online-Connector für Cloud Search unterstützt die folgenden Betriebssysteme:

  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64-Bit)

Unveröffentlichte Dokumente indexieren

Der SharePoint Online-Connector für Cloud Search berücksichtigt immer die SharePoint-Einstellung "Suchbarkeit", d. h., sie kann nicht überschrieben werden. Bei Dokumententwürfen hängt die Indexierung von den Berechtigungen ab, die dem Nutzerkonto des Connectors erteilt werden. Wenn der Nutzer nur eine Leseberechtigung hat ("Alles lesen"), werden alle SharePoint-Einstellungen unter "Entwurfselementsicherheit" beibehalten.

Unterstützte Authentifizierungsmethoden

Der SharePoint Online-Connector für Cloud Search unterstützt die Live-Authentifizierung.

Bekannte Einschränkungen des Connectors

  • Die Connectorinstanz kann nur Inhalte aus einer einzelnen Websitesammlung indexieren. Bei mehreren Websitesammlungen benötigen Sie für jede eine separate Connectorinstanz.
  • Die Zahl der eindeutigen Nutzer und Gruppen, die in Zugriffsteuerungslisten (Access Control Lists, ACLs) für die einzelnen Websitesammlungen verwendet werden, wirkt sich auf den Speicherverbrauch aus.
  • In der aktuellen Version des Connectors werden keine Sofortbenachrichtigungen zu Löschvorgängen generiert.
  • Der Connector erkennt Löschvorgänge aus dem Quell-Repository anhand der Neuindexierung von Inhalten. Bei zuvor indexierten Inhalten kann die Latenz für die Löscherkennung mehr als vier Stunden betragen.

Voraussetzungen

Der SharePoint Online-Connector für Google Cloud Search kann unter Linux oder Windows installiert werden. Für das Deployment benötigen Sie die folgenden erforderlichen Komponenten:

  • SharePoint Online-Umgebung.
  • Java JRE 1.8. Die Laufzeitumgebung muss auf einem Computer installiert sein, auf dem der SharePoint Online-Connector für Google Cloud Search ausgeführt wird.
  • Die folgenden G Suite-Informationen. Sie sind erforderlich, um Beziehungen zwischen Google Cloud Search und der Datenquelle herzustellen:

    In der Regel erhalten Sie diese Anmeldedaten vom G Suite-Administrator der Domain.

  • Nutzerkonto für den Connector mit der Berechtigung "Websitesammlungsadministrator" für die zu indexierende Websitesammlung.

Deployment

So stellen Sie den SharePoint Online-Connector für Google Cloud Search bereit:

  1. Installieren Sie die Software des SharePoint Online-Connectors für Google Cloud Search.
  2. Geben Sie die Konfiguration des SharePoint Online-Connectors an.
  3. Konfigurieren Sie den Zugriff auf die Google Cloud Search-Datenquelle.
  4. Konfigurieren Sie den Zugriff auf SharePoint Online.
  5. Konfigurieren Sie die SharePoint-Identitätszuordnung zu Google Cloud Search.
  6. Konfigurieren Sie die Erstellung von HTML-Inhalten und die Unterstützung strukturierter Daten für SharePoint-Listenelemente.
  7. Konfigurieren Sie die O365-Identitätszuordnung zu Google Cloud Search.
  8. Aktivieren Sie das Logging.

1. Den SharePoint Online-Connector für Google Cloud Search installieren

Die Installationssoftware für den Connector wird von Google in den folgenden Dateien bereitgestellt:

google-cloudsearch-sharepoint-connector-v1-0.0.2.zip
google-cloudsearch-o365-identity-connector-v1-0.0.2.zip

Laden Sie den Microsoft SharePoint Online-Connector und den Microsoft Office 365-Identitätsconnector herunter. Extrahieren und speichern Sie sie dann in einem lokalen Arbeitsverzeichnis, in dem der Connector ausgeführt wird. Dieses Verzeichnis kann auch alle relevanten Dateien enthalten, die für die Ausführung erforderlich sind, einschließlich der Konfigurationsdatei und der Schlüsseldatei des Dienstkontos.

2. Konfiguration des SharePoint Online-Connectors angeben

Damit der Connector auf SharePoint Online zugreifen und Inhalte indexieren kann, müssen Sie zuerst seine Konfigurationsdatei erstellen. Indem Sie dort Parameter festlegen, steuern Sie das Verhalten und die Attribute des SharePoint Online-Connectors, z. B. Folgendes:

  • Den Zugriff auf eine Datenquelle
  • Den Zugriff auf SharePoint Online

So erstellen Sie eine Konfigurationsdatei:

  1. Öffnen Sie einen Texteditor Ihrer Wahl und fügen Sie dem Dateiinhalt Schlüssel/Wert-Paare hinzu. Dies wird in den folgenden Abschnitten beschrieben.
  2. Benennen und speichern Sie die Konfigurationsdatei. Google empfiehlt den Namen connector-config.properties. Zum Ausführen des Connectors sind dann keine zusätzlichen Befehlszeilenparameter erforderlich.

3. Zugriff auf die Datenquelle von Google Cloud Search konfigurieren

Die ersten Parameter, die in jeder Konfigurationsdatei angegeben werden müssen, sind diejenigen, die für den Zugriff auf die Cloud Search-Datenquelle erforderlich sind. Sie finden sie in der folgenden Tabelle. Normalerweise benötigen Sie die ID der Datenquelle, die ID der Identitätsquelle und den Pfad zur privaten Schlüsseldatei des Dienstkontos, um den Zugriff des Connectors auf Cloud Search konfigurieren zu können. Wie Sie eine Datenquelle einrichten, wird im Hilfeartikel Datenquelle für die Suche hinzufügen beschrieben.

Einstellung Parameter
ID der Datenquelle api.sourceId=1234567890abcdef Pflichtangabe. Die ID der Google Cloud Search-Quelle, die der G Suite-Administrator eingerichtet hat.
Pfad zur privaten Schlüsseldatei des Dienstkontos api.serviceAccountPrivateKeyFile=./PrivateKey.json Pflichtangabe. Die Schlüsseldatei des Google Cloud Search-Dienstkontos für die Zugriffsberechtigungen des SharePoint Online-Connectors auf Google Cloud Search.
ID der Identitätsquelle api.identitySourceId=x0987654321 Pflichtangabe. Die vom G Suite-Administrator eingerichtete ID der Identitätsquelle von Cloud Search.

4. Zugriff auf SharePoint Online konfigurieren

Bevor der Connector auf SharePoint Online zugreifen und zu indexierende Daten extrahieren kann, müssen Sie den Zugriff auf SharePoint Online konfigurieren. Verwenden Sie die folgenden Parameter, um der Konfigurationsdatei Zugriffsinformationen hinzuzufügen.

Einstellung Parameter
Vollständig qualifizierter Domainname der SharePoint-Websitesammlung sharepoint.server=http://yoursharepoint.example.com/ Pflichtangabe. Wenn der Domainname nicht vollständig qualifiziert ist, müssen Sie die DNS-Überschreibung auf dem Connectorhost festlegen.
Modus "Nur Websitesammlung" sharepoint.siteCollectionOnly=true Pflichtangabe. Legen Sie für SharePoint Online immer "true" fest.
SharePoint-Nutzername sharepoint.username=username Pflichtangabe. Der Nutzername für das Konto, das für den Zugriff auf SharePoint Online verwendet werden soll.
SharePoint-Passwort sharepoint.password=user_password Pflichtangabe. Das Passwort für das Konto, das für den Zugriff auf SharePoint Online verwendet werden soll.
Authentifizierungsmodus sharepoint.formsAuthenticationMode=LIVE Pflichtangabe. Legen Sie die Einstellung für SharePoint Online auf LIVE fest.
Deployment-Typ sharepoint.deploymentType=ONLINE Pflichtangabe. Legen Sie die Einstellung für SharePoint Online auf ONLINE fest.

5. SharePoint-Identitätszuordnung zu Google Cloud Search konfigurieren

In Google Cloud Search können Kunden ACL-Beschränkungen auf Suchergebnisse anwenden. Diese ACLs können sowohl mit Google-Hauptkonten als auch mit externen Hauptkonten definiert werden.

Der SharePoint Online-Connector unterstützt folgende Identitäten:

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

Um die richtigen Sicherheitsbeschränkungen auf SharePoint-Inhalte anzuwenden, müssen Sie auch die folgenden externen Identitäten mit Google synchronisieren:

  • Den Identitätsconnector von SharePoint, um lokale SharePoint-Gruppen zu synchronisieren
  • Den Identitätsconnector von O365, um O365-Identitäten zu synchronisieren

Für ein solches Setup benötigen Sie zwei Identitätsquellen.

  • Eine Identitätsquelle zum Synchronisieren von O365-Nutzern und -Gruppen
  • Eine Identitätsquelle für lokale SharePoint-Gruppen
Einstellung Parameter
ID der Identitätsquelle api.identitySourceId=1234567890abcdef ID der Identitätsquelle zum Synchronisieren der lokalen SharePoint-Gruppen.

Pflichtangabe. Die ID der vom G Suite-Administrator eingerichteten Google Cloud Search-Quelle. Weitere Informationen finden Sie im Hilfeartikel Datenquelle für die Suche hinzufügen.

Verwendete Identitätsquellen api.referenceIdentitySources=defaultIdentitySource Pflichtangabe. Verwenden Sie für SharePoint Online den festen Wert "defaultIdentitySource".
IDs der verwendeten Identitätsquellen api.referenceIdentitySource.defaultIdentitySource.id=112233abcd Pflichtangabe. IDs der Identitätsquellen zum Synchronisieren von O365-Identitäten.

6. Für SharePoint-Listenelemente die Erstellung von HTML-Inhalt und die Unterstützung strukturierter Daten konfigurieren

Damit zusätzliche Metadaten für SharePoint-Listenelemente indexiert werden können, müssen Sie den Connector so konfigurieren, dass er strukturierte Daten bzw. das Generieren von HTML-Inhalten unterstützt.

HTML-Inhalte generieren

Konfigurieren Sie den Vorgang mithilfe der Parameter in der folgenden Tabelle.

Einstellung Parameter
Titelfeld der HTML-Vorlage contentTemplate.sharePointItem.title=Title Das SharePoint-Feld, das als "Titel" für den generierten HTML-Code verwendet wird.
Felder, die im HTML-Inhalt eine hohe Suchqualität haben sollen contentTemplate.sharePointItem.quality.high=highField1,highField2… Felder, die im generierten HTML-Code als Felder mit hoher Qualität enthalten sein sollen. Übereinstimmungen von Suchbegriffen mit diesen Feldern werden höher eingestuft.
Felder, die im HTML-Inhalt eine mittlere Suchqualität haben sollen contentTemplate.sharePointItem.quality.medium=mediumField1, mediumField2… Felder, die im generierten HTML-Code als Felder mit mittlerer Qualität enthalten sein sollen.
Felder, die im HTML-Inhalt eine niedrige Suchqualität haben sollen contentTemplate.sharePointItem.quality.low=lowField1, lowField2… Felder, die im generierten HTML-Code als Felder mit niedriger Suchqualität enthalten sein sollen.
Nicht zugeordnete Spalten im HTML-Inhalt contentTemplate.sharepointItem.unmappedColumnsMode=APPEND Die Standardeinstellung ist APPEND. Falls auf IGNORE festgelegt, generiert der Connector nur mithilfe der zugeordneten Spalten HTML-Code. Legen Sie die Einstellung auf APPEND fest, sodass sie im generierten HTML-Code keine zugeordneten Felder enthält, d. h. keine Felder, die zu der hohen, mittleren oder niedrigen Konfiguration gehören.

Unterstützung für strukturierte Daten

Wenn das Schema für die Datenquelle anhand der folgenden Richtlinien definiert wird, füllt der Connector strukturierte Daten für SharePoint-Listenelemente auf:

  • Der Connector ordnet die Namen der SharePoint-Inhaltstypen den entsprechenden Objektdefinitionen zu, indem er sie wie von der Cloud Search API angegeben normalisiert. Die Cloud Search-API unterstützt nur A–Z, a–z und 0–9 als Zeichen für Objektdefinitionen. Der Connector normalisiert Namen von Inhaltstypen, indem nicht unterstützte Zeichen ausgeschlossen werden.Beispielsweise wird der Inhaltstyp "Announcements" (Ankündigungen) der Objektdefinition "Announcements" zugeordnet, während der Inhaltstyp "News Article" (Zeitungsartikel) der Objektdefinition "NewsArticle" zugeordnet wird.

  • Der Connector ordnet die Namen von SharePoint-Attributen entsprechenden Attributdefinitionen zu.

7. O365-Identitätszuordnung zu Google Cloud Search konfigurieren

Falls Sie geeignete Sicherheitsmaßnahmen auf SharePoint-Inhalte anwenden möchten, die auf O365-Identitäten basieren, müssen Sie den O365-Identitätsconnector konfigurieren, der mit dem SharePoint Online-Connectorpaket geliefert wird.

O365-Zugangsdaten erwerben

Für den O365-Identitätsconnector müssen Sie die entsprechenden Anmeldedaten angeben, damit er Nutzer und Gruppen aus dem O365-Konto lesen kann. Weitere Informationen dazu, wie Sie eine Azure Active Directory-Anwendung erstellen, finden Sie im Azure-Portal. Beim Einrichten der Anmeldedaten für die O365-Anwendung erhalten Sie Folgendes:

  • Die Anwendungs-ID
  • Den Mandanten
  • Den Clientschlüssel

Konfiguration des Connectors

Einstellung Parameter
ID der Identitätsquelle api.identitySourceId=1234567890abcdef Pflichtangabe. Die ID der Identitätsquelle zum Synchronisieren von O365-Identitäten.

Die ID der vom G Suite-Administrator eingerichteten Google Cloud Search-Quelle. Weitere Informationen finden Sie im Hilfeartikel Datenquelle für die Suche hinzufügen. Dieser Wert sollte mit der Konfiguration von defaultIdentitySource im SharePoint Online-Connector übereinstimmen.

Google-Kundennummer api.customerId=c1b1d1e1 Pflichtangabe. Die Kunden-ID, die Ihrer Google-Domain zugeordnet ist.

Falls Sie noch keine haben, folgen Sie dieser Anleitung.

ID der O365-Anwendung o365.clientId=a63c6eb3-29e7-486...

Pflichtangabe. Die ID für die Einrichtung der O365-Anwendung.

O365-Mandant o365.clientId=a63c6eb3-29e7-486...

Pflichtangabe. Der Mandant Ihres O365-Kontos.

O365-Clientschlüssel o365.clientSecret=raHJN15vRLBKs...

Pflichtangabe. Anmeldedatenschlüssel aus der Einrichtung der O365-Anwendung.

Connector-Logs

Erstellen Sie im selben Verzeichnis, in dem sich die Binärdatei des Connectors befindet, einen Ordner namens **logs**.

Erstellen Sie dort außerdem eine ASCII- oder UTF-8-Datei namens logging.properties und fügen Sie den folgenden Inhalt ein:

handlers = java.util.logging.ConsoleHandler,java.util.logging.FileHandler
# Default log level
.level = INFO
# uncomment line below to increase logging level for O365 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-sharepoint.%g.log
java.util.logging.FileHandler.limit=10485760
java.util.logging.FileHandler.count=10
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

O365-Identitätsconnector ausführen

Führen Sie den Connector mithilfe des Befehls cmd.exe auf dem Hostcomputer aus:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-o365-identity-connector-v-withlib.jar

8. Logging aktivieren

Erstellen Sie im selben Verzeichnis, in dem sich die Binärdatei des Connectors befindet, einen Ordner namens **logs**.

Erstellen Sie dort außerdem eine ASCII- oder UTF-8-Datei namens logging.properties und fügen Sie den folgenden Inhalt ein:

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

Beispiel: Konfigurationsdatei

Die folgende Konfigurationsdatei enthält die Parameter (Schlüssel/Wert-Paare), mit denen das Verhalten eines Beispielconnectors definiert wird.

api.sourceId=08ef8becd116faa4546b8ca2c84b2879
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

# Optional
contentTemplate.sharepointItem.title=Title
contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

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

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

SharePoint Online-Identitätsconnector ausführen

Damit Nutzer über Cloud Search in den SharePoint-Inhalten suchen können, auf die sie Zugriff haben, müssen zuerst die Hauptkonten in der O365- und der SharePoint-Websitesammlung den Identitäten in Google Cloud Identity zugeordnet werden. Dies erfolgt mithilfe des O365- und des SharePoint Online-Identitätsconnectors. Wenn der O365-Connector die Nutzer und Gruppen synchronisiert hat, führen Sie den SharePoint Online-Identitätsconnector wie unten erläutert aus, um die Gruppen der SharePoint-Websitesammlung zu synchronisieren.

Der Identitätsconnector verwendet eine Konfigurationsdatei, die der zum Indexieren von Inhalt ähnlich ist. Dies ist ein Beispiel:

api.customerId=C05d3djk8
api.serviceAccountPrivateKeyFile=service_account.json
api.identitySourceId=08ef8becd116faa475de26d9b291fed9

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

api.referenceIdentitySources=defaultIdentitySource
api.referenceIdentitySource.defaultIdentitySource.id=08ef8becd116faa5d3783f8c5a80e5aa

Wie Sie sehen, wurde das Attribut api.customerId hinzugefügt. Eine Anleitung zum Abrufen der Kunden-ID (customerId) finden Sie unter diesem Link.

Der Identitätsconnector befindet sich in derselben JAR-Datei, mit der Inhalte indexiert werden. Sie können ihn ausführen, indem Sie den folgenden Befehl im Verzeichnis der Konfigurationsdatei ausführen:

java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-v<version>-withlib.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector

SharePoint Online-Connector ausführen

Führen Sie den SharePoint Online-Connector mithilfe des Befehls cmd.exe auf dem Hostcomputer aus:

java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v-withlib.jar

Weiterführende Informationen

Die Informationen in diesem Abschnitt gehen über die grundlegende Konfiguration des SharePoint-Connectors hinaus.

Inhaltstyp für MSG-Dateien aus Microsoft Outlook überschreiben

Wenn der Connector beim Crawlen auf MSG-Dateien (Outlook) stößt, überschreibt er ihren Inhaltstyp und indexiert sie als application/vnd.ms-outlook.