smartbi v8用户手册计划任务

1、目录功能概述2任务41.2.2.1报表导出7报表设置9导出设置10资源离线16资源离线-报表设置17资源离线-导出设置20表数据填充21定制222.22.32.43.计划233.1 间隔类型和运行设置26管理294.1 调度日志304.4.2 运行. 31Smartbi 产品支持计划任务功能，主要用来完成一些需要定时、定期执行的任务，比如定时自动发送报表给。具体内容说明如下：一、Smartbi 产品计划任务指什么？答：计划任务是一种自动调度机制，表示某个时间点或事件触发系统自动执行相应操作。计划任务包含两个部分：计划和任务。计划表示制定执行任务的方式或时间等；任务则表示执行的具体内容；通过“管

2、理控制”对计划的执行进行。二、Smartbi 产品计划任务可实现哪些功能？答： Smartbi 产品任务有四种类型，其中“表数据填充、报表导出、页面导出”这三种提供设置界供用户定义任务，可满足日常任务要求；“自定义”类型则可用于满足更复杂的任务要求。1、 表数据填充：表示将临时表所依赖的业务查询或数据表或视图返回的结果集中的数据抽取并到该临时表中。2、 报表导出：表示将报表以各类报表文件的形式导出到本地或以邮件附件的形式发送给相关。3、 页面导出：表示将页面以 MHT 格式导出到本地或以邮件附件的形式发送给相关。4、 自定义：是指通过用户自己输入 JavaScript来定制任务，实现除“表数据

3、填充”、“报表导出”和“页面导出”功能之外的其它功能。1. 功能概述功能简介计划任务是 Smartbi 提供的一种调度机制，表示某个时间点或事件触发系统自动执行相应操作。计划任务包含三个部分：任务、计划、管理控制。其中：计划：表示制定执行任务的方式或时间等；任务：则表示执行的具体内容。有五种任务类型：表数据填充、报表导出、页面导出、资源离线和自定义。管理控制：对计划的执行进行。计划任务可实现如下功能：支持各类报表资源的生成及导出：可将灵活分析、电子表格、指标报表、分析报表、仪表页面等资源以文件的形式导出到本地或以邮件附件的形式发送给相关静态报表，支持周期性的调度。参见报表导出。或生成支持表数据

4、填充：表数据填充是系统提供的一种任务类型，表示将临时表所依赖的业务查询或数据表或视图返回的结果集中的数据抽取并充。到该临时表中。参见表数据填支持资源离线：子表格和页面资源离线，并可以在电脑上或是移动端打开直接浏览离线资源。参见资源离线。支持自定义任务：通过编写，调用 Smartbi API，完成更复杂的计划任务。参见自定义。应用场景场景 1：在日常工作中，企业经常需要制作业务周期，如“每月销售”、“每月员工出勤情况”等，并发送给审阅；场景 2：又如业务系般每晚进行数据的抽取和导入，所以每天的清晨，公司的各级管理都需要一份昨日的业务分析，而系统分析又不可能每天清晨去运行和更新这一张张报表。场景

5、3：移动设备可以通过资源离线功能，将离线数据好放在移动设备上或是 PC 上，即使设备脱离网络环境时，也可以随时查看数据。Smartbi 提供的“计划任务”功能，就是帮助用户解决这个问题。利用该功能，用户可以将需要发出的报表定时进行运行和发送，产品支持多种格式输出。实现原理：用户把需要执行的任务按性质进行分类，制定不同的计划（相当于有一个虚拟雇员），让他们根据计划时间表的安排自动执行任务，并可将执行结果发送给相关。这种任务自动化的处理，可替企业节省大量的工作量，第一时间为企业提供及时、准确的分析报表。术语定义界面介绍术语定义计划计划是指定制执行任务的方式或时间等。任务任务是指某项具体的操作内容。

6、自定义任务是指通过用户自己编写的 JavaScript来定制任务。管理控制管理控制是对计划任务执行的。“计划任务”界面主要分为以下几个区域：资源目录区：该区显示三个节点“任务、计划和管理控制”，其中任务和计划节点下分别用于存放已创建的计划文件和任务文件；管理控制节点为进入“管理控制界面”的入口之一。该区右上方的搜索引擎可以对计划任务中的资源进行快速搜索定位。主界面区：该区是用户与系统交互的区域，默认显示了任务、计划及控制操作的快捷方式。2. 任务任务表示调度执行的具体内容。有五种任务类型：表数据填充、报表导出、页面导出、资源离线和自定义。功能：在左侧资源目录树下，选中任务节点或是其子目录节点右

7、键选择新建任务，或是在主界面点击快捷方式新建任务。点击新建任务后，则进入任务定义区域：界面介绍任务基本信息区：根据需要输入任务的名称、别名和描述。任务内容定义区：和任务类型关联，根据任务类型不同，则设置选项也不同。此内容介绍详细请参考各个任务类型设置。任务操作按钮区：任务操作按钮。查看运行：查看任务生成的 JS 运行。测试运试运行执行此任务，查看相关运行效果。保存：保存此计划任务。关闭：关闭此任务，进入计划任务主页面。2.1 报表导出报表导出是系统提供的一种任务类型，表示将报表以各类报表文件的形式导出到本地或以邮件附件的形式发送给相关。报表导出支持的报表类型有：电子报表、组合分析、分析、分析、

8、word 分析报告。操作在新建任务界面基本信息区的设置项任务类型下拉列表中选择 报表导出。界面介绍任务类型在选择报表导出选项后，然后根据需要进行报表设置和导出设置，如下所示报表设置：选择需要导出的报表，并对其参数导出类型进行设置。导出设置：报表导出类型、地址、名称等导出相关的设置。参考示例计划任务导出资源到本地计划任务导出报表并发邮件给收件人计划任务导出资源到机器计划任务以固定参数方式导出资源计划任务以枚举参数方式导出资源计划任务实现每天定时导出日报计划任务实现灵活分析导出静态报表注意事项只支持单选的下拉框参数进行枚举取值方式设置。若将存在多个参数且每个参数有多个备选值的报表导出，当导出设置项

9、参数枚举勾选时，导出的数据文件的个数为各参数所有备选值的积的个数。两个参 数，每个参数有两个备选值，则将导出四个数据文件。若不进行固定的文件名称设置，则导出的数据文件命名为：所选导出报表的别名_参数 1 取值_参数 2 取值_参数 N 取值.后缀名。若相同条件下的资源重新导出，则会覆盖相同路径下的同名文件，得到的文件。2.1.1 报表设置报表设置是指导出报表的相关设置，主要包含选择导出哪张报表，参数导出类型和值的设置。选择报表选择需要导出的具体报表。单击 选择报表 按钮，弹出选择源报表框。目前支持导出。的报表类型有：电子报表、组合分析、分析、分析、word 分析参数值设置类型设置导出报表时的报

10、表参数取值，主要有两个选项：固定参数值、枚举参数值。固定参数值：表示导出报表中的参数为固定取值，且导出的文件个数只有一个。固定参数值设置主要有以下两种设置方式：使用默认值：表示参数取值为当前报表后再次打开显示的值。选择使用默认值的参数不允许再进行使用固定值设置。使用固定值：表示参数取值为用户选择的值。选择使用固定值的参数不允许再进行使用默认值设置枚举参数值：表示导出报表中的参数为枚举取值，且导出的文件个数与所选报表参数的所有备选值的个数匹配，导出的数据文件的个数为各参数所有备选值的数。枚举参数值设置主要有以下两种设置方式：注意：枚举参数值只支持下拉框参数，并且参数必须为单选参数。枚举设置：表示

11、参数取值默认为所有值。使用固定值：表示参数取值为用户选择的值。积的个2.1.2 导出设置导出设置是指报表导出类型、地址、名称等导出相关的设置。导出设置。切换 Tab 页来进入导出设置导出类型为共享目录界面：导出类型为邮件类型界面：导出设置设置项说明如下：页签设置项说明导出设置导出格式设置报表导出的数据文件格式，主要有：EXCEL、TXT、CSV、WORD、PDF、静态报表、数据分析包。不同的资源类型支持导出的类型是不同的，具体请参考下面资源和类型对应表。EXCEL2003/Excel：表示以 Excel2003/Excel 表的文件格式导出到本地。TXT：表示以 txt 文本格式导出到本地，以

12、该格式导出时需要设置分隔符。CSV：表示以 csv 的文件格式导出到本地。WORD/Word2003：表示以 WORD/word2003 的文件格式导出到本地。PDF：表示以 PDF 的文件格式导出到本地。JPEG/PNG：表示以 JPG/PNG 的文件格式导出到本地。一般是仪表分析和地图分析支持。HTML/MHT：表示以 HTML/MHT 的文件格式导出到本地。静态报表：表示将报表以表格的样式导出到系统文件目录（如各公共文件目录或个人目录）。目前只有灵活分析支持这种类型的导出。数据分析包：表示将报表以数据分析包的格式导出到本地。灵活分析、组合分析才支持。可以参考数据分析包相关章节。导出类型设

13、置报表导出的方式主要有：共享目录、邮件。共享目录：表示数据文件导出到服务器的盘符地址。其中数据文件为多个时，以文件夹形式导出；数据文件为单个时，以单个数据文件导出。需要进行如下设置：目标路径：用于设置报表导出到本地的目标文件夹路径（服务器上）。文件名称：用于设置报表以数据文件导出到本地的名 称。不设置文件名称时，导出文件的名称默认为：所选导出报表的别名_参数 1 的取值_参数 2 的取值。动态文件名：是否添加参数名：勾选表示文件名后面自动添加参数值。枚举参数时，文件名必须添加参数值。是否在文件名后添加时间戳：勾选表示文件名后面自动添加时间戳，时间戳格式为 YYYYMMDDHHMMSS，例如：

14、test_20181126110700.xlsx。邮件：表示所有数据文件以附件的形式发送到相关人，允许设置文件是否以压缩文件发送。需要进行如下设置：注意：发件人的相关信息请在邮件设置中进行设置。动态文件名：是否在导出文件名后添加参数值、时间戳。压缩文件：发送的文件是否是以压缩的方式发送。打勾则表示是以压缩文件发送。收信人：用于设置接收报表的邮箱地址，且以分号分隔多个收件人。抄送：用于设置接收报表的抄送邮箱地址，且以分号分隔多个抄送地址。备注：v6 及以上版本电子表格报表支持导出 CSV。压缩文件资源和类型对应表发送的文件是否是以压缩的方式发送。打勾则表示是以压缩文件发送。此选项一般用户导出资源

15、过大，或是枚举参数同时导出多个资源的情况。不打勾不以压缩文件方式导出的效果如下图：类型组合分析分析分析电子表格word 分析ExcelExcel2003TXTCSVWordWord2003PDFJPEGPNGHTMLMHT静态报表数据分析包密送：用于设置接收报表的密送邮箱地址，且以分号分隔多个密送地址。邮件标题：用于设置邮件的标题。不设置时，默认显示任务名称_日期时间。邮件正文：用于设置邮件正文。不设置时，默认显示这是一个系统自动发送的邮件，所含附件是您订阅的报表。作为正文内容：如果是导出的，是否作为邮件正文发送。打勾则表示是。打勾后以压缩文件导出的效果如下图：作为正文内容作为正文内容：如果是

16、导出的打勾则作为邮件附件导出。，是否作为邮件正文发送。打勾则表示是，不2.2 资源离线资源离线主要是把电子表格离线到览资源。或是 PC 上，以便在没有网络的情况下也可以浏目前支持离线操作的资源只有电子表格和页面，支持一个任务同时导出多个资源。应用场景：场景 1：有些数据量比较大，或是刷新比较慢的报表希望每段时间定制导出离线资源到 PC上，这样客户可以直接在 PC 上离线打开，无需占用内存。场景 2：可以把一些资源离线到移动应用上，这样用户可以设置每次登录的时候自动离线包，这样在没有网络的时候，也可以看到操作的离线资源。打勾后，以正文方式发送效果，如下图：在新建任务界面基本信息区的设置项任务类型

17、下拉列表中选择 资源离线。2.2.1 资源离线-报表设置报表设置是指资源的相关设置，主要包含选择导出哪些资源，以及参数取值的设置选择资源选择需要离线的具体资源。单击 选择资源 按钮，弹出选择资源支持导出的资源类型有：电子表格。框。目前参数设置资源离线时需要对参数进行设置。参数列表区列出了资源上的所有参数，取值范围可对参数值进行设置。取值范围选项2.2.2 资源离线-导出设置导出设置是指资源的导出类型和具体的导出设置。导出类型分为：公共目录和移动发布。导出类型为共享目录：导出类型为“共享目录”时，需要指定资源导出的路径。该路径为服务器上的绝对路径。如 c:/temp/。设置项描述无不设置参数值静

18、态列表参数值来源于设置的静态列表数据来自参数参数值来源于所选择的参数的备选值列表2.3 表数据填充表数据填充是系统提供的一种任务类型，表示将联合数据源临时表所依赖的业务查询或数据表或视图返回的结果集中的数据抽取并到该临时表中。在创建任务时，选择任务类型为表数据填充，则下面的任务内容设置变为表数据填导出类型为移动发布：导出类型为“移动发布”时，需要设置资源离线的目标，可选择用户组或者用户。当任务运行时，在移动端进行登录时，可自动离线包进行离线查看资源。充设置。具体操作步骤请参考示例：如何将数据集数据通过计划任务抽取到临时表中2.4 定制定制即自定义任务，是系统提供的一种任务类型，是指通过用户自己

19、输入 JavaScript来定制个性化任务，实现无法通过配置实现的其它功能。自定义的优势是能实现更丰富的功能，满足各种特殊的应用，但这种方式比较复杂，需要熟悉 JavaScript 与任务编写规范。关于 JavaScript 的介绍请参见 附录 2：JavaScript 参考|_概述。自定义任务有专门的文档介绍，可以参考计划任务开发指南操作在新建任务界面基本信息区的设置项任务类型下拉列表中选择 定制，进入定制设置文本区。当编写自定义任务时，可以通过下面的写法来引入 JAVA 类：importClass(java.lang.System);通过这些类就可以使用 Java 的功能。如下图所示，这个

20、任务会在服务器的输出o属性说明联合数据源选择需要填充数据表所在的联合数据源Schemas选择需要填充数据表所在的 Schemas，有些数据库无 Schemas，则直接选表表选择需要填充数据的表World! 字符串。3. 计划计划是指定制执行任务的方式或时间等。一个计划支持调度多项任务。操作在左侧资源目录树下，选中计划节点或其子目录节点，右键选择新建计划，或是在主界面点击快捷方式新建计划。点击新建任务后，则进入计划定义区域。界面介绍计划界面主要分为以下几个区域：基本信息区：该区用于设置并显示计划的基本信息，如：计划名称、计划别名、计划描述、计划执行的任务等。执行设置区：该区用于设置执行当前计划传

21、递的用户名及和计划执行失败的重试机制。功能按钮区：该区放置了各项功能的按钮：手动执行、保存、关闭。各设置项说明如下：域设置项说明基本信息区计划名称表示当前计划的真名，计划一旦保存后，该设置项不允许修改。计划别名表示当前计划的别名。计划描述表示对当前计划的描述信息。待执行任务表示选择当前计划执行的任务。允许选择多个任务。触发类型表示触发该计划执行的类型，目前只支持时间类型。间隔类型表示执行该计划的频率，主要包含：、每分、每时、每天、每周、每月、手工输入。是否启用表示是否启用当前计划，默认勾选。并且以状态图标形象显示当前计划所处的状态。是否指定生效范围表示当前计划是否限定在生效范围内才执行。生效范

22、围表示当前计划的生效范围。运行设置会根据间隔类型不同，显示出不同的运行设置。表示针对不同的计划执行间隔类型而进行的相应的运行时间的设置。执行设置区执行用户表示执行当前计划所传递的用户名，主要有两类：计划创建者、特定用户。计划创建者：是指创建当前计划的用户。特定用户：是指除当前计划创建用户之外自定义指定的用户。此时，需要制定具体的用户名和。失败重试机制表示执行当前计划失败的情况下重新执行计划的设置，主要有：重试次数、重试间隔。区说明表数据填充时，执行计划的用户需要有导入资源的查看权限以及目标临时表的编辑权限。手动执行的计划做为计划的一次执行，其执行情况在调度日志中。3.1 间隔类型和运行设置间隔

23、类型表示执行该计划的频率，主要包含：月、手工输入。、每分、每时、每天、每周、每：表示计划只执行一次。执行完计划后，计划的启用状态变为停止，即计划的是否启用选项的勾选状态变为不勾选。每分：表示计划按分的频率执行。 每时：表示计划按小时的频率执行。每天：表示计划按天的频率执行。 每周：表示计划按周的频率执行。 每月：表示计划按月的频率执行。手工输入：可以自己写表达式实现当前不满足的间隔类型。运行设置会根据间隔类型不同，显示出不同的运行设置。表示针对不同的计划执行间隔类型而进行的相应的运行时间的设置。：表示计划只执行一次。执行完计划后，计划的启用状态变为停止，即计划的是否启用选项的勾选状态变为不勾选

24、。运行设置包含触发时间和运行的具体日期设置，如下图。可以根据需要修改。重试次数：表示重新执行当前计划的次数。重试间隔：表示每隔多长时间重新执行一次当前计划。间隔的时间主要以分钟和小时来计量。功能按钮区手动执行该按钮表示手动执行一次当前计划。该按钮要在当前计划保存之后才允许操作。该按钮表示一份当前的计划副本，为快速创建计划的方式。保存该按钮表示保存当前计划信息及设置。关闭该按钮表示退出当前计划设置窗口。每分每分：表示计划按分钟的频率执行。运行设置包含触发时间、间隔时间 和起始日期。其中触发时间默认是为 12： 00，起始日期默认值取当前系统时间，间隔时间默认值为每1分钟为一次执行间隔时数。 可以

25、根据需要修改。每时每时：表示计划按时的频率执行。运行设置包含触发时间、间隔时间 和起始日期。其中触发时间默认是为 12： 00，起始日期默认值取当前系统时间，间隔时间默认值为每1时为一次执行间隔时数。可以根据需要修改。每天每天：表示计划按天的频率执行。运行设置包含触发时间、间隔时间 和起始日期。其中触发时间默认是为 12： 00，起始日期默认值取当前系统时间，间隔时间默认值为每1天为一次执行间隔时数。可以根据需要修改。每周每周：表示计划按周的频率执行。运行设置包含触发时间和选择。其中触发时间默认是为 12：00，选择列举出周一到周日供选择。可以根据需要修改。每月每月：表示计划按月的频率执行。运

26、行设置包含触发时间、间隔时间和选择月份。其中触发时间默认是为 12：00，间隔时间可以设置这个月的某几天或是这个月的某州的到 12 月供选择。可以根据需要修改。几，选择月份列举出 1 月手动输入当固定的频率仍然不满足需要时，可以通过手动输入表达式的方式设置自己想要的频率。如下示例，表示每 5 分钟执行一次。CRON 表达式书写规则，可以在搜索获得。4.管理管理是对计划执行的。操作右键 或 双击 左侧资源树中的管理打开进入管理控制界面。管理控制界面介绍管理控制界面主要分为以下几个区域：页签切换区：该区用于在运行和调度日志两个界面进行切换。浏览设置区：该区用于对浏览报表的设置项进行设置，不同页签界

27、面中的设置项不同，详细信息请分别参见 运行和 调度日志。信息显示区：该区用于显示各计划的相关信息，如计划的基本信息、上次执行信息、下次执行信息等。4.1 调度日志调度是执行计划的指令。调度日志是对各计划通过指令执行的相关情况的一种调度类型、调度结果、调度结果、详细描述等。调度日志是按照计划每次执行的先后顺序执行情况。调度日志界面介绍在调度日志界面允许用户进行如下操作：活动，主要的内容有：筛选参数：调度类型、计划类型、任务类型、开始时间、结束时间，查询出用户关心的日志。当调度日志超过一页的情况下，允许切换不同的页进行浏览。允许设置每页显示的数。允许用户删除所选定的日志。明细表属性介绍4.2 运行运行是各计划相关情况的式，是以计划为进行的活动，主要的内容有：上次执行信息、下次执行信息以及当前状态。运行是按照各计划创建的先后顺序列出其相关情况。调度日志项说明名称计划和其下包含任务的名称类型计划任务触发类型。时间计划任务执行的时间调度类型调度的类型即为计划运行指令的类型，主要有以下几种：执行：表示处于启用状态下的计划进行运行。重试：表示处于重试状态下的计划进行运行。激活：表示计划从停止状态变为启用状态。变更：表示对计划进行了运行频度设置项的修改。移除：