# 通知設計書 13-製造指示完了通知

## 概要

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

### 本通知の処理概要

製造指示完了通知は、Build Orderが完了ステータスに遷移した際に、発行者、責任者、および関連するパーツの購読者に自動的に通知を送信する機能である。

**業務上の目的・背景**：製造指示の完了は、製造プロセスにおける重要なマイルストーンである。完了通知により、関係者は製造成果物の検収、在庫への登録確認、後続の出荷・販売プロセスの開始など、次のステップへ迅速に移行できる。また、親ビルドや販売注文に紐づいている場合は、それらの担当者にも通知することで、サプライチェーン全体での情報共有を促進する。

**通知の送信タイミング**：Build._action_complete()メソッド内で、製造指示が正常に完了処理された後にトリガーされる。具体的には、ステータスがCOMPLETEに変更され、完了日時が記録された後に送信される。

**通知の受信者**：製造指示の発行者（issued_by）、責任者（responsible）、製造対象パーツの購読者、親ビルドの発行者・責任者、関連販売注文の作成者・責任者が受信対象となる。完了操作を実行したユーザーは除外される。

**通知内容の概要**：製造指示が完了したことを通知し、製造指示の詳細（参照番号、パーツ名、数量）および詳細ページへのリンクを含む。

**期待されるアクション**：受信者は製造成果物の品質確認、在庫登録の確認、後続プロセス（出荷、販売など）の開始を行う。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（_action_complete処理内で直接呼び出し） |
| 優先度 | 中 |
| リトライ | 無（通知送信失敗時はログ記録のみ） |

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

1. 製造指示の発行者（issued_by）
2. 製造指示の責任者（responsible）
3. 製造対象パーツの購読者（part.get_subscribers()）
4. 親ビルドが存在する場合：親ビルドの発行者・責任者
5. 販売注文が紐づいている場合：販売注文の作成者・責任者
6. 完了操作を実行したユーザーは`target_exclude`により除外

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | [INVENTREE_INSTANCE] |
| 件名 | Build order {reference} has been completed |
| 形式 | HTML |

### 本文テンプレート

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

{% block title %}
{{ message }}
{% if link %}
<p>Click on the following link to view this order: <a href="{{ link }}">{{ link }}</a></p>
{% endif %}
{% endblock title %}

{% block body %}
<tr style="height: 3rem; border-bottom: 1px solid">
    <th>Build Order</th>
    <th>Part</th>
    <th>Quantity</th>
</tr>
<tr style="height: 3rem">
    <td style="text-align: center;">{{ build }}</td>
    <td style="text-align: center;">{{ build.part.full_name }}</td>
    <td style="text-align: center;">{{ build.quantity }}</td>
</tr>
{% endblock body %}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| build | 製造指示オブジェクト | Build instance | Yes |
| name | 通知名 | 動的生成 | Yes |
| slug | 通知カテゴリスラッグ | 'build.completed' | Yes |
| message | 通知メッセージ | "A build order has been completed" | Yes |
| link | 製造指示詳細ページへのリンク | construct_absolute_url() | Yes |
| template | メールテンプレート情報 | {'html': 'email/build_order_completed.html', 'subject': name} | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | Build.complete_build()呼び出し | 正常に完了処理された場合 | 製造指示完了操作 |
| API | POST /api/build/{id}/complete/ | 同上 | REST API経由での完了操作 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 未完了アウトプット存在 | incomplete_count > 0 の場合はエラー |
| 子ビルド未完了 | BUILDORDER_REQUIRE_CLOSED_CHILDS設定時、子ビルドが未完了の場合 |
| データインポート中 | isImportingData()がTrueの場合は通知をスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[complete_build呼び出し] --> B[handle_transition]
    B --> C[_action_complete実行]
    C --> D{incomplete_count > 0?}
    D -->|Yes| E[ValidationError]
    D -->|No| F{has_open_child_builds?}
    F -->|Yes & 設定有効| E
    F -->|No| G[ステータス更新]
    G --> H[complete_allocations offload]
    H --> I[trigger_event発火]
    I --> J[送信先ユーザー収集]
    J --> K[trigger_notification呼び出し]
    K --> L[各通知プラグインで送信]
    L --> M[NotificationEntry記録]
    M --> N[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| build_build | 製造指示情報取得 | 発行者、責任者、親ビルド |
| part_part | パーツ情報 | 購読者取得用 |
| order_salesorder | 販売注文情報 | 関連販売注文の担当者 |
| users_owner | 責任者情報 | 通知先決定 |
| auth_user | ユーザー情報 | 送信先ユーザー |

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

#### build_build

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| issued_by | 発行者取得 | 通知対象 |
| responsible | 責任者取得 | 通知対象 |
| part | 製造対象パーツ | 購読者取得用 |
| parent | 親ビルド参照 | 親ビルド担当者通知用 |
| sales_order | 関連販売注文 | 販売注文担当者通知用 |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | メール送信エラー | ログ記録、処理続行 |
| テンプレートエラー | テンプレート変数不正 | ログ記録、処理続行 |
| 宛先不正 | 宛先ユーザーが無効 | 該当ユーザーをスキップ |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 同一カテゴリ・オブジェクトに対し1回（check_recent機能） |

### 配信時間帯

制限なし（リアルタイム送信）

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

- 通知を受信できるのは、該当する権限（view権限）を持つユーザーのみ
- メール本文には機密情報を含まないよう、リンクのみを提供
- NOTIFY_BY_EMAILユーザー設定によりメール通知の受信可否を制御可能

## 備考

- 完了通知はNewOrderやOrderCanceledとは異なり、専用のコンテキストを構築
- 親ビルド、販売注文への連携通知機能あり
- BuildEvents.COMPLETEDイベントも発火される

---

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

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

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | models.py | `src/backend/InvenTree/build/models.py` | Buildモデルの構造（行76-111） |
| 1-2 | events.py | `src/backend/InvenTree/build/events.py` | BuildEventsの定義 |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | models.py | `src/backend/InvenTree/build/models.py` | Build.complete_build()（行648-662）、_action_complete()（行664-743） |

**主要処理フロー**:
1. **行672-678**: 子ビルド未完了チェック
2. **行680-683**: 未完了アウトプットチェック
3. **行688-691**: ステータス・完了日時更新
4. **行693-702**: complete_allocationsタスクオフロード
5. **行705**: trigger_event(BuildEvents.COMPLETED)発火
6. **行707-721**: 送信先ユーザー収集
7. **行723-743**: trigger_notification呼び出し

#### Step 3: 通知コンテキストを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | models.py | `src/backend/InvenTree/build/models.py` | contextオブジェクトの構築（行726-735） |

**コンテキスト内容**:
- build: 製造指示インスタンス
- name: 通知タイトル
- slug: 'build.completed'
- message: "A build order has been completed"
- link: 絶対URL
- template: HTMLテンプレート参照

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

```
Build.complete_build() [build/models.py:648]
    │
    └─ handle_transition()
           │
           └─ _action_complete() [build/models.py:664]
                  │
                  ├─ 各種検証チェック
                  │
                  ├─ self.save()
                  │
                  ├─ offload_task(complete_build_allocations)
                  │
                  ├─ trigger_event(BuildEvents.COMPLETED)
                  │
                  ├─ targets収集
                  │      ├─ issued_by
                  │      ├─ responsible
                  │      ├─ part.get_subscribers()
                  │      ├─ parent.issued_by / responsible
                  │      └─ sales_order.created_by / responsible
                  │
                  └─ trigger_notification() [common/notifications.py]
                         │
                         └─ plugin.send_notification() [各プラグイン]
```

### データフロー図

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

complete_build() ───▶ _action_complete() ───▶ Build更新(COMPLETE)
                              │                        │
                              ├─ offload_task ────▶ 在庫割当完了処理
                              │                        │
                              ├─ trigger_event ───▶ BuildEvents.COMPLETED
                              │                        │
                              └─ trigger_notification ───▶ 通知送信
                                        │
                                        ├──────────────▶ NotificationMessage
                                        ├──────────────▶ Email送信
                                        └──────────────▶ Slack送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| models.py | `src/backend/InvenTree/build/models.py` | ソース | Buildモデル、complete_build実装 |
| events.py | `src/backend/InvenTree/build/events.py` | ソース | BuildEventsイベント定義 |
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | trigger_notification関数 |
| tasks.py | `src/backend/InvenTree/build/tasks.py` | ソース | complete_build_allocationsタスク |
| build_order_completed.html | `src/backend/InvenTree/templates/email/build_order_completed.html` | テンプレート | メール本文テンプレート |
