Развертывание соединителя Microsoft SharePoint Online

Вы можете настроить Google Cloud Search для возврата результатов из контента SharePoint Online вашей организации в дополнение к контенту Google Workspace. Для этого используйте коннектор Google Cloud Search SharePoint Online и настройте его для доступа к определённому источнику данных SharePoint Online.

Важные соображения

Уважаемые настройки SharePoint

Коннектор Cloud Search SharePoint Online всегда учитывает настройку видимости поиска в SharePoint, которую невозможно переопределить. Для черновиков документов разрешения учётной записи пользователя (которую коннектор использует для доступа к SharePoint Online) определяют, какие черновики будут индексироваться и возвращаться. Если у учётной записи есть только разрешение «Полное чтение», коннектор учитывает настройки «Видимость элементов черновика» в SharePoint.

Вы также можете настроить коннектор для ограничения результатов на основе доступа к учётной записи пользователя. Чтобы применить фильтрацию по безопасности к контенту SharePoint, необходимо синхронизировать следующие внешние идентификаторы с каталогом Google:

Поисковая оптимизация

Вы можете улучшить пользовательский опыт, настроив коннектор для возврата более релевантных результатов поиска.

Чтобы использовать API, задайте значения параметров генерации HTML в файле конфигурации коннектора SharePoint Online. Эти параметры позволяют указать, какие поля оказывают большее или меньшее влияние на совпадения.

Чтобы настроить схему, следуйте инструкциям в разделе «Создание и регистрация схемы» . При настройке схемы:

  • Чтобы сопоставить имена типов контента SharePoint с соответствующими определениями объектов, коннектор нормализует имена типов контента, исключая неподдерживаемые символы. Для определений объектов API Cloud Search поддерживает только символы AZ, az и 0–9 в качестве допустимых символов. Например, тип контента «Объявления» сопоставляется с определением объекта «Объявления». Тип контента «Новостная статья» сопоставляется с «NewsArticle» (без пробелов).

  • Если коннектор не может сопоставить определение объекта с определением объекта, он использует резервный тип объекта ( itemMetadata.objectType ). Подробнее о параметрах конфигурации метаданных см . здесь.

  • Соединитель сопоставляет имена свойств SharePoint с определениями свойств.

  • Когда соединитель обнаруживает файлы Microsoft Outlook .msg при индексации содержимого, он переопределяет тип содержимого файлов и индексирует их как application/vnd.ms-outlook.

Известные ограничения разъема

  • Каждый экземпляр коннектора может индексировать контент только из одной коллекции сайтов. Для индексации нескольких коллекций сайтов настройте дополнительные экземпляры коннектора.
  • Потребление памяти увеличивается с количеством уникальных пользователей и групп, которые вы используете в списках контроля доступа для каждой коллекции сайтов.
  • Уведомления об удалении не приходят мгновенно, и коннектору может потребоваться более 4 часов, чтобы распознать, что пользователь удалил контент из исходного репозитория.

Системные требования

Системные требования
Операционная система
  • Windows Server 2016
  • Убунту
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10 (64-разрядная версия)
Аутентификация
  • Живая аутентификация
Программное обеспечение
  • Среда SharePoint Online
  • Java JRE 1.8, установленная на компьютере, на котором будет работать коннектор Google Cloud Search SharePoint Online.

Разверните соединитель

Предпосылки

  1. Создайте закрытый ключ Google Workspace, содержащий идентификатор вашей учётной записи сервиса. Чтобы узнать, как получить закрытый ключ, перейдите к разделу Настройка доступа к API Google Cloud Search .

  2. Администратор Google Workspace должен добавить источник данных для поиска . Запишите идентификатор источника данных.

  3. Если соединитель возвращает результаты на основе списков ACL (результаты не являются общедоступными), ваш администратор Google Workspace должен создать два источника удостоверений и предоставить вам их идентификаторы:

    • один для пользователей и групп Office 365
    • один для групп SharePoint

    Администратор также должен получить идентификатор клиента Google Workspace вашей организации и передать его вам.

    Узнайте, как получить эти значения в разделе Сопоставление идентификаторов пользователей в Cloud Search .

  4. Настройте учетную запись пользователя для соединителя, имеющую права администратора коллекции сайтов SharePoint Online.

  5. Если коннектор возвращает результаты на основе списков контроля доступа (результаты не являются общедоступными), создайте учётные данные для чтения пользователей и групп из вашей учётной записи Office 365. Следуйте инструкциям Microsoft по созданию приложения Azure Active Directory . При настройке приложения:

    1. Дайте приложению описательное имя, например, «gcs-o365-identity-connector».
    2. Добавьте разрешения. Приложению требуются права «Группа.Чтение.Все» и «Пользователь.Чтение.Все».
    3. Запишите следующую информацию для использования в конфигурации соединителя:
      • Идентификатор приложения
      • Жилец
      • Секрет клиента

Шаг 1. Установите программное обеспечение коннектора SharePoint Online

  1. Клонируйте репозиторий коннектора из GitHub.

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

  2. Проверьте желаемую версию коннектора:

    $ git checkout tags/v1-0.0.3

  3. Создайте соединитель.

    $ mvn package

    Чтобы пропустить тесты при сборке коннектора, выполните mvn package -DskipTests вместо mvn package .

  4. Скопируйте zip-файл соединителя в локальный каталог установки:

    $ 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

Шаг 2. Создайте файл конфигурации коннектора SharePoint Online

  1. В том же каталоге, где установлен коннектор, создайте новый файл и назовите его sharepoint-online-connector.config . Если вы планируете запустить несколько экземпляров коннектора, добавьте к имени дополнительные сведения, чтобы его можно было отличить.

  2. Добавьте параметры в виде пар ключ/значение к содержимому файла, как в следующем примере:

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

    Подробное описание каждого параметра см. в справочнике параметров конфигурации .

  3. (Необязательно) При необходимости настройте дополнительные параметры коннектора. Подробнее см. в разделе «Параметры коннектора, предоставляемые Google» .

Шаг 3. Настройте ведение журнала для коннектора SharePoint Online

  1. Создайте папку с именем logs в том же каталоге, где находится двоичный файл коннектора.

  2. Создайте в том же каталоге файл в кодировке Latin-1 с именем logging.properties и добавьте в него следующее содержимое:

    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

Шаг 4. Настройте соединитель удостоверений SharePoint Online

Этот шаг необходим для применения списков контроля доступа (ACL) SharePoint Online на основе удостоверений к результатам поиска. Если вы настроили коннектор с публичными списками контроля доступа (ACL), этот шаг можно пропустить.

  1. В том же каталоге, где установлена система SharePoint Online Connector, создайте новый файл и назовите его sharepoint-online-identity-connector.config .

  2. Добавьте параметры в виде пар ключ/значение к содержимому файла, как в следующем примере:

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

    Значения практически такие же, как для коннектора SharePoint Online, за исключением того, что вместо api.sourceId используется параметр api.customerId . Значение api.customerId — это идентификатор клиента, полученный от администратора Google Workspace.

Шаг 5. Установите соединитель удостоверений Office 365

Этот шаг необходим для применения списков контроля доступа (ACL) SharePoint Online на основе удостоверений к результатам поиска. Если вы настроили коннектор с публичными списками контроля доступа (ACL), этот шаг можно пропустить.

  1. Клонируйте репозиторий коннектора из GitHub.

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

  2. Проверьте желаемую версию коннектора: 

    $ git checkout tags/v1-0.0.3

  3. Создайте соединитель. 

    $ mvn package

    Чтобы пропустить тесты при сборке коннектора, выполните mvn package -DskipTests вместо mvn package .

  4. Скопируйте zip-файл соединителя в локальный каталог установки: 

    $ 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

Шаг 6. Настройте соединитель удостоверений Office 365 и ведение журнала.

  1. В том же каталоге, где установлена идентификационная модель соединителя, создайте новый файл и назовите его o365-identity-connector.config .

  2. Добавьте параметры в виде пар «ключ/значение» к содержимому файла, как показано в следующем примере. Примечание: все параметры обязательны для заполнения. 

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

    Подробное описание каждого параметра см. в справочнике по настройке соединителя удостоверений Office 365 .

  3. Создайте папку с именем logs в том же каталоге, где находится двоичный файл коннектора.

  4. Создайте файл ASCII или UTF-8 с именем logging.properties в том же каталоге и добавьте следующее содержимое: 

    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

Шаг 7. Запустите коннектор SharePoint Online.

На следующих этапах вы сопоставите субъекты в Office 365 и коллекции сайтов SharePoint с удостоверениями в службе Cloud Identity. Синхронизация выполняется с помощью коннектора удостоверений Office 365 и коннектора удостоверений SharePoint Online.

После синхронизации пользователей и групп коннектором Office 365 запустите коннектор удостоверений SharePoint Online для синхронизации групп семейства сайтов SharePoint. Затем запустите коннектор SharePoint Online для индексации и предоставления результатов пользователям Cloud Search.

  1. Запустите соединитель удостоверений 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. Запустите соединитель удостоверений 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. Запустите соединитель 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

Справочник параметров конфигурации

Доступ к источнику данных

Параметр Параметр
Идентификатор источника данных api.sourceId= 1234567890abcdef

Обязательно. Идентификатор источника данных Google Cloud Search, настроенный администратором Google Workspace.

Путь к файлу закрытого ключа учетной записи службы api.serviceAccountPrivateKeyFile= PrivateKey.json

Обязательно. Путь к файлу ключа учётной записи службы Google Cloud Search.

Доступ к SharePoint Online

Параметр Параметр
Полное доменное имя для коллекции сайтов SharePoint sharepoint.server= http://yoursharepoint.example.com/

Обязательно. Если доменное имя не полностью квалифицировано, установите переопределение DNS на хосте коннектора.

Режим «Только коллекция сайтов» sharepoint.siteCollectionOnly=true

Обязательно. Для SharePoint Online установите значение true .

Имя пользователя SharePoint sharepoint.username= username

Обязательно. Имя пользователя учётной записи, используемой для доступа к SharePoint Online.

пароль SharePoint sharepoint.password= user_password

Обязательно. Пароль учетной записи, используемой для доступа к SharePoint Online.

Режим аутентификации sharepoint.formsAuthenticationMode=LIVE

Обязательно. Для SharePoint Online значение всегда равно `LIVE`.

Тип развертывания sharepoint.deploymentType=ONLINE

Обязательно. Для SharePoint Online значение всегда «ONLINE».

Сопоставление удостоверений SharePoint

Параметр Параметр
Идентификатор источника идентичности api.identitySourceId= 1234567890abcdef

Обязательно. Идентификатор источника удостоверений Cloud Search для источника удостоверений групп SharePoint.

Источники справочной информации об идентичности api.referenceIdentitySources=defaultIdentitySource

Обязательно. Для SharePoint Online значение всегда равно `defaultIdentitySource`.

Идентификаторы источников справочной идентичности api.referenceIdentitySource.defaultIdentitySource.id= 112233abcd

Обязательно. Идентификатор источника удостоверений Cloud Search для пользователей и групп Office 365.

Генерация HTML-контента

Параметр Параметр
Поле заголовка HTML-шаблона contentTemplate.sharePointItem.title= Title

Поле SharePoint, которое будет использоваться в качестве заголовка HTML-шаблона для сгенерированного HTML.

Поля высокого качества поиска HTML-контента contentTemplate.sharePointItem.quality.high= highField1 [, highField2 ,...]

Список полей, разделённых запятыми, которые следует включить в сгенерированный HTML-код в качестве полей высокого качества. Если условия поискового запроса соответствуют этим полям, результаты ранжируются выше.

Поля среднего качества поиска HTML-контента contentTemplate.sharePointItem.quality.medium= mediumField1 [, mediumField2 ,...]

Список полей, разделенных запятыми, которые следует включить в сгенерированный HTML-код в качестве полей среднего качества.

Поля с низким качеством поиска по HTML-контенту contentTemplate.sharePointItem.quality.low= lowField1 [, lowField2 ,...]

Список полей, разделенных запятыми, которые следует включить в сгенерированный HTML как поля низкого качества.

Неотображенные столбцы содержимого HTML contentTemplate.sharepointItem.unmappedColumnsMode= APPEND

Как коннектор обрабатывает несопоставленные столбцы. Значение — APPEND (по умолчанию) или IGNORE.

  • APPEND — Соединитель генерирует HTML-контент со всеми полями, включая те, для которых не установлен уровень качества (высокий, средний или низкий).
  • ИГНОРИРОВАТЬ — Коннектор генерирует HTML-контент только с сопоставленными полями.

Конфигурация соединителя удостоверений Office 365

Параметр Параметр
Идентификатор источника идентичности api.identitySourceId= 1234567890abcdef

Обязательно. Идентификатор источника удостоверений Office 365. Это значение должно совпадать со значением `api.referenceIdentitySource.defaultIdentitySource.id` в конфигурации коннектора SharePoint Online.

Идентификатор клиента Google api.customerId= c1b1d1e1

Обязательно. Идентификатор клиента Google Workspace вашей организации.

Идентификатор приложения Office 365 o365.clientId= a63c6eb3-29e7-486

Обязательно. Идентификатор приложения из настроек приложения Office 365.

Арендатор Office 365 o365.tenant= 185ef9ed-29e7-486

Обязательно. Клиент для вашей учётной записи Office 365 (ваше приложение Azure Activity Directory).

Секрет клиента Office 365 o365.clientSecret= raHJN15vRLBKs

Обязательно. Секретные учётные данные из настройки приложения Office 365.