# 通知設計書 11-返品発注アイテム受領通知

## 概要

本ドキュメントは、InvenTreeシステムにおける「返品発注アイテム受領通知」の設計仕様を定義する。返品注文（ReturnOrder）のアイテムが受領された際に、関係者に通知を送信する機能について詳述する。

### 本通知の処理概要

返品発注アイテム受領通知は、顧客から返品されたアイテムが倉庫に受領された際に、関係するユーザーへ自動的に通知を送信する機能である。

**業務上の目的・背景**：返品処理は顧客対応において重要なプロセスである。返品アイテムが受領されたことを関係者に迅速に通知することで、品質検査、在庫再登録、顧客への確認連絡など、後続の業務プロセスを円滑に進めることができる。また、担当者が返品状況をリアルタイムに把握することで、顧客満足度の向上に寄与する。

**通知の送信タイミング**：ReturnOrder.receive_line_item()メソッドが実行され、返品アイテムが正常に受領処理された直後にトリガーされる。具体的には、在庫アイテムのステータス更新、ロケーション移動、トラッキングエントリ追加が完了した後に送信される。

**通知の受信者**：返品発注の責任者（responsible）、および返品アイテムに関連するパーツの購読者（subscribers）が受信対象となる。受領操作を実行したユーザーは除外される。

**通知内容の概要**：返品発注のアイテムが受領されたことを通知し、返品発注へのリンクを含む。メッセージには返品発注の詳細情報が含まれる。

**期待されるアクション**：受信者は返品アイテムの品質検査を実施し、在庫への再登録または廃棄の判断を行う。必要に応じて顧客への連絡を行い、返品処理の完了を確認する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

1. `notify_responsible()`関数により送信先を決定
2. 返品発注（ReturnOrder）の`responsible`フィールドに設定されたユーザーまたはグループ
3. `extra_users`として返品アイテムのパーツに購読しているユーザー（`line.item.part.get_subscribers()`）
4. 受領操作を実行したユーザー（user）は`exclude`パラメータにより除外

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | [INVENTREE_INSTANCE] |
| 件名 | Items Received |
| 形式 | 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 %}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| name | 通知名（"Items Received"） | InvenTreeNotificationBodies.ReturnOrderItemsReceived | Yes |
| message | 通知メッセージ | InvenTreeNotificationBodies.ReturnOrderItemsReceived | Yes |
| link | 返品発注詳細ページへのリンク | construct_absolute_url(order.get_absolute_url()) | No |
| slug | 通知カテゴリスラッグ | 'return_order.items_received' | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ReturnOrder.receive_line_item()呼び出し | アイテムが正常に受領された場合 | 返品アイテム受領処理の完了時 |
| API | /api/order/return-order/{id}/receive/ | 同上 | REST API経由での受領処理 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 既に受領済みのアイテム | line.received_date が既に設定されている場合は処理がスキップされ、通知も送信されない |
| データインポート中 | isImportingData()がTrueの場合は通知をスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[receive_line_item呼び出し] --> B{received_date確認}
    B -->|既に受領済み| C[処理終了]
    B -->|未受領| D[在庫アイテム分割判定]
    D --> E[ステータス更新・ロケーション移動]
    E --> F[トラッキングエントリ追加]
    F --> G[LineItem更新]
    G --> H[trigger_event発火]
    H --> I[notify_responsible呼び出し]
    I --> J[送信先ユーザー収集]
    J --> K[trigger_notification呼び出し]
    K --> L[各通知プラグインで送信]
    L --> M[NotificationEntry記録]
    M --> N[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| order_returnorder | 返品発注情報取得 | 責任者、顧客情報 |
| order_returnorderlineitem | 返品アイテム情報 | 受領対象アイテム |
| stock_stockitem | 在庫アイテム情報 | 返品対象在庫 |
| part_part | パーツ情報 | 購読者取得用 |
| users_owner | 責任者情報 | 通知先決定 |

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

#### order_returnorder

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| responsible | 責任者取得 | 返品発注に紐づく |
| created_by | 除外対象ユーザー | 操作実行者 |

#### order_returnorderlineitem

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| received_date | 受領済み判定 | NULLでない場合はスキップ |
| item | 在庫アイテム参照 | 返品対象 |
| quantity | 返品数量 | 在庫分割判定用 |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- ReturnOrderItemsReceived通知ボディは`common/notifications.py`で定義
- 通知テンプレートは`templates/email/return_order_received.html`を使用
- プラグインベースの通知システムにより、拡張可能な設計

---

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

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

### 推奨読解順序

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

まず、通知に関連するデータ構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notifications.py | `src/backend/InvenTree/common/notifications.py` | NotificationBody、InvenTreeNotificationBodiesクラスの構造（行26-85） |
| 1-2 | models.py | `src/backend/InvenTree/common/models.py` | NotificationEntry、NotificationMessageモデル（行1616-1722） |

**読解のコツ**: NotificationBodyはdataclassで定義され、name, slug, message, templateの4つのフィールドを持つ。ReturnOrderItemsReceivedは行79-84で定義されている。

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

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | models.py | `src/backend/InvenTree/order/models.py` | ReturnOrder.receive_line_item()メソッド（行2879-2954） |

**主要処理フロー**:
1. **行2899-2901**: 既に受領済みかチェック
2. **行2903-2911**: 在庫アイテムの分割処理
3. **行2913-2929**: 在庫アイテムのステータス・ロケーション更新
4. **行2931-2939**: トラッキングエントリ追加
5. **行2941-2943**: LineItem更新
6. **行2945**: trigger_event発火
7. **行2947-2954**: notify_responsible呼び出し（通知送信）

#### Step 3: 通知送信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | helpers_model.py | `src/backend/InvenTree/InvenTree/helpers_model.py` | notify_responsible関数の実装 |
| 3-2 | notifications.py | `src/backend/InvenTree/common/notifications.py` | trigger_notification関数（行87-218） |

**主要処理フロー**:
- **行96-98**: データインポート中のスキップ判定
- **行129-137**: 重複通知チェック（check_recent）
- **行144-175**: ターゲットユーザーの収集とフィルタリング
- **行191-214**: 各通知プラグインでの送信実行

#### Step 4: 通知プラグインを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | core_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/core_notifications.py` | 各通知プラグインの実装（行19-175） |

**主要処理フロー**:
- **行19-60**: InvenTreeUINotifications - UI通知の作成
- **行63-116**: InvenTreeEmailNotifications - メール送信
- **行119-175**: InvenTreeSlackNotifications - Slack送信

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

```
ReturnOrder.receive_line_item() [order/models.py:2879]
    │
    ├─ stock_item.splitStock() [分割が必要な場合]
    │
    ├─ stock_item.set_status() / save() / clearAllocations()
    │
    ├─ stock_item.add_tracking_entry()
    │
    ├─ trigger_event(ReturnOrderEvents.RECEIVED)
    │
    └─ notify_responsible() [InvenTree/helpers_model.py]
           │
           └─ trigger_notification() [common/notifications.py:87]
                  │
                  ├─ NotificationEntry.check_recent()
                  │
                  ├─ target_fnc() → ユーザー収集
                  │
                  └─ plugin.send_notification() [各プラグイン]
                         │
                         ├─ InvenTreeUINotifications.send_notification()
                         │      └─ NotificationMessage.objects.bulk_create()
                         │
                         ├─ InvenTreeEmailNotifications.send_notification()
                         │      └─ send_email()
                         │
                         └─ InvenTreeSlackNotifications.send_notification()
                                └─ requests.post()
```

### データフロー図

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

ReturnOrderLineItem ───▶ receive_line_item() ───▶ StockItem更新
       │                        │                        │
       │                        ├──────────────────▶ StockItemTracking
       │                        │                        │
       │                        └─── notify_responsible() ───▶ NotificationMessage (UI)
       │                                    │                        │
       │                                    ├──────────────────▶ Email送信
       │                                    │                        │
       │                                    └──────────────────▶ Slack送信
       │
       └──────────────────────────────────────────────────▶ NotificationEntry
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| models.py | `src/backend/InvenTree/order/models.py` | ソース | ReturnOrder、receive_line_item実装 |
| notifications.py | `src/backend/InvenTree/common/notifications.py` | ソース | 通知基盤、trigger_notification |
| models.py | `src/backend/InvenTree/common/models.py` | ソース | NotificationEntry、NotificationMessage |
| core_notifications.py | `src/backend/InvenTree/plugin/builtin/integration/core_notifications.py` | ソース | 通知プラグイン実装 |
| helpers_model.py | `src/backend/InvenTree/InvenTree/helpers_model.py` | ソース | notify_responsible関数 |
| return_order_received.html | `src/backend/InvenTree/templates/email/return_order_received.html` | テンプレート | メール本文テンプレート |
