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

Możesz skonfigurować Google Cloud Search tak, aby oprócz treści Google Workspace zwracał wyniki z treści SharePoint Online Twojej organizacji. Użyj oprogramowania sprzęgającego Cloud Search SharePoint Online i skonfiguruj je tak, aby miało dostęp do konkretnego źródła danych SharePoint Online.

Istotne kwestie

Zanim wdrożysz oprogramowanie sprzęgające SharePoint Online, zapoznaj się z tymi kwestiami.

Ustawienia SharePoint

Oprogramowanie sprzęgające zawsze uwzględnia ustawienie Widoczność w wyszukiwarce w SharePoint. W przypadku dokumentów roboczych uprawnienia na koncie użytkownika, którego oprogramowanie sprzęgające używa do uzyskiwania dostępu do SharePoint Online, określają, które dokumenty robocze są indeksowane i zwracane. Jeśli konto ma tylko uprawnienia „Pełny odczyt”, oprogramowanie sprzęgające uwzględnia ustawienia „Widoczność elementu roboczego”.

Możesz też skonfigurować oprogramowanie sprzęgające tak, aby ograniczało wyniki na podstawie dostępu do konta użytkownika. Aby zastosować przycinanie zabezpieczeń, zsynchronizuj te tożsamości zewnętrzne z katalogiem Google Cloud:

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

Optymalizacja wyszukiwania

Popraw jakość wyszukiwania, konfigurując oprogramowanie sprzęgające tak, aby zwracało trafne wyniki. Aby ustawić poziomy wpływu pól, użyj parametrów generowania kodu HTML w pliku konfiguracji.

Aby skonfigurować schemat, przeczytaj artykuł Tworzenie schematu i rejestrowanie go. Podczas konfigurowania schematu:

  • Oprogramowanie sprzęgające normalizuje typy treści SharePoint do prawidłowych nazw definicji obiektów (A–Z, a–z, 0–9). Na przykład „News Article” (Artykuł) zmieni się na „NewsArticle”.
  • Jeśli oprogramowanie sprzęgające nie może dopasować definicji obiektu, używa rezerwowego typu obiektu (itemMetadata.objectType). Więcej informacji znajdziesz w sekcji Parametry konfiguracji metadanych.
  • Oprogramowanie sprzęgające mapuje nazwy właściwości SharePoint na definicje właściwości.
  • Oprogramowanie sprzęgające zastępuje typ MIME plików .msg Microsoft Outlook i indeksuje je jako application/vnd.ms-outlook.

Znane ograniczenia oprogramowania sprzęgającego

  • Każda instancja oprogramowania sprzęgającego indeksuje treści tylko z jednego zbioru witryn. Aby indeksować wiele zbiorów witryn, skonfiguruj dodatkowe instancje.
  • Zużycie pamięci wzrasta wraz z liczbą unikalnych użytkowników i grup w listach ACL.
  • Rozpowszechnianie powiadomień o usunięciu może potrwać ponad 4 godziny.

Wymagania systemowe

Wymagania systemowe
System operacyjny Windows Server 2016, Ubuntu, Red Hat Enterprise Linux 5.0 lub SUSE Enterprise Linux 10 (64-bitowy).
Uwierzytelnianie Uwierzytelnianie w czasie rzeczywistym.
Oprogramowanie Środowisko SharePoint Online; Java JRE 1.8.

Wdrażanie oprogramowania sprzęgającego

Aby wdrożyć oprogramowanie sprzęgające SharePoint Online, wykonaj te czynności.

Wymagania wstępne

  1. Utwórz klucz prywatny Google Workspace. Więcej informacji znajdziesz w artykule Konfigurowanie dostępu do Cloud Search API.
  2. Dodaj źródło danych do wyszukiwania i zapisz jego identyfikator. Więcej informacji znajdziesz w artykule Dodawanie źródła danych w Google Cloud Search.
  3. W przypadku wyników opartych na listach ACL administrator musi utworzyć 2 źródła tożsamości (jedno dla Office 365 i jedno dla grup SharePoint) oraz podać identyfikator klienta Google Workspace. Więcej informacji znajdziesz w artykule Mapowanie tożsamości użytkowników.
  4. Skonfiguruj konto użytkownika dla oprogramowania sprzęgającego z uprawnieniami administratora zbioru witryn SharePoint Online.
  5. Utwórz dane logowania do aplikacji Azure Active Directory z uprawnieniami Group.Read.All i User.Read.All. Zapisz identyfikator aplikacji, najemcę i tajny klucz klienta.

Krok 1. Zainstaluj oprogramowanie sprzęgające

  1. Sklonuj repozytorium: 
    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
$ cd sharepoint-connector
  2. Sprawdź wybraną wersję (np. v1-0.0.3): 
    $ git checkout tags/v1-0.0.3
  3. Utwórz oprogramowanie sprzęgające: 
    $ mvn package
     Aby pominąć testy, użyj polecenia mvn package -DskipTests.
  4. Rozpakuj plik ZIP do katalogu instalacyjnego.

Krok 2. Utwórz plik konfiguracji

W katalogu instalacyjnym utwórz plik sharepoint-online-connector.config. Dodaj parametry jako pary klucz-wartość, jak pokazano w tym przykładzie:

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

Szczegółowe informacje znajdziesz w dokumentacji lub w parametrach dostarczonych przez Google.

Krok 3. Skonfiguruj logowanie

Utwórz folder logs i plik logging.properties z tą treścią:

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

Aby zastosować listy ACL oparte na tożsamościach, utwórz plik sharepoint-online-identity-connector.config z parametrem api.customerId i innymi parametrami połączenia, jak w tym przykładzie:

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

Krok 5. Zainstaluj łącznik tożsamości Office 365

Jeśli używasz list ACL opartych na tożsamościach SharePoint Online, wykonaj ten krok. Jeśli używasz publicznych list ACL, pomiń ten krok.

  1. Sklonuj repozytorium Office 365:

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

  2. Sprawdź i utwórz oprogramowanie sprzęgające za pomocą polecenia mvn package.

  3. Rozpakuj plik ZIP do katalogu instalacyjnego.

Krok 6. Skonfiguruj łącznik tożsamości Office 365

  1. W tym samym katalogu co instalacja łącznika tożsamości utwórz plik o nazwie o365-identity-connector.config i dodaj parametry jako pary klucz-wartość:

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

    Opisy parametrów znajdziesz w sekcji Łącznik tożsamości Office 365.

  2. W tym samym katalogu utwórz folder o nazwie logs.

  3. W tym samym katalogu utwórz plik o nazwie logging.properties z tą treścią:

       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

Po skonfigurowaniu oprogramowania sprzęgającego uruchom je, aby rozpocząć synchronizację i indeksowanie. Każde polecenie uruchom w osobnym oknie terminala.

  1. Uruchom łącznik tożsamości Office 365, aby zsynchronizować użytkowników i grupy:

    $ 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, aby zsynchronizować grupy zbioru witryn:

    $ 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. Uruchom oprogramowanie sprzęgające SharePoint Online, aby indeksować treści:

    $ 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

W tych sekcjach znajdziesz listę parametrów konfiguracji używanych do konfigurowania oprogramowania sprzęgającego SharePoint Online.

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 zbioru witryn SharePoint sharepoint.server=http://yoursharepoint.example.com/

Wymagane. Jeśli nazwa domeny nie jest pełna i jednoznaczna, ustaw zastępowanie DNS na hoście oprogramowania sprzęgającego.
Tryb „Tylko zbiór 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 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ść to zawsze `LIVE`.
Typ wdrożenia sharepoint.deploymentType=ONLINE

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

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

Wymagane. W przypadku SharePoint Online wartość to zawsze `defaultIdentitySource`.
Identyfikatory referencyjnych ź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żytkowników i grup Office 365.

Generowanie treści HTML

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

Pole SharePoint, które ma być używane jako tytuł szablonu HTML dla wygenerowanego kodu HTML.
Pola treści HTML o wysokiej jakości wyszukiwania contentTemplate.sharePointItem.quality.high=highField1[,highField2,...]

Lista pól rozdzielona przecinkami, które mają być uwzględnione w wygenerowanym kodzie HTML jako pola wysokiej jakości. Gdy wyszukiwane hasła pasują do tych pól, wyniki są klasyfikowane wyżej.
Pola treści HTML o średniej jakości wyszukiwania contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

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

Lista pól rozdzielona przecinkami, które mają być uwzględnione w wygenerowanym kodzie HTML jako pola niskiej jakości.
Nieprzypisane kolumny treści HTML contentTemplate.sharepointItem.unmappedColumnsMode=APPEND

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

  • APPEND – oprogramowanie sprzęgające generuje treść HTML ze wszystkimi polami, w tym z tymi, które nie mają ustawionego poziomu jakości (wysoki, średni lub niski).
  • IGNORE – oprogramowanie sprzęgające generuje treść HTML tylko z przypisanymi 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ą `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 konta Office 365 (aplikacja Azure Activity Directory).
Tajny klucz klienta Office 365 o365.clientSecret=raHJN15vRLBKs

Wymagane. Tajny klucz danych logowania z konfiguracji aplikacji Office 365.