反馈已提交

网络繁忙

定时调度任务设置

  • 文档创建者:doreen0813
  • 编辑次数:32次
  • 最近更新:Carly 于 2021-10-20
  • 1. 概述

    1.1 版本

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

    1.2 功能简介

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

    定时调度任务设置时包含四个操作步骤,分别为:基本设置调度对象调度周期文件处理。如下图所示:

    1578904847675543.png

    2. 添加任务

    管理员进入数据决策系统,点击管理系统>定时调度>添加任务,如下图所示:

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

    1578905108368674.png

    3. 基本设置

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

    17.png

    1)任务名称:

    填写定时调度任务的名称,不能为空。

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

    2)默认用户组:

    设置默认用户组的目的是为了在「文件处理」时根据用户组成员发送通知,默认为无。

    点击默认用户组的编辑按钮之后,可以根据用户、部门、角色来添加用户组成员。最终的用户组取用户、部门、角色的并集且去掉重复项,这三个都不是必填项,可以自由组合。

    需要注意的是,用户的添加方式有两种:

    • 平台:用户来源于决策平台。

    1596527417908117.png

    • 自定义用户:用户来源于服务器数据集。

    1596527518723291.png


    4. 调度对象

    调度对象步骤中对象类型分为三种,分别为:报表模板BI 模板无调度对象。下面将分别介绍。

    4.1 报表模板

    「报表模板」是安装路径 %FineBI_HOME%\webapps\webroot\WEB-INF\reportlets 文件夹下面的模板,为 FineReport 模板。

    调度对象若选择报表模板,请参考 定时调度任务详细设置步骤 的 4.1 节。

    4.2 BI 模板

    对象类型若选择为 BI 模板,如下图所示:

    20.png

    1)对象类型

    BI 模板:BI 工程中创建的仪表板。

    2)选择模板

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

    3)过滤设置

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

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

    1573627810154325.png

    4)调度结果

    除通用结果外,会根据默认用户组内的用户单独生成结果;此调度结果按钮必须在「默认用户组」中选择用户才能选择。勾选该按钮后,可根据设置的 行列权限 给不同用户发送不同数据结果。

    注:用户要有 BI 模板使用到的业务包权限才能勾选「调度结果」选项,否则预览模板时会失败。

    5)文件名称

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

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

    6)附件存档

    BI 模板包含excelpdf可选。

    若勾选附件存档后的选项,定时调度任务结束后,会生成不同格式的附件,附件内容为所选择的 BI 模板内容,保存在%BI_HOME%\webapps\webroot\WEB-INF\schedule文件夹下。如下图所示:

    10.png

    7)文件处理

    可配置文件处理的逻辑,默认选中不清理

    若选择任务结束即清理,任务结束后会将 所有结果文件 都清理掉(包括 cpr 和附件),所以当所设置的定时调度任务需要使用定时调度附件时,例如在 文件处理 步骤中勾选「使用附件」的邮件通知,会出现结果文件被清理,无法找到的问题。

    4.3 无调度对象

    调度对象若选择无调度对象,请参考 定时调度任务详细设置步骤 的 4.2 节。

    5. 调度周期

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

    21.png

    1)开始时间

    设置该定时调度任务的开始执行时间。

    • 配置结束立即执行:则开始时间为任务完成创建的时间。

    • 设置开始时间:则开始时间为具体设置的时间。

    1596527990404024.png

    2)执行频率

    • 只执行一次:任务执行一次,此后不再执行。

    • 简单重复执行:设置每隔n分钟/小时/天/周执行一次。

    1596528075502481.png

    • 明细频率设置:按的格式设置执行频率。可自由组合。

    1596528169132785.png

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

    1596528610294234.png

    • 表达式设置

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

    1596528757314528.png

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

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

    1596528841572263.png

    3)结束时间

    结束时间的选项根据上面的执行频率选择不同显示不同选项:

     结束时间

    只执行一次

    简单重复执行

    明细频率设置

    表达式设定

    任务执行一次后即结束任务实际结束时间---
    无限期-无结束时间,定时更新任务会一直定时执行无结束时间,定时更新任务会一直定时执行无结束时间,定时更新任务会一直定时执行
    设定结束时间-根据设定的结束时间根据设定的结束时间根据设定的结束时间
     额外重复执行次数 -在设置的开始时间执行了定时任务之后会在间隔时间达到后再执行任务的次数  -

    4)执行条件

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

    • 始终执行:不进行条件判断,直接执行定时任务。

    • 公式判断:指定时任务在执行前要对当前公式内容进行判定,公式为 true 则继续执行定时任务,如果公式为 false 则不执行或者延迟执行。延迟执行是指在「调度周期」步骤中勾选任务重启,会在间隔一段设定的时间后再次执行定时任务,重新进行条件判断,以此类推,当重启次数达到设置值的时候,条件判断还是不满足,则不执行,如果中间有一次满足则执行定时任务。详细内容参见文档:公式判断

    • 自定义类判断:指执行自定义类,返回值为 true 的时候执行定时任务,详细内容参见文档:自定义判断

    • 预警判断:通过定时调度任务中的预警判断,可实现组件出现异常值后,主动推送给用户,方便及时处理/优化。详细内容参见文档:定时调度支持组件预警

    5)任务重启

    勾选如果任务中断按以下频率重新启动设置频率和次数。

    1596529017529659.png

    任务重启设定是一项防范措施,用于定时任务执行可能中断(例如网络原因导致邮件发送失败,不满足执行条件中断等)时的自动重启。如果定时任务执行中断且设定了自动重启,那么该定时任务就会按照自动重启项的设定重新执行直至成功或者达到所设定重启次数的最大值,任务重启设定默认不启用

    • 定时任务执行重启遵循以下规则:
      如果快照生成失败,那么对应的附件发送不会执行。

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

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

    6. 文件处理

    6.1 报表模板

    「报表模板」的文件处理请参考 定时调度任务详细设置步骤 的 6.1 章节。

    6.2 BI 模板

    若选择 BI 模板,则为下图所示:

    1596529160850307.png

    默认勾选定时计算,其他处理方式手动勾选。

    6.2.1 邮件通知

    注:请先配置  邮箱

    30.png

    定时调度任务执行结束后,会发送邮件通知。各设置项说明如下表所示:

    设置项说明
    收件人默认只能使用「默认用户组」
    抄送和密送

    支持用户选择和自定义邮箱

    注:该自定义邮箱功能需 FineBI5.1 版本支持

    主题/内容

    支持公式,不能为空

    注:定时调度可使用的公式请参见:定时调度支持的公式

    使用附件

    若定时调度任务有生成附件(包括 excel、pdf),邮件可以附带附件,没有生成附件,则该选项灰化,不可选取

    6.2.2 客户端通知

    勾选APP通知,填写主题和内容,选择链接,如下图所示:

    注:消息推送给 APP,必须把该仪表板挂到虚拟目录上,且推送的人必须是虚拟目录有权限看的人(超级管理员除外,此处指的是除去超级管理员之后的其他用户)。

    31.png

    详细请参见:[通用]定时任务推送消息至APP

    6.3 无调度对象

    「无调度对象」的文件处理请参考 定时调度任务详细设置步骤 的 6.2 节。

    7. 注意事项

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

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

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

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

    附件列表


    主题: 管理员指南
    • 有帮助
    • 没帮助
    • 只是浏览

    售前咨询电话

    400-811-8890转1

    在线技术支持

    在线QQ:800049425

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

    总裁办24H投诉

    热线电话:173-1278-1526

    文 档反 馈

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

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

    不再提示

    10s后关闭