# 機能設計書 110-エージェント別レポート

## 概要

本ドキュメントは、Chatwootにおけるエージェント別パフォーマンスレポート機能について記述する。各エージェントの会話数、解決数、平均応答時間、平均解決時間などのKPIを集計し、パフォーマンス分析を提供する機能である。

### 本機能の処理概要

**業務上の目的・背景**：カスタマーサポートチームのマネジメントにおいて、エージェント個々のパフォーマンスを把握することが重要である。本機能により、エージェントの生産性や品質を定量的に評価でき、適切なフィードバック、トレーニング計画、リソース配分の最適化に活用できる。

**機能の利用シーン**：
- エージェントレポート画面でパフォーマンス一覧を確認
- 特定期間のエージェント別KPIを比較
- エージェントの業績評価やコーチングの根拠データとして活用
- CSVエクスポートで外部ツールでの詳細分析

**主要な処理内容**：
1. アカウント内の全エージェントのパフォーマンスデータ取得
2. エージェント毎の会話数、解決数、平均応答時間の集計
3. CSV形式でのレポート出力
4. 営業時間ベースの計算オプション

**関連システム・外部連携**：特になし（内部集計処理）

**権限による制御**：レポート閲覧には report:view 権限が必要。check_authorization によりアクセス制御される。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 30 | エージェントレポート画面 | 主画面 | エージェントパフォーマンス分析 |
| 31 | エージェントレポート概要 | 主画面 | エージェントレポート概要一覧 |
| 32 | エージェントレポート詳細 | 主画面 | 特定エージェントの詳細レポート |

## 機能種別

集計処理 / 帳票出力

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| since | Integer (Unix timestamp) | No | 期間開始（秒） | - |
| until | Integer (Unix timestamp) | No | 期間終了（秒） | - |
| business_hours | Boolean | No | 営業時間ベースで計算するか | - |

### 入力データソース

- 画面入力: レポート画面のフィルタ条件
- DBテーブル: conversations, reporting_events, account_users

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | Integer | ユーザーID |
| conversations_count | Integer | 担当した会話数 |
| resolved_conversations_count | Integer | 解決した会話数 |
| avg_resolution_time | Float | 平均解決時間（秒） |
| avg_first_response_time | Float | 平均初回応答時間（秒） |
| avg_reply_time | Float | 平均返信時間（秒） |

### 出力先

- 画面表示: JSON形式でAPIレスポンス
- ファイル: CSV形式でダウンロード（agents_report.csv）

### CSVカラム

| カラム名 | 説明 |
|---------|------|
| Agent Name | エージェント名 |
| Conversations Count | 担当会話数 |
| Avg First Response Time | 平均初回応答時間（フォーマット済み） |
| Avg Resolution Time | 平均解決時間（フォーマット済み） |
| Avg Reply Time | 平均返信時間（フォーマット済み） |
| Resolved Conversations Count | 解決会話数 |

## 処理フロー

### 処理シーケンス

```
1. リクエスト受信
   └─ APIエンドポイント: /api/v2/accounts/:account_id/reports/agents

2. 認可チェック
   └─ authorize :report, :view?

3. レポートデータ生成
   ├─ generate_agents_report (ReportsHelper)
   │      └─ V2::Reports::AgentSummaryBuilder.new.build
   │             ├─ 会話数カウント
   │             └─ reporting_events からメトリクス集計
   └─ エージェント毎にデータ整形

4. CSVレスポンス生成
   ├─ Content-Type: text/csv
   ├─ Content-Disposition: attachment; filename=agents_report.csv
   └─ ERBテンプレートでCSV生成
```

### フローチャート

```mermaid
flowchart TD
    A[リクエスト受信] --> B[認可チェック]
    B --> C[AgentSummaryBuilder.build]
    C --> D[会話数カウント]
    D --> E[reporting_events集計]
    E --> F[エージェント毎に統計計算]
    F --> G[generate_readable_report_metrics]
    G --> H[CSV生成]
    H --> I[CSVダウンロード]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-110-01 | 対象エージェント | アカウントに紐づく全ユーザー（account_users）が対象 | 常時 |
| BR-110-02 | 営業時間計算 | business_hours=true の場合、value_in_business_hours を使用 | パラメータ指定時 |
| BR-110-03 | 時間フォーマット | 時間は TimeFormatPresenter でフォーマット（例: 2h 30m） | CSV出力時 |
| BR-110-04 | null許容 | データがない場合は null を返却 | 常時 |

### 計算ロジック

会話数カウント:
```ruby
account.conversations.where(created_at: range).group('assignee_id').count
```

メトリクス集計:
```ruby
reporting_events
  .select(
    "user_id",
    "COUNT(CASE WHEN name = 'conversation_resolved' THEN 1 END) as resolved_count",
    "AVG(CASE WHEN name = 'conversation_resolved' THEN #{average_value_key} END) as avg_resolution_time",
    "AVG(CASE WHEN name = 'first_response' THEN #{average_value_key} END) as avg_first_response_time",
    "AVG(CASE WHEN name = 'reply_time' THEN #{average_value_key} END) as avg_reply_time"
  )
  .group(:user_id)
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| agents | conversations | SELECT + GROUP BY + COUNT | エージェント毎の会話数 |
| agents | reporting_events | SELECT + GROUP BY + AVG + COUNT | メトリクス集計 |
| agents | account_users | SELECT | 対象エージェント一覧 |
| agents | users | SELECT | エージェント名取得 |

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

#### conversations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| COUNT | * | account_id = Current.account.id, created_at BETWEEN since AND until | エージェント毎 |
| GROUP BY | assignee_id | - | グループ化キー |

#### reporting_events

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| COUNT | * | name = 'conversation_resolved' | 解決数 |
| AVG | value / value_in_business_hours | name = 'conversation_resolved' | 平均解決時間 |
| AVG | value / value_in_business_hours | name = 'first_response' | 平均初回応答時間 |
| AVG | value / value_in_business_hours | name = 'reply_time' | 平均返信時間 |
| GROUP BY | user_id | - | グループ化キー |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 401 | Unauthorized | 未認証状態でアクセス | ログインページへリダイレクト |
| 403 | Forbidden | レポート閲覧権限なし | エラーメッセージ表示 |

### リトライ仕様

特になし。同期処理のため即時エラー返却。

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

読み取り専用のため、トランザクション管理は不要。

## パフォーマンス要件

- レスポンス時間: 1秒以内（通常のエージェント数）
- インデックス: conversations.assignee_id, reporting_events.user_id

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

- 認証必須: Devise TokenAuthによる認証
- 認可: Punditによるレポート閲覧権限チェック
- アカウントスコープ: Current.account で他アカウントのデータにアクセス不可

## 備考

- TimeFormatPresenter で時間を人間が読みやすい形式に変換（例: 3600秒 -> "1h"）
- エージェントが存在しても、該当期間にデータがない場合は0または null を返却
- CSV出力時はヘッダー行を含む

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | reporting_event.rb | `app/models/reporting_event.rb` | イベントタイプと値の構造 |
| 1-2 | account_user.rb | `app/models/account_user.rb` | アカウントとユーザーの関連 |

**読解のコツ**: `reporting_events.name` で first_response, reply_time, conversation_resolved を識別。`user_id` でエージェントを特定。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | reports_controller.rb | `app/controllers/api/v2/accounts/reports_controller.rb` | agents アクション |

**主要処理フロー**:
- **21-23行目**: `agents` アクション
  - `@report_data = generate_agents_report`
  - `generate_csv('agents_report', 'api/v2/accounts/reports/agents')`

#### Step 3: ヘルパー層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | reports_helper.rb | `app/helpers/api/v2/accounts/reports_helper.rb` | generate_agents_report |

**主要処理フロー**:
- **2-12行目**: `generate_agents_report`
  - AgentSummaryBuilder でレポートデータ取得
  - Current.account.users でエージェント一覧取得
  - generate_readable_report_metrics でフォーマット

#### Step 4: ビルダー層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | agent_summary_builder.rb | `app/builders/v2/reports/agent_summary_builder.rb` | 集計ロジック |
| 4-2 | base_summary_builder.rb | `app/builders/v2/reports/base_summary_builder.rb` | 基底クラス |

**主要処理フロー**:
- **4-7行目**: `build` - メイン処理
- **14-15行目**: `fetch_conversations_count` - 会話数カウント
- **17-22行目**: `prepare_report` - 全エージェントの統計生成
- **24-34行目**: `build_agent_stats` - 個別エージェントの統計

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

```
Api::V2::Accounts::ReportsController#agents
    │
    ├─ check_authorization
    │
    └─ generate_agents_report (ReportsHelper)
           │
           ├─ V2::Reports::AgentSummaryBuilder.new.build
           │      │
           │      ├─ load_data (BaseSummaryBuilder)
           │      │      ├─ fetch_conversations_count
           │      │      │      └─ conversations.group('assignee_id').count
           │      │      └─ load_reporting_events_data
           │      │             └─ reporting_events.select(...).group(:user_id)
           │      │
           │      └─ prepare_report
           │             └─ account_users.map { build_agent_stats }
           │
           ├─ Current.account.users.map
           │      └─ reports.find { |r| r[:id] == agent.id }
           │
           └─ generate_readable_report_metrics
                  └─ Reports::TimeFormatPresenter.new.format
```

### データフロー図

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

パラメータ ─────────▶ ReportsController#agents ─────▶ CSV ファイル
(since, until,              │                              │
 business_hours)            │                              ├─ ヘッダー行
                           ▼                              ├─ エージェント行 x N
              AgentSummaryBuilder                          │
                    │                                      │
        ┌───────────┴───────────┐                          │
        ▼                       ▼                          │
  conversations          reporting_events                  │
  (COUNT BY assignee_id) (AVG, COUNT BY user_id)          │
        │                       │                          │
        └───────────┬───────────┘                          │
                    ▼                                      │
              build_agent_stats                            │
                    │                                      │
                    ▼                                      │
         TimeFormatPresenter.format                        │
                    │                                      │
                    └──────────────────────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| reports_controller.rb | `app/controllers/api/v2/accounts/reports_controller.rb` | コントローラー | agents アクション |
| reports_helper.rb | `app/helpers/api/v2/accounts/reports_helper.rb` | ヘルパー | generate_agents_report |
| agent_summary_builder.rb | `app/builders/v2/reports/agent_summary_builder.rb` | ビルダー | エージェントサマリー生成 |
| base_summary_builder.rb | `app/builders/v2/reports/base_summary_builder.rb` | ビルダー | サマリー基底クラス |
| time_format_presenter.rb | `app/presenters/reports/time_format_presenter.rb` | プレゼンター | 時間フォーマット |
| agents.csv.erb | `app/views/api/v2/accounts/reports/agents.csv.erb` | ビュー | CSVテンプレート |
| reporting_event.rb | `app/models/reporting_event.rb` | モデル | レポーティングイベント |
