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

Możesz skonfigurować Google Cloud Search tak, aby oprócz treści z Google Workspace zwracało wyniki z zasobów SharePoint Online Twojej organizacji. Użyjesz oprogramowania sprzęgającego Google Cloud Search z SharePoint Online i skonfigurujesz je pod kątem dostępu do określonego źródła danych usługi SharePoint Online.

Ważne informacje

Uznawane ustawienia SharePoint

Oprogramowanie sprzęgające Cloud Search z SharePoint Online zawsze obsługuje ustawienie Widoczność przy wyszukiwaniu w usłudze SharePoint, którego nie można zastąpić. W przypadku wersji roboczych dokumentów uprawnienia konta użytkownika (używanego 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 odczyt”, oprogramowanie sprzęgające uwzględnia ustawienia widoczności elementów roboczych w SharePoint.

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

  • Użytkownicy Office 365 i Azure AD
  • Grupy zabezpieczeń Office 365 i Azure AD
  • Grupy SharePoint (z użytkownikami i grupami Office 365)

Optymalizacja wyszukiwania

Możesz zwiększyć komfort użytkowników, konfigurując oprogramowanie sprzęgające tak, aby zwracało trafniejsze wyniki wyszukiwania.

Aby korzystać z interfejsu API, ustaw wartości parametrów generowania kodu HTML w pliku konfiguracji oprogramowania sprzęgającego z SharePoint Online. Dzięki tym parametrom możesz określać, 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:

  • Aby zmapować nazwy typów treści SharePoint na odpowiadające im definicje obiektów, oprogramowanie sprzęgające normalizuje nazwy typów treści, wykluczając nieobsługiwane znaki. W przypadku definicji obiektów interfejs Cloud Search API obsługuje tylko prawidłowe znaki 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ł wiadomości” jest mapowany na wartość „NewsArticle” (bez spacji).

  • Gdy oprogramowanie sprzęgające nie może dopasować definicji obiektu do definicji obiektu, użyje on zastępczego typu obiektu (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 programie Microsoft Outlook podczas indeksowania treści, zastępuje typ treści tych plików i indeksuje je jako application/vnd.ms-outlook.

Ograniczenia znanego oprogramowania sprzęgającego

  • Każda instancja oprogramowania sprzęgającego może indeksować treści tylko z jednego zbioru witryn. Aby indeksować wiele kolekcji witryn, skonfiguruj dodatkowe instancje oprogramowania sprzęgającego.
  • Wykorzystanie pamięci wzrasta wraz z liczbą unikalnych użytkowników i grup używanych na listach kontroli dostępu (ACL) dla każdego zbioru witryn.
  • Powiadomienia o usunięciu nie są natychmiastowe i może minąć ponad 4 godziny, zanim oprogramowanie sprzęgające rozpozna, że użytkownik usunął treści z repozytorium źródłowego.

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 usługi SharePoint Online
  • Oprogramowanie Java JRE 1.8 zainstalowane na komputerze, na którym będzie działać oprogramowanie sprzęgające usługi SharePoint Online w Google Cloud Search

Wdrażanie oprogramowania sprzęgającego

Wymagania wstępne

  1. Utwórz klucz prywatny Google Workspace zawierający identyfikator konta usługi. Informacje o tym, jak uzyskać klucz prywatny, znajdziesz w artykule Konfigurowanie dostępu do interfejsu Google Cloud Search API.

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

    • jedna dla użytkowników i grup Office 365
    • jedna dla grup SharePoint

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

    Dowiedz się, jak uzyskać te wartości, w artykule Mapowanie tożsamości użytkowników w Cloud Search.

  4. Skonfiguruj konto użytkownika dla oprogramowania sprzęgającego, które ma uprawnienia administratora kolekcji witryn SharePoint 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 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 wymaga „Group.Read.All” i „User.Read.All”.
    3. Zapisz te informacje, aby użyć ich w konfiguracji oprogramowania sprzęgającego:
      • Identyfikator aplikacji
      • Najemca
      • Tajny klucz klienta

Krok 1. Zainstaluj oprogramowanie sprzęgające z programem 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 polecenie 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 co instalacja oprogramowania sprzęgającego utwórz nowy plik i nazwij go sharepoint-online-connector.config. Jeśli planujesz uruchomić wiele instancji oprogramowania sprzęgającego, dodaj do nazwy więcej szczegółów, aby je odróż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) W razie potrzeby skonfiguruj dodatkowe parametry oprogramowania sprzęgającego. Szczegółowe informacje znajdziesz w artykule Parametry oprogramowania sprzęgającego dostarczone przez Google.

Krok 3. Konfigurowanie logowania dla oprogramowania sprzęgającego usługi SharePoint Online

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

  2. W tym samym katalogu utwórz plik zakodowany alfabetem łacińskim 1 o nazwie logging.properties i dodaj do niego 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 do zastosowania do wyników wyszukiwania list kontroli dostępu opartych na tożsamości 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 co instalacja oprogramowania sprzęgającego 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 wyjątkiem tego, że zamiast api.sourceId parametr ma wartość api.customerId. Wartość api.customerId to identyfikator klienta otrzymany od administratora Google Workspace.

Krok 5. Instalowanie oprogramowania sprzęgającego Office 365 Identity

Ten krok jest wymagany do zastosowania do wyników wyszukiwania list kontroli dostępu opartych na tożsamości 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 polecenie 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 oprogramowania sprzęgającego usługi Office 365 Identity i rejestrowania

  1. W tym samym katalogu, w którym znajduje się instalacja oprogramowania sprzęgającego tożsamości, utwórz nowy plik i nazwij go o365-identity-connector.config.

  2. Dodaj parametry w postaci par 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 materiałach dotyczących konfiguracji oprogramowania sprzęgającego Office 365 Identity (w języku angielskim).

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

  4. W tym samym katalogu utwórz plik ASCII lub UTF-8 o nazwie logging.properties i dodaj do niego 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 oprogramowania sprzęgającego SharePoint Online

W poniższych krokach mapujesz podmioty zabezpieczeń zarówno w Office 365, jak i w kolekcji witryn SharePoint na tożsamości w usłudze Cloud Identity. Ta synchronizacja jest przeprowadzana z oprogramowaniem sprzęgającym Identity Office 365 i oprogramowaniem sprzęgającym tożsamości SharePoint Online.

Gdy oprogramowanie sprzęgające Office 365 zsynchronizuje użytkowników i grupy, uruchom łącznik tożsamości SharePoint Online, aby zsynchronizować grupy kolekcji witryn SharePoint. Następnie uruchomisz oprogramowanie sprzęgające z SharePoint Online, aby zindeksować i udostępnić 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 oprogramowanie sprzęgające 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

Odniesienie do parametrów konfiguracji

Dostęp do źródła danych

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

To pole jest 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

To pole jest wymagane. Ścieżka do pliku klucza konta usługi Google Cloud Search.

Dostęp online do usługi SharePoint Online

lokalizacji, Parametr
Pełna i jednoznaczna nazwa domeny dla zbioru witryn SharePoint sharepoint.server=http://yoursharepoint.example.com/

To pole jest 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

To pole jest wymagane. W przypadku usługi SharePoint Online ustaw wartość true.

Nazwa użytkownika programu SharePoint sharepoint.username=username

To pole jest wymagane. Nazwa użytkownika konta używanego do uzyskiwania dostępu do usługi SharePoint Online.

Hasło programu SharePoint sharepoint.password=user_password

To pole jest wymagane. Hasło do konta używanego do uzyskiwania dostępu do usługi SharePoint Online.

Tryb uwierzytelniania sharepoint.formsAuthenticationMode=LIVE

To pole jest wymagane. W przypadku usługi SharePoint Online wartość to zawsze „LIVE”.

Typ wdrożenia sharepoint.deploymentType=ONLINE

To pole jest wymagane. W przypadku usługi SharePoint Online wartość to zawsze „ONLINE”.

Mapowanie tożsamości usługi SharePoint

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

To pole jest wymagane. Identyfikator źródła tożsamości Cloud Search dla źródła tożsamości grup SharePoint.

Odnośne źródła tożsamości api.referenceIdentitySources=defaultIdentitySource

To pole jest wymagane. W przypadku pola SharePoint Online wartość to zawsze „defaultIdentitySource”.

Odwołania do identyfikatorów źródeł tożsamości api.referenceIdentitySource.defaultIdentitySource.id=112233abcd

To pole jest 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

lokalizacji, 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,...]

Rozdzielona przecinkami lista pól, które należy uwzględnić w wygenerowanym kodzie HTML jako pola wysokiej jakości. Gdy wyszukiwane hasła pasują do tych pól, wyniki otrzymują wyższą pozycję w rankingu.

Pola jakości wyszukiwania w medium treści HTML contentTemplate.sharePointItem.quality.medium=mediumField1[,mediumField2,...]

Rozdzielona przecinkami lista pól do uwzględnienia w wygenerowanym kodzie HTML jako pól średniej jakości.

Pola treści HTML o niskiej jakości wyszukiwania 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 niezmapowanych kolumn przez oprogramowanie sprzęgające. Wartość to APPEND (domyślna) lub IGNORE.

  • APPEND – oprogramowanie sprzęgające generuje treść w języku HTML ze wszystkimi polami, także tymi, które nie mają ustawionego poziomu jakości (wysoki, średni lub niski).
  • IGNORE – oprogramowanie sprzęgające generuje treść w języku HTML tylko z zmapowanymi polami.

Konfiguracja oprogramowania sprzęgającego tożsamości Office 365

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

To pole jest 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

To pole jest wymagane. Identyfikator klienta Google Workspace Twojej organizacji.

Identyfikator aplikacji Office 365 o365.clientId=a63c6eb3-29e7-486

To pole jest wymagane. Identyfikator aplikacji z konfiguracji aplikacji Office 365.

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

To pole jest wymagane. Najemca konta Office 365 (aplikacja katalogu aktywności Azure)

Klucz klienta Office 365 o365.clientSecret=raHJN15vRLBKs

To pole jest wymagane. Obiekt tajny danych logowania z konfiguracji aplikacji Office 365