Wdrażanie oprogramowania sprzęgającego Microsoft SharePoint Online

Możesz skonfigurować Google Cloud Search tak, aby zwracał wyniki z SharePoint Online organizacji oprócz treści z Google Workspace. Użyj łącznika Google Cloud Search SharePoint Online i skonfiguruj go tak, aby uzyskiwał dostęp do konkretnego źródła danych SharePoint Online.

Ważne kwestie

Uwzględniane ustawienia SharePoint

Łącznik Cloud Search SharePoint Online zawsze honoruje ustawienie Widoczność w wyszukiwarce w SharePoint, którego nie można zastąpić. W przypadku dokumentów roboczych uprawnienia na koncie użytkownika (używane przez oprogramowanie sprzęgające do uzyskiwania dostępu do usługi SharePoint Online) określają, które wersje robocze dokumentów są indeksowane i zwracane. Jeśli konto ma tylko uprawnienia „Pełny dostęp do odczytu”, łącznik uwzględnia ustawienia „Widoczność elementów w wersji roboczej” w SharePoint.

Skonfigurujesz też oprogramowanie sprzęgające tak, aby ograniczyć wyniki na podstawie dostępu do konta użytkownika. Aby zastosować ograniczanie zabezpieczeń w przypadku treści SharePoint, zsynchronizuj te zewnętrzne tożsamości z katalogiem Google:

  • Użytkownicy Office 365 / Azure AD
  • Grupy zabezpieczeń Office 365 lub Azure AD
  • grupy SharePoint (z użytkownikami i grupami Office 365 jako członkami);

Optymalizacja wyszukiwania

Możesz poprawić komfort użytkowników, konfigurując złącze tak, aby zwracało trafniejsze wyniki wyszukiwania.

Aby używać interfejsu API, ustaw wartości parametrów generowania kodu HTML w pliku konfiguracji złącza SharePoint Online. Te parametry umożliwiają określenie, które pola mają większy lub mniejszy wpływ na dopasowanie.

Aby skonfigurować schemat, wykonaj instrukcje podane w artykule Tworzenie schematu i rejestrowanie go. Podczas konfigurowania schematu:

  • Aby mapować nazwy typów treści SharePoint na odpowiadające im definicje obiektów, sprzęgacz normalizuje nazwy typów treści, wykluczając nieobsługiwane znaki. W przypadku definicji obiektów interfejs Cloud Search API obsługuje jako prawidłowe znaki tylko z A–Z, a–z i 0–9. Na przykład typ treści „Ogłoszenia” jest mapowany na definicję obiektu „Ogłoszenia”. Typ treści „Artykuł prasowy” jest mapowany na „Artykuł prasowy” (bez spacji).

  • Jeśli oprogramowanie sprzęgające nie może dopasować definicji obiektu do definicji obiektu, używa typu obiektu zastępczego (itemMetadata.objectType). Dowiedz się więcej o parametrach konfiguracji metadanych.

  • Oprogramowanie sprzęgające mapuje nazwy właściwości SharePoint na ich definicje.

  • Gdy podczas indeksowania treści łącznik napotka pliki .msg programu Microsoft Outlook, zastąpi typ tych plików i zacznie indeksować je jako application/vnd.ms-outlook..

Znane ograniczenia w przypadku usługi Connectors

  • Każda instancja usługi może indeksować treści tylko z jednej kolekcji witryn. Aby indeksować większą liczbę kolekcji witryn, skonfiguruj dodatkowe wystąpienia łącznika.
  • Zużycie pamięci wzrasta wraz z liczbą unikalnych użytkowników i grup, których używasz w uprawnieniach dostępu do poszczególnych kolekcji witryn.
  • Powiadomienia o usunięciu nie są natychmiastowe. Zanim oprogramowanie sprzęgające wykryje, że użytkownik usunął treści z repozytorium źródłowego, może minąć ponad 4 godziny.

Wymagania systemowe

Wymagania systemowe
System operacyjny
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64-bitowy)
Uwierzytelnianie
  • Uwierzytelnianie na żywo
Oprogramowanie
  • Środowisko SharePoint Online
  • Java JRE 1.8 zainstalowana na komputerze, na którym ma działać łącznik usługi Google Cloud Search z SharePoint Online.

Wdrażanie oprogramowania sprzęgającego

Wymagania wstępne

  1. Utwórz klucz prywatny Google Workspace, który zawiera identyfikator konta usługi. Aby dowiedzieć się, jak uzyskać klucz prywatny, zapoznaj się z artykułem Konfigurowanie dostępu do interfejsu Google Cloud Search API.

  2. Administrator Google Workspace musi dodać źródło danych do wyszukiwania. Zapisz identyfikator źródła danych.

  3. Jeśli oprogramowanie sprzęgające zwraca wyniki na podstawie list kontroli dostępu (wyniki nie są publiczne), administrator Google Workspace musi utworzyć 2 źródła tożsamości i przekazać Ci ich identyfikatory:

    • jedna dla użytkowników i grup Office 365,
    • po jednej dla grup SharePoint.

    Administrator musi też uzyskać identyfikator klienta Google Workspace Twojej organizacji i przekazać go Tobie.

    Aby dowiedzieć się, jak uzyskać te wartości, przeczytaj artykuł Mapowanie tożsamości użytkowników w Cloud Search.

  4. Skonfiguruj konto użytkownika łącznika, które ma uprawnienia administratora kolekcji witryn SharePoint Online.

  5. Jeśli usługa zwraca wyniki na podstawie list dostępu (nie są one publiczne), utwórz dane logowania, aby odczytać użytkowników i grupy z konta Office 365. Postępuj zgodnie z instrukcjami firmy Microsoft, aby utworzyć aplikację Azure Active Directory. Podczas konfigurowania aplikacji:

    1. Nadaj aplikacji nazwę opisową, na przykład „gcs-o365-identity-connector”.
    2. Dodaj uprawnienia. Aplikacja musi mieć uprawnienia „Group.Read.All” i „User.Read.All”.
    3. Zapisz te informacje, które będą używane w konfiguracji oprogramowania sprzęgającego:
      • Identyfikator aplikacji
      • Najemca
      • Tajny klucz klienta

Krok 1. Instalowanie oprogramowania łącznika SharePoint Online

  1. Sklonuj repozytorium oprogramowania sprzęgającego z GitHuba.

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

  2. Pobierz odpowiednią wersję oprogramowania sprzęgającego:

    $ git checkout tags/v1-0.0.3

  3. Utwórz oprogramowanie sprzęgające.

    $ mvn package

    Aby pominąć testy podczas tworzenia oprogramowania sprzęgającego, uruchom mvn package -DskipTests zamiast mvn package.

  4. Skopiuj plik ZIP z oprogramowaniem sprzęgającym do lokalnego katalogu instalacji:

    $ 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

Krok 2. Tworzenie pliku konfiguracji oprogramowania sprzęgającego SharePoint Online

  1. W tym samym katalogu, w którym znajduje się instalacja usługi łącznika, utwórz nowy plik o nazwie sharepoint-online-connector.config. Jeśli planujesz uruchomić wiele wystąpień usługi łącznika, dodaj do nazwy więcej szczegółów, aby ją wyróżnić.

  2. Dodaj parametry jako pary klucz-wartość do zawartości pliku, jak w tym przykładzie:

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

    Szczegółowe opisy poszczególnych parametrów znajdziesz w dokumentacji parametrów konfiguracji.

  3. (Opcjonalnie) Skonfiguruj dodatkowe parametry oprogramowania sprzęgającego zgodnie z potrzebami. Szczegółowe informacje znajdziesz w artykule Parametry oprogramowania sprzęgającego dostarczone przez Google.

Krok 3. Konfigurowanie logowania w przypadku oprogramowania sprzęgającego SharePoint Online

  1. Utwórz folder o nazwie logs w tym samym katalogu, który zawiera plik binarne oprogramowania sprzęgającego.

  2. W tym samym katalogu utwórz plik zakodowany w standardzie Latin-1 o nazwie logging.properties i dodaj tę treść:

    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

Krok 4. Konfigurowanie łącznika tożsamości SharePoint Online

Ten krok jest wymagany do zastosowania w wynikach wyszukiwania uprawnień ACL opartych na tożsamości w SharePoint Online. Jeśli skonfigurujesz konwerter za pomocą publicznych reguł kontroli dostępu, możesz pominąć ten krok.

  1. W tym samym katalogu, w którym znajduje się instalacja łącznika SharePoint Online, utwórz nowy plik o nazwie sharepoint-online-identity-connector.config.

  2. Dodaj parametry jako pary klucz-wartość do zawartości pliku, jak w tym przykładzie:

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

    Wartości są prawie takie same jak w przypadku oprogramowania sprzęgającego SharePoint Online, z tym że zamiast api.sourceId jest parametr api.customerId. Wartością parametru api.customerId jest identyfikator klienta otrzymany od administratora Google Workspace.

Krok 5. Instalowanie łącznika tożsamości Office 365

Ten krok jest wymagany, aby w wynikach wyszukiwania zastosować oparte na tożsamości listy kontroli dostępu (ACL) usługi SharePoint Online. Jeśli skonfigurujesz konwerter za pomocą publicznych reguł kontroli dostępu, możesz pominąć ten krok.

  1. Sklonuj repozytorium z łącznikami z GitHuba.

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

  2. Pobierz odpowiednią wersję oprogramowania sprzęgającego:

    $ git checkout tags/v1-0.0.3

  3. Utwórz oprogramowanie sprzęgające.

    $ mvn package

    Aby pominąć testy podczas tworzenia oprogramowania sprzęgającego, uruchom mvn package -DskipTests zamiast mvn package.

  4. Skopiuj plik ZIP oprogramowania sprzęgającego do lokalnego katalogu instalacji:

    $ 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

Krok 6. Konfigurowanie łącznika tożsamości Office 365 i konfigurowanie rejestrowania

  1. W tym samym katalogu, w którym znajduje się zainstalowany łącznik tożsamości, utwórz nowy plik i nadaj mu nazwę o365-identity-connector.config.

  2. Dodaj parametry w postaci par klucz-wartość do zawartości pliku, jak w tym przykładzie. Uwaga: wszystkie parametry są wymagane.

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

    Szczegółowe opisy poszczególnych parametrów znajdziesz w dokumentacji konfiguracji oprogramowania sprzęgającego tożsamości Office 365.

  3. Utwórz folder o nazwie logs w tym samym katalogu, który zawiera plik binarne.

  4. W tym samym katalogu utwórz plik ASCII lub UTF-8 o nazwie logging.properties i dodaj tę treść:

    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

Krok 7. Uruchamianie łącznika SharePoint Online

W kolejnych krokach zmapujesz podmioty zabezpieczeń w Office 365 i kolekcji witryn SharePoint na tożsamości w usłudze Cloud Identity. Synchronizacja jest przeprowadzana za pomocą łącznika tożsamości Office 365 i łącznika tożsamości SharePoint Online.

Po zsynchronizowaniu użytkowników i grup przez oprogramowanie sprzęgające Office 365 uruchom oprogramowanie sprzęgające tożsamości usługi SharePoint Online, aby zsynchronizować grupy kolekcji witryn SharePoint. Następnie uruchamiasz łącznik SharePoint Online, aby zindeksować i przekazać wyniki użytkownikom Cloud Search.

  1. Uruchom łącznik tożsamości 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. Uruchom łącznik tożsamości 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. Uruchom łącznik 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

Informacje o parametrach konfiguracji

Dostęp do źródła danych

Ustawienie Parametr
Identyfikator źródła danych api.sourceId=1234567890abcdef

Wymagane. Identyfikator źródła danych Google Cloud Search skonfigurowanego przez administratora Google Workspace.
Ścieżka do pliku klucza prywatnego konta usługi api.serviceAccountPrivateKeyFile=PrivateKey.json

Wymagane. Ścieżka do pliku klucza konta usługi Google Cloud Search.

Dostęp do SharePoint Online

Ustawienie Parametr
Pełna i jednoznaczna nazwa domeny kolekcji witryn SharePoint sharepoint.server=http://yoursharepoint.example.com/

Wymagane. Jeśli nazwa domeny nie jest w pełni kwalifikowana, ustaw zastąpienie DNS na hoście oprogramowania sprzęgającego.
Tryb „Tylko kolekcja witryn” sharepoint.siteCollectionOnly=true

Wymagane. W przypadku SharePoint Online ustaw wartość true.
Nazwa użytkownika SharePoint sharepoint.username=username

Wymagane. Nazwa użytkownika konta używanego do uzyskiwania dostępu do usługi SharePoint Online.
Hasło SharePoint sharepoint.password=user_password

Wymagane. hasło do konta używanego do uzyskiwania dostępu do SharePoint Online;
Tryb uwierzytelniania sharepoint.formsAuthenticationMode=LIVE

Wymagane. W przypadku SharePoint Online wartość jest zawsze „LIVE”.
Typ wdrożenia sharepoint.deploymentType=ONLINE

Wymagane. W przypadku SharePoint Online wartość jest zawsze „ONLINE”.

Mapowanie tożsamości w SharePoint

Ustawienie Parametr
Identyfikator źródła tożsamości api.identitySourceId=1234567890abcdef

Wymagane. Identyfikator źródła tożsamości Cloud Search dla źródła tożsamości grup SharePoint.
Źródła tożsamości do odwołania api.referenceIdentitySources=defaultIdentitySource

Wymagane. W przypadku SharePoint Online wartość jest zawsze taka sama: „defaultIdentitySource”.
Identyfikatory referencyjne źródeł tożsamości api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

Wymagane. Identyfikator źródła tożsamości Cloud Search dla źródła tożsamości Użytkownicy i grupy w Office 365.

Generowanie treści HTML

Ustawienie Parametr
Pole tytułu szablonu HTML contentTemplate.sharePointItem.title=Title

Pole SharePoint używane jako tytuł szablonu HTML dla wygenerowanego kodu HTML.
Pola treści HTML wysokiej jakości contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Rozdzielona przecinkami lista pól, które mają zostać uwzględnione w wygenerowanym kodzie HTML jako pola wysokiej jakości. Gdy wyszukiwane hasła pasują do tych pól, wyniki mają wyższą pozycję w rankingu.
Pola jakości wyszukiwania w treściach HTML contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Lista pól rozdzielona przecinkami, które mają być uwzględnione w wygenerowanym kodzie HTML jako pola o średniej jakości.
Pola treści HTML niskiej jakości contentTemplate.sharePointItem.quality.low=lowField1[,lowField2,...]

Rozdzielona przecinkami lista pól, które mają zostać uwzględnione w wygenerowanym kodzie HTML jako pola niskiej jakości.
Niezmapowane kolumny treści HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Sposób obsługi kolumn bez mapowania przez łącznik. Wartość to APPEND (domyślnie) lub IGNORE.

  • APPEND – złącze generuje zawartość HTML ze wszystkimi polami, w tym z tymi, które nie mają ustawionego poziomu jakości (wysoki, średni lub niski).
  • IGNORE (ignoruj) – łącznik generuje zawartość HTML z tylko zmapowanymi polami.

Konfiguracja łącznika tożsamości Office 365

Ustawienie Parametr
Identyfikator źródła tożsamości api.identitySourceId=1234567890abcdef

Wymagane. Identyfikator źródła tożsamości Office 365. Ta wartość powinna być zgodna z wartością parametru „api.referenceIdentitySource.defaultIdentitySource.id” w konfiguracji złącza SharePoint Online.
Identyfikator klienta Google api.customerId=c1b1d1e1

Wymagane. Identyfikator klienta Google Workspace Twojej organizacji.
Identyfikator aplikacji Office 365 o365.clientId=a63c6eb3-29e7-486

Wymagane. Identyfikator aplikacji z konfiguracji aplikacji Office 365.

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

Wymagane. Najemca Twojego konta Office 365 (aplikacja Azure Activity Directory)
Tajny klucz klienta Office 365 o365.clientSecret=raHJN15vRLBKs

Wymagane. Obiekt tajny danych logowania z konfiguracji aplikacji Office 365