部署 Microsoft SharePoint Online 连接器

您可以设置 Google Cloud Search，使其除了返回 Google Workspace 内容之外，还返回贵组织的 SharePoint Online 内容。使用 Cloud Search SharePoint Online 连接器，并将其配置为访问特定的 SharePoint Online 数据源。

重要注意事项

在部署 SharePoint Online 连接器之前，请注意以下事项。

遵循的 SharePoint 设置

连接器始终遵循 SharePoint 上的搜索可见性设置。对于草稿文档，连接器用于访问 SharePoint Online 的用户账号的权限会控制连接器编入索引和返回哪些草稿文档。 如果账号仅具有“完全读取”权限，则连接器会遵循“草稿项可见性”设置。

您还可以配置连接器，以根据用户账号访问权限限制结果。 如需应用安全修剪，请将以下外部身份与 Google Cloud Directory 同步：

• Office 365 / Azure AD 用户。
• Office 365 / Azure AD 安全群组。
• SharePoint 群组（成员包括 Office 365 用户和群组）。

搜索优化

通过配置连接器来返回相关结果，从而改进搜索体验。使用配置文件中的 HTML 生成参数设置字段影响级别。

如需设置架构，请参阅创建和注册架构。 设置架构时：

• 连接器会将 SharePoint 内容类型标准化为有效的对象定义名称 (A-Z、a-z、0-9)。例如，“新闻文章”会变为“NewsArticle”。
• 如果连接器无法匹配对象定义，则会使用后备对象类型 (itemMetadata.objectType)。请参阅元数据配置参数。
• 连接器将 SharePoint 属性名称映射到属性定义。
• 连接器会替换 Microsoft Outlook .msg 文件的媒体类型，并将其以 application/vnd.ms-outlook 形式编入索引。

已知的连接器限制

• 每个连接器实例只能将单个网站集中的内容编入索引。 如需将多个网站集编入索引，请设置其他实例。
• ACL 中的唯一身份用户和群组数量越多，内存消耗就越大。
• 删除通知可能需要 4 小时以上才能生效。

系统要求

部署连接器

请按照以下步骤部署 SharePoint Online 连接器。

前提条件

1. 创建 Google Workspace 私钥。请参阅配置对 Cloud Search API 的访问权限。
2. 添加可供搜索的数据源并记录其 ID。请参阅添加可供搜索的数据源。
3. 对于基于 ACL 的结果，您的管理员必须创建两个身份源（一个用于 Office 365，一个用于 SharePoint 群组），并提供 Google Workspace 客户 ID。请参阅映射用户身份。
4. 为连接器设置一个具有 SharePoint Online 网站集管理员权限的用户账号。
5. 创建具有 Group.Read.All 和 User.Read.All 权限的 Azure Active Directory 应用凭据。记下应用 ID、租户和客户端密钥。

第 1 步：安装连接器软件

1. 克隆代码库：

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

2. 查看所选版本（例如 v1-0.0.3）：

   $ git checkout tags/v1-0.0.3

3. 构建连接器：

   $ mvn package

   如需跳过测试，请使用 mvn package -DskipTests。
4. 将 ZIP 文件解压缩到安装目录。

第 2 步：创建配置文件

在安装目录中创建 sharepoint-online-connector.config。以键值对的形式添加参数，如以下示例所示：

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

如需了解详情，请参阅参考文档或 Google 提供的参数。

第 3 步：设置日志记录

创建一个 logs 文件夹和一个包含以下内容的 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 身份连接器

如需应用基于身份的 ACL，请使用 api.customerId 和其他连接参数创建 sharepoint-online-identity-connector.config，如以下示例所示：

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

第 5 步：安装 Office 365 身份连接器

如果您使用的是基于 SharePoint Online 身份的 ACL，请执行此步骤。 如果您使用的是公共 ACL，请跳过此步骤。

1. 克隆 Office 365 代码库：

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

2. 使用 mvn package 签出并构建连接器。

3. 将 ZIP 文件解压缩到安装目录。

第 6 步：配置 Office 365 身份连接器

1. 在身份连接器安装目录中，创建一个名为 o365-identity-connector.config 的文件，并以键值对的形式添加参数：

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

   如需了解参数说明，请参阅 Office 365 身份连接器。

2. 在同一目录中，创建一个名为 logs 的文件夹。

3. 在同一目录中，创建一个名为 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 步：启动连接器

配置连接器后，运行它们以开始同步和编入索引。在各自的终端窗口中运行每个命令。

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 -jar google-cloudsearch-sharepoint-connector-v1-0.0.3.jar -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
   

配置参数参考

以下各部分列出了用于配置 SharePoint Online 连接器的配置参数。

数据源访问权限

SharePoint Online 访问权限

SharePoint 身份映射

HTML 内容生成

Office 365 身份连接器配置