# 機能設計書 292-Copy-DbaXESessionTemplate

## 概要

本ドキュメントは、dbatoolsリポジトリから拡張イベントセッションテンプレートをSSMS（SQL Server Management Studio）のテンプレートディレクトリにコピーするCopy-DbaXESessionTemplate機能について記述する。

### 本機能の処理概要

Copy-DbaXESessionTemplateは、dbatoolsに同梱されているキュレーションされた拡張イベントセッションテンプレートを、SSMSのテンプレートディレクトリにインストールするコマンドレットである。これにより、SSMS GUIからテンプレートにアクセスできるようになる。

**業務上の目的・背景**：拡張イベントセッションの設定は複雑であり、デッドロック検出、クエリパフォーマンス追跡、接続監視、データベースヘルスチェックなどの一般的な監視シナリオには定型的なテンプレートが有用である。dbatoolsコミュニティが提供するテンプレートをSSMSに統合することで、DBAは手動でセッションを構成する手間を省き、すぐに監視を開始できる。

**機能の利用シーン**：
- SSMS新規インストール後の監視テンプレートのセットアップ
- DBA環境の標準化（チーム内で同じテンプレートを共有）
- 新しいdbatoolsバージョンでのテンプレート更新
- カスタムテンプレートのSSMSへの展開

**主要な処理内容**：
1. コピー元ディレクトリ（デフォルトはdbatoolsのbin/XEtemplates）の確認
2. 宛先ディレクトリ（デフォルトはSSMSのXEventTemplates）の存在確認と作成
3. Get-DbaXESessionTemplateを使用してMicrosoft以外のテンプレートをフィルタリング
4. テンプレートファイルのコピー実行

**関連システム・外部連携**：SQL Server Management Studioのテンプレートディレクトリを使用。SSMSがインストールされていなくても任意のディレクトリにコピー可能。

**権限による制御**：ファイルシステムへの書き込み権限が必要。SQL Server権限は不要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 85 | XEセッションテンプレート | 補助機能 | XEセッションテンプレートのコピー |

## 機能種別

ファイル操作 / 構成管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Path | string[] | No | コピー元テンプレートディレクトリ。デフォルト: $script:PSModuleRoot\bin\XEtemplates | ディレクトリ存在確認 |
| Destination | string | No | コピー先ディレクトリ。デフォルト: $home\Documents\SQL Server Management Studio\Templates\XEventTemplates | 必要に応じて作成 |
| EnableException | switch | No | 例外を有効にする | - |

### 入力データソース

- dbatoolsモジュールディレクトリ内のXEテンプレートファイル（XMLフォーマット）
- Get-DbaXESessionTemplateコマンドレットの出力

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| なし | - | パイプラインへの出力なし（Write-Messageによるログ出力のみ） |

### 出力先

- ファイルシステム（指定されたDestinationディレクトリ）
- Write-Messageによるコンソール出力（進捗表示）

## 処理フロー

### 処理シーケンス

```
1. 宛先ディレクトリの確認
   └─ 存在しない場合は作成
2. テンプレートファイルの取得
   └─ Get-DbaXESessionTemplateを使用
   └─ Microsoft以外のテンプレートをフィルタ
3. ファイルのコピー
   └─ 各テンプレートファイルをDestinationにコピー
   └─ 進捗をWrite-Messageで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{宛先ディレクトリ存在?}
    B -->|No| C[ディレクトリ作成]
    B -->|Yes| D[テンプレート取得]
    C --> D
    D --> E[Microsoft以外をフィルタ]
    E --> F{ファイルループ}
    F --> G[ファイルコピー]
    G --> H[進捗出力]
    H --> F
    F -->|完了| I[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | Microsoftテンプレート除外 | Microsoftが提供するテンプレートはコピー対象外 | 常時 |
| BR-002 | ディレクトリ自動作成 | 宛先ディレクトリが存在しない場合は自動作成 | 宛先不存在時 |
| BR-003 | 上書きコピー | 同名ファイルは上書きされる | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

データベース操作は行わない。ファイルシステム操作のみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| DirectoryCreateError | ディレクトリ作成エラー | 宛先ディレクトリの作成に失敗 | 権限の確認 |
| FileCopyError | ファイルコピーエラー | テンプレートファイルのコピーに失敗 | ファイルアクセス権の確認 |

### リトライ仕様

リトライ処理なし。エラー発生時はStop-Functionで処理終了。

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

ファイルシステム操作のためトランザクション制御なし。

## パフォーマンス要件

特に規定なし。ファイル数に依存した処理時間。

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

- ファイルシステムへの書き込み権限が必要
- SSMSテンプレートディレクトリへのアクセスにはユーザー権限で十分（管理者権限不要）
- カスタムテンプレートをコピーする場合は、信頼できるソースからのファイルのみを使用すること

## 備考

- SSMSがインストールされていない環境では、デフォルトの宛先ディレクトリが存在しないため、Destinationパラメータで明示的に指定する必要がある
- Microsoft公式のテンプレートは除外される（system_health等のシステムセッションテンプレート）

---

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

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

### 推奨読解順序

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

テンプレートファイルの構造とGet-DbaXESessionTemplateの出力を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Copy-DbaXESessionTemplate.ps1 | `public/Copy-DbaXESessionTemplate.ps1` | パラメータ定義（52-56行目） |

**読解のコツ**: $script:PSModuleRootはdbatoolsモジュールのルートディレクトリを指す。

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

processブロックでのファイル操作フローを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Copy-DbaXESessionTemplate.ps1 | `public/Copy-DbaXESessionTemplate.ps1` | processブロック（57-76行目） |

**主要処理フロー**:
1. **58行目**: Test-FunctionInterruptによる中断チェック
2. **60-65行目**: 宛先ディレクトリの存在確認と作成
3. **68行目**: Get-DbaXESessionTemplateでテンプレート取得、Microsoftを除外
4. **69-71行目**: ファイルコピーループ

#### Step 3: 関連機能を理解する

Get-DbaXESessionTemplateの動作を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaXESessionTemplate.ps1 | `public/Get-DbaXESessionTemplate.ps1` | テンプレート取得ロジック |

**主要処理フロー**:
- テンプレートXMLの解析とSourceプロパティの取得
- Microsoftテンプレートの識別

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

```
Copy-DbaXESessionTemplate
    │
    ├─ Test-FunctionInterrupt
    │
    ├─ Test-Path (宛先確認)
    │      └─ New-Item (ディレクトリ作成)
    │
    ├─ Get-DbaXESessionTemplate
    │      └─ Where-Object Source -ne Microsoft
    │
    └─ foreach $file
           │
           ├─ Write-Message (進捗出力)
           │
           └─ Copy-Item
```

### データフロー図

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

Path (XEtemplates) ──────▶ Get-DbaXESessionTemplate
                                  │
                                  ▼
                           フィルタリング
                           (Microsoft除外)
                                  │
                                  ▼
                           Copy-Item ──────────────▶ Destination
                                                    (SSMSテンプレート)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Copy-DbaXESessionTemplate.ps1 | `public/Copy-DbaXESessionTemplate.ps1` | ソース | メイン処理 |
| Copy-DbaXESessionTemplate.Tests.ps1 | `tests/Copy-DbaXESessionTemplate.Tests.ps1` | テスト | Pesterテスト |
| Get-DbaXESessionTemplate.ps1 | `public/Get-DbaXESessionTemplate.ps1` | ソース | テンプレート取得 |
| XEtemplates/ | `bin/XEtemplates/` | リソース | テンプレートファイル格納 |
