概述
ThingsBoard支持以灵活schedule配置调度多种类型事件。 ThingsBoard Scheduler按schedule触发已配置的scheduler事件。 触发scheduler事件时，会从事件配置生成 Rule Engine Message，其结构与Rule Engine Message类似。 生成的消息会被转发到 Rule Engine，并从 Root Rule Chain开始处理。
视频教程
观看下方视频教程，按步骤了解如何使用此功能。
Scheduler管理
租户管理员和客户用户可在ThingsBoard中配置Scheduler events。
Scheduler events页面显示当前已配置的scheduler事件。 支持添加、更新或删除scheduler事件。页面支持List view和Calendar view两种模式。 可通过页面顶部的对应图标切换视图。
在Calendar view模式下，scheduler事件按其schedule以标签形式显示。
默认Calendar view为Month类型。 Calendar view type下拉菜单可切换到其他视图类型，可选类型如下：
- Month / Week / Day / List Year / List Month / List Week / List Day / Agenda Week / Agenda Day
点击右上角 + 按钮，或在Calendar view中点击任意单元格可创建新的scheduler事件。
Scheduler Event对话框
Scheduler event编辑对话框包含Configuration和Schedule两个表单。
Configuration表单用于根据所选event类型设置event type和event configuration参数。 scheduler event的配置说明见 Scheduler Event Types章节。
Schedule表单用于配置event schedule。
Schedule表单参数如下：
- Timezone - 处理该scheduler event的时区。
- Start Date/Time - 触发该scheduler event的日期/时间。
- Repeat - 该scheduler event为一次性或重复执行。
- Repeats - 重复规则，可选Daily或Weekly。
- Repeat on - 适用于Weekly，指定触发该scheduler event的星期几。
- Ends on - 该scheduler event重复结束的日期。
Scheduler Event类型
在Configuration中的Event type字段可选择现有event类型或指定自定义类型。
Custom Type
Custom type按message结构使用默认scheduler event配置表单。
- Originator - message originator，可为Single entity（如Device、Asset等）或 Group of entities。未指定时，scheduler event实体本身作为originator。
- Message type - 符合Rule Engine message类型的message type。可为已有message type或自定义。未指定时，scheduler event type将作为message type。
- Message body - JSON格式的message body。
- Metadata - 表示message metadata字段的key/value表。
Generate Report
支持按schedule生成 Reporting功能支持的报告。
- Report configuration：
- Base URL - Report Server需能访问的ThingsBoard UI的base URL。
- Dashboard - 用于生成报告的仪表板。
- Dashboard state parameter value - 指定报告生成的目标仪表板状态。可点击字段最右侧按钮调用Select dashboard state对话框自动设置。
- Timezone - 报告中显示目标仪表板所用的时区。
- Use dashboard time window - 若勾选，报告生成时使用目标仪表板中配置的time window。
- Time window - 报告生成时使用的仪表板time window。
- Report name pattern - 生成报告的文件名模式，可包含
%d{date-time pattern}形式的日期时间模式。详见 SimpleDateFormat文档。 - Report type - 报告文件类型，可为PDF | PNG | JPEG。
- Use current user credentials - 若勾选，将使用创建该报告配置的用户凭证在报告生成时打开仪表板UI。
- Customer user credentials - 其凭证将用于打开仪表板UI的目标客户用户。
- Generate Test Report按钮用于测试，将按当前配置执行报告生成。生成成功时会自动下载报告文件。
-
Send email - 若勾选，将发送带报告附件的邮件。
- Email configuration：
- From - 发件地址
- To - 收件人地址列表（逗号分隔）
- Cc - 抄送地址列表（逗号分隔）
- Bcc - 密送地址列表（逗号分隔）
- Subject - 邮件主题，可按 SimpleDateFormat使用
%d{date-time pattern}形式的日期时间模式。 - Body - 邮件正文，可按 SimpleDateFormat使用
%d{date-time pattern}形式的日期时间模式。
更新属性
支持为实体或实体组按schedule更新属性。
- Target - 要更新属性的目标实体，可为Single entity（如Device、Asset等）或 Group of entities。
- Entity attributes scope - 要更新属性的 scope。若Target中指定了Device实体类型，可选择。可为Server attributes或Shared attributes。其他实体类型均使用Server attributes scope。
- Server / Shared attributes - 表示待更新属性值的key/value表。
向设备发送RPC请求
支持按schedule向设备或设备组发送命令（RPC call）。
- Target - 接收命令的目标设备，可为Single device或 Group of devices。
- Method - RPC call方法。
- Params - JSON格式的RPC call参数。
Scheduler部件
ThingsBoard支持通过Scheduler events或Reports schedule部件管理scheduler事件，这些部件属于Scheduling部件包。
Scheduler events部件功能与 Scheduler events页面相同。 还可为自定义scheduler event类型配置预定义表单。 可在部件配置的Advanced选项卡中配置Custom event types列表实现。
- Display name - 自定义event类型的显示名称。
- Type name - 自定义event的内部名称。
- Display originator entity select - 是否在scheduler event配置表单中允许选择originator。
- Display message type select - 是否在scheduler event配置表单中允许选择message type。
- Display message metadata table - 是否在scheduler event配置表单中显示metadata表。
- Configuration HTML template - 用于生成编辑event configuration对象自定义表单的HTML代码。