调度参数是DataWorks任务调度时使用的参数，调度参数会根据任务调度的业务时间及调度参数的取值格式自动替换取值，实现在任务调度时间内参数的动态取值。本文为您介绍调度参数的主要类型、注意事项和典型的配置示例。
背景信息
- 自定义参数：
需要在中进行赋值，赋值后可在代码中引用自定义参数的变量名。
自定义参数包括如下类型：- 系统内置参数，详情可参见自定义参数：系统内置参数。
- ${…}参数，详情可参见自定义参数：${…}参数。
- $[…]参数，详情可参见自定义参数：$[…]参数。
- 常量参数，详情可参见自定义参数：常量参数。
- 系统内置变量：
无需手动赋值，参数可以在代码中直接引用，包括业务时间参数${bdp.system.bizdate}和定时时间参数${bdp.system.cyctime}。系统内置变量的详情可参见系统内置变量。
- 不同类型节点调度参数示例，详情请参见不同类型节点调度参数赋值格式及示例。
- 应用调度参数后，您可以进入运维中心查看参数替换情况，详情请参见在运维中心页面查看参数替换情况。
- 使用过程中的常见问题，详情请参见常见问题。
注意事项
- 测试运行数据开发任务时，代码中引用的调度参数需手动赋值。
节点配置调度参数并发布生产环境自动调度后，调度系统会根据任务运行的业务时间自动替换调度参数的取值。但在数据开发界面测试运行时不经过调度系统，所以直接单击工具栏的运行或高级运行时，需要给代码中引用的调度参数手动赋值。
例如，使用调度参数bdp.system.bizdate调度运行任务时，此参数会被替换为当前任务运行的具体业务时间，但是在数据开发页面通过运行按钮调测代码时，bdp.system.bizdate参数不会替换为业务时间，您需要手动为此参数设置一个具体的时间常量数据，详情可参见开发环境测试调度参数。
- 在数据开发页面测试调度参数的替换情况，请务必使用开发环境冒烟测试。详情可参见开发环境测试调度参数。
- 代码中的变量被修改，或者需要重新为变量赋值常量，请务必使用高级运行。
- 使用工具栏的高级运行功能时，每次运行前均需要为代码中的变量赋值常量，用于保障任务运行时，代码中的变量取值正确。
- 使用工具栏的运行功能时，仅第一次运行时会产生赋值对话窗，需要您为变量赋值，后续运行时均不会产生赋值对话窗。
说明 数据开发任务后续运行时，运行功能默认取用第一次的赋值取值，可能会导致取值错误。因此，建议您使用高级运行功能为代码中的变量赋值。 - ${…}参数与$[…]参数的用法注意事项：
- 取N小时前、N分钟前的时间数据需用$[…]参数。
如果需要精确到秒时，建议使用$[…]参数，例如，$[yyyy-mm-dd-1-1/24]。说明 $[…]参数不支持$[yyyy-N]、$[mm-N]等这种直接进行年月数据计算的用法。
- 取N年前、N月前的时间数据需用${…}参数。
如果需要对年份、月份进行计算，建议使用${…}参数，例如，${yyyy-N}、${mm-N}。说明 ${…}参数只能精确到年月日，因此${…}参数不支持${yyyy-mm-dd-1/24}等用法。
- 取N小时前、N分钟前的时间数据需用$[…]参数。
配置调度参数
| 功能点 | 描述 |
|---|---|
| 新增参数 | 同一个调度任务可以配置多个调度参数，当需要使用多个调度参数时，您可以单击新增参数添加。 |
| 加载代码中的参数 | 用于将当前数据开发节点中用到的参数添加至调度参数中，便于调度任务后续使用。
说明 如果加载的是代码中的变量参数，则加载后您需要自行进行赋值。
|
| 用表达式定义 | 调度参数配置界面默认使用可视化界面定义参数（即区域1），如果您习惯使用表达式定义，则可单击用表达式定义进行参数定义。
说明
|
自定义参数：系统内置参数
| 内置参数 | 定义 |
|---|---|
| $bizdate | 业务日期，格式为yyyymmdd。
该参数的应用较为广泛，日常调度中默认运行时间的前一天为业务日期。 |
| $cyctime | 任务的定时时间，格式为yyyymmddhh24miss。 |
| $gmtdate | 当前日期，格式为yyyymmdd。
该参数默认为当天日期，补数据时传入的是 |
| $bizmonth | 业务月份，格式为yyyymm。
|
| $jobid | 任务所属的业务流程ID。 |
| $nodeid | 节点ID。 |
| $taskid | 任务ID，即节点实例ID。 |
- 通用Shell节点
- 赋值格式：
value1 value2。value1、value2为系统内置参数，DataWorks当前可用的系统内置参数，请参见表 1。 - 引用格式：在代码中引用变量$1,$2 ...。
说明 EMR Shell、EMR Spark Shell节点的赋值要求，请参考ODPS SQL节点引用方式。 - 赋值格式：
- ODPS SQL节点、离线同步节点、PyODPS节点、EMR类型节点
说明 通过用表达式定义方式进行参数赋值时，多个参数赋值公式之间使用一个空格分隔。- 赋值格式：
key1=value1 key2=value2。key1、key2为自定义的参数名称，value1、value2是系统内置参数，DataWorks当前可用的系统内置参数列表，请参见上述表 1。 - 引用格式：
- ODPS SQL节点、EMR类型节点、离线数据同步节点
直接引用
${key1}、${key2}，其中key1和key2为自定义的参数名称。例如，dt=${key1}。 - PyODPS节点
在全局变量中增加一个名为args的字典对象
args=['key1'] args=['key2']。其中key1和key2为自定义的参数名称。
- ODPS SQL节点、EMR类型节点、离线数据同步节点
- 赋值格式：
自定义参数：${…}参数
- yyyy表示4位的年份，取值为$bizdate的年份。
- yy：表示2位的年份，取值为$bizdate的年份。
- mm表示月，取值为$bizdate的月份。
- dd表示天，取值为$bizdate的天。
- 由于$bizdate精确到年月日，因此${…}参数只能精确到年月日。
- ${…}参数不支持${yyyy-mm-dd-1/24}等用法。如果需要精确到秒，建议使用$[…]参数。例如，$[yyyy-mm-dd-1-1/24]。
- 通用Shell节点
- 赋值格式：
value1 value2。value1、value2为自定义的日期取值。 - 引用格式：在代码中引用变量$1,$2 ...。
说明 EMR Shell节点和EMR Spark Shell节点，请参考ODPS SQL节点引用方式。 - 赋值格式：
- ODPS SQL节点、离线同步节点、PyODPS节点、EMR类型节点说明 通过用表达式定义方式进行参数赋值时，多个参数赋值公式之间使用一个空格分隔。
- 赋值格式：
key1=value1 key2=value2。key1、key2为自定义的参数名称，value1、value2为自定义的日期取值。常见的日期取值如下表所示。日期加减周期 value值 后N年 ${yyyy+N} 前N年 ${yyyy-N} 后N月 ${yyyymm+N} 前N月 ${yyyymm-N} 后N周 ${yyyymmdd+7*N} 前N周 ${yyyymmdd-7*N} 后N天，年月日加N天 ${yyyymmdd+N} 前N天，年月日减N天 ${yyyymmdd-N} - 引用格式：
- ODPS SQL节点、EMR类型节点、离线数据同步节点
直接引用
${key1}、${key2}，其中key1和key2是自定义的参数名称。例如，dt=${key1}。 - PyODPS节点
在全局变量中增加一个名为args的字典对象：
args=['key1'] args=['key2']。其中key1和key2是自定义的参数名称。
- ODPS SQL节点、EMR类型节点、离线数据同步节点
- 赋值格式：
自定义参数：$[…]参数
- yyyy：表示4位的年份，取值为$cyctime的年份。
- yy：表示2位的年份，取值为$cyctime的年份。
- mm：表示月，取值为$cyctime的月份。
- dd：表示天，取值为$cyctime的天。
- hh24：表示小时（12进制使用hh），取值为$cyctime的小时。
- ss：表示秒，取值为$cyctime的秒。
- mi：表示分钟，取值为$cyctime的分钟。
- 通用Shell节点
- 赋值格式：
value1 value2。value1、value2为系统内置参数，DataWorks当前可用的系统内置参数列表，请参见上述表 1。 - 引用格式：在代码中引用变量$1,$2 ...。
说明 EMR Shell节点和EMR Spark Shell节点，请参考ODPS SQL节点引用方式。 - 赋值格式：
- ODPS SQL节点、离线同步节点、PyODPS节点、EMR类型节点
![$[…]参数赋值示例](https://help-static-aliyun-doc.aliyuncs.com/assets/img/zh-CN/1021292361/p335821.png)
说明- 通过用表达式定义方式进行参数赋值时，多个参数赋值公式之间使用一个空格分隔。
- 当参数取到小时分钟时，参数替换值由实例的定时时间决定，也就是节点调度配置的定时调度时间决定。
- 如果当前节点为日调度节点，并且设置定时调度时间为1：00，则小时的参数取值为01。
- 如果当前节点为小时调度节点，并且设置定时调度时间为0：00~23：59分，每小时调度一次，那么
- 第一个小时实例定时时间为0点，小时的参数取值为00。
- 第二个小时实例定时时间为1点，小时的参数取值为01。
- ...
- 调度参数替换值在实例生成的时候便已经确定，所以调度参数的替换值不会随着实例实际运行时间的改变而改变。
- 赋值格式：
key1=value1 key2=value2。key1、key2为自定义的参数名称，value1、value2为自定义的日期取值。常见的日期取值如下表所示。时间加减周期 value取值 后N年 $[add_months(yyyymmdd,12*N)] 前N年 $[add_months(yyyymmdd,-12*N)] 后N月 $[add_months(yyyymmdd,N)] 前N月 $[add_months(yyyymmdd,-N)] 后N周 $[yyyymmdd+7*N] 前N周 $[yyyymmdd-7*N] 后N天 $[yyyymmdd+N] 前N天 $[yyyymmdd-N] 后N小时 $[hh24miss+N/24] 前N小时 $[hh24miss-N/24] 后N分钟 $[hh24miss+N/24/60] 前N分钟 $[hh24miss-N/24/60] - 引用格式：
- ODPS SQL节点、EMR类型节点、离线数据同步节点
直接引用
${key1}、${key2}，其中key1和key2为自定义的参数名称。例如，dt=${key1}。 - PyODPS节点
在全局变量中增加一个名为args的字典对象：
args=['key1'] args=['key2']。其中key1和key2为自定义的参数名称。
- ODPS SQL节点、EMR类型节点、离线数据同步节点
自定义参数：常量参数
123）和字符常量（例如"abc"）。
- 通用Shell节点
- 赋值格式：
value1 value2。value1、value2为自定义的常量，DataWorks当前可用的系统内置参数列表，如"abc" 1234。 - 引用格式：在代码中引用变量$1,$2 ...。
- 赋值格式：
- ODPS SQL节点、离线同步节点、PyODPS节点、EMR类型节点
说明 通过用表达式定义方式进行参数赋值时，多个参数赋值公式之间使用一个空格分隔。- 赋值格式：
key1=value1 key2=value2。key1、key2为自定义的参数名称，value1、value2为自定义的常量。例如，key1="abc" key2=1234。 - 引用格式：
- ODPS SQL节点、EMR类型节点、离线数据同步节点
直接引用
${key1}、${key2}，其中key1和key2为自定义的参数名称。例如，dt=${key1}。 - PyODPS节点
在全局变量中增加一个名为args的字典对象：
args=['key1'] args=['key2']。其中key1和key2为自定义的参数名称。
- ODPS SQL节点、EMR类型节点、离线数据同步节点
- 赋值格式：
系统内置变量
- 变量类型
系统内置变量的类型如下表所示。
类型 定义 对比说明 ${bdp.system.bizdate} 实例计算时对应的业务日期，业务日期默认为运行日期的前一天，默认格式为yyyymmdd。 取值可精确到天。 定时时间和业务日期的计算公式为：定时时间所在日期=业务日期+1，业务日期默认为运行日期的前一天。
${bdp.system.cyctime} 实例的定时运行时间，默认格式为yyyymmddhh24miss。 取值可精确到小时、分钟、秒。 - 赋值引用要求
无需手动赋值，参数可以在代码中直接引用。
自定义参数应用对比
| 参数类型 | 代码引用方式 | 调度参数赋值 | 调度替换值 |
|---|---|---|---|
| ${yyyymmdd} | pt=${datetime1} |
datetime1=${yyyymmdd} |
datetime1=20191031 |
| $[yyyymmddhh24miss] | pt=${datetime2} |
datetime2=$[yyyymmddhh24miss] |
datetime2=201911010000 |
| $bizdate（业务时间） | pt=${datetime3} |
datetime3=$bizdate |
datetime3=20191031 |
| $cyctime（定时时间，精确到分秒） | pt=${datetime4} |
datetime4=$cyctime |
datetime4=20191101000000 |
| $gmtdate（当前时间，精确到天） | pt=${datetime5} |
datetime5=$gmtdate |
datetime5=20191101 |
| $bizmonth（业务月份） | pt=${datetime6} |
datetime6=$bizmonth |
当业务时间是当前月份时，$bizmonth的值为上个月的月份。当业务时间不是当前月份时，$bizmonth的值为业务时间的月份。示例如下：
|
${…}和$[…]参数的区别
| 比较项 | ${…}参数 | $[…]参数 |
|---|---|---|
| 时间基准 | 以$bizdate的时间为基准参与运算。$bizdate为业务日期，默认为当前时间减一天。 | 以$cyctime的时间为基准参与运算。$cyctime为任务定时调度时间。
例如，定时时间为当天的00:30，即 |
| 补数据使用 | 补数据时选择的业务日期和参数替换结果保持一致。 | 和Oracle的时间运算方式一致。执行补数据时，参数替换结果为选择的业务日期+1天。
例如，补数据选择的业务日期为20190720，则执行时cyctime替换结果为20190721。 |
| 时间精确度 | 精确到天 | 精确到秒
不支持${yyyy-mm-dd-1/24}等用法，建议使用$[yyyy-mm-dd-1-1/24]。 |
| 时间 | ${…}参数 | $[…]参数 |
|---|---|---|
| 年份：2019年 |
|
|
| 年份：19年 |
|
|
| 年份：2018年 |
|
不支持 |
| 月份 |
|
|
| 日期（天） |
|
|
| 日期：2019年06月20日 |
|
|
| 日期2019年07月19日 |
|
|
| 日期：2018年07月20日 |
|
|
| 时间：10:30:00 | 不支持 |
|
| 时间：2019-07-20 10:30:00 | 不支持 |
|
| 时间：2019-07-20 10:29:00 | 不支持 |
|
| 时间：2019-07-20 08:30:00 | 不支持 |
|
您可以通过业务时间维度查看${…}和$[…]自定义参数的区别，详情请参见自定义参数的区别。
不同类型节点调度参数赋值格式及示例
| 节点类型 | 参数赋值格式 | 说明 |
|---|---|---|
|
变量名1=参数1 变量名2=参数2 |
多个参数之间用空格分隔 |
| 通用Shell节点 | 参数1 参数2 |
多个参数之间用空格分隔 |
- ODPS SQL、ODPS MR类型：参数赋值格式为
变量名1=参数1 变量名2=参数2，多个参数之间用空格分隔。 - Shell类型：参数赋值格式为
参数1 参数2，多个参数之间用空格分隔。
- ODPS SQL节点、离线数据节点示例、EMR类型节点使用示例。
- 如果使用系统调度参数，无需在右侧的调度配置界面为变量赋值，在代码中直接引用系统参数即可。
- 如果使用自定义参数，需要在右侧的调度配置界面以变量名=自定义参数的方式为变量赋值，在代码中引用变量名。
- PyODPS节点示例。
为避免侵入代码，PyODPS节点不会在代码中替换${param_name}的字符串，但会在执行代码前，在全局变量中增加一个名为args的字典对象，调度参数可以在此获取。
例如，在节点的中，输入def=${yyyymmdd}，则可以通过下图的方式在代码中获取该参数。
- 通用Shell节点示例。
Shell节点中的变量不允许自定义命名，只能以$1,$2,$3...命名。参数到达第10个后，请使用${10}的方式声明变量。
开发环境测试调度参数
- 使用冒烟测试
您可以单击代码编辑页面的在开发环境进行冒烟测试，通过手动输入业务日期模拟节点自动调度的场景，获取当前业务日期下调度参数的替换值，通过冒烟测试的结果检查确认调度参数的取值是否是预期的取值。
说明- 在开发环境进行冒烟测试时，每次修改调度参数后，都需要重新保存、提交至开发环境，代码才会更新。
- 在开发环境进行冒烟测试时，会生成实例产生实例费。
- 手动替换参数
任务在数据开发界面运行（①）或高级运行（②），都不会根据页面右侧的参数配置来替换调度参数，您需要手动为代码中的变量（③或④）赋值常量。
在运维中心页面查看参数替换情况
节点的任务代码完成开发提交发布后，在周期任务中，周期实例中的调度参数在实例生成时已经进行替换，您可以在页面查看节点的调度参数取值是否正确。
如果您在数据开发页面修改、提交了调度参数，并发布至生产环境，请首先检查周期任务中的执行参数是否符合预期。
常见问题
- 调度参数典型场景
- 调度参数测试运行常见问题
- 运行按钮的赋值逻辑差异运行，高级运行和开发环境冒烟测试赋值逻辑有什么区别
- 调度参数运维与查看