# バッチ設計書 18-scheduled_stocktake_reports

## 概要

本ドキュメントは、InvenTreeシステムにおける在庫棚卸レポートの自動生成バッチ処理について記述します。このバッチは、定期的に在庫スナップショット（棚卸エントリ）を作成し、古いエントリを削除することで、在庫履歴の管理を自動化します。

### 本バッチの処理概要

**業務上の目的・背景**：在庫管理において、定期的な棚卸（ストックテイク）は在庫の正確性を維持するために不可欠です。棚卸エントリは、特定時点での各部品の在庫数量をスナップショットとして記録し、在庫の推移分析や監査対応に活用されます。本バッチは、この棚卸処理を自動化し、定期的なスナップショット作成と古いデータの削除を行います。

**バッチの実行タイミング**：日次（毎日1回）。Django-Qスケジューラによりスケジュールされ、バックグラウンドワーカーによって実行されます。

**主要な処理内容**：
1. 古い棚卸エントリの削除（STOCKTAKE_DELETE_OLD_ENTRIESが有効な場合）
2. 棚卸機能の有効確認（STOCKTAKE_ENABLE）
3. 自動レポート生成間隔の確認（STOCKTAKE_AUTO_DAYS）
4. 最近のレポート生成有無の確認（holdoff機能）
5. 棚卸処理の実行（perform_stocktake）

**前後の処理との関連**：本バッチは独立して動作します。生成された棚卸エントリは、レポート画面やAPIから参照可能です。

**影響範囲**：part_partstocktakeテーブルに対して挿入・削除操作を行います。在庫データ自体は変更しません。

## バッチ種別

レポート生成 / データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | Django-Qスケジューラによる自動実行 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（Django-Qスケジューラ） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django-Qワーカー稼働中 | バックグラウンドワーカーが稼働している必要がある |
| データベース接続可能 | PartStocktakeテーブルへのアクセスが可能であること |
| STOCKTAKE_ENABLE有効 | 棚卸機能が有効化されていること（レポート生成に必要） |

### 実行可否判定

- STOCKTAKE_DELETE_OLD_ENTRIES: Trueの場合、古いエントリの削除を実行
- STOCKTAKE_ENABLE: Falseの場合、レポート生成をスキップ
- STOCKTAKE_AUTO_DAYS: 0以下の場合、自動レポート生成をスキップ
- check_daily_holdoff: 最近レポートが生成された場合はスキップ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはパラメータを取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| グローバル設定 STOCKTAKE_DELETE_OLD_ENTRIES | DB | 古いエントリ削除の有効/無効 |
| グローバル設定 STOCKTAKE_DELETE_DAYS | DB | 削除対象日数（デフォルト365日） |
| グローバル設定 STOCKTAKE_ENABLE | DB | 棚卸機能の有効/無効 |
| グローバル設定 STOCKTAKE_AUTO_DAYS | DB | 自動レポート生成間隔（デフォルト7日） |
| part_partstocktake | DB | 既存の棚卸エントリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| part_partstocktake | DB | 新規棚卸エントリの作成 |
| ログ出力 | テキスト | 処理状況のログメッセージ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ part.stocktake、PartStocktakeモジュールのインポート
2. Phase 1: 古いエントリの削除
   └─ STOCKTAKE_DELETE_OLD_ENTRIES確認
   └─ Trueの場合:
      ├─ STOCKTAKE_DELETE_DAYS取得（デフォルト365日）
      ├─ threshold = now - delete_n_days
      ├─ PartStocktake.objects.filter(date__lt=threshold)
      └─ 該当レコードを削除
3. Phase 2: 棚卸機能確認
   └─ STOCKTAKE_ENABLE確認
   └─ Falseの場合は"Stocktake functionality is not enabled"をログ出力して終了
4. Phase 3: 自動レポート間隔確認
   └─ STOCKTAKE_AUTO_DAYS取得（デフォルト7日）
   └─ 0以下の場合は"Stocktake auto reports are disabled"をログ出力して終了
5. Phase 4: 最近のレポート確認
   └─ check_daily_holdoff('STOCKTAKE_RECENT_REPORT', report_n_days)
   └─ Falseの場合は"Stock history was recently generated"をログ出力して終了
6. Phase 5: 棚卸処理実行
   └─ part.stocktake.perform_stocktake()呼び出し
7. Phase 6: タスク成功記録
   └─ record_task_success('STOCKTAKE_RECENT_REPORT')
8. バッチ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{STOCKTAKE_DELETE_OLD_ENTRIES?}
    B -->|True| C[古いエントリの削除]
    B -->|False| D{STOCKTAKE_ENABLE?}
    C --> D
    D -->|False| E[ログ出力して終了]
    D -->|True| F{STOCKTAKE_AUTO_DAYS > 0?}
    F -->|いいえ| G[ログ出力して終了]
    F -->|はい| H{最近レポート生成済み?}
    H -->|はい| I[ログ出力して終了]
    H -->|いいえ| J[perform_stocktake実行]
    J --> K[タスク成功記録]
    K --> L[バッチ終了]
    E --> L
    G --> L
    I --> L
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 古いエントリ削除 | part_partstocktake | DELETE | 指定日数以上前のレコード削除 |
| 棚卸エントリ作成 | part_partstocktake | INSERT | 新規スナップショットの作成 |

### テーブル別操作詳細

#### part_partstocktake

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | date < threshold | 古いレコードの削除 |
| INSERT | part, quantity, date等 | perform_stocktake()で決定 | 棚卸スナップショット作成 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 機能無効 | STOCKTAKE_ENABLEがFalse | ログ出力後にスキップ |
| - | 自動生成無効 | STOCKTAKE_AUTO_DAYSが0以下 | ログ出力後にスキップ |
| - | holdoff | 最近レポート生成済み | ログ出力後にスキップ |
| - | DatabaseError | データベース接続エラー | 例外発生、リトライ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Django-Qのデフォルト設定に依存 |
| リトライ間隔 | Django-Qのデフォルト設定に依存 |
| リトライ対象エラー | 一時的なデータベースエラー |

### 障害時対応

1. ログを確認してエラー原因を特定
2. 設定値を確認
3. 必要に応じて手動で再実行

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各操作単位 |
| コミットタイミング | 削除完了時、棚卸処理完了時 |
| ロールバック条件 | 処理中にエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 削除: 数百〜数千件、作成: 部品数に依存 |
| 目標処理時間 | 10分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行は推奨しない（棚卸処理は重い処理のため）
- check_daily_holdoff機能により、短期間での重複実行を防止

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 古いエントリ削除時 | "Deleting {n} old stock entries" |
| 情報ログ | 機能無効時 | "Stocktake functionality is not enabled - exiting" |
| 情報ログ | 自動生成無効時 | "Stocktake auto reports are disabled, exiting" |
| 情報ログ | holdoff時 | "Stock history was recently generated - exiting" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| タスク失敗 | 1回 | システム管理者 |
| 処理時間 | 30分超過 | システム管理者 |

## 備考

- STOCKTAKE_DELETE_DAYSのデフォルト値は365日（1年）
- STOCKTAKE_AUTO_DAYSのデフォルト値は7日（週次）
- perform_stocktake()はpart.stocktakeモジュールに実装
- check_daily_holdoffとrecord_task_successで実行間隔を管理
- 棚卸処理は全部品に対して在庫スナップショットを作成するため、処理時間が長くなる可能性がある
- OpenTelemetryによるトレーシングに対応
