反馈已提交

网络繁忙

您好,只有最新版本的6.X支持在线编辑修改,如果想创建/编辑文档,请移步到 *最新版本*

定时调度任务设置

  • 文档创建者:doreen0813
  • 历史版本:43
  • 最近更新:Suki陈 于 2023-08-21
  • 1. 概述

    1.1 版本

    FineBI 版本JAR 包新增功能
    5.1--
    5.12020-08-04「调度周期」步骤中执行频率提前校验,执行频率若设置错误,前端弹窗提示错误
    5.1.52020-09-30向 FINE_CONF_ENTITY 表中新增字段,可改变定时调度生成附件的语言
    5.1.19-

    1)定时调度「文件处理」删除「打印文件」方式

    2)定时调度「调度对象>文件处理」默认选择「仅保留最近1次」

    5.1.20-对象类型新增「多选报表模板」
    5.1.23-定时调度「调度周期>执行频率 」为「明细频率」时,

    下方的删除按钮默认不显示,仅当勾选了一条/多条明细频率之后,方出现删除按钮

    1.2 功能简介

    有关定时调度功能基本的介绍和操作方法可以参见文档:定时调度

    定时调度任务设置时包含四个操作步骤,如下图所示。本文将详细介绍这四个操作步骤中的设置项。

    2. 添加任务

    管理员登录数据决策系统,点击「管理系统>定时调度>任务管理」,点击「添加任务」,即可新建一个定时调度任务。如下图所示:

    注:普通用户若需要设置定时调度任务,需要管理员为其配置「管理系统>定时调度」的使用权限,具体步骤请参见 定时调度管理权限 。

    3. 基本设置

    「基本设置」界面如下图所示:

    3.1 任务名称

    填写定时调度任务的名称。

    • 任务名称不可为空。

    • 任务名称不可与其他定时调度任务重复,否则提示「任务名称已经存在」。

    • 任务名称只允许包含字母、汉字、数字、下划线、减号、点和括号。

    • 进行中的任务名称禁止修改。

    3.2 默认用户组

    用途:设置默认用户组的目的是为了在第四步「文件处理」时根据用户组成员发送通知。默认用户组可为空。

    设置:点击「编辑」按钮,支持根据「用户、部门、角色」来添加默认用户组成员,点击「确定」即可成功添加,最终的用户组取三者的并集且去掉重复项。

    其中,用户的添加方式有两种:

    • 平台:用户来源于数据决策系统。

    1596527417908117.png

    • 自定义用户:用户来源于服务器数据集。但是选择的数据集列数据需要是平台中的用户名,否则任务执行无法成功。

    1596527518723291.png


    4. 调度对象

    4.1 调度对象

    调度对象有四种类型:报表模板、多选报表模板、BI 模板、无调度对象。

    本章仅介绍调度对象为「BI 模板」时的设置,其他请参考 定时调度任务详细设置步骤 的第四章。

    1)无调度对象

    当调度对象选择「无调度对象」时,仅支持设置「调度结果」,一般用于企业发送公告。

    2)报表模板

    当调度对象选择「报表模板」时,可选择单张 FineReport 模板,用于推送、保存、查看报表执行结果。支持以下设置:

    3)多选报表模板

    当调度对象选择「多选报表模板」时,可选择多张 FineReport 模板,但仅可使用邮件推送报表执行结果。支持以下设置:

    • 多选报表模板和单个报表模板的设置基本相同,可为每张模板单独配置参数设置、文件名称和附件存档。支持拖拽调整模板的先后顺序。

    • 执行条件处若使用「公式判断」或「自定义类判断」,涉及到和模板内容相关的,只支持取第一个选中的模板。

    • 文件处理处仅支持「邮件通知」一种处理方式,标题或正文中若使用公式,只支持取第一个选中的模板。

    4)BI模板

    当调度对象选择「BI模板」时,可选择单张FineBI仪表板。支持以下设置:

    4.2 选择模板

    选择 BI 工程中创建的仪表板,不能为空。

    4.3 过滤设置

    支持对所选择的仪表板添加过滤条件,比如对所选择的销售管理中心驾驶舱添加过滤条件属于 2017 年的数据,如下图所示:

    注1:设置定时调度的账号需要有业务包的授权权限,才能在「过滤设置」对业务包内的字段进行过滤。

    注2:若文件处理方式选择「客户端通知」,过滤设置仅对定时结果链接生效,对自定义链接不生效。

    注3:过滤条件只是对展示结果做最后过滤,不会对预警条件生效,就是先预警后过滤。

    1573627810154325.png

    4.4 调度结果

    注1:若「定时调度>基本设置>默认用户组」为空,则「调度结果」这个功能置灰不可用。

    注2:若勾选了「除通用结果外,根据默认用户组内的用户单独生成结果」设置项,但是用户没有 BI 模板使用到的业务包权限,那么用户预览模板时会失败。

    若勾选了「除通用结果外,根据默认用户组内的用户单独生成结果」设置项,那么会为「默认用户组」里面的所有成员生成独立的结果。

    勾选该按钮后,可根据设置的 行列权限 给不同用户发送不同数据结果。

    4.5 文件名称

    生成结果文件的名称,包括了结果报表、附件(excel、word、pdf),支持公式输入,比如${now()}

    如果不填写的话生成的结果报表和附件名称就使用模板名称(去后缀)。

    注:需勾选调度结果按钮才能使用公式,后面执行条件等输入公式同理。

    4.6 附件存档

    可选择生成的附件类型,包括:excel和pdf

    若勾选附件存档后的选项,定时调度任务结束后,会生成不同格式的附件。

    附件内容为所选择的模板内容,保存在%BI_HOME%\webapps\webroot\WEB-INF\schedule文件夹下。如下图所示:

    10.png

    4.7 文件处理

    可配置文件处理的逻辑,默认选中「仅保留最近1次」。

    若选择「任务结束即清理」,任务结束后会将 所有结果文件 都清理掉(包括 cpr 和附件)。

    所以当所设置的定时调度任务需要使用定时调度附件时,例如在 文件处理 步骤中勾选「使用附件」的「邮件通知、FTP上传附件、自定义附件处理」等,会出现结果文件被清理,无法找到的问题。同时访问「定时结果链接」时也会报错:非常抱歉,您无法查看该页面,Index: 0, Size: 0,如需访问请联系管理员

    注:当生成的结果报表超过 10 个时,在点击下一步时会弹出提示信息:「预计产生N套结果文件,可能导致计算量过大,是否继续」,如果点击继续,则跳到下一步调度周期的设置。

    5. 调度周期

    「调度周期」的界面如下图所示:

    5.1 开始时间

    设置该定时调度任务的开始执行时间。支持两种配置:

    • 配置结束立即执行:定时调度任务设置完成后立马执行。

    • 设置开始时间:在指定的开始时间后执行任务,支持精确到秒。



    5.2 执行频率

    1)只执行一次

    任务只会执行一次。

    2)简单重复执行

    可按分钟、小时、天、周设置执行间隔的时间段。

    3)明细频率设置

    按月、日、时、分的格式设置执行频率。可自由组合。

    注1:设置明细频率后,无需勾选该频率前面的方框,所有的频率都会生效。

    注2:5.1.23 及之后版本的工程,明细频率下方的删除按钮默认不显示。仅当勾选了一条/多条明细频率之后,方出现删除按钮。

    注3:若一个调度任务设置了多条明细频率,任务管理页面显示的下次运行时间。会根据第一条明细来显示,但真正的执行时间仍为所有的明细值。如下图所示:

    2020-08-04 及之后的 JAR ,若不触发所设置的明细频率,弹窗提示:以下执行频率无法触发,请检查频率设置,并确保和任务开始时间、结束时间无冲突。如下图所示:

    1596528610294234.png

    4)表达式设置

    通过表达式的形式设置执行频率。

    表达式设定的文本框可自己手动填写 cronExpression,也可通过点击旁边的表达式设置按钮来直接选择相应的表达式,点击「预置表达式」按钮时,展开预置表达式窗口,点击其中的文字说明,则其上的文本框显示并保存相应的 cronExpression,再次点击收起预置表达式按钮时收起预置表达式窗口,详细内容参见文档:表达式设定

    1596528757314528.png

    2020-08-04 及之后的 JAR ,若表达式设置的执行频率任务执行中并不触发,弹窗提示:以下执行频率无法触发,请检查频率设置,并确保和任务开始时间、结束时间无冲突,如下图所示:

    注:2020-08-04 及之后的 JAR,若表达式设置错误,则直接提示:格式错误

    1596528841572263.png

    5.3 结束时间

    结束时间包括「任务执行一次后结束、无限期、设定结束时间、额外重复执行次数」四个设置项。

    根据执行频率的不同,结束时间的设置项也会有所不同,详情请参见下表:

    执行频率
    结束时间
    只执行一次

    任务执行一次后结束

    不支持更改

    简单重复执行

    支持3种设置

    无限期、设定结束时间、额外重复执行次数

    明细频率设置

    支持2种设置

    无限期、设定结束时间

    表达式设定

    支持2种设置

    无限期、设定结束时间

    5.4 执行条件

    执行条件是指在执行定时任务之前进行判断,满足条件才执行定时任务,不满足则不执行或者延迟一段时间后再校验执行。

    执行条件
    简介参考文档
    始终执行不进行条件判断,直接执行定时任务-
    公式判断

    定时调度任务执行前,对当前公式内容进行判定

    公式为 true 则执行定时任务,公式为 false 则不执行或者延迟执行

    定时任务执行条件之公式判断
    自定义类判断

    定时调度任务执行前,执行自定义类

    返回值为 true 的时候执行定时任务

    定时任务执行条件之自定义类判断
    预警判断通过定时调度任务中的预警判断,可实现组件出现异常值后,主动推送给用户,方便及时处理/优化定时调度支持组件预警

    5.5 任务重启

    任务重启设定是一项防范措施,用于定时任务执行可能中断(例如网络原因导致邮件发送失败,不满足执行条件中断等)时的自动重启。

    如果定时任务执行中断且设定了自动重启,那么该定时任务就会按照自动重启项的设定重新执行直至成功或者达到所设定重启次数的最大值,任务重启设定默认不启用。

    定时任务执行重启遵循以下规则:

    • 如果「快照生成」失败,那么对应的附件发送不会执行。

    • 重启策略适用于「条件判断、快照生成、附件发送」三个方面的判断,逐一进行判断,如果不成功则进行确定是否采用了重启策略。

    • 重启时遵循任务最小化原则:如果快照生成正常、附件发送有问题,那么只需要重新发送附件,并且只需要重新发送之前发送失败的项目(邮件、FTP、自定义附件处理,哪个失败发送哪个即可)。

    6. 文件处理

    「文件处理」界面,支持多种处理方式,如下图所示:

    注1:调度对象为无调度对象时,仅支持平台通知、邮件通知、短信通知、客户端通知四种处理方式。

    注2:调度对象为多选报表模板时,仅支持邮件通知处理方式。

    调度对象处理方式
    简介参考文档
    报表模板定时计算定时计算就是生成结果报表( .cpr 文件 )和其他附件的过程,默认勾选且不能更改-
    挂载平台定时调度任务执行结束后,将生成的结果报表挂载到数据决策系统的目录下定时调度挂载平台
    平台通知定时调度任务执行结束后,给数据决策系统的用户推送生成的结果报表定时调度平台通知
    邮件通知定时调度任务执行结束后,给数据决策系统的用户的邮箱推送生成的结果报表和附件定时调度邮件通知
    短信通知定时调度任务执行结束后,给数据决策系统的用户的手机发送短信,提醒查看定时调度短信通知
    客户端通知定时调度任务执行结束后,给数据决策系统的用户的App、HTML5端、钉钉、微信等客户端推送生成的结果报表

    定时调度客户端通知-APP通知

    微信定时推送消息

    钉钉定时推送消息

    FTP上传附件定时调度任务执行结束后,通过FTP将任务生成的结果报表和附件上传至服务器定时调度FTP上传附件
    SFTP上传附件定时调度任务执行结束后,通过SFTP将任务生成的结果报表和附件上传至服务器定时调度SFTP上传附件
    自定义附件处理定时调度任务执行结束后,自定义结果报表和附件的上传方式

    自定义上传文件至磁盘

    自定义上传文件至 FTP 服务器

    BI模板邮件通知定时调度任务执行结束后,给数据决策系统的用户的邮箱推送生成的结果报表和附件定时调度邮件通知
    客户端通知定时调度任务执行结束后,给数据决策系统的用户的App、HTML5端、钉钉、微信等客户端推送生成的结果报表定时调度客户端通知-APP通知
    无调度对象平台通知定时调度任务执行结束后,给数据决策系统的用户推送生成的结果报表定时调度平台通知
    邮件通知定时调度任务执行结束后,给数据决策系统的用户的邮箱推送生成的结果报表和附件定时调度邮件通知
    短信通知定时调度任务执行结束后,给数据决策系统的用户的手机发送短信,提醒查看定时调度短信通知
    客户端通知定时调度任务执行结束后,给数据决策系统的用户的App、HTML5端、钉钉、微信等客户端推送生成的结果报表

    定时调度客户端通知-APP通知

    微信定时推送消息

    钉钉定时推送消息

    7. 注意事项

    在「调度对象」步骤中若勾选「附件存档」,定时调度任务结束后生成的附件可修改语言。

    超级管理员可通过「fine_conf_entity可视化配置插件」改变定时调度生成附件的语言。重启服务器后设置生效。

    注:修改 FineDB 数据库表字段值的方法请参考 FineDB 常用表字段修改 。

    IDVALUE附件语言
    LanguageConfig.localezh_CN简体中文
    zh_TW繁体中文
    en_US英文
    ja_JP日文
    ko_KR韩文

    附件列表


    主题: 管理员指南
    已经是第一篇
    已经是最后一篇
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

    请前往「服务平台」,选择「在线支持」

    热线电话:400-811-8890转2

    在线QQ(将在2023.01.03关停):800049425

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭