提供給背景處理的參數

本節描述提供給背景處理的各類型參數。

一般參數

下列資訊會傳遞至每個背景處理。

  • 批次代碼。批次代碼是背景處理的唯一識別碼。

  • 批次執行緒編號。執行緒編號僅用於能以多個平行執行緒執行的背景處理。它包含處理的相對執行緒編號。例如,如果計費處理設定為以 20 個平行執行緒執行,則這 20 個實例各自都會收到相對的執行緒編號 (1 到 20)。請參考平行背景處理的最佳執行緒數目以取得更多資訊。

  • 批次執行緒計數。執行緒數目僅用於能以多個平行執行緒執行的背景處理。它包含已排定的平行執行緒總數。例如,如果計費處理設定為以 20 個平行執行緒執行,則這 20 個實例都會收到執行緒數目 20。請參考平行背景處理的最佳執行緒數目以取得更多資訊。

  • 批次重新執行編號。重新執行編號僅用於下載指定執行編號相關資訊的背景處理。只有在您需要下載歷史執行 (而不是最新執行) 時才應提供此編號。

  • 批次業務日期。業務日期僅用於在處理中使用目前日期的背景處理。例如,計費處理可以使用業務日期來決定應下載的帳單週期。如果此參數留白,則會使用系統日期。如有提供,此日期的格式必須為 YYYY-MM-DD。備註:此參數僅在 QA 時用於測試處理在一段時間內的行為。

    備註:線上提交的批次工作在提交時間上可能會稍微延遲。如果所需執行日期/時間接近午夜,則您的批次工作可能會在提交後的隔天執行。在此情況下,如果您將業務日期留空,請記住,您的業務日期將設定為提交工作後的隔天。
  • 置換確認間隔最大記錄數。此參數是選擇性的,可置換每個背景處理的標準確認。例如,如果您在白天提交工作,但想要更頻繁地確認以釋出保留的資源,可降低此值。當背景處理是在晚上 (或週末) 執行,而且您的伺服器有大量記憶體時,可以考慮提高此值。

  • 置換游標重新起始間隔最大分鐘數。此參數是選擇性的,可置換每個背景處理的標準游標重新起始分鐘數。例如,如果您在白天提交工作,但想要更頻繁地確認以釋出保留的資源 (或更頻繁地起始游標),可降低這些值。當背景處理是在晚上 (或週末) 執行,而且您的伺服器有大量記憶體時,可以考慮提高這些值。

  • 使用者 ID。請注意下列使用者 ID 相關事項:

    • 提交工作的使用者以及批次提交上記錄的使用者 ID,都應該可以存取確保執行安全之批次控制的應用服務。

    • 任何在其所建立或更新之記錄上標記使用者 ID 的批次處理,都會在適用的處理中使用此使用者 ID。

    • 此使用者 ID 的顯示設定檔會控制訊息中日期與幣別值的格式化方式。

    • 線上提交批次工作時,批次使用者、語言及電子郵件地址會預設為提交工作之使用者的明細。只有在「批次工作提交」應用服務上被授予「使用者置換」存取模式的使用者,才能夠置換批次使用者 ID。

    • 如果提交使用者具備使用者置換權限,他們就能夠在從線上提交複製或重新執行批次工作時,保留原始批次使用者明細。如果勾選「以原始使用者身分執行」方塊,則會將原始批次執行的批次使用者、語言及電子郵件地址複製到新的批次工作。否則,會預設使用來自提交使用者的使用者明細。

  • 密碼。目前未使用密碼。

  • 語言代碼。語言代碼用於存取語言特定控制資料表值。例如,錯誤訊息以此語言代碼顯示。

  • 追蹤程式啟動追蹤程式結束追蹤 SQL追蹤輸出。這些開關僅用於 QA 與標竿測試。如果勾選了追蹤程式啟動,則會在每次啟動程式時顯示訊息。如果勾選了追蹤程式結束,則會在每次結束程式時顯示訊息。如果勾選了追蹤 SQL,則會在每次執行 SQL 陳述式時顯示訊息。如果勾選了追蹤輸出,則會撰寫背景處理所格式化的特殊訊息。

備註:開啟追蹤輸出開關時所顯示的資訊取決於每個背景處理。背景處理有可能不會顯示此開關的特殊資訊。

其他通用參數

每個批次控制都支援其他參數的定義。另有部分其他參數是所有批次處理通用或特定類型的批次處理通用的。批次控制應與其他適當的參數一起傳遞。不過,當引入其他新的參數時,可能無法以其他新的參數更新現有批次控制。

下列資料表會標明可連結至批次控制的通用參數。請注意,即便有序號可控制批次參數的參數顯示順序,但批次處理不會使用該順序,而是使用參數名稱識別特定參數。在某些情況下支援多個參數名稱 (「駝峰式大小寫」版本與「全部大寫」版本)。

參數名稱 描述 其他註釋
MAX-ERRORS / maxErrors 每個批次處理的執行參數都有其專屬預設常數,可決定批次處理在需要中止執行之前可發生的錯誤數。使用者可以使用此參數來置換該常數。 輸入值必須為大於或等於零的整數。此參數的最大有效值為 999,999,999,999,999。
DIST-THD-POOL 每個批次處理都在執行緒集區中執行。只有批次處理應在其他非預設的執行緒集區中執行時,才需要此參數。 預設執行緒集區名稱為 DEFAULT
emailMode 透過關聯的電子郵件地址提交批次工作時,預設邏輯是無論成功或失敗,工作完成即傳送電子郵件。使用此參數可根據工作結束時的狀態來限制電子郵件。 有效值
  • ERROR — 只在工作結束時處於錯誤狀態才傳送電子郵件。

  • SUCCESS — 只在工作成功結束時才傳送電子郵件。

  • ALL — 一律只在工作結束時傳送電子郵件。(這是預設值。)

下列參數僅適用於使用執行緒層級 SQL Select 執行緒工作分配方法的工作,如平行背景處理中所述。
overrideLowIdValue 指定用於計算執行緒範圍的新低 ID。架構依預設會假設 ID 介於多個 0 (例如,000000000) 到多個 9 (例如,9999999999) 之間,但此參數會置換低值。 參數值可以是實際數字,也可以設為自動。如果設定為自動,則會設為與背景處理相關之資料庫資料表中目前的最低值。
overrideHighIdValue 指定用於計算執行緒範圍的新高 ID。架構依預設會假設 ID 介於多個 0 (例如,000000000) 到多個 9 (例如,9999999999) 之間,但此參數會置換高值。 參數值可以是實際數字,也可以設為自動。如果設定為自動,則會設為與背景處理相關之資料庫資料表中目前的最高值。
idRangeOverrideClass 使用此參數以指定要計算執行緒範圍的自訂類別。在執行批次期間,會建立此置換類別並呼叫 setter 方法來視需要初始化 ID。系統會呼叫高和低 getter 方法,以擷取用於執行的高和低 ID。 指定的類別名稱必須實作介面 com.splwg.base.api.batch.BatchIdRangeOverride。
下列參數僅適用於執行單一確認的工作,例如擷取批次工作。
numRecordsToFlush 此參數會定義排清休眠快取的頻率,以避免發生高堆積耗用與記憶體不足的錯誤。

特定批次參數

部分背景處理會定義其功能專用的其他參數。當處理接收其他參數時,會在應用程式的批次控制事項中定義並記錄它們。

線上提交批次工作時,將會預設使用批次控制記錄上設定的任何預設參數值,並可置換。請注意,如果在批次控制組態中將參數值設定為「加密」,該值就會以加密形式顯示。