# 帳票設計書 15-Export-DbaXESessionTemplate

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Export-DbaXESessionTemplate` コマンドに関する帳票設計書です。このコマンドは、拡張イベントセッションをSSMS用再利用可能XMLテンプレートとしてエクスポートする機能を提供します。

### 本帳票の処理概要

Export-DbaXESessionTemplateは、既存のSQL Server拡張イベント（XE）セッション定義をXMLテンプレートファイルに変換するコマンドです。生成されたテンプレートはSSMSのテンプレートブラウザから直接利用可能で、新規セッション作成時に再利用できます。

**業務上の目的・背景**：拡張イベントセッションの構築には専門知識が必要で、イベント・アクション・ターゲットの組み合わせを正しく設定する必要があります。一度構築した監視セッションをテンプレート化することで、チーム内での共有や標準化が可能になります。SSMSのテンプレート機能との統合により、GUIからも容易に再利用できる形式で保存できます。

**帳票の利用シーン**：
- 社内標準監視セッションのテンプレート化
- ベストプラクティスセッションの配布
- SSMSテンプレートライブラリの拡充
- 監視設定の標準化・ガバナンス
- 新規サーバーセットアップ時のセッション展開

**主要な出力内容**：
1. XMLテンプレートファイル（SSMS互換形式）
2. セッション定義（イベント、アクション、ターゲット）
3. セッション構成設定

**帳票の出力タイミング**：PowerShellコンソールまたはスクリプトからコマンド実行時に即座に出力されます。

**帳票の利用者**：データベース管理者（DBA）、パフォーマンスエンジニア、運用チーム

## 帳票種別

テンプレートファイル（XML形式 / SSMS XEテンプレート互換）

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| N/A | PowerShellコンソール | コマンドライン | Export-DbaXESessionTemplate コマンド実行 |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | XML（SSMS XEテンプレート形式） |
| 用紙サイズ | N/A（XMLファイル） |
| 向き | N/A |
| ファイル名 | {SessionName}.xml |
| 出力方法 | ファイル保存 |
| 文字コード | UTF-8 |

### XML固有設定

| 項目 | 内容 |
|-----|------|
| スキーマ | SSMS XEvent Templates 互換 |
| 拡張子 | .xml |
| 保存先デフォルト | Documents\SQL Server Management Studio\Templates\XEventTemplates |

## 帳票レイアウト

### レイアウト概要

SSMS XEvent テンプレート形式のXMLとして出力されます。

```
┌─────────────────────────────────────┐
│      XML宣言                        │
├─────────────────────────────────────┤
│      event_session要素              │
│   ┌───────────────────────────────┐ │
│   │   event要素（イベント定義）    │ │
│   │   ├─ action要素              │ │
│   │   └─ predicate要素           │ │
│   ├───────────────────────────────┤ │
│   │   target要素（ターゲット定義） │ │
│   └───────────────────────────────┘ │
└─────────────────────────────────────┘
```

### ヘッダー部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | XML宣言 | XMLバージョン情報 | 固定 | <?xml version="1.0"?> |

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | event_session | セッション定義ルート | Session | XML要素 | 可変 |
| 2 | event | イベント定義 | Session.Events | XML要素 | 可変 |
| 3 | action | アクション定義 | Event.Actions | XML要素 | 可変 |
| 4 | predicate | フィルター条件 | Event.Predicate | XML要素 | 可変 |
| 5 | target | ターゲット定義 | Session.Targets | XML要素 | 可変 |

### フッター部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | N/A | XML終了タグのみ | - | - |

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| SqlInstance | 対象SQL Serverインスタンス | Yes（InputObjectがない場合） |
| Session | 対象セッション名（ワイルドカード対応） | No |
| Path | 出力ディレクトリ | No（デフォルト: SSMSテンプレートフォルダ） |
| FilePath | 出力ファイルパス | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | セッション名 | 取得順 |

### 改ページ条件

N/A（XMLファイル出力のため）

## データベース参照仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| sys.server_event_sessions | セッション一覧 | XEStore経由 |
| sys.server_event_session_events | イベント定義 | XEStore経由 |
| sys.server_event_session_actions | アクション定義 | XEStore経由 |
| sys.server_event_session_targets | ターゲット定義 | XEStore経由 |

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

#### XEStore Session

| 参照項目（カラム名） | 帳票項目との対応 | 取得条件 | 備考 |
|-------------------|----------------|---------|------|
| Name | セッション名/ファイル名 | Session パラメータ | テンプレート名 |
| SaveSessionToTemplate() | XMLテンプレート | - | XEStoreメソッド |

## 計算仕様

### 計算項目一覧

| 項目名 | 計算式 | 端数処理 | 備考 |
|-------|-------|---------|------|
| ファイル名 | Remove-InvalidFileNameChars(Session.Name) + ".xml" | - | 不正文字除去 |

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[Export-DbaXESessionTemplate実行] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaXESession]
    B -->|No| D[InputObject使用]
    C --> E[Session取得]
    D --> E
    E --> F[ループ: 各セッション]
    F --> G[Remove-InvalidFileNameChars]
    G --> H{Path存在確認}
    H -->|No| I[エラー終了]
    H -->|Yes| J{FilePath指定?}
    J -->|No| K[Path + SessionName.xml]
    J -->|Yes| L[FilePath使用]
    K --> M[SaveSessionToTemplate実行]
    L --> M
    M --> N[Get-ChildItem]
    N --> O{次セッション?}
    O -->|Yes| F
    O -->|No| P[終了]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| パス不存在 | 指定Pathが存在しない | "{Path} does not exist." | 有効なパスを指定 |
| 接続エラー | SQL Server接続失敗 | "Error occurred while establishing connection to {instance}" | 接続情報を確認 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 1〜50セッション |
| 目標出力時間 | 10秒以内 |
| 同時出力数上限 | 制限なし |

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

- SQL Server 2008以上が必要
- VIEW SERVER STATE権限が必要
- デフォルト出力先はユーザーのDocumentsフォルダ内
- セッション定義には機密性の高いフィルター条件が含まれる可能性

## 備考

- デフォルト出力先: $home\Documents\SQL Server Management Studio\Templates\XEventTemplates
- 出力されたテンプレートはSSMSのテンプレートブラウザから利用可能
- ファイル名に使用できない文字は自動的に除去される
- 上書きフラグ（第3引数$true）でファイル上書きを許可

---

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

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

### 推奨読解順序

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

XESessionオブジェクトとSaveSessionToTemplateメソッドの仕組みを理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Export-DbaXESessionTemplate.ps1 | `public/Export-DbaXESessionTemplate.ps1` | パラメータ定義（行82-93）でPath, Session等を確認 |

**読解のコツ**: XEStoreのSaveSessionToTemplateメソッドがSSMS互換XMLを生成することを理解する

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Export-DbaXESessionTemplate.ps1 | `public/Export-DbaXESessionTemplate.ps1` | beginブロック（行94-96） |
| 2-2 | Export-DbaXESessionTemplate.ps1 | `public/Export-DbaXESessionTemplate.ps1` | processブロック（行97-122） |

**主要処理フロー**:
1. **行100-106**: SqlInstanceからGet-DbaXESession呼び出し
2. **行108-121**: 各セッションのテンプレート出力

#### Step 3: テンプレート保存処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Export-DbaXESessionTemplate.ps1 | `public/Export-DbaXESessionTemplate.ps1` | 出力処理（行108-121） |

**主要処理フロー**:
- **行109**: Remove-InvalidFileNameCharsでファイル名サニタイズ
- **行111-113**: パス存在確認
- **行115-117**: ファイルパス決定
- **行119**: SaveSessionToTemplate実行
- **行120**: Get-ChildItemでFileInfo返却

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

```
Export-DbaXESessionTemplate
    │
    ├─ Test-ExportDirectory (begin)
    │      └─ パス存在確認
    │
    ├─ Get-DbaXESession
    │      └─ XEセッション取得
    │
    ├─ Remove-InvalidFileNameChars
    │      └─ ファイル名サニタイズ
    │
    ├─ Test-Path
    │      └─ パス存在確認
    │
    ├─ Join-DbaPath
    │      └─ パス結合
    │
    ├─ XEStore.SaveSessionToTemplate()
    │      └─ XMLテンプレート保存
    │
    └─ Get-ChildItem
           └─ FileInfo返却
```

### データフロー図

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

SqlInstance ───────▶ Get-DbaXESession ───────────▶ Session Objects
                            │
Session ───────────▶ Filter Sessions ────────────▶ Target Sessions
                            │
                            ▼
                     Remove-InvalidFileNameChars ─▶ Clean Session Name
                            │
                            ▼
Path ──────────────▶ Join-DbaPath ───────────────▶ Full File Path
                            │
                            ▼
                     SaveSessionToTemplate() ────▶ XML Template File
                            │
                            ▼
                     Get-ChildItem ──────────────▶ FileInfo Object
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Export-DbaXESessionTemplate.ps1 | `public/Export-DbaXESessionTemplate.ps1` | ソース | メイン処理 |
| Export-DbaXESessionTemplate.Tests.ps1 | `tests/Export-DbaXESessionTemplate.Tests.ps1` | テスト | 単体テスト |
| Get-DbaXESession.ps1 | `public/Get-DbaXESession.ps1` | ソース | セッション取得 |
| Remove-InvalidFileNameChars.ps1 | `private/Remove-InvalidFileNameChars.ps1` | ソース | ファイル名サニタイズ |
| Test-ExportDirectory.ps1 | `private/Test-ExportDirectory.ps1` | ソース | ディレクトリ検証 |
| Join-DbaPath.ps1 | `private/Join-DbaPath.ps1` | ソース | パス結合 |
