【onlyoffice中文指南】3-保存文件

作者 日期
雨中星辰 2018-12-20

参考图和步骤说明了在ONLYOFFICE文档服务器中保存文档的过程。

【onlyoffice中文指南】3-保存文件_第1张图片
image.png
  1. 用户在文档编辑器中编辑文档
  2. 文档编辑器将更改到文档编辑服务
  3. 用户关闭文档编辑器
  4. 文档编辑服务手表与文档工作结束并收集变化从发送文档编辑器到一个文档。
  5. 文档编辑服务使用JavaScript API的callbackUrl通知文件存储服务文档编辑已经结束,并返回到修改后的文档的链接。
  6. 文件存储服务文档编辑服务下载包含所有保存的更改的文档文件,并将其存储。

如何在实践中做到这一点

  1. 创建一个回调处理程序以从文档编辑服务中保存文档。
  2. 创建一个html文件以打开文档。
  3. 在文档编辑器初始化的配置脚本中,在参数行中使用Callback处理程序指定文件的URL 。
new DocsAPI.DocEditor(“placeholder”,{
     “document”:{
         “fileType”:“docx”,
         “key”:“Khirz6zTPdfd7”,
         “title”:“Example Document Title.docx”,
         “url”:“https: //example.com/url-to-example-document.docx”
    },
    “documentType”:“text”,
     “editorConfig”:{
         “callbackUrl”:“https://example.com/url-to-callback.ashx”
    }
});

其中**example.com**是安装**文档管理器**和**文档存储服务**的服务器的名称。
  1. 在浏览器中打开html文件并编辑文档。
  2. 关闭文档编辑器。大约10秒钟检查您的文档。应保存所有更改,这意味着配置正确。

保存延迟

文档编辑完成后,文档编辑服务会通知文档存储服务。完成此操作之前的时间是使用已编辑文件到Office Open XML格式的转换时间计算的(这取决于文件大小,复杂性和计算机能力,并且可以执行相当长的时间),以及转换开始延迟时间(默认值等于5秒)。在大多数常见情况下,编辑完成后的时间约为10秒。

转换开始延迟是必要的,以允许在没有文件保存的情况下返回文件编辑会话,例如,当重新加载打开文件以进行编辑的浏览器页面时。可以在文档服务器配置文件中更改转换开始延迟时间,该文件可在以下路径中找到:

对于Linux - /etc/onlyoffice/documentserver/default.json

对于Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\default.json

参数

{
    "services": {
        "CoAuthoring": {
            "server": {
                "savetimeoutdelay": 5000
            }
        }
    }
}
参数 描述 类型
services.CoAuthoring.server.savetimeoutdelay 定义编辑文件关闭后的转换开始延迟时间(以毫秒为单位)。 integer 5000

示例default.json配置

{
    "services": {
        "CoAuthoring": {
            "server": {
                "savetimeoutdelay": 5000
            }
        }
    }
}

自动存储

文档编辑服务允许在编辑完成之前获取当前文档状态。该过程在ONLYOFFICE文档服务器中称为forcedave。当forcesave开始,文档编辑服务执行请求的回调处理程序与链接到文档的URL参数,并与6的值状态参数。forceave过程可以通过以下方式启动:

  • 通过c参数中的forceave值对document命令服务的请求。将请求发送到回调处理程序时,forcesavetype参数将具有0值。

  • 启用editorConfig.customization.forcesave模式,在编辑器初始化配置中将其设置为true。在这种情况下,每次用户单击“ 保存”按钮时,将完成forceave,并且在将请求发送到回调处理程序时,forcesavetype参数将具有1值。

  • 您可以在文件服务器配置文件中启用重复强制尝试启动,该文件可在以下路径中找到:

    对于Linux - /etc/onlyoffice/documentserver/default.json

    对于Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\default.json

    参数

    参数 描述 类型
    services.CoAuthoring.autoAssembly.enable 指定启用重复强制保存。默认值为false boolean false
    services.CoAuthoring.autoAssembly.interval 定义初始化强制保存的时间间隔(以分钟为单位)。 string 5m

    示例default.json配置

{
    "services": {
        "CoAuthoring": {
            "autoAssembly": {
                "enable": true,
                "interval": "5m"
            }
        }
    }
}

在将请求发送到回调处理程序时 ,forcesavetype参数将具有2值。

onlyoffice中文指南 目录

【onlyoffice中文指南】0-基本概念
【onlyoffice中文指南】1-onlyoffice的工作原理
【onlyoffice中文指南】2-打开文件
【onlyoffice中文指南】3-保存文件
【onlyoffice中文指南】4-协同编辑
【onlyoffice中文指南】5-转换和下载文件
【onlyoffice中文指南】6-文档历史
【onlyoffice中文指南】7-安全
【onlyoffice中文指南】8-高级参数
【onlyoffice中文指南】9-回调处理程序
【onlyoffice中文指南】10-Document配置
【onlyoffice中文指南】11-编辑器(Editor)参数配置
【onlyoffice中文指南】12-问题及排除

本文翻译自官方文档

你可能感兴趣的:(【onlyoffice中文指南】3-保存文件)