# 通知設計書 16-製造指示在庫不足通知

## 概要

本ドキュメントは、InvenTreeシステムにおける「製造指示在庫不足通知」の設計仕様を定義する。製造指示（Build Order）に必要な部品の在庫が不足している際に、関係者へ通知を送信する機能について詳述する。

### 本通知の処理概要

製造指示在庫不足通知は、新しいBuild Orderが作成された際に、必要な部品の在庫状況をチェックし、不足があればパーツの購読者および責任者に通知を送信する機能である。

**業務上の目的・背景**：製造指示を実行するためには、BOM（部品表）に記載された全ての部品が必要数量だけ在庫されている必要がある。在庫不足を早期に検出し通知することで、購買担当者は追加発注を行い、生産管理者は製造スケジュールを調整することができる。これにより、製造遅延を最小限に抑え、サプライチェーンの効率化に寄与する。

**通知の送信タイミング**：Build Orderが作成された後、`check_build_stock`タスクがオフロードされ、BOMに含まれる各部品の在庫状況をチェックする。不足部品が検出された場合に通知が送信される。

**通知の受信者**：製造対象パーツの購読者（part.get_subscribers()）、および製造指示の責任者（responsible）が受信対象となる。

**通知内容の概要**：製造指示に必要な在庫が不足していることを通知する。不足している部品のリスト（パーツ名、必要数量、在庫数量、利用可能数量）および製造指示詳細ページへのリンクを含む。

**期待されるアクション**：受信者は不足部品を確認し、追加発注の手配、代替部品の検討、製造スケジュールの調整などの対応を行う。

## 通知種別

- メール通知（InvenTreeEmailNotifications経由）
- UI通知（InvenTreeUINotifications経由）
- Slack通知（InvenTreeSlackNotifications経由、設定時）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（offload_taskによるバックグラウンド実行） |
| 優先度 | 中 |
| リトライ | 無（通知送信失敗時はログ記録のみ） |

### 送信先決定ロジック

1. 製造対象パーツの購読者（build.part.get_subscribers()）をターゲットに設定
2. 製造指示の責任者（responsible）をターゲットに追加
3. `trigger_notification()`関数を使用して通知送信

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | [INVENTREE_INSTANCE] |
| 件名 | Stock required for build order |
| 形式 | HTML |

### 本文テンプレート

```html
{% extends "email/email.html" %}

{% block title %}
Stock is required for the following build order
Build order {{ build.reference }} - building {{ build.quantity }} x {{ part.full_name }}
<p>Click on the following link to view this build order: <a href='{{ link }}'>{{ link }}</a></p>
{% endblock title %}

{% block body %}
<tr colspan='3' style='height: 2rem; text-align: center;'>The following parts are low on required stock</tr>
<tr style="height: 3rem; border-bottom: 1px solid">
    <th>Part</th>
    <th>Required Quantity</th>
    <th>Available</th>
</tr>
{% for line in lines %}
<tr style="height: 2.5rem; border-bottom: 1px solid">
    <td style='padding-left: 1em;'>
        <a href='{{ line.link }}'>{{ line.part.full_name }}</a>{% if line.part.description %} - <em>{{ line.part.description }}</em>{% endif %}
    </td>
    <td style="text-align: center;">{{ line.required }}</td>
    <td style="text-align: center;">{{ line.available }}</td>
</tr>
{% endfor %}
{% endblock body %}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| build | 製造指示オブジェクト | Build instance | Yes |
| part | 製造対象パーツ | build.part | Yes |
| name | 通知名（"Stock required for build order"） | 定数 | Yes |
| message | 通知メッセージ | "Build order {build} requires additional stock" | Yes |
| link | 製造指示詳細ページへのリンク | construct_absolute_url(build.get_absolute_url()) | Yes |
| lines | 不足部品のリスト | 計算結果 | Yes |
| template | メールテンプレート情報 | {'html': 'email/build_order_required_stock.html', 'subject': name} | Yes |

### lines配列の各要素

| 変数名 | 説明 | データ取得元 |
|--------|------|-------------|
| link | 部品詳細ページへのリンク | construct_absolute_url(sub_part.get_absolute_url()) |
| part | 不足部品オブジェクト | BomItem.sub_part |
| in_stock | 在庫数量 | sub_part.get_stock_count() |
| allocated | 割当済み数量 | sub_part.allocation_count() |
| available | 利用可能数量 | max(0, in_stock - allocated) |
| required | 必要数量 | bom_item.quantity * build.quantity |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 非同期タスク | check_build_stock | 不足部品が1つ以上存在 | Build作成後にオフロード |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 全部品の在庫が充足 | lines配列が空（不足部品なし）の場合は通知不要 |
| データインポート中 | isImportingData()がTrueの場合は通知をスキップ |
| バーチャル部品 | BOMに含まれるバーチャル部品（virtual=True）は対象外 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Build作成完了] --> B[offload_task: check_build_stock]
    B --> C{isImportingData?}
    C -->|Yes| D[終了]
    C -->|No| E[Build.part取得]
    E --> F[BOMアイテム取得]
    F --> G[各BOMアイテムに対してループ]
    G --> H[在庫数量・割当数量計算]
    H --> I{available < required?}
    I -->|Yes| J[linesに追加]
    I -->|No| K[次のBOMアイテムへ]
    J --> K
    K --> G
    K --> L{lines.length > 0?}
    L -->|No| D
    L -->|Yes| M[ターゲットユーザー収集]
    M --> N[trigger_notification]
    N --> D
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| build_build | 製造指示情報取得 | 責任者、製造数量 |
| part_part | パーツ情報 | BOM取得、在庫計算 |
| part_bomitem | BOMアイテム情報 | 必要部品リスト |
| stock_stockitem | 在庫情報 | 在庫数量計算 |
| users_owner | 責任者情報 | 通知先決定 |

### テーブル別参照項目詳細

#### build_build

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| part | 製造対象パーツ | BOM取得用 |
| quantity | 製造数量 | 必要数量計算用 |
| responsible | 責任者取得 | 通知対象 |

#### part_bomitem

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| sub_part | 必要部品 | 在庫チェック対象 |
| quantity | 単位必要数量 | 必要総数量計算 |
| allow_variants | バリアント許可 | 在庫計算に影響 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| common_notificationentry | INSERT/UPDATE | 通知送信記録 |
| common_notificationmessage | INSERT | UI通知メッセージ |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT/UPDATE | key | BuildEvents.STOCK_REQUIRED | 通知カテゴリ |
| INSERT/UPDATE | uid | Build.pk | 対象オブジェクトID |
| INSERT/UPDATE | updated | 現在日時 | 最終送信日時 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Part.DoesNotExist | build.partが削除された | ログ出力、処理終了 |
| 送信失敗 | メール送信エラー | ログ記録、処理続行 |
| テンプレートエラー | テンプレート変数不正 | ログ記録、処理続行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 同一Build Orderに対し1回（check_recent機能） |

### 配信時間帯

制限なし（Build作成時に非同期実行）

## セキュリティ考慮事項

- 通知を受信できるのは、該当する権限（view権限）を持つユーザーのみ
- メール本文には部品名と数量情報を含むが、価格情報は含まない
- NOTIFY_BY_EMAILユーザー設定によりメール通知の受信可否を制御可能

## 備考

- check_build_stockタスクはBuild作成後にoffload_taskでバックグラウンド実行
- BOMのinclude_virtual=Falseにより、バーチャル部品は在庫チェック対象外
- 在庫数量計算時、allow_variantsフラグに応じてバリアントの在庫も含める

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: タスクのオフロードを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | models.py | `src/backend/InvenTree/build/models.py` | after_save_buildシグナルハンドラ内のoffload_task呼び出し |

**読解のコツ**: Build作成後のpost_saveシグナルで、check_build_stockタスクがオフロードされる。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | tasks.py | `src/backend/InvenTree/build/tasks.py` | check_build_stock()（行167-249） |

**主要処理フロー**:
1. **行175-177**: データインポート中のスキップ
2. **行181**: lines配列の初期化
3. **行183-189**: buildとpart取得、エラーハンドリング
4. **行195**: BOMアイテム取得（include_virtual=False）
5. **行196-219**: 各BOMアイテムの在庫チェックループ
6. **行199**: 在庫数量取得（include_variants考慮）
7. **行201**: 割当済み数量取得
8. **行203**: 利用可能数量計算
9. **行205**: 必要数量計算
10. **行207-219**: 不足時にlinesへ追加
11. **行221-223**: 不足なしの場合は終了
12. **行226-228**: ターゲットユーザー収集
13. **行232-244**: コンテキスト構築
14. **行246-249**: trigger_notification呼び出し

#### Step 3: 在庫計算ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | models.py | `src/backend/InvenTree/part/models.py` | Part.get_stock_count()、Part.allocation_count() |

### プログラム呼び出し階層図

```
Build.save() → post_save signal
    │
    └─ offload_task(check_build_stock, build) [build/models.py]
           │
           └─ check_build_stock(build) [build/tasks.py:167]
                  │
                  ├─ isImportingData() チェック
                  │
                  ├─ build.part.get_bom_items(include_virtual=False)
                  │
                  ├─ for bom_item in bom_items:
                  │      │
                  │      ├─ sub_part.get_stock_count(include_variants)
                  │      │
                  │      ├─ sub_part.allocation_count()
                  │      │
                  │      └─ available < required → linesに追加
                  │
                  ├─ build.part.get_subscribers() → targets
                  │
                  ├─ build.responsible → targets.append
                  │
                  └─ trigger_notification() [common/notifications.py]
```

### データフロー図

```
[入力]                    [処理]                         [出力]

Build作成 ───▶ offload_task ───▶ check_build_stock()
                                       │
                                       ├─ BOMアイテム取得
                                       │
                                       ├─ 各部品の在庫計算
                                       │      │
                                       │      ├─ in_stock = get_stock_count()
                                       │      ├─ allocated = allocation_count()
                                       │      └─ available = in_stock - allocated
                                       │
                                       ├─ 不足部品リスト作成
                                       │
                                       └─ trigger_notification ───▶ 通知送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| tasks.py | `src/backend/InvenTree/build/tasks.py` | ソース | check_build_stockタスク実装 |
| models.py | `src/backend/InvenTree/build/models.py` | ソース | post_saveシグナル、タスクオフロード |
| models.py | `src/backend/InvenTree/part/models.py` | ソース | Part.get_stock_count()、allocation_count() |
| events.py | `src/backend/InvenTree/build/events.py` | ソース | BuildEvents.STOCK_REQUIRED定義 |
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | trigger_notification関数 |
| build_order_required_stock.html | `src/backend/InvenTree/templates/email/build_order_required_stock.html` | テンプレート | メール本文テンプレート |
