調度參數是DataWorks任務調度時使用的參數，可根據您配置的調度參數取值規則，在每次任務運行時自動替換為真實的取值，實現任務調度時間內參數的動態替換。本文為您介紹調度參數支援的格式及相關使用。
背景資訊
您可在代碼中通過本文為您介紹：瞭解調度參數支援的格式後，您可根據業務需求配置並使用調度參數，詳情請參見後續：配置及使用調度參數。
${變數名}的方式定義變數，並在介面，通過調度參數運算式為代碼中的變數賦值，實現調度情境下的代碼動態入參。部分節點的調度參數配置存在差異（例如，通用Shell節點中的變數只能以$1、$2、$3...命名），詳情請參見各類型節點的調度參數配置樣本。說明 調度參數支援賦值常量，即每次進行任務調度時，該參數傳入同一個值。本文主要基於通過調度參數實現代碼動態入參情境進行說明。
概念介紹
調度參數通常會被用於指代某些動態時間的情境，此情境下，您可基於業務日期和定時時間進行調度參數的取值設定。配置調度參數前，您可先瞭解這兩個時間概念，便於後續設定調度參數取值。
| 概念 | 描述 |
| 業務日期 | 指昨天，在離線計算情境下，交易日期為業務發生的日期。DataWorks預設取調度時間內，任務預期調度已耗用時間的前一天（即昨天）的日期為業務日期，精確到天。例如，今天統計前一天的營業額，此處的前一天，指交易發生的日期，也就是業務日期。 |
| 定時時間 | 指今天，即某業務資料加工任務的預期執行時間。DataWorks預設取調度時間內，任務預期調度啟動並執行時間點（即今天）為定時時間，精確到秒。任務預期執行時間，與實際開始執行時間並非完全一致。任務實際開始執行時間受多方因素影響。 |
調度參數支援的格式
通常，調度參數用於擷取不同的時間資料，您可根據業務需求，選擇基於業務日期或定時時間擷取相應時間資料。
說明 DataWorks提供了部分內建變數，其格式固定，為了使用更加靈活，建議您通過以下方式自訂時間格式。
| 取值方式 | 參數格式 | 參數樣本 | 相關參考 |
| 基於業務日期擷取時間資料。 | 通常，使用大括弧${...}，結合yyyy、yy、mm及dd自訂群組合產生時間參數，擷取業務日期前後多少年、月、天。說明 業務日期為 定時時間所在日期-1。即${yyyymmdd}的取值與$[yyyymmdd-1]取值一致。 | 可通過${yyyymmdd}、${yyyy-mm-dd}等${...}自訂時間格式擷取，例如：
| 更多賦值樣本，請參見自訂參數${...}。 |
| 基於定時時間擷取時間資料。 | 通常，使用中括弧$[...]，結合yyyy、yy、mm、dd、hh24、mi及ss自訂群組合產生時間參數，擷取定時時間前後多少年、月、天、小時、分鐘、秒。 | 可通過$[yyyymmddhh24miss]等$[...]自訂時間格式擷取。例如，取前一天的前一小時，參數運算式為$[yyyymmdd-1-1/24]。 |
|
調度參數無法覆蓋的情境（即通過上述運算式無法直接擷取預期格式的參數賦值），您可先通過上述方式擷取時間格式資料，再執行下表操作擷取相應時間。
| 情境樣本 | 操作說明 | 相關參考 |
| 通過引擎函數將時間格式的內容加工為時間戳記。 | 在代碼中使用引擎函數擷取目標時間。 | 調度參數傳回值二次處理的典型情境 |
| ${mm}01：擷取每月1號。 | 通過純字串拼接，擷取目標時間。 | 無 |
注意事項
${…}參數相關。取N年前、N月前的時間資料需使用${…}參數。${…}參數只能精確到年月日，因此${…}參數不支援${yyyy-mm-dd-1/24}用法。- 如需對年份、月份進行計算，建議使用
${…}參數。例如，${yyyy-N}、${mm-N}。
$[…]參數相關。- 取N小時前、N分鐘前的時間資料需使用
$[…]參數。- $[…]參數基於時分秒進行替換，無法根據
$[yyyy-N]、$[mm-N]時間格式擷取多少年前、多少月前的時間資料。單獨取年份、月份，請使用${…}參數。 - 如需擷取精確到秒的時間資料時，建議使用
$[…]參數。例如，$[yyyy-mm-dd-1-1/24]。
- $[…]參數基於時分秒進行替換，無法根據
$[...]調度參數替換值不隨執行個體實際已耗用時間改變。$[...]根據執行個體定時時間取值，調度參數替換值在執行個體產生時已確定，因此調度參數的替換值不會隨著執行個體實際已耗用時間而改變。詳情請參見附錄：調度參數與業務日期、定時時間、實際已耗用時間的關係。
說明$[...]取小時參數時，支援取不同時間格式。hh24代表根據24小時制時間格式取值，hh代表根據12小時制時間格式取值。
- 取N小時前、N分鐘前的時間資料需使用
${bizdate}變數名說明。部分節點代碼會內建一個
${bizdate}變數名，該變數名無特殊含義。您可根據業務需求自訂代碼中的變數名。- 取小時、分鐘時間的跨天問題處理。
取多少小時、分鐘，可能存在跨天問題，跨天時間的參數處理，詳情請參見調度參數往前取一個小時，如何處理跨天參數替換的問題。
附錄：參數列表
自訂參數${...}及$[...]的功能差異，詳情請參見${…}和$[…]參數的功能差異。- 自訂參數${...}常用取值樣本如下。
日期加減周期 擷取方式 前/後N年 ${yyyy±N}前/後N月 ${yyyymm±N}前/後N周 ${yyyymmdd±7*N}前/後N天 ${yyyymmdd±N}年月日加/減N天 ${yyyymmdd±N}加/減N年（yyyy格式） ${yyyy±N}年加/減N年（yy格式） ${yy±N}年重要- 單獨擷取
多少月前、多少年前等時間資料，建議使用${...}參數。 ${…}參數僅支援對天、月、年時間進行加減。
- 單獨擷取
- 自訂參數$[...]常用取值樣本如下。
時間加減周期 擷取方式 後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±N]前/後N小時 擷取該時間資料包含如下方式： $[hh24miss±N/24]、$[hh24±N/24]$[自訂時間格式±N/24]。例如，取前一個小時的不同時間格式：- 取月：
$[mm-1/24]。 - 取年：
$[yyyy-1/24]。 - 取年月：
$[yyyymm-1/24]。 - 取年月日：
$[yyyymmdd-1/24]。 - 取前一天且前一小時：
$[yyyymmdd-1-1/24]
- 取月：
前/後N分鐘 擷取該時間資料包含如下方式： $[hh24miss±N/24/60]$[yyyymmddhh24miss±N/24/60]$[mi±N/24/60]$[自訂時間格式±N/24/60]。例如，取定時時間15分鐘前的不同時間格式：$[yyyy-15/24/60]$[yyyymm-15/24/60]$[yyyymmdd-15/24/60]$[hh24-15/24/60]$[mi-15/24/60]
hh24表示小時（12進位使用hh），由於$cyctime精確到時分秒，因此$[…]參數可以精確到時分秒。您可以結合引擎函數，擷取更多參數取值，詳情請參見調度參數傳回值二次處理的典型情境。重要- 擷取
多少小時、多少分鐘前等時間資料請使用$[...]參數。 - 調度參數替換值在執行個體產生時已經確定，因此調度參數的替換值不會隨著執行個體實際已耗用時間而改變。
- 系統內建參數DataWorks支援下表的系統參數，可用於設定調度參數的取值。但該方式靈活性差，建議參考上文描述，使用自訂參數的方式設定調度參數取值。
內建參數 定義 $bizdate 業務日期，格式為 yyyymmdd，與自訂參數${yyyymmdd}取值一致。該參數的應用較為廣泛，日常調度中預設任務預期已耗用時間的前一天為業務日期。
$cyctime 任務的定時時間，格式為 yyyymmddhh24miss，與自訂參數$[yyyymmddhh24miss]取值一致。$gmtdate 當前日期，格式為 yyyymmdd。該參數預設取當天日期，執行補資料操作時輸入的日期為
業務日期+1。$bizmonth 業務月份，格式為 yyyymm。- 如果業務日期的月份與當前月份一致，則
$bizmonth=業務日期月份-1。 - 如果業務日期的月份與當前月份不一致，則
$bizmonth=業務日期月份。
$jobid 任務所屬的商務程序ID。 $nodeid 節點ID。 $taskid 節點產生的執行個體ID。 - 如果業務日期的月份與當前月份一致，則
附錄：調度參數與業務日期、定時時間、實際已耗用時間的關係
| 關係類別 | 說明及樣本 |
| 調度參數與實際已耗用時間的關係 | 調度參數替換值在執行個體產生時已確定，因此，調度參數的替換值不會隨著執行個體實際已耗用時間的改變而產生變化。 |
| 調度參數與任務定時時間的關係 | 當調度參數取小時、分鐘時，參數替換值由執行個體的定時時間決定，即由節點調度配置的定時調度時間決定。 例如，當前節點為小時調度節點，並且設定定時調度時間為 00：00~23：59，每小時調度一次，則：
|
| 調度參數與業務日期、定時時間的關係 |  |
附錄：關於夏令時說明
DataWorks可保障在進入和退出夏令時當天，任務能夠正確運行。進入與退出夏令時切換產品側的解決方案詳情，請參見情境：夏令時切換對調度任務啟動並執行影響。為避免夏令時切換對您任務執行造成額外理解成本，建議實施夏令時的地區優先查看此文檔。後續：配置及使用調度參數
瞭解調度參數支援的時間格式後，您可基於業務需求配置並使用調度參數，詳情請參見配置並使用調度參數。