ONLYOFFICE Docs 如何与 Alfresco 连接集成

关于 ONLYOFFICE 和 Alfresco 的集成
- 主要功能特征
- 支持的格式
- 6.0.0 版新特性
ONLYOFFICE Docs 与 Alfresco 连接集成
- 需求依赖项
- 安装 ONLYOFFICE 和 Alfresco Module 包
- 配置 ONLYOFFICE 和 Alfresco Module 包
- 为 ONLYOFFICE 和 Alfresco 的连接开启 JWT 功能
- 连接示例 ONLYOFFICE Docs
开始使用 ONLYOFFICE Docs 与 Alfresco 的集成功能

关于 ONLYOFFICE 和 Alfresco 的集成

ONLYOFFICE 提供一个官方的连接器，可以把 ONLYOFFICE Docs 和 Alfresco 连接集成起来，在文档库中创建、编辑以及转换办公文档。你可以从官方Alfresco 插件库[1]或ONLYOFFICE 的 GitHub 页面[2]下载。

注解：关于 ONLYOFICE 和 Alfresco 连接集成的底层工作原理细节请参考API 文档[3]

主要功能特征

创建、编辑、查看文档、表格和幻灯片
转换文件格式
实时协作处理文档：两种协作模式，快速模式和严格模式，跟踪文档变化、批注、内建聊天功能
JWT 支持，加密通信，赋予访问权限的用户之外，禁止任何其他人访问文档。

支持的格式

创建、编辑和阅览功能支持的格式：DOCX、PPTX、XLSX
处理表单的格式：OFORM、DOCXF
格式转换支持的格式：ODT、ODP、ODS、DOC、XLS、PPT、RTF
通过转换为 OOXML 格式来编辑的格式：ODP、ODS、ODT、RTF、CSV、TXT
阅读支持的格式：PDF

6.0.0 版新特性

功能增加：

文档编辑器里创建新文件
文档编辑器从文档模板创建新文件
文档管理器里增加了“下载”功能
与存储的文档比较
从存储合并邮件
从存储区插入图像
增加了文件改变历史功能，高亮显示不同版本的修改细节
自定义文档编辑器视图画面
从文档编辑器中标记为收藏
文档编辑器增加了 goBack 返回 url 连接的功能
编辑器根据文档类型改变显示图标
检测手机浏览器
加利西亚文的文件模板

功能修订：

在文档属性详细页面加载预览
CONTRIBUTOR 贡献者权限的用户无法加入编辑的 bug 已被修复
Document Server 文档服务器的 v6.0 以前版本不再支持

完整的升级说明文档见这里[4]

ONLYOFFICE Docs 与 Alfresco 连接集成

需求依赖项

ONLYOFFICE Document Server 文档服务器 v7.1 以上版本需要一个已经安装部署好的文档服务器，可以被 Alfresco 以及其它任意客户端解析访问，且文档服务器可以向 Alfresco 服务器发起 POST

注解：关于如何安装 ONLYOFFICE Docs 可以参考官方文档[5]

Alfresco v5.2 - 7.2
ONLYOFFICE Connector 连接器 v6.0.0

安装 ONLYOFFICE 和 Alfresco Module 包

可以在GitHub 上下载最新的已编译的安装包[6]，你需要 onlyoffice-integration-repo.jar和 onlyoffice-integration-share.jar文件。如果想要自行从源码编译安装该模块，例如修改源代码，请参考开发指南[7]

在 repo和 share路径下载已编译的安装包

cd onlyoffice-alfresco/
mvn clean install

上传已编译的*.jar 文件至 alfresco 服务器的相对应路径中
- 从 onlyoffice-alfresco/repo/target/到 /webapps/alfresco/WEB-INF/lib/
- 从 onlyoffice-alfresco/share/target/到 /webapps/share/WEB-INF/lib/
可选操作，因为 Alfresco 和共享功能被部署为两个不同的网络服务，修改编辑配置文件alfresco-global.properties，设定主机地址、端口、协议

alfresco.host=<hostname>
alfresco.port=443
alfresco.protocol=httpsshare.host=<hostname>
share.port=443
share.protocol=https

重启 Alfresco 服务器

sudo ./alfresco.sh stop
sudo ./alfresco.sh start

检查该模块是否出现在列表 /share/page/console/admin-console/module-package中

配置 ONLYOFFICE 和 Alfresco Module 包

找到Alfresco Administration Console管理面板，打开 http://<alfrescohost>/alfresco/s/onlyoffice/onlyoffice-config设定下列参数。

Document Server 文档服务器设置：

Document Editing Service address文档服务器地址：输入文档服务器的 URL 地址
Secret Key密钥：设定加密数据传输的密钥，更多细节请参考本文的启用 ONLYOFFICE 和 Alfresco 集成的 JWT 功能[8]

高级服务器设置：

Document Editing Service address for internal requests from the Alfresco server：Alfresco 服务器内部访问文档服务器的地址。
Alfresco server address for internal requests from the Document Editing Service：文档服务器内部访问 Alfresco 服务器的地址。

一般设置：

Ignore SSL Certificate：关闭 SSL 安全连接功能
Enable Force Save：开启强制保存，这样当点击保存按钮后，就会保存进入 Alfresco 的存储，而关闭该选项则只是保存在编辑器的缓存中，直到关闭编辑器再保存进 Alfresco 的存储中。
Save docx, xlsx, pptx as a new version of the original file after conversion：文件格式转换后，docx、xlsx、pptx 保存为旧格式文件的新版本，而关闭该选项则会在文件所在的文件夹内创建一个新的独立文件。
Open the file for editing：允许系统管理员选择哪些文件格式可以通过转换为 OOXML 格式来支持编辑功能。

配置界面

为 ONLYOFFICE 和 Alfresco 的连接开启 JWT 功能

为了保护文档不受未授权的访问，ONLYOFFICE 编辑器使用 JSON Web Token 网络令牌 JWT 技术，在文档编辑器初始化时这个token令牌加入到配置中，贯穿于 ONLYOFFICE 文档服务进程的数据传输全过程，secret key密钥用来签署 JSON 网络令牌，验证请求文档服务的合法性。

为保护文档，需要在 ONLYOFFICE Docs 配置文件中开启令牌验证并且设定自己的密钥，在连接器设置中输入该密钥。

第一步：配置 ONLYOFFICE Docs

使用任意编辑器打开编辑 local.json文件
- Linux 系统下：/etc/onlyoffice/documentserver/local.json
- Wndows 系统下：%ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
- Docker 方式：进入 ONLYOFFICE Docs 容器：
```
docker exec -it <containerID> bash
```
  打开文件 /etc/onlyoffice/documentserver/local.json
开启令牌验证功能，把下面三个条目从 false改为 true
- services.CoAuthoring.token.enable.browser
- services.CoAuthoring.token.enable.request.inbox
- services.CoAuthoring.token.enable.request.outbox
设定自己的密钥，替换下面三个条目中密钥值，这三者必须保持一致
- services.CoAuthoring.token.enable.request.outbox
- services.CoAuthoring.secret.outbox.string
- services.CoAuthoring.secret.session.string

{"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}
}

保存修改
重启服务使修改生效：

supervisorctl restart all

第二步：在连接器的设置中设定同样的密钥在连接器的设置里，在Secret key中设定同样的密钥，保存。

连接示例 ONLYOFFICE Docs

从 ONLYOFFICE 连接器 v5.0.0 版本开始，可以在安装自己的 ONLYOFFICE Docs 之前免费试用连接在线版本的 ONLYOFFICE 编辑器。

选中Connect to demo ONLYOFFICE Document Server连接示例 ONLYOFFICE Document 服务器选择框，点击save保存按钮。

注解：这是一个公开的测试服务器，仅有 30 天试用期，不要分享敏感保密信息。

开始使用 ONLYOFFICE Docs 与 Alfresco 的集成功能

新建文档：

打开一个文件夹
点击Create...新建按钮
选择文件类型：文档、表格或幻灯片

新建文档

编辑或阅览一个文档：

找到需要打开的文档
点击Edit in ONLYOFFICE在 ONLYOFFICE 中编辑按钮。

编辑文档

把一个非 XML 文档转换为 XML 格式（docx、xlsx、pptx）

找到需要转换格式的文档
点击Convert using ONLYOFFICE使用 ONLYOFFICE 转换按钮文档会被自动转换为 XML 格式，保存在原文件夹中，可以配置针对一个文件夹的自动转换规则，更多细节请参考官方 Alfresco 文档[9]

格式转换

下载文件为指定格式

找到需要下载的文件
点击Download as...下载为按钮，选择所需要的格式

下载为

查看文件修改历史：

点击文件名或图标，打开文件属性信息
在右侧面板中找到Version History版本历史
可用的区域是：最新版本和以往版本，文件的改变高亮显示
上传新版本请点击右上角对应的图标
快速查看当前版本，将光标移动到文件上，对应的版本号将自动显示在文件名右侧，例如 1.0

文件历史版本

或

在文档编辑器中打开File文件子菜单
在子菜单中选择Version History文件历史选项

在文档编辑器中新建文件：

打开File文件子菜单
点击Create New新建选项

一个新的 .docx文件创建在新的标签页。

创建自定义模板：

用创建 Alfresco 的管理员账号登陆
依次打开My files -> Data Dictionary -> Node Templates
添加自定义模板，格式为：.docx、.xlsx、.pptx

自定义模板

从模板新建文件：

进入一个需要新建文档的文件夹
点击Create...新建按钮
选择Create document from template从模板新建文件，选择所需的模板

从模板新建文件

或

在编辑器中打开File文件子菜单
点击Create New新建选项
选择所需的模板

从模板新建文件

学习如何与存储中的文件做对比，请参考这篇文档[10]

文件对比

学习如何与存储中的文件进行邮件合并，请参考这篇文档[11]

邮件合并

学习如何从存储插入图片，请参考这篇文档[12]

从存储插入图片

学习如何在编辑器中将文件加入收藏，请参考这篇文档[13]

加入收藏

ONLYOFFICE如何与Alfresco Share连接集成

参考资料

[1]

Alfresco 插件库: https://hub.alfresco.com/t5/alfresco-content-services-add/onlyoffice-connector-for-alfresco/m-p/291397

[2]

ONLYOFFICE 的 GitHub 页面: https://github.com/ONLYOFFICE/onlyoffice-alfresco

[3]

API 文档: https://api.onlyoffice.com/editors/alfresco

[4]

升级说明文档见这里: https://github.com/ONLYOFFICE/onlyoffice-alfresco/blob/master/CHANGELOG.md

[5]

官方文档: https://helpcenter.onlyoffice.com/installation/docs-index.aspx

[6]

GitHub 上下载最新的已编译的安装包: https://github.com/onlyoffice/onlyoffice-alfresco/releases

[7]

开发指南: https://api.onlyoffice.com/editors/alfresco

[8]

启用 ONLYOFFICE 和 Alfresco 集成的 JWT 功能: #启用ONLYOFFICE和Alfresco集成的JWT功能

[9]

官方 Alfresco 文档: https://docs.alfresco.com/5.1/tasks/library-folder-rules-define-create.html

[10]

请参考这篇文档: https://helpcenter.onlyoffice.com/ONLYOFFICE-Editors/ONLYOFFICE-Document-Editor/HelpfulHints/Comparison.aspx

[11]

请参考这篇文档: https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/usageinstructions/usemailmerge.aspx

[12]

请参考这篇文档: https://helpcenter.onlyoffice.com/onlyoffice-editors/onlyoffice-document-editor/usageinstructions/insertimages.aspx

[13]

请参考这篇文档: https://helpcenter.onlyoffice.com/userguides/groups-gettingstarted-documents.aspx