Microsoft SharePoint Online-Connector bereitstellen

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

Wichtige Aspekte

Anerkannte SharePoint-Einstellungen

Der SharePoint Online-Connector für Cloud Search berücksichtigt immer die SharePoint-Einstellung Suchbarkeit, die nicht überschrieben werden kann. Bei Entwürfen steuern die Berechtigungen für das Nutzerkonto, über das der Connector auf SharePoint Online zugreift, welche Entwürfe indexiert und zurückgegeben werden. Wenn das Konto nur Leseberechtigungen hat, werden die SharePoint-Einstellungen für die Sichtbarkeit von Entwurfselementen berücksichtigt.

Sie können den Connector auch so konfigurieren, dass die Ergebnisse basierend auf dem Zugriff auf das Nutzerkonto beschränkt werden. Wenn Sie das Sicherheits-Trimming auf SharePoint-Inhalte anwenden möchten, synchronisieren Sie die folgenden externen Identitäten mit dem Google-Verzeichnis:

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

Suchoptimierung

Sie können die Nutzererfahrung verbessern, indem Sie den Connector so konfigurieren, dass relevantere Suchergebnisse zurückgegeben werden.

Wenn Sie die API verwenden möchten, legen Sie in der Konfigurationsdatei des SharePoint Online-Connectors Werte für Parameter zur HTML-Generierung fest. Mit diesen Parametern können Sie festlegen, welche Felder mehr oder weniger Einfluss auf Übereinstimmungen haben.

Folgen Sie der Anleitung unter Schema erstellen und registrieren, um ein Schema einzurichten. Wenn Sie ein Schema einrichten:

  • Um die Namen von SharePoint-Inhaltstypen den entsprechenden Objektdefinitionen zuzuordnen, normalisiert der Connector die Namen der Inhaltstypen, indem nicht unterstützte Zeichen ausgeschlossen werden. Für Objektdefinitionen unterstützt die Cloud Search API nur die Zeichen A–Z, a–z und 0–9. Der Inhaltstyp „Ankündigungen“ ist beispielsweise der Objektdefinition „Ankündigungen“ zugeordnet. Der Inhaltstyp „Nachrichtenartikel“ ist „NewsArticle“ zugeordnet (kein Leerzeichen).

  • Wenn der Connector keine Objektdefinition mit Objektdefinition abgleichen kann, verwendet er den Fallback-Objekttyp (itemMetadata.objectType). Weitere Informationen zu Konfigurationsparametern für Metadaten

  • Der Connector ordnet SharePoint-Attributnamen den Attributdefinitionen zu.

  • Wenn der Connector bei der Indexierung von Inhalten Microsoft Outlook-MSG-Dateien findet, wird der Inhaltstyp der Dateien überschrieben und sie werden als application/vnd.ms-outlook. indexiert

Bekannte Einschränkungen bei Connectors

  • Jede Connector-Instanz kann nur Inhalte aus einer einzelnen Websitesammlung indexieren. Wenn Sie mehrere Websitesammlungen indexieren möchten, müssen Sie zusätzliche Connector-Instanzen einrichten.
  • Die Arbeitsspeichernutzung steigt mit der Anzahl der einzelnen Nutzer und Gruppen, die Sie in ACLs für jede Websitesammlung verwenden.
  • Löschbenachrichtigungen erfolgen nicht sofort und es kann mehr als vier Stunden dauern, bis ein Connector erkennt, dass ein Nutzer Inhalte aus dem Quell-Repository gelöscht hat.

Systemanforderungen

Systemanforderungen
Betriebssystem
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64-Bit)
Authentifizierung
  • Live-Authentifizierung
Software
  • SharePoint Online-Umgebung
  • Java JRE 1.8, installiert auf dem Computer, auf dem der SharePoint Online-Connector für Google Cloud Search ausgeführt wird

Connector bereitstellen

Voraussetzungen

  1. Erstellen Sie einen privaten Google Workspace-Schlüssel, der Ihre Dienstkonto-ID enthält. Informationen zum Abrufen eines privaten Schlüssels finden Sie im Hilfeartikel Zugriff auf die Google Cloud Search API konfigurieren.

  2. Ihr Google Workspace-Administrator muss eine Datenquelle für die Suche hinzufügen. Notieren Sie sich die ID der Datenquelle.

  3. Wenn der Connector Ergebnisse auf Grundlage von ACLs zurückgibt (Ergebnisse sind nicht öffentlich), muss Ihr Google Workspace-Administrator zwei Identitätsquellen erstellen und Ihnen deren IDs mitteilen:

    • eine für Office 365-Nutzer und -Gruppen
    • eine für SharePoint-Gruppen

    Der Administrator muss außerdem die Google Workspace-Kundennummer Ihrer Organisation abrufen und an Sie weitergeben.

    Weitere Informationen zum Abrufen dieser Werte finden Sie unter Nutzeridentitäten in Cloud Search zuordnen.

  4. Richten Sie ein Nutzerkonto für den Connector ein, der Administratorberechtigungen für die SharePoint Online-Websitesammlung hat.

  5. Wenn der Connector Ergebnisse auf der Grundlage von ACLs zurückgibt (Ergebnisse sind nicht öffentlich), erstellen Sie Anmeldedaten, um Nutzer und Gruppen aus Ihrem Office 365-Konto zu lesen. Folgen Sie der Anleitung von Microsoft, um eine Azure Active Directory-Anwendung zu erstellen. Gehen Sie beim Einrichten der App so vor:

    1. Geben Sie der App einen aussagekräftigen Namen, z. B. „gcs-o365-identity-connector“.
    2. Fügen Sie Berechtigungen hinzu. Die App benötigt „Group.Read.All“ und „User.Read.All“.
    3. Notieren Sie sich die folgenden Informationen für die Connector-Konfiguration:
      • Anwendungs-ID
      • Mandant
      • Clientschlüssel

Schritt 1. SharePoint Online-Connector-Software installieren

  1. Klonen Sie das Connector-Repository aus GitHub.

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

  2. Prüfen Sie die gewünschte Version des Connectors:

    $ git checkout tags/v1-0.0.3

  3. Erstellen Sie den Connector.

    $ mvn package

    Wenn Sie beim Erstellen des Connectors Tests überspringen möchten, führen Sie mvn package -DskipTests anstelle von mvn package aus.

  4. Kopieren Sie die ZIP-Datei des Connectors in Ihr lokales Installationsverzeichnis:

    $ 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

Schritt 2: Konfigurationsdatei für den SharePoint Online-Connector erstellen

  1. Erstellen Sie im selben Verzeichnis wie die Connector-Installation eine neue Datei und nennen Sie sie sharepoint-online-connector.config. Wenn Sie viele Connector-Instanzen ausführen möchten, fügen Sie dem Namen weitere Details hinzu, um die Instanzen voneinander zu unterscheiden.

  2. Fügen Sie dem Dateiinhalt Parameter als Schlüssel/Wert-Paare hinzu, wie im folgenden Beispiel gezeigt:

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

    Ausführliche Beschreibungen der einzelnen Parameter finden Sie in der Referenz zu Konfigurationsparametern.

  3. Optional: Konfigurieren Sie nach Bedarf weitere Connector-Parameter. Weitere Informationen zu den von Google bereitgestellten Connectorparametern

Schritt 3. Logging für den SharePoint Online-Connector einrichten

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

  2. Erstellen Sie dort auch eine Latin-1-codierte Datei mit dem Namen logging.properties und fügen Sie den folgenden Inhalt hinzu:

    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 Online-Identitätsconnector konfigurieren

Dieser Schritt ist erforderlich, um identitätsbasierte SharePoint Online-ACLs auf Suchergebnisse anzuwenden. Wenn Sie den Connector mit öffentlichen ACLs eingerichtet haben, können Sie diesen Schritt überspringen.

  1. Erstellen Sie im Verzeichnis, in dem sich auch die Installation des SharePoint Online-Connectors befindet, eine neue Datei und nennen Sie sie sharepoint-online-identity-connector.config.

  2. Fügen Sie dem Dateiinhalt Parameter als Schlüssel/Wert-Paare hinzu, wie im folgenden Beispiel gezeigt:

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

    Die Werte sind fast dieselben wie für den SharePoint Online-Connector, nur dass der Parameter statt api.sourceId api.customerId lautet. Der Wert für api.customerId ist die Kundennummer, die Sie von Ihrem Google Workspace-Administrator erhalten haben.

Schritt 5: Office 365-Identitätsconnector installieren

Dieser Schritt ist erforderlich, um identitätsbasierte SharePoint Online-ACLs auf Suchergebnisse anzuwenden. Wenn Sie den Connector mit öffentlichen ACLs eingerichtet haben, können Sie diesen Schritt überspringen.

  1. Klonen Sie das Connector-Repository aus GitHub.

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

  2. Prüfen Sie die gewünschte Version des Connectors:

    $ git checkout tags/v1-0.0.3

  3. Erstellen Sie den Connector.

    $ mvn package

    Wenn Sie beim Erstellen des Connectors Tests überspringen möchten, führen Sie mvn package -DskipTests anstelle von mvn package aus.

  4. Kopieren Sie die ZIP-Datei des Connectors in Ihr lokales Installationsverzeichnis:

    $ 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

Schritt 6: Office 365-Identitätsconnector konfigurieren und Logging einrichten

  1. Erstellen Sie im Verzeichnis, in dem sich auch die Installation des Identitätsconnectors befindet, eine neue Datei und nennen Sie sie o365-identity-connector.config.

  2. Fügen Sie dem Dateiinhalt Parameter als Schlüssel/Wert-Paare hinzu, wie im folgenden Beispiel gezeigt. Hinweis: Alle Parameter sind erforderlich.

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

    Eine ausführliche Beschreibung der einzelnen Parameter finden Sie in der Konfigurationsreferenz für den Office 365-Identitätsconnector.

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

  4. 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 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: SharePoint Online-Connector starten

In den folgenden Schritten ordnen Sie die Hauptkonten aus Office 365 und der SharePoint-Websitesammlung den Identitäten im Cloud Identity-Dienst zu. Die Synchronisierung erfolgt mit dem Office 365- und dem SharePoint Online-Identitätsconnector.

Nachdem der Office 365-Connector die Nutzer und Gruppen synchronisiert hat, führen Sie den SharePoint Online-Identitätsconnector aus, um die Gruppen der SharePoint-Websitesammlung zu synchronisieren. Anschließend führen Sie den SharePoint Online-Connector aus, um die Ergebnisse für Ihre Cloud Search-Nutzer zu indexieren und bereitzustellen.

  1. Führen Sie den Office 365-Identitätsconnector aus:

    $ 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:

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

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

Referenz zu Konfigurationsparametern

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 Online-Zugriff

Einstellung Parameter
Vollständig qualifizierter Domainname für die SharePoint-Websitesammlung sharepoint.server=http://yoursharepoint.example.com/

Erforderlich. Wenn der Domainname nicht vollständig qualifiziert ist, richten Sie die DNS-Überschreibung auf dem Connector-Host ein.
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, mit dem auf SharePoint Online zugegriffen wird.
SharePoint-Passwort sharepoint.password=user_password

Erforderlich. Das Passwort für das Konto, mit dem auf SharePoint Online zugegriffen wird.
Authentifizierungsmodus sharepoint.formsAuthenticationMode=LIVE

Erforderlich. Bei SharePoint Online lautet der Wert immer „LIVE“.
Deployment-Typ sharepoint.deploymentType=ONLINE

Erforderlich. Bei 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.
Referenz-Identitätsquellen api.referenceIdentitySources=defaultIdentitySource

Erforderlich. Für SharePoint Online lautet der Wert immer „defaultIdentitySource“.
Referenz-IDs der Identitätsquellen api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Erforderlich. Die ID der Cloud Search-Identitätsquelle für die Identitätsquelle von Office 365-Nutzern und ‐Gruppen.

Erstellung von HTML-Inhalten

Einstellung Parameter
Titelfeld der HTML-Vorlage contentTemplate.sharePointItem.title=Title

Das SharePoint-Feld, das als Titel der HTML-Vorlage für generierten HTML-Code verwendet werden soll.
Felder für HTML-Inhalte mit hoher Suchqualität contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Eine durch Kommas getrennte Liste von Feldern, die im generierten HTML-Code als Felder mit hoher Qualität enthalten sein sollen. Wenn die Suchbegriffe mit diesen Feldern übereinstimmen, werden die Ergebnisse höher eingestuft.
Felder für HTML-Inhalt mit mittlerer Suchqualität contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Eine durch Kommas getrennte Liste von Feldern, die im generierten HTML-Code als Felder mit mittlerer Qualität enthalten sein sollen.
Felder für HTML-Inhalte mit niedriger Suchqualität contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Eine durch Kommas getrennte Liste von Feldern, die im generierten HTML-Code als Felder mit niedriger Qualität enthalten sein sollen.
Nicht zugeordnete Spalten im HTML-Inhalt contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Verarbeitung nicht zugeordneter Spalten durch den Connector. Der Wert ist APPEND (Standardeinstellung) oder IGNORE.

  • APPEND: Der Connector generiert HTML-Inhalte mit allen Feldern, auch mit Feldern, für die keine bestimmte Qualitätsstufe festgelegt wurde (hoch, mittel oder niedrig).
  • IGNORE: Der Connector generiert HTML-Inhalte nur mit 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-Anwendung)
Office 365-Clientschlüssel o365.clientSecret=raHJN15vRLBKs

Erforderlich. Anmeldedaten-Secret aus der Einrichtung der Office 365-Anwendung