跳到主要内容

Confluence 集成

这个应用程序允许用户在 Confluence 中使用 ONLYOFFICE 文档直接编辑办公文档。

该连接器可在官方的 Atlassian 应用市场获取。

功能特性​

  • 目前,支持编辑的文档格式有:DOCM、DOCX、DOTM、DOTX、XLSB、XLSM、XLSX、XLTM、XLTX、POTM、POTX、PPSM、PPSX、PPTM、PPTX、PDF。
  • 以下格式仅支持查看:DOC、DOT、EPUB、FB2、FODT、HTM、HTML、HWP、HWPX、MD、MHT、MHTML、ODT、OTT、PAGES、RTF、STW、SXW、TXT、WPS、WPT、XML、CSV、ET、ETT、FODS、NUMBERS、ODS、OTS、SXC、XLS、XLT、DPS、DPT、FODP、KEY、ODG、ODP、OTP、POT、PPS、PPT、SXI、DJVU、OXPS、XPS、VSDM、VSDX、VSSM、VSSX、VSTM、VSTX。
  • 该应用程序将在 Office 文档的文档库中创建一个新的在 ONLYOFFICE 中编辑菜单选项。这使多个用户能够实时协作,并将更改保存回 Confluence。
  • 以下文档格式可转换为 OOXML:DOC、DOCM、DOCX、DOT、DOTM、DOTX、EPUB、FB2、FODT、HTM、HTML、HWP、HWPX、MD、MHT、MHTML、ODT、OTT、PAGES、RTF、STW、SXW、TXT、WPS、WPT、XML、CSV、ET、ETT、FODS、NUMBERS、ODS、OTS、SXC、XLS、XLSB、XLSM、XLSX、XLT、XLTM、XLTX、DPS、DPT、FODP、KEY、ODG、ODP、OTP、POT、POTM、POTX、PPS、PPSM、PPSX、PPT、PPTM、PPTX、SXI、OXPS、PDF、XPS。

安装 ONLYOFFICE 文档​

您需要有一个 ONLYOFFICE 文档(文档服务器)实例,该实例必须能从 Confluence 和任何终端客户端解析并连接。如果无法满足此条件,请使用官方的 ONLYOFFICE 文档安装指南。ONLYOFFICE 文档还必须能够直接向 Confluence 发送 POST 请求。

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

安装 Confluence ONLYOFFICE 集成应用程序​

在 Confluence 的管理插件页面上传已编译的target/onlyoffice-confluence-plugin.jar文件。

最新的编译包文件可在这里以及 Atlassian 应用市场获取。

您也可以从 Confluence 管理面板安装该应用程序:

  1. 以管理员身份登录您的 Confluence 实例。
  2. 导航至管理插件页面。
  3. 点击左侧面板中的查找新应用程序或查找新插件。
  4. 通过搜索找到 ONLYOFFICE Connector for Confluence。搜索结果将包含与您的 Confluence 实例兼容的插件版本。
  5. 点击安装以下载并安装该应用程序。
  6. 现在您可以在已安装并准备就绪对话框中点击关闭。

配置 Confluence ONLYOFFICE 集成应用程序​

在管理插件页面找到已上传的 ONLYOFFICE Connector for Confluence。点击配置,然后输入安装了 ONLYOFFICE 文档的服务器名称:

https://<documentserver>/

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

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

编译 Confluence ONLYOFFICE 集成应用程序​

如果您计划自行编译 Confluence ONLYOFFICE 集成应用程序(例如,编辑源代码然后进行编译),请按照以下步骤操作:

  1. 成功编译需要稳定的 Java 版本。如果未安装,可使用以下命令安装 Open JDK 8:

    sudo apt-get update
    sudo apt-get install openjdk-8-jdk
  2. 安装 Atlassian 插件软件开发工具包(SDK)。安装过程可参考这里。

  3. 获取子模块:

    git submodule update --init --recursive
  4. 编译软件包:

    atlas-package

工作原理​

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

  1. 用户导航至 Confluence 附件并选择在 ONLYOFFICE 中编辑操作。

  2. Confluence 向 OnlyOfficeEditorServlet 发出请求(URL 格式为:/plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id)。

  3. Confluence 将文档发送到 ONLYOFFICE 文档存储服务,并接收一个临时链接。

  4. Confluence 准备一个包含以下属性的 JSON 对象:

    • url:ONLYOFFICE 文档用于下载文档的临时链接;
    • callbackUrl:ONLYOFFICE 文档用于通知文档编辑状态的 URL;
    • docserviceApiUrl:客户端需要回复给 ONLYOFFICE 文档的 URL(由files.docservice.url.api属性提供);
    • key:用于指示 ONLYOFFICE 文档是否需要重新下载文档的 UUID;
    • title:文档标题(名称)。
  5. Confluence 获取该对象,并从freemarker模板构建一个页面,填充所有这些值,以便客户端浏览器可以加载编辑器。

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

  7. 然后,ONLYOFFICE 文档从 Confluence 下载文档,用户开始编辑。

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

  9. 在10 秒无操作后,ONLYOFFICE 文档向callbackUrl发送 POST 请求,告知 Confluence 客户端已完成文档编辑并关闭了窗口。

  10. Confluence 下载文档的新版本,替换旧版本。

在此处下载 Confluence ONLYOFFICE 集成应用程序:这里。