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

Możesz skonfigurować usługę Google Cloud Search tak, aby zwracała wyniki z treści Dataplex Online, które są dodatkiem do treści z Google Workspace. Ty użyć oprogramowania sprzęgającego Google Cloud Search z SharePoint Online i skonfigurować je tak, uzyskać dostęp do określonego źródła danych SharePoint Online.

Ważne informacje

Honorowe ustawienia usługi SharePoint

Oprogramowanie sprzęgające Cloud Search SharePoint Online zawsze obsługuje ustawienie Widoczność przy wyszukiwaniu, którego nie można zastąpić. W przypadku dokumentów roboczych uprawnienia do konta 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 stan „Pełny odczyt” uprawnień, oprogramowanie sprzęgające uwzględnia ustawienie „Widoczność elementu 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ć przycinanie zabezpieczeń w przypadku treści z SharePoint, musisz zsynchronizować te tożsamości zewnętrzne z katalogiem Google:

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

Optymalizacja wyszukiwania

Możesz poprawić przez skonfigurowanie oprogramowania sprzęgającego tak, aby zwracało trafniejsze wyniki wyszukiwania.

Aby korzystać z tego interfejsu API, ustaw wartości parametrów generowania kodu HTML w pliku konfiguracji oprogramowania sprzęgającego SharePoint Online. Te parametry pozwalają określić, które pola mają większy lub mniejszy wpływ na dopasowania.

Aby skonfigurować schemat, postępuj zgodnie z instrukcjami podanymi w artykule Tworzenie i rejestrowanie schematu. Podczas konfigurowania schematu:

  • W celu zmapowania nazw typów treści oprogramowania sprzęgającego na odpowiednie definicje obiektów oprogramowanie sprzęgające normalizuje nazwy typów treści przez wykluczenie nieobsługiwanych znaków. 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ł z wiadomościami”, mapuje na „NewsArticle” (bez spacji).

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

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

  • Gdy oprogramowanie sprzęgające napotka pliki .msg w Microsoft Outlook podczas indeksowania treści, zastępuje typ treści tych plików i indeksuje je jako application/vnd.ms-outlook.

Znane ograniczenia oprogramowania sprzęgającego

  • Każda instancja oprogramowania sprzęgającego może indeksować treść tylko z jednego zbioru witryn. Aby indeksować wiele zbiorów witryn, skonfiguruj dodatkowe instancje oprogramowania sprzęgającego.
  • Wykorzystanie pamięci zwiększa się wraz z liczbą unikalnych użytkowników i grup używanych na listach kontroli dostępu (ACL) w każdej 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
  • Środowisko Java JRE 1.8 zostało zainstalowane na komputerze, na którym będzie działać oprogramowanie sprzęgające usługi Google Cloud Search SharePoint Online

Wdrażanie oprogramowania sprzęgającego

Wymagania wstępne

  1. Utwórz klucz prywatny Google Workspace zawierający identyfikator konta usługi. Aby dowiedzieć się, jak uzyskać klucz prywatny, przeczytaj artykuł Konfigurowanie dostępu do interfejsu Google Cloud Search API.

  2. Administrator Google Workspace musi dodać źródło danych do przeszukiwania. Zanotuj 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:

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

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

    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 oprogramowania sprzęgającego, które ma uprawnienia administratora gromadzenia danych o witrynach online.

  5. Jeśli oprogramowanie sprzęgające zwraca wyniki na podstawie list kontroli dostępu (wyniki nie są publiczne), utwórz dane logowania, aby odczytywać użytkowników i grupy z konta Office 365. Wykonaj instrukcje Microsoftu, 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 wymaga ustawienia „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. Zainstaluj oprogramowanie sprzęgające usługi 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. Sprawdź 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-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 oprogramowania sprzęgającego, utwórz nowy plik i nadaj mu nazwę sharepoint-online-connector.config. Jeśli planujesz uruchomić wiele instancji oprogramowania sprzęgającego, dodaj więcej szczegółów do nazwy, aby ją rozróż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. Więcej informacji: Parametry oprogramowania sprzęgającego udostępnione przez Google.

Krok 3. Konfigurowanie logowania w oprogramowaniu sprzęgającym z SharePoint Online

  1. W tym samym katalogu, który zawiera plik binarny oprogramowania sprzęgającego, utwórz folder o nazwie logs.

  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 oprogramowania sprzęgającego tożsamości SharePoint Online

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 oprogramowanie sprzęgające z publicznymi listami kontroli dostępu, możesz pominąć ten krok.

  1. W tym samym katalogu, w którym znajduje się instalacja oprogramowania sprzęgającego z SharePoint Online, utwórz nowy plik i nadaj mu nazwę 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 parametrem jest api.customerId. Wartość api.customerId to identyfikator klienta otrzymany od administratora Google Workspace.

Krok 5. Zainstaluj oprogramowanie sprzęgające 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 oprogramowanie sprzęgające z publicznymi listami kontroli dostępu, możesz pominąć ten krok.

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

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

  2. Sprawdź 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. Skonfiguruj oprogramowanie sprzęgające tożsamości Office 365 oraz logowanie

  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 jako pary klucz/wartość do zawartości pliku, jak w przykładzie poniżej. 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. W tym samym katalogu, który zawiera plik binarny oprogramowania sprzęgającego, utwórz folder o nazwie logs.

  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. Uruchom oprogramowanie sprzęgające usługi SharePoint Online

W kolejnych krokach zmapujesz podmioty zabezpieczeń zarówno w Office 365, jak i w kolekcji witryny Dataplex na tożsamości w usłudze Cloud Identity. Synchronizacja jest przeprowadzana za pomocą oprogramowania sprzęgającego Office 365 Identity i oprogramowania sprzęgającego 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 oprogramowanie sprzęgające z SharePoint Online, aby indeksować i udostępniać 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 oprogramowanie sprzęgające tożsamości usługi 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 oprogramowanie sprzęgające usługi 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

Dokumentacja parametrów 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 skonfigurowany 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 dla kolekcji witryn Dataplex 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 zbieranie witryn sharepoint.siteCollectionOnly=true

Wymagane. W przypadku usługi 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 korzystania z SharePoint Online.
Tryb uwierzytelniania sharepoint.formsAuthenticationMode=LIVE

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

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

Mapowanie tożsamości Dataplex

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.
Referencyjne źródła tożsamości api.referenceIdentitySources=defaultIdentitySource

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

Wymagane. Identyfikator źródła tożsamości Cloud Search dla źródła tożsamości użytkowników i grup 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 medium wyszukiwania w treści HTML contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Rozdzielona przecinkami lista pól, które mają zostać 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.
Kolumny niezmapowane treści HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

Jak oprogramowanie sprzęgające obsługuje niezmapowane kolumny. Wartość to APPEND (domyślna) lub IGNORE.

  • DODATEK – oprogramowanie sprzęgające generuje treść HTML ze wszystkimi polami, również tymi, które nie mają określonego poziomu jakości (wysoki, średni lub niski).
  • IGNORE – oprogramowanie sprzęgające generuje treść HTML tylko z zmapowanymi polami.

Konfiguracja oprogramowania sprzęgającego 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 pasować do wartości `api.referenceIdentitySource.defaultIdentitySource.id` w konfiguracji oprogramowania sprzęgającego 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.

Najemca 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