1. 概念编辑
1.1 版本
FineBI 版本 | JAR 包版本 | 功能变动 |
---|---|---|
5.1 | - | - |
5.1.6 | 2020-09-30 | 增加「结果通知」功能 |
1.2 应用场景
在进行大数据量数据更新时,往往需要在固定时间按重复进行计划进行数据更新,以便能够显示最新的数据库数据。
在更新后,普通用户需要知道自己的数据集更新失败的错误原因,且需要通知用户更新的结果信息,以便他们知道数据已经成功更新。
注:在进行数据更新前需要是管理员或者拥有对应数据业务包的管理权限。
1.3 功能介绍
FineBI 提供定时更新功能,可以设定时间,将业务包中的非实时数据表更新到本地。
定时更新可以设置「全局定时更新」、「业务包定时更新」和「单表定时更新」。
同时支持「更新结果通知」,用户能及时了解更新结果。
注:不建议设定过于频繁的更新频率。过于频繁容易带来数据还没更新完,系统就开始下一次更新的情况,而这样的情况会带来宕机风险。
2. 全局定时更新编辑
2.1 新建定时更新任务
注:只有超级管理员可以全局更新,其他用户不具备全局更新的功能。
1)进入「数据准备>更新设置」,如下图所示:
2)点击定时更新,如下图所示:
2.2 设置定时更新内容
1)自动弹出定时更新设置框,可以对定时更新进行具体的设置。
任务名称:点击可以更改定时更新任务的名字。
开始时间和结束时间:是指更新任务开始和结束的时间,并不是指更新的时长。开始和结束的时间粒度可细化到时分秒。点击可选择开始时间。
执行频率:「只执行一次」、「简单重复执行」有「明细频率设置」、「表达式设定」四种执行频率方式。
结果通知:可选择「通知时机」、「通知对象」、「通知方式」。
示例设置如下图所示:
「执行频率」以及对应的「结束时间」设置如下所示:
执行频率 | 说明 | 对应结束时间 |
---|---|---|
只执行一次 | 在设置的开始时间开始后,该定时更新任务只执行一次更新 | 无需设置结束时间 |
简单重复执行 | 可设置四种时间粒度,分别是:「分钟、小时、天、周」,可进行简单的间隔时间设置。例如:每隔1天执行一次 | 执行频率选择「简单重复执行」后,结束时间有三种选项:
|
明细频率设置 | 可进行细化的间隔时间设置。
| 执行频率选择「明细频率设置」后,任务结束时间只能选择两种:「无限期」或「设定结束时间」:
|
表达式设定 | 指设定一些「特定时间」的更新频率。
填入时间频率的 Cron 表达式,需填写正确的表达式才能进行定时更新 | 执行频率选择「自定义表达式」后,任务结束时间只能选择两种:「无限期」或「设定结束时间」,可参考本章「明细频率设置」 注:Cron表达式的详细使用方法可参考本章「3. Cron表达式」 |
通知内容选项如下所示:
通知内容 | 说明 |
---|---|
通知时机 | 可勾选「仅在任务报错时通知」,若勾选则在更新任务中有更新失败情况才会发送通知。 |
通知对象 | 支持设置通知对象:「部门」、「角色」、「用户」 注:只要将用户选择至「部门」、「角色」、「用户」中的任意一个,被设置用户即可收到消息 |
通知方式 | 可选择「平台通知」、「邮件通知」、「短信通知」 |
4)点击「确定」,可以看到设定好的定时更新任务出现在更新任务框中。可以建立多个定时任务,并且对定时任务进行编辑和删除。如下图所示:
2.3 查看更新结果
由于根据示例的设置,「技术支持」部门 Anna 登录数据决策系统,点击「消息提示>查看消息」,即可看到更新任务执行结果详情,如下图所示:
若用户点击「处理」,可进入更新任务管理界面查看详细更新情况,详情参见:管理更新情况,如下图所示:
注:若需要处理更新任务执行情况,需要有对应「更新任务管理权限」。
3. 业务包定时更新编辑
进入「数据准备>业务包」,点击「业务包更新」,点击「定时设置」,如下图所示:
弹出定时设置框,设置方法与界面与全局定时更新一致(参考第二节全局定时更新),设置通知对象为「技术支持」部门,点击「确定」,通知方式为「平台通知」,如下图所示:
4. 单表定时更新编辑
4.1 自助数据集定时更新
用户对自助数据集使用到的基础表进行定时更新,基础表的更新会触发自助数据集的更新,从而实现自助数据集的定时更新。
4.2 单表更新操作方法
1)进入「数据准备」,选择需要定时更新的单表,点击「更新信息>单表更新」。如下图所示:
2)点击「定时设置」,如下图所示:
3)弹出定时设置框,设置方法与界面与全局定时更新一致,但「单表更新」支持设置更新方式,可选择「全量更新」和「增量更新」,如下图所示:
4)点击「确定」,可以看到设定好的定时更新任务出现在更新任务框中。可以建立多个定时任务,并且对定时任务进行编辑和删除。如下图所示:
5. Cron表达式编辑
Cron表达式为一个字符串,由 5 个或 6 个空格隔开,分为 6 或 7 个域,每一个域代表一个时间范围。Cron有如下两种语法格式:
Seconds Minutes Hours DayofMonth Month DayofWeek Year。
Seconds Minutes Hours DayofMonth Month DayofWeek。
从左到右(用空格隔开):秒 分 小时 月份中的日期 月份 星期中的日期 年份(可选)。
5.1 域
每一个域可出现的字符如下:
域 | 允许值 | 允许的特殊字符 |
---|---|---|
秒(Seconds) | 0~59的整数 | , - * / 四个字符 |
分(Minutes) | 0-59的整数 | , - * / 四个字符 |
小时(Hours) | 0-23的整数 | , - * / 四个字符 |
日期(DayofMonth) | 0-31的整数(但是需要考虑月的天数) | ,- * ? / L W C 八个字符 |
月份(Month) | 1-12的整数或英文JAN-DEC | , - * / 四个字符 |
星期(DayofWeek) | 1-7的整数或英文SUN-SAT(1=SUN, 2=MON,...) | , - * ? / L C # 八个字符 |
年份(Year) | 1970-2099 | , - * / 四个字符 |
5.1.1 字符含义
每一个域除了使用数字还可以出现特殊字符,其中特殊字符的含义如下:
字符 | 含义 |
---|---|
* | 表示匹配该域的任意值,假如在 Minutes 域使用 *,即表示每分钟都会触发事件 |
? | 只能用在 DayofMonth(日期)和 DayofWeek(星期)两个域。它也匹配域的任意值,但实际不会。因为 DayofMonth 和 DayofWeek 会相互影响。例如想在每月的 20 日触发调度,不管 20 日到底是星期几,则只能使用如下写法: 13 13 15 20 * ?,其中最后一位只能用 ?,而不能使用 *,如果使用 * 表示不管星期几都会触发,实际上并不是这样 |
- | 表示范围,例如在 Minutes 域使用 5-20,表示从 5 分到 20 分钟每分钟触发一次 |
/ | 表示起始时间开始触发,然后每隔固定时间触发一次,例如在Minutes域使用 5/20,则意味着 5 分钟触发一次,而 25,45等分别触发一次 |
, | 表示列出枚举值。例如:在Minutes域使用 5,20,则意味着在 5 和 20 分每分钟触发一次 |
L | 该字符只在 DayofMonth(日期)和 DayofWeek(星期)域中使用,代表“Last”的意思,但它在两个字段中意思不同。L在日期字段中,表示这个月份的最后一天,如一月的 31 号,非闰年二月的 28 号;如果L用在星期中,则表示星期六,等同于7。但是,如果 L 在前面有一个数值 X ,它就具有其他含义了。例如,月份中的 6L 表示该月的倒数第六天;星期域中的 FRIL 表示这个月的最后一个星期五 |
W | 该字符只能出现在 DayofMonth(日期)域里,是对前导日期的修饰,表示离该日期最近的工作日。例如 15W 表示离该月15 号最近的工作日,如果该月15 号是星期六,则匹配 14 号星期五;如果15 日是星期日,则匹配 16 号星期一;如果 15 号是星期二,那结果就是15 号星期二。但必须注意关联的匹配日期不能够跨月,如你指定 1W,如果 1 号是星期六,结果匹配的是 3 号星期一,而非上个月最后的那天。W 字符串只能指定单一日期,而不能指定日期范围 |
LW | 在 DayofMonth 字段可以组合使用 LW,它的意思是当月的最后一个工作日 |
C | 该字符只在 DayofMonth(日期)和 DayofWeek(星期)域中使用,代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如:5C 在日期字段中就相当于日历 5 日以后的第一天;1C 在星期字段中相当于星期日后的第一天 |
# | 该字符只能在 DayofWeek(星期)域中使用,表示当月某个工作日。如 6#3 表示当月的第三个星期五( 6 表示星期五,#3表示当前的第三个);而 4#5 表示当月的第五个星期三,假设当月没有第五个星期三,忽略不触发 |
5.2 示例
Cron表达式示例:
每隔 5 秒执行一次:*/5 * * * * ?
每隔 1 分钟执行一次:0 */1 * * * ?
每隔 1 小时执行一次:0 0 */1 * * ?
每天 23 点执行一次:0 0 23 * * ?
每天凌晨 1 点执行一次:0 0 1 * * ?
每月 1 号凌晨 1 点执行一次:0 0 1 1 * ?
在 26 分、29 分、33 分执行一次:0 26,29,33 * * * ?
每天的 0 点、13 点、18 点、21 点都执行一次:0 0 0,13,18,21 * * ?
根据以上表达式规则获取 Cron 表达式以后,可参考链接 http://www.pppet.net/ 检查写的表达式是否正确,确保正确以后填入。