[テンプレ]バッチ処理共通仕様書

関連テンプレ構成
テンプレート
# バッチ処理共通仕様

## 実行環境
| 項目 | 仕様 |
|-----|------|
| 実行サーバー | [バッチサーバー名/環境] |
| 実行ユーザー | [実行アカウント] |
| スケジューラー | [cron/TaskScheduler/その他] |
| ログ出力先 | [ログファイルパス] |
| 一時ファイル格納先 | [一時ディレクトリパス] |

## 共通処理フロー
```mermaid
graph TD
    A[バッチ起動] --> B[開始ログ出力]
    B --> C[パラメータチェック]
    C --> D{パラメータ正常?}
    D -->|異常| E[エラーログ出力]
    E --> F[異常終了]
    D -->|正常| G[業務処理実行]
    G --> H{処理結果}
    H -->|成功| I[成功ログ出力]
    H -->|エラー| J[エラーログ出力]
    I --> K[正常終了]
    J --> L[異常終了]
    K --> M[終了ログ出力]
    L --> M
```

## ログ出力仕様
| ログレベル | 出力タイミング | 出力内容 |
|----------|------------|---------|
| INFO | バッチ開始時 | バッチ名、実行日時、パラメータ |
| INFO | バッチ終了時 | 処理件数、処理時間、終了ステータス |
| WARN | 警告発生時 | 警告内容、発生箇所 |
| ERROR | エラー発生時 | エラー内容、スタックトレース、発生箇所 |

## エラー処理方針
| エラー種別 | 対応方針 |
|----------|---------|
| システムエラー | 即座に処理中断、管理者へメール通知 |
| データエラー | エラーレコードをスキップして処理継続、エラーログに記録 |
| リトライ可能エラー | 最大3回リトライ、失敗時は異常終了 |

## 通知仕様
| 通知条件 | 通知先 | 通知方法 | 通知内容 |
|---------|-------|---------|---------|
| 異常終了時 | システム管理者 | メール | バッチ名、エラー内容、発生日時 |
| 処理件数0件時 | 業務担当者 | メール | バッチ名、実行日時、警告メッセージ |
| 処理時間超過時 | システム管理者 | メール | バッチ名、処理時間、閾値 |

## リトライ仕様
| 項目 | 仕様 |
|-----|------|
| リトライ対象エラー | 一時的なネットワークエラー、DB接続エラー、外部API一時障害 |
| 最大リトライ回数 | 3|
| リトライ間隔 | 初回: 30秒、2回目: 1分、3回目: 3|
| リトライ失敗時の対応 | 異常終了、管理者へメール通知 |

---
プレビュー

バッチ処理共通仕様

実行環境

項目 仕様
実行サーバー [バッチサーバー名/環境]
実行ユーザー [実行アカウント]
スケジューラー [cron/TaskScheduler/その他]
ログ出力先 [ログファイルパス]
一時ファイル格納先 [一時ディレクトリパス]

共通処理フロー

graph TD
    A[バッチ起動] --> B[開始ログ出力]
    B --> C[パラメータチェック]
    C --> D{パラメータ正常?}
    D -->|異常| E[エラーログ出力]
    E --> F[異常終了]
    D -->|正常| G[業務処理実行]
    G --> H{処理結果}
    H -->|成功| I[成功ログ出力]
    H -->|エラー| J[エラーログ出力]
    I --> K[正常終了]
    J --> L[異常終了]
    K --> M[終了ログ出力]
    L --> M

ログ出力仕様

ログレベル 出力タイミング 出力内容
INFO バッチ開始時 バッチ名、実行日時、パラメータ
INFO バッチ終了時 処理件数、処理時間、終了ステータス
WARN 警告発生時 警告内容、発生箇所
ERROR エラー発生時 エラー内容、スタックトレース、発生箇所

エラー処理方針

エラー種別 対応方針
システムエラー 即座に処理中断、管理者へメール通知
データエラー エラーレコードをスキップして処理継続、エラーログに記録
リトライ可能エラー 最大3回リトライ、失敗時は異常終了

通知仕様

通知条件 通知先 通知方法 通知内容
異常終了時 システム管理者 メール バッチ名、エラー内容、発生日時
処理件数0件時 業務担当者 メール バッチ名、実行日時、警告メッセージ
処理時間超過時 システム管理者 メール バッチ名、処理時間、閾値

リトライ仕様

項目 仕様
リトライ対象エラー 一時的なネットワークエラー、DB接続エラー、外部API一時障害
最大リトライ回数 3回
リトライ間隔 初回: 30秒、2回目: 1分、3回目: 3分
リトライ失敗時の対応 異常終了、管理者へメール通知