定时调度任务详细设置步骤

  • 文档创建者:susie
  • 编辑次数:47次
  • 最近更新:15951872293 于 2020-09-03
  • 1. 概述

    1.1 版本

    报表服务器版本JAR 包
    新增功能
    10.0
    2020-07-08「调度周期」步骤中执行频率提前校验,执行频率若设置错误,前端弹窗提示错误
    2020-08-03「文件处理」步骤中新增SFTP上传附件选项

    1.2 功能简介

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

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

    30.png

    2. 添加任务

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

    注:普通用户若需要设置定时调度任务,需要管理员 开启分级授权 后,为其分配「定时调度」管理节点的查看权限,具体步骤请参见 根据用户分配权限示例 

    1578366776832238.png

    3. 基本设置

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

    1595927704647176.png

    1)任务名称:

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

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

    2)默认用户组:

    设置默认用户组的目的是为了在第四步「文件处理」时根据用户组成员发送通知,默认为,这个会在第四步作介绍,先讲一下默认用户组如何设置。

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

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

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

    1595927819951520.png

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

    1595927882724269.png

    4. 调度对象

    两种对象类型在设置调度对象时有所不同,下面将分别介绍。

    4.1 报表模板

    当对象类型选择报表模板时,界面如下图所示:

    1595927964211616.png

    4.1.1 选择模板

    从设计器工作目录中选择一个报表,不能为空。

    4.1.2 类型

    选择报表的执行方式。

    如果选择了 CPT 报表,那么有四种分别为:预览、填报、分析、新填报,默认为预览

    如果选择了 FRM 报表,那么只有预览这一种。

    4.1.3 参数设置

    报表中引入参数是跟下面调度结果联合使用的,可以为默认用户组里面的成员生成独立的报表结果。

    注:「参数设置」中有关参数的注意事项请查看本文第七章节。

    参数设置的输入方式有两种,分别为:

    • 默认:可选择值的数据类型,值采用文本框填写的形式。

    • 数据集:值的数据类型为自动匹配,值采用添加服务器数据集的形式。

    13.png

    4.1.4 调度结果

    • 如果勾选了这个设置项,那么会为「默认用户组」里面的所有成员生成独立的报表结果,独立报表结果的文件夹以默认用户组成员的用户名命名,同时也会生成通用报表结果。用户名相关的参数会生效,具体效果请参见:定时任务邮件发送实现不同的人发送不同内容

    • 如果不勾选这个设置项,则只生成通用报表结果。

    详细内容可参见文档:定时任务的权限控制,生成的结果文件也会区别开来:

    Snag_294ed6b1.png

    注:调度结果这个功能开启的前提是基本设置中有设置「默认用户组」,否则置为灰色不可使用。

    通用结果报表查看权限需要满足:

    • 平台内用户需要要目录标签的权限+没有开启模板权限控制/开启模板权限控制后有该任务模板的权限,才可以查看,否则没有权限。

    • 平台外没有开启模板权限控制/开启模板权限控制后有该任务模板的权限,才可以查看,否则没有权限。

    详细内容可参见文档:定时任务 CPR 文件内容权限控制

    4.1.5 文件名称

    生成结果文件的名称,包括了结果报表、附件(excel、word、pdf),支持公式输入,比如${now()}。如果不填写的话生成的结果报表和附件名称就使用模板名称(去后缀)。

    4.1.6 附件存档

    可选择生成的附件类型,包括:结果报表(.cpr文件 ),excel03、excel07、word、pdf。

    Word 附件中,不支持 FRM 报表中的图表组件,只支持单元格元素图表。设置定时任务时,若在「调度对象」步骤中选择模板的类型为决策报表,并勾选附件存档excel03excel07wordpdf,则生成的附件不支持 body 背景色。

    注:2018-12-27 及之后版本的 JAR 包,默认必须生成结果报表。

    4.1.7 文件处理

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

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

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

    4.2 无调度对象

    如果调度对象类型选择无调度对象,那么无需进行其他设置。这个选项一般用于通过定时调度发一些企业的通知公告,不需要绑定对象。

    可根据默认用户组设置调度结果。

    1595928430265736.png

    5. 调度周期

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

    36.png

    1)开始时间

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

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

    • 设置开始时间:自定义任务开始执行的时间。

    1575442452612479.png

    2)执行频率

    • 只执行一次:任务只会执行一次。

    • 简单重复执行:可按分钟、小时、天、周设置执行间隔的时间段。

    1575442675678730.png

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

    Snag_298550cc.png

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

    Snag_298db9ef.png

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

    1594197652581468.png


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

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

    Snag_298fe9fe.png

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

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

    1594197738220263.png


    3)结束时间

    结束时间包括任务执行一次后结束无限期设定结束时间额外重复执行次数四个设置项。其中结束时间根据执行频率的不同,设置项也会有所不同,具体区别见下面的表格:

    Snag_29a80428.png

    4)执行条件

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

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

    • 公式判断:指定时任务在执行前要对当前公式内容进行判定,公式为 true 则继续执行定时任务,如果公式为 false 则不执行或者延迟执行,详细内容参见文档:公式判断

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

    5)任务重启

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

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

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

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

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

    1595987886608512.png

    6. 文件处理

    调度对象为报表模板无调度对象时,它们的文件处理方式有所不同,下面将分开介绍。

    6.1 报表模板

    当调度对象选择了报表模板,「文件处理」界面如下图所示:

    1595928609711518.png

    1)定时计算

    定时计算就是生成结果报表( .cpr 文件 )和其他附件的过程,默认勾选且不能更改。

    2)挂载平台

    定时调度任务执行结束后,将报表挂载到决策平台的目录下。

    注:挂载名称暂不支持公式。

    1595928718615064.png

    3)平台通知

    定时调度任务执行结束后,会发送决策平台消息通知。

    勾选定时结果链接在平台内打开,点击平台消息的链接可以单独访问结果报表。该方式等同于直接在平台外访问链接的权限。

    • 若没有开启模板权限控制,那么直接可以查看平台通知里的结果链接。

    • 若开了模板权限控制,那么需要给查看的用户分配该模板的权限,才可以查看,否则没有权限。

    注:若 JAR 包为 2019-09-27 及之前版本,「平台通知」里主题和内容不支持公式。

    1595928784212674.png

    4)邮件通知

    注:使用该设置项之前需要先配置邮箱,具体步骤请参见:邮箱

    邮件通知界面如下图所示:

    15.png

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

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

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

    注:2018-12-27 及之后版本的 JAR 包可自定义邮箱信息

    主题/内容

    支持公式,不能为空

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

    正文预览报表内容勾选后邮件的正文可预览报表的内容
    正文加上结果链接勾选后邮件的正文附带可以单独访问结果报表的链接
    使用附件若定时调度任务有生成附件( 包括 Excel03、Excel07、Word、PDF ),邮件可以附带附件,没有生成附件,则该选项灰化,不可选取

    对于正文预览报表内容和使用附件,有以下几点需要注意:

    • 根据所生成的结果报表来展示,即根据不同用户所对应的的模板参数显示。

    • 如果某收件人有对应的结果报表,则单独发给此收件人。

    • 如果某些收件人没有对应的结果报表,则一起发送通用结果报表。

    • 如果某些收件人既没有对应的结果报表,也没有通用结果报表,则发送失败。

    • 如果定时调度任务执行多次,每执行一次,用户就会收到一次结果报表和附件。

    • 如果一个用户在一次任务里有多个结果报表,则正文和附件也会发送多个,且附件名称重命名时拼上模板参数。详细内容参见文档:定时任务邮件发送实现不同的人发送不同内容

    5)短信通知

    注:使用该设置项之前需要先开通短信服务,开通方法参见文档:短信

    默认用户组里设置了手机的用户,会在定时调度任务运行成功后收到短信通知。短信通知界面如下图所示:

    16.png

    各设置项说明如下表所示:

    设置项说明
    收件人只能使用默认用户组
    短信签名用户可在帆软市场 短信服务 处预定义
    短信模板

    用户可在帆软市场 短信服务 处预定义

    注:2018-12-27 及之后版本的 JAR 包,短信通知支持选择短信模板

    短信参数

    可通过参数动态发送定时调度任务的特定内容。

    短信推送的参数除了支持本文注意事项中的参数,还支持以下两个参数,这两个参数在两种调度对象的场景下都可使用:

    • $taskname:定时调度任务名

    • $time:任务执行时间

    6)客户端通知

    定时调度任务完成后,可以向移动端 App 发送通知,详细介绍参见文档:[通用]定时任务推送消息至App。「客户端通知」界面如下图所示:

    17.png

    各设置项说明如下表所示:

    设置项说明
    推送终端必须勾选App 通知
    接收人只能使用默认用户组
    消息类型有三种类型,分别为链接消息图文消息文件消息
    主题消息的主题,支持公式输入
    内容消息的内容,支持公式输入
    链接

    有两种类型,分别为定时结果链接自定义链接,定时结果链接指向结果报表内容。自定义链接可挂载FineReport 设计器中 预览模板 时生成的 URL 。若自定义链接为填报模板点击填报预览生成的链接,可在客户端实现填报功能

    注:需根据实际情况修改 预览模板 生成 URL 中的 IP ,自定义链接才能生效

    7)FTP上传

    定时调度任务结束后,将结果报表和附件上传到 FTP。有关 FTP 上传设置的介绍参见文档:FTP 上传附件

    9.png

    8)SFTP 上传附件

    定时调度任务结束后,将结果报表和附件上传到 SFTP。有关 SFTP 上传设置的介绍请参见文档:SFTP 上传附件

    9.png


    9)自定义附件处理

    定时调度任务结束后,自定义结果报表和附件的上传方式,详细内容参见文档:自定义上传文件至磁盘 和 自定义上传文件至 FTP 服务器

    10.png

    10)打印文件

    定时调度任务结束后,设置的打印机会打印出结果报表内容。

    11.png

    6.2 无调度对象

    当调度对象选择了无调度对象,在进行到第四步时,文件处理方式只包含以下四个设置项,不过设置方法跟上面是相同的,此处不再赘述。

    12.png

    7. 注意事项

    7.1 支持参数

    定时调度所支持的参数如下表所示:

    调度对象参数备注
    报表模板$fine_username用户名
    $fine_position职位
    $fine_role角色
    today()今天的日期
    A1报表单元格
    report1~A1报表块单元格
    无调度对象today()今天的日期

    7.2 不支持的参数名称

    若用户在「调度对象」步骤中所设置的参数名称与下表所示的参数名称相同,即使用了定时调度生成的默认参数,结果链接的参数列表中不显示该参数且模板显示异常。

    注:「调度对象」步骤中所设置的参数值若为空,结果链接的参数列表中不显示该参数。

    不支持的参数名称结果链接出现的场景 
    _PAPERHEIGHT


    用户在「文件处理」步骤中勾选:

    1)挂载平台

    2)平台通知,并勾选下方定时结果链接在平台内打开按钮。

    3)邮件通知,并勾选下方正文加上结果链接按钮



    _PAPERWIDTH
    _FIT_
    executeFormula
    fine_username
    fr_username
    fine_position
    fr_userposition
    fine_role
    fr_authority
    showType
    showtype
    SESSIONID

    示例如下所示:

    注:定时调度发送邮件请参考 定时发送邮件

    1)「调度对象」步骤中未使用上方表格中不支持的默认参数

    以邮件通知为例,点击收件人邮件中的结果链接,如下图所示:

    1578478396207273.png

    2)「调度对象」步骤中使用了上方表格中不支持的默认参数(以 SESSIONID 为例)

    以邮件通知为例,点击收件人邮件中的结果链接,如下图所示:

    1578478343445050.png

    附件列表


    主题: 数据准备