Jira ONLYOFFICE 集成应用

此 应用程序 允许用户从 Jira Software 中使用 ONLYOFFICE 文档编辑办公文档。

该连接器可在官方 Atlassian Marketplace.中获得。

特性

• 目前，可以编辑以下文档格式：DOCX、XLSX、PPTX、DOCXF、OFORM。
• 以下格式可供查看：DOC、DOCM、DOC、DOTX、DOTM、ODT、FODT、OTT、RTF、TXT、HTML、HTM、MHT、PDF、DJVU、FB2、EPUB、XPS、XLS、XLSM、XLTZ、XLTX、XLTM、ODS、FODS、OTS、CSV、PPS、PPSX、PPSM、PPT、PPTM、POT、POTX、POTM、ODP、FODP、OTP。
• 该插件将在 Office 文档的文档库中创建一个新的菜单选项- 在ONLYOFFICE 中编辑。 这允许多个用户实时协作并将更改保存回 Jira。

安装 ONLYOFFICE 文档

您将需要一个 ONLYOFFICE 文档（文档服务器）实例，该实例可从 Jira 和任何最终客户端解析和连接。 如果不是这种情况，请使用官方 ONLYOFFICE 文档文档页面。 ONLYOFFICE 文档还必须能够直接发布到 Jira。

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

安装 Jira ONLYOFFICE 集成应用

将编译好的 target/onlyoffice-jira-app.jar 上传到 管理应用 页面的 Jira。

最新的编译包文件可在 此处 和 Atlassian Marketplace上获得。

您还可以从 Jira 管理面板安装该应用程序：

1. 导航到 管理应用程序 页面。
2. 单击左侧面板上的 查找新应用。
3. 使用搜索找到 适用于 Jira 的 ONLYOFFICE 连接器。
4. 单击 安装 以下载并安装该应用程序。

配置 Jira ONLYOFFICE 集成应用

在 管理应用 页面上找到上传的应用。单击 配置 并输入安装了 ONLYOFFICE 文档的服务器的名称：

http://documentserver/

其中 documentserver 是安装了 ONLYOFFICE 文档 的服务器的名称。 该地址必须可供用户浏览器和 Jira 服务器访问。 要正常工作,Jira 服务器地址也必须可以从 ONLYOFFICE 文档 访问。

从 7.2 版开始，默认情况下启用 JWT，并自动生成密钥以限制对 ONLYOFFICE 文档的访问，这也是出于安全原因和数据完整性考虑。 在 Jira 管理页面上指定您自己的密钥。 在 ONLYOFFICE 文档 配置文件中，指定相同的密钥并启用验证。

有时您的网络配置可能不允许使用公共地址在 Jira 和 ONLYOFFICE 文档之间进行请求。 高级服务器设置部分允许您为来自 Jira 的内部请求设置 ONLYOFFICE 文档地址， 以及为来自 ONLYOFFICE 文档的内部请求设置返回的 Jira 地址。

编译 Jira ONLYOFFICE 集成应用

如果您打算自己编译 Jira ONLYOFFICE 集成应用程序（例如编辑源代码并在之后编译它），请按照以下步骤操作：

1. 需要稳定的 Java 版本才能成功构建。 如果您没有安装它，请使用以下命令安装 Open JDK 8：

   sudo apt-get update sudo apt-get install openjdk-8-jdk
2. 安装 Atlassian Plugin SDK。此处描述了安装过程。
3. 编译包： atlas-package

使用 Jira ONLYOFFICE 集成应用

使用ONLYOFFICE集成应用程序，您可以在Jira仪表板内查看、编辑和合著附加到任务的office文件。

要编辑文档，请单击附件名称旁边的 ONLYOFFICE 文档图标 - 相应的在线编辑器将在新选项卡中打开。

编辑会话结束后，包含所有更改的文档将保存为新附件。 您将通过带有后缀的相同名称识别它。如果您正在协作编辑附件，则仅在最后一个用户退出编辑器后才会保存更改。

它是如何运作的

ONLYOFFICE 集成遵循此处的API文档。

1. 用户导航到 Jira 附件并选择 在 ONLYOFFICE 中编辑 操作。
2. Jira 向 OnlyOfficeEditorServlet 发出请求（表单的 URL：/plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. Jira 将文档发送到 ONLYOFFICE 文档存储服务并接收临时链接。

4. Jira 准备一个具有以下属性的 JSON 对象：该应用程序准备一个具有以下属性的 JSON 对象：

   • Url：ONLYOFFICE 文档用于下载文档的临时链接，
   • callbackUrl：ONLYOFFICE 文档通知文档编辑状态的 URL，
   • docserviceApiUrl：客户端需要回复ONLYOFFICE 文档的 URL（由 files.docservice.url.api 属性提供），
   • key：指示 ONLYOFFICE 文档是否再次下载文档的 UUID，
   • Title：文档标题（名称）。
5. Jira 获取此对象并从 freemarker 模板构造一个页面，填充所有这些值，以便客户端浏览器可以加载编辑器。
6. 客户端浏览器从 ONLYOFFICE 文档向 JavaScript 库发出请求，并向 ONLYOFFICE 文档发送具有上述属性的 DocEditor 配置。
7. 然后 ONLYOFFICE 文档从文档存储中下载文档，用户开始编辑。
8. 当所有用户和客户端浏览器都完成编辑后，他们会关闭编辑窗口。
9. 在 10 秒 不活动后，ONLYOFFICE 文档会向回调 URL 发送一个 POST，让 Jira 知道客户端已完成对文档的编辑并关闭它。
10. 包含所有更改的文档将保存为新附件，并在文件名中添加了后缀。

在 此处下载 Jira ONLYOFFICE 集成应用程序。