外部IF ファイル連携仕様

目的: 外部システムとのファイル連携における仕様を明確に定義し、データの確実な授受と整合性を保証する。ファイル形式、転送方式、エラーハンドリングを標準化することで、安定した連携を実現する
スコープ: 外部システムとの間で行われるファイルベースのデータ連携（CSV、XML、JSON等）の仕様をカバーする。API連携やデータベース直接連携は対象外
推奨する実施タイミング: 外部インターフェース設計の段階で、連携先システムと合意形成しながら実施する
関連するステークホルダー: システムアーキテクト、連携先システムの担当者、インフラチーム、運用チーム

📥 重要な前提知識・インプット

前提知識: ファイル転送プロトコル（SFTP、FTP、HTTP等）、文字エンコーディング、ファイル形式（CSV、XML、JSON等）の仕様、バッチ処理の基礎知識
インプット: 外部インターフェース一覧、連携先システムの既存仕様書、ファイル連携要件、非機能要件（性能・可用性・セキュリティ）

📄 成果物の定義

ドキュメントテンプレート: 📄[テンプレ]外部IF ファイル連携仕様
必須要素: ファイル連携仕様書（インターフェースID、連携方式、ファイル形式、データ項目定義、処理フロー、エラーハンドリング、ファイル保管ルール）

✅ 品質基準・レビュー観点

✅ 品質チェックリスト:

チェック項目	チェック内容
ファイル形式の明確性	文字コード、区切り文字、改行コード、BOM有無が明記されているか
データ項目の網羅性	全ての項目について型・桁数・必須/任意・制約が定義されているか
エラーハンドリング	想定されるエラーケースと対処方法が定義されているか
セキュリティ	転送時の暗号化、認証方式、アクセス制御が考慮されているか
運用考慮	ファイル保管期間、リトライ方針、監視項目が明確か

👁️‍🗨️ レビュー観点:

連携先との合意: ファイル仕様について連携先システムの担当者と合意が取れているか
データ整合性: データの重複、欠損、不整合を検出・防止する仕組みがあるか
性能要件: ファイルサイズ、処理時間、連携頻度が要件を満たしているか
障害時の対応: ファイル転送失敗時のリトライ、エスカレーション、復旧手順が明確か
テスト容易性: 正常系・異常系のテストケースが定義可能な仕様になっているか

🧪成果物のサンプル

# IF-003: マスタデータ取込

**概要:**
マスタ管理システムから商品マスタや分類マスタ等の基礎データをCSVファイル形式で日次バッチ処理により取り込むファイル連携インターフェース。毎日深夜に最新のマスタデータを取得し、本システムのデータベースを更新することで、マスタデータの同期を実現する。

**連携方式:**
- プロトコル: SFTP
- 連携頻度: 日次（毎日 AM 2:00）
- ファイル形式: CSV（UTF-8、BOM無し）

**ファイル配置:**
```
/data/import/master_YYYYMMDD.csv
```

**ファイル命名規則:**
```
{ファイル種別}_{YYYYMMDD}.csv
例: master_20251120.csv
```

**CSV仕様:**
```csv
product_id,product_name,category,price,stock
P001,商品A,カテゴリ1,1000,50
P002,商品B,カテゴリ2,2000,30
```

**列定義:**
| 列No | 項目名 | 型 | 桁数 | 必須 | 備考 |
|------|-------|-----|-----|-----|------|
| 1 | product_id | 文字列 | 10 | ○ | 商品ID |
| 2 | product_name | 文字列 | 100 | ○ | 商品名 |
| 3 | category | 文字列 | 50 | ○ | カテゴリ |
| 4 | price | 数値 | 10 | ○ | 価格 |
| 5 | stock | 数値 | 5 | ○ | 在庫数 |

**処理フロー:**
1. ファイル取得
2. バリデーション（形式チェック、必須チェック）
3. データ取込（トランザクション処理）
4. 処理結果ログ出力
5. 完了ファイル作成（`master_YYYYMMDD.done`）

**エラーハンドリング:**
- バリデーションエラー: エラーログ出力、管理者通知
- ファイル不存在: リトライ（最大3回、10分間隔）
- 取込エラー: ロールバック、エラーファイル出力

**ファイル保管:**
- 処理済みファイルは7日間保管後削除
- エラーファイルは30日間保管

---