部署 Microsoft SharePoint On-Prem 连接器

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

您可以设置 Google Cloud Search,使其从 Google Workspace 本地内容返回结果,而不仅仅是 Google Workspace 内容。 您可以使用 Google Cloud Search SharePoint On-Prem 连接器并将其配置为访问特定的 SharePoint 数据源。

重要注意事项

受认可的 SharePoint 设置

Cloud Search SharePoint On-Prem 连接器始终遵循 SharePoint 上的搜索可见性设置,此设置无法覆盖。对于草稿文档,用户帐号(连接器用于访问 SharePoint Online)的权限(这些权限)控制将哪些草稿文档编入索引和返回文档。如果帐号仅具有“完整读取”权限,则连接器会遵循 SharePoint 上的“草稿内容公开范围”设置。

您也可以将连接器配置为根据用户帐号访问权限来限制结果。您可以使用 Google 主帐号和外部主帐号来定义 ACL。如需对 SharePoint 内容应用安全调整,请将以下外部身份与 Google 目录同步:

  • Active Directory 用户
  • Active Directory 群组
  • SharePoint 本地群组(成员包括 Active Directory 用户和群组)

要同步 AD 用户和群组,请使用 Google Cloud Directory Sync,并启用身份映射群组。要同步 SharePoint 本地群组,请使用 SharePoint 身份连接器。

连接器还需要使用 AD 执行查询,以获取其他信息以同步主帐号。例如,借助 AD 查找,连接器可以执行以下操作:

  • 将网域群组的 SID 映射到相应的 sAMAccountName。
  • 将用户 sAMAccountName 映射到 SharePoint 本地群组成员资格的电子邮件地址。

搜索优化

您可以将连接器配置为返回更相关的搜索结果,从而改善用户体验。

要使用该 API,请在 SharePoint Online 连接器配置文件中设置 HTML 生成参数的值。通过这些参数,您可以设置哪些字段对匹配的影响程度更高或更低。

如需设置架构,请按照创建和注册架构中的说明操作。设置架构时:

  • 为了将 SharePoint 内容类型的名称映射到相应的对象定义,连接器会通过排除不受支持的字符来标准化内容类型名称。对于对象定义,Cloud Search API 仅支持 A-Z、a-z 和 0-9 作为有效字符。例如,内容类型“公告”对应着对象定义“通告”。内容类型“新闻报道”对应的是“新闻报道”(不含空格)。

  • 如果连接器无法将对象定义与对象定义匹配,则将使用后备对象类型 (itemMetadata.objectType)。详细了解元数据配置参数

  • 为了将 SharePoint 属性名称映射到属性定义,连接器对十六进制编码字符进行解码并移除“ows_”前缀,然后排除不受支持的字符(A-Z、a-z 和 0-9 之外的所有字符作为有效字符),从而将属性名称标准化。

Microsoft Outlook 邮件处理

如果连接器在将内容编入索引时遇到 Microsoft Outlook .msg 文件,它会替换此类文件的媒体类型,并将它们作为 application/vnd.ms-outlook. 编入索引

多租户配置

如果您的 SharePoint 是多租户部署,其中多个客户网站托管在同一个 Web 应用中,则您需要在配置文件中配置网站收集模式。在多租户部署中,您只会获得网站集的权限,而不能获取 SharePoint On-Prem 连接器要求的完整读取权限。

要启用网站收集模式,请执行以下操作:

  • 向连接器用户帐号授予网站集管理员权限。
  • 将连接器配置文件中的 sharepoint.server 设置为网站集网址,例如 http://sharepoint.example.com/sites/sitecollection。该网址无需与 SharePoint 使用完全相同的情况。
  • 将连接器配置文件中的 sharepoint.siteCollectionOnly 设置为 true

如果要在多租户环境中将多个网站集编入索引,则需要为每个网站集配置一个连接器实例。

已知的连接器限制

  • 连接器检测到数据库中的内容所花的时间会随着连接器监控的数据库数量而增加。
  • 内存消耗会随着您在每个网站集的 ACL 中使用的唯一用户和群组的数量而增加。
  • 您只能使用来自一个 Active Directory 网域的身份配置连接器。
  • 不支持某些常见的 Active Directory 和 Windows 主帐号,例如 EveryoneBUILTIN\UsersAll Authenticated Users
  • 删除通知不是即时的,并且连接器可能需要超过 4 个小时才能识别出用户在源代码库中删除了内容。

系统要求

系统要求
操作系统
  • Windows Server 2016
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10(64 位)
软件
  • SharePoint 服务器
    • SharePoint Server 2016
    • SharePoint Server 2013
  • 将运行 Google Cloud Search SharePoint On-Prem 连接器的计算机上的 Java JRE 1.8
身份验证
  • NTLM
  • Kerberos
  • HTTP 基本身份验证
  • ADFS

部署连接器

前提条件

  1. 创建包含您的服务帐号 ID 的 Google Workspace 私钥。如需了解如何获取私钥,请参阅配置对 Google Cloud Search REST API 的访问权限

  2. 您的 Google Workspace 管理员必须添加要搜索的数据源。记录数据源 ID。

  3. 如果连接器基于 ACL 返回结果(结果未公开),则您的 Google Workspace 管理员必须创建两个身份源并向您提供其 ID:

    • 一个用于同步 Active Directory 用户和群组的身份源。
    • 一个用于同步 SharePoint 本地群组的身份源

    管理员还必须获取贵单位的 Google Workspace 客户 ID 并提供给您。

    如需了解如何获取这些值,请参阅在 Cloud Search 中映射用户身份

  4. 为在用户政策中拥有 SharePoint Web 应用的完整读取权限的连接器设置用户帐号。

  5. 如果 SharePoint Web 应用没有根网站集,请创建一个。

  6. 如果网站集合已被写入锁定,请使用具有管理员权限的帐号登录 SharePoint 服务器并运行 PrepareWriteLockedSites.ps1 脚本。

  7. 如需获取数据源指标以通知连接器配置,请使用具有农场管理权限的帐号登录 SharePoint 服务器并运行 diagnose_sp.ps1

    输出结果会报告 Web 应用、文档和用户群组成员资格的数量。使用此信息来估算所需的连接器实例数量、内存要求和文档数。

第 1 步:安装 Google Cloud Search SharePoint On-Prem 连接器软件。

  1. 从 GitHub 克隆连接器代码库:

    $ git clone https://github.com/google-cloudsearch/sharepoint-connector.git
    $ cd sharepoint-connector
  2. 检出所需的连接器版本:

    $ git checkout tags/latest_version

    其中:latest_version = 一个值,例如 v1-0.0.5

  3. 构建该连接器。

    $ mvn package

    如需在构建连接器时跳过测试,请运行 mvn package -DskipTests 而不是 mvn package

  4. 将连接器 zip 文件复制到本地安装目录:

    $ cp target/google-cloudsearch-sharepoint-connector-latest_version.zip installation-dir
    $ cd installation-dir
    $ unzip google-cloudsearch-sharepoint-connector-latest_version.zip
    $ cd google-cloudsearch-sharepoint-connector-latest_version

第 2 步:创建 SharePoint On-Prem 连接器配置文件

  1. 在连接器安装所在的目录中,创建一个文件。Google 建议您将文件命名为 connector-config.properties,这样无需其他命令行参数即可运行连接器。如果您打算运行多个连接器实例,请在名称中添加详细信息进行区分。

  2. 将参数作为键值对添加到文件内容中,如以下示例所示:

    ### Sharepoint On-Prem Connector configuration ###
    
    # Required parameters for data source access
    api.sourceId=08ef8becd116faa4546b8ca2c84b2879
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint on-premises access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    
    # Optional parameters for schema mapping
    contentTemplate.sharepointItem.title=Title
    contentTemplate.sharepointItem.unmappedColumnsMode=APPEND
    

    有关每个参数的详细说明,请参阅配置参数参考文档

  3. (可选)根据需要配置其他连接器参数。如需了解详情,请转到 Google 提供的连接器参数

第 3 步:对于 HTTPS,请将 SharePoint 添加为受信任的主机

如果 SharePoint 配置为使用 HTTPS,请获取 SharePoint 证书,以将其添加为连接器的可信主机。

  1. 在将运行连接器的计算机上,打开浏览器并转至 SharePoint。

  2. 在随即打开的警告页面中,点击我了解此风险添加例外。该页面会显示“This Connection is Untrusted”消息,因为该证书是自签名证书,而非由受信任的证书授权机构签名。

  3. 点击查看按钮后,点击该按钮。

  4. 转到详细信息标签页,然后点击导出

  5. 将证书保存在连接器目录中,名称为 sharepoint.crt

  6. 点击关闭,然后点击取消以关闭窗口。

  7. 打开命令提示符,然后输入以下命令:

    $ keytool -importcert -keystore cacerts.jks -storepass changeit -file sharepoint.crt -alias sharepoint

    当看到“是否信任此证书?”的提示时,输入 yes

第 4 步:设置日志记录

  1. 在包含连接器二进制文件的目录中,创建一个名为 logs 的文件夹。

  2. 在同一目录(而非 logs)中,创建一个名为 logging.properties 的 Latin1 编码文件。

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

第 5 步:配置 SharePoint On-Prem 身份连接器

必须执行此步骤,才能将基于 SharePoint On-Prem 身份的 ACL 应用于搜索结果。如果您使用公共 ACL 设置连接器,则可以跳过此步骤。

  1. 在 SharePoint Online 连接器安装所在的目录中,创建一个文件,并将其命名为 sharepoint-onprem-identity-connector.config

  2. 将参数作为键值对添加到文件内容中,如以下示例所示:

    ### SharePoint On-prem identity connector configuration ###
    
    # Required parameters for data source access
    api.customerId=C05d3djk8
    api.serviceAccountPrivateKeyFile=service_account.json
    api.identitySourceId=08ef8becd116faa475de26d9b291fed9
    
    # Required parameters for SharePoint access
    sharepoint.server=http://sp-2016:32967/sites/doc-center-site-collection
    sharepoint.siteCollectionOnly=true
    sharepoint.username=contoso\\admin
    sharepoint.password=pa$sw0rd
    sharepoint.stripDomainInUserPrincipals=true
    
    # Required parameters for AD lookup
    adLookup.host=dc.contoso.com
    adLookup.username=contoso\\admin
    adLookup.password=pa$sw0rd
    api.referenceIdentitySources=CONTOSO,contoso
    api.referenceIdentitySource.contoso.id=08ef8becd116faa5d3783f8c5a80e5aa
    api.referenceIdentitySource.CONTOSO.id=08ef8becd116faa5d3783f8c5a80e5aa
    

    其值与 SharePoint On-Prem 连接器的值几乎相同,只是参数不是 api.sourceId,而是 api.customerIdapi.customerId 的值是从 Google Workspace 管理员那里获取的客户 ID。

第 6 步:启动 SharePoint On-Prem 连接器

在以下步骤中,您需要将本地 Active Directory 和 SharePoint 网站集中的主帐号映射到 Google Cloud Identity 服务中的身份。这种同步是通过 Google Cloud Directory Sync (GCDS) 和 SharePoint On-Prem 身份连接器完成的。

GCDS 同步用户和群组后,要同步 SharePoint 网站集群组,请运行 SharePoint On-Prem 身份连接器。最后,运行 SharePoing On-Prem 连接器,以将结果编入索引并提供给 Cloud Search 用户。

  1. 配置并运行 GCDS(如果您尚未配置并运行)。请务必启用身份映射群组

  2. 运行 SharePoint On-Prem 身份连接器:

    $ java -Djava.util.logging.config.file=logging.properties -cp "google-cloudsearch-sharepoint-connector-version.jar" com.google.enterprise.cloudsearch.sharepoint.SharePointIdentityConnector -Dconfig=sharepoint-onprem-identity-connector.config
  3. 运行 SharePoint On-Prem 连接器。使用命令语法保护 SharePoint 网站安全:

    • HTTP(不需要受信任的主机):

      $ java -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar
    • HTTPS(将 SharePoint 添加为受信任的主机):

      $ java -Djavax.net.ssl.trustStore=cacerts.jks -Djavax.net.ssl.trustStoreType=jks -Djavax.net.ssl.trustStorePassword=changeit -Djava.util.logging.config.file=logging.properties -jar google-cloudsearch-sharepoint-connector-v1-version.jar

配置参数参考

数据源访问权限

设置 参数
数据源 ID api.sourceId=1234567890abcdef

必需,由 Google Workspace 管理员设置的 Google Cloud Search 数据源 ID。

服务帐号私钥文件路径 api.serviceAccountPrivateKeyFile=PrivateKey.json

必需,Google Cloud Search 服务帐号密钥文件的路径。

SharePoint 本地访问权限

设置 参数
SharePoint 服务器网址 sharepoint.server=http://yoursharepoint.example.com/

必需,完全限定主机名的 SharePoint 服务器的网址,例如 http://yoursharepoint.example.com/。如果主机名不是完全限定的,您必须在连接器主机上设置 DNS 覆盖。

SharePoint 用户名 sharepoint.username=YOURDOMAIN\\ConnectorUser

在 Linux 上或不属于 SharePoint Server AD 网域的 Windows 计算机上运行连接器时,必须设置此参数。

SharePoint 密码 sharepoint.password=user_password

在 Linux 上或不属于 SharePoint Server AD 网域的 Windows 计算机上运行连接器时,必须设置此参数。

使用实时身份验证连接到 SharePoint sharepoint.username=AdaptorUser Live Authentication Id

sharepoint.password uS3R_passWoRD

sharepoint.formsAuthenticationMode=LIVE

使用 ADFS 身份验证连接到 SharePoint sharepoint.username=AdaptorUser@yourdomain.com

sharepoint.password=uS3R_passWoRD

sharepoint.sts.endpoint=https://adfs.example.com/adfs/services/trust/2005/usernamemixed

sharepoint.sts.realm=urn:myserver:sharepointhttps://yoursharepoint.example.com/_trust

sharepoint.formsAuthenticationMode=ADFS

网站集索引

设置 参数
索引类型 sharepoint.siteCollectionOnly=boolean

可选,多租户 SharePoint 部署除外(了解详情)。如果设置为 true,则将连接器索引 sharepoint.server 作为网站集而不是虚拟服务器。默认值为 null(自动检测)。

SharePoint 身份映射

设置 参数
身份源 ID api.identitySourceId=1234567890abcdef

必需,用于同步 SharePoint 本地群组的身份源 ID。Google Workspace 管理员设置的 Google Cloud Search 来源 ID,如添加要搜索的数据源中所述。

引用身份源 api.referenceIdentitySources=CONTOSO,contoso

活跃目录主帐号的引用身份源列表(以英文逗号分隔)。该值与参考 Active Directory 主帐号的 Active Directory NETBIOS 名称匹配。

引用身份源 ID api.referenceIdentitySource.DOMAIN.id=identity-source-id

必需,用于同步 Active Directory 主帐号的身份源 ID。

Active Directory 查询

设置 参数
Active Directory 主机 adLookup.host=host

必需,Active Directory 主机名,例如 dc.contoso.com 或 IP 地址。

Active Directory 查询端口 adLookup.port=port

可选。默认值为 389。SSL 使用 686。

Active Directory 查询方法 adLookup.method=value

(可选)默认值为“standard”。对于 HTTPS 连接,请设为“ssl”。

Active Directory 查询用户 adLookup.username=CONTOSO\user1

必需,有权执行 Active Directory 查询的用户。

Active Directory 查询密码 adLookup.password=password123

必需,adLookup.user 所指定用户的密码。

HTML 内容生成

设置 参数
HTML 模板标题字段 contentTemplate.sharePointItem.title=Title

用作生成的 HTML 的 HTML 模板标题的 SharePoint 字段。

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 内容,包括未设置质量级别(高、中或低)的字段。
  • IGNORE - 连接器生成只包含映射字段的 HTML 内容。