跳到主要内容

SharePoint 集成

该解决方案可让用户借助 ONLYOFFICE 文档在 SharePoint 中编辑办公文档。

功能特性​

  • 目前，可编辑的文档格式有：DOCX、XLSX、PPTX。
  • 仅支持查看的文档格式如下：PDF、DJVU、TXT、CSV、ODT、ODS、ODP、DOC、XLS、PPT、PPS、EPUB、RTF、HTML、HTM、MHT、XPS。
  • 该插件会在 Office 文档的文件上下文菜单和功能区中新增一个在 ONLYOFFICE 中编辑的菜单项。这支持多个用户实时协作，并将更改保存回 SharePoint。

安装 ONLYOFFICE 文档​

您需要一个 ONLYOFFICE 文档（文档服务器）实例，该实例必须能从 SharePoint 和任何终端客户端解析并连接。如果无法满足此要求，请参考官方 ONLYOFFICE 文档安装指南。ONLYOFFICE 文档还必须能够直接向 SharePoint 发送 POST 请求。

使用 Docker 是启动 ONLYOFFICE 文档实例的最简单方法。

安装 ONLYOFFICE SharePoint 集成解决方案​

要在 SharePoint 中使用 ONLYOFFICE 文档，必须执行以下步骤：

  1. 点击开始，指向所有程序，选择管理工具，然后点击服务。确保 SharePoint 管理服务已启动。

  2. 点击开始->SharePoint 管理外壳，进入包含 .wsp 文件的目录。

  3. 运行Install.ps1脚本：

    PS> .\Install.ps1

  4. 输入您的 SharePoint 网站地址：

    https://<yoursharepointsite>
    备注

    除了步骤3 和4，您也可以输入以下命令：

    Add-SPSolution -LiteralPath <SolutionPath>/onlyoffice.wsp

    在 SharePoint 中央管理主页上，点击系统设置->场管理->管理场解决方案。在解决方案管理页面，点击 onlyoffice.wsp->部署解决方案。

  5. 在 SharePoint 中央管理主页的应用程序管理下，点击管理 Web 应用程序。

  6. 确保选择了您的网站，然后点击身份验证提供程序图标。

  7. 在身份验证提供程序弹出窗口中，点击默认区域。

  8. 在编辑身份验证下，勾选启用匿名访问，然后点击保存。

  9. 返回 Web 应用程序管理，点击匿名策略图标。

  10. 在匿名访问限制下，选择您的区域，将权限设置为无 – 无策略，然后点击保存。

配置 SharePoint ONLYOFFICE 集成解决方案​

在 SharePoint 中，打开包含管理设置的 /_layouts/15/Onlyoffice/Settings.aspx页面。输入以下地址来连接 ONLYOFFICE 文档：

https://<documentserver>/

其中，文档服务器地址是安装了 ONLYOFFICE 文档的服务器名称，该地址必须能被用户浏览器和 SharePoint 服务器访问。SharePoint 服务器地址也必须能被 ONLYOFFICE 文档访问，以确保正常工作。您可以注册一个免费的 ONLYOFFICE 云，并使用其公共 IP 地址或公共 DNS，这些地址或 DNS 可以在云控制台的实例部分找到。

备注

请注意，如果您使用 SharePoint 设置了子网站，为确保功能正常，您需要为每个子网站额外配置 ONLYOFFICE 文档连接。进入每个子网站的设置，在相应字段中输入 ONLYOFFICE 文档地址。

从 7.2 版本开始，JWT 默认启用，并且会自动生成密钥，用于限制对 ONLYOFFICE 文档的访问，保障安全性和数据完整性。在 SharePoint 管理设置中指定您自己的密钥。在 ONLYOFFICE 文档配置文件中，指定相同的密钥并启用验证。

如果启用了 JWT 保护，由于 SharePoint 安全策略会阻止外部的 Authorization 标头，因此需要指定一个自定义标头名称。该标头也应在 ONLYOFFICE 文档的签名设置中指定。有关签名的更多信息，请参见这里。

编译 ONLYOFFICE SharePoint 集成解决方案​

编译 ONLYOFFICE SharePoint 集成解决方案有两种方法：

  1. 使用 MS Visual Studio：

    1. 进入 SharePoint 服务器，在 Visual Studio 中打开该项目。
    2. 在解决方案资源管理器中，打开项目的快捷菜单，然后选择发布。
    3. 在发布对话框中，选择发布到文件系统选项按钮。
    4. 点击发布按钮。发布过程完成后，将创建解决方案 .wsp 文件。
    5. 将生成的文件复制到包含 Install.ps1 文件的文件夹中（默认是 BuildAndInstall 文件夹）。

  2. 借助提供的 build.bat 文件：

    1. 进入 BuildAndInstall 文件夹。
    2. 运行build.bat文件。
    3. 生成的解决方案 .wsp 文件将被创建并放置在 BuildAndInstall 文件夹中。

工作原理​

ONLYOFFICE 集成遵循此处记录的 API 规范。

  1. 用户在 SharePoint 中导航到一个文档，然后在上下文菜单或功能区中选择在 ONLYOFFICE 中编辑操作。

  2. SharePoint 向编辑器页面发出请求（URL 格式为： /_layouts/15/Onlyoffice/editorPage.aspx?SPListItemId={ItemId}&SPListURLDir={ListUrlDir}&action=track）。

  3. SharePoint 准备一个包含以下属性的 JSON 对象：

    • url-ONLYOFFICE 文档用于下载文档的 URL；
    • callbackUrl-ONLYOFFICE 文档用于通知文档编辑状态的 URL；
    • DocumentServerHost-客户端需要回复给 ONLYOFFICE 文档的 URL（可在设置页面设置）；
    • Key-来自 SharePoint 的文件标识符；
    • FileName-文档标题（名称）；
    • CurrentUserId-用户标识；
    • CurrentUserName-用户名。

  4. SharePoint 构建一个页面，填充所有这些值，以便客户端浏览器可以加载编辑器。

  5. 客户端浏览器向 ONLYOFFICE 文档的 JavaScript 库发出请求，并将包含上述属性的 DocEditor 配置发送给 ONLYOFFICE 文档。

  6. 然后，ONLYOFFICE 文档从 SharePoint 下载文档，用户开始编辑。

  7. 当所有用户和客户端浏览器完成编辑后，他们关闭编辑窗口。

  8. 在10 秒无操作后，ONLYOFFICE 文档会向callbackUrl发送 POST 请求，告知 SharePoint ONLYOFFICE 解决方案客户端已完成文档编辑并关闭了它。

  9. SharePoint 下载文档的新版本，替换旧版本。

在此处下载 ONLYOFFICE SharePoint 集成解决方案。