# 機能設計書 515-Set-DbaAgentJobOutputFile

## 概要

本ドキュメントは、SQL Server Agentジョブステップの出力ファイルパスを設定するdbatools関数「Set-DbaAgentJobOutputFile」の機能設計書である。

### 本機能の処理概要

Set-DbaAgentJobOutputFileは、SQL Server Agentジョブステップの実行ログ・出力を保存するファイルパスを設定する機能を提供する。

**業務上の目的・背景**：SQL Server Agentジョブの実行状況をトラブルシューティングする際、ジョブステップの詳細な出力ログが必要となる。ジョブ履歴だけでは情報が不十分な場合、ステップごとの出力ファイルを設定することで、コマンド出力、エラーメッセージ、実行詳細を集中管理できる。本機能により、SSMSで個別にジョブステップを編集することなく、一括で出力ファイル設定を行える。

**機能の利用シーン**：
- ジョブトラブルシューティングのためのログ集約設定
- 監査要件に対応したジョブ実行ログの保存
- 複数ジョブの出力ログパスの一括変更
- 新規環境構築時のログ出力設定の標準化

**主要な処理内容**：
1. 対象SQL Serverインスタンスへの接続
2. 指定されたジョブの取得
3. 対象ステップの特定（指定なしの場合はGUIで選択）
4. 各ステップの OutputFileName プロパティを更新
5. SMO Alter()メソッドによる変更のコミット

**関連システム・外部連携**：SQL Server JobServer.Jobs、JobSteps、ファイルシステム

**権限による制御**：sysadmin権限が必要。出力ファイルパスはSQL Serverサービスアカウントが書き込み可能な場所である必要がある。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | SQL Server Management Studio - Job Step Properties | 参照画面 | ジョブステップの出力ファイル設定 |
| - | PowerShell Console | 主画面 | コマンド実行インターフェース |
| - | Out-GridView | 参照画面 | ステップ選択GUI（Step未指定時） |

## 機能種別

データ更新操作 (UPDATE)

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 対象SQL Serverインスタンス | パイプライン入力可 |
| SqlCredential | PSCredential | No | 代替認証資格情報 | - |
| Job | object[] | No* | 対象ジョブ名 | 実質必須（未指定時は警告） |
| Step | object[] | No | 対象ステップ名 | - |
| OutputFile | string | Yes | 出力ファイルパス | 空値不可 |
| EnableException | switch | No | 例外処理を有効化 | - |

### 入力データソース

- SQL Server JobServer.Jobs[$name].JobStepsコレクション

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | インスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Job | string | ジョブ名 |
| JobStep | string | ステップ名 |
| OutputFileName | string | 新しい出力ファイルパス |
| OldOutputFileName | string | 変更前の出力ファイルパス |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 各インスタンスの処理
   ├─ Connect-DbaInstanceで接続
   └─ Jobパラメータの確認
       ├─ 未指定: 警告メッセージを出力し終了
       └─ 指定: 次の処理へ

2. 各ジョブの処理
   ├─ ジョブオブジェクト取得
   └─ ステップの特定
       ├─ Step指定あり: 指定ステップをフィルタ
       └─ Step指定なし:
           ├─ ステップ数 > 1: Out-GridViewで選択
           └─ ステップ数 = 1: 唯一のステップを使用

3. 各ステップの処理
   ├─ 現在の出力ファイルパスを記録
   ├─ ShouldProcess確認
   ├─ OutputFileNameプロパティを更新
   ├─ Alter()メソッド呼び出し
   ├─ Refresh()メソッド呼び出し
   └─ PSCustomObjectで結果を出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[各インスタンスをループ]
    B --> C[Connect-DbaInstance]
    C --> D{Job指定?}
    D -->|No| E[警告: ジョブ名必須]
    E --> F[return]
    D -->|Yes| G[各ジョブをループ]
    G --> H[ジョブオブジェクト取得]
    H --> I{Step指定?}
    I -->|Yes| J[指定ステップをフィルタ]
    I -->|No| K{ステップ数 > 1?}
    K -->|Yes| L[Out-GridViewで選択]
    K -->|No| M[唯一のステップを使用]
    J --> N{ステップ取得成功?}
    L --> N
    M --> N
    N -->|No| O[警告: ステップなし]
    O --> P{次のジョブ?}
    N -->|Yes| Q[各ステップをループ]
    Q --> R[現在の出力ファイル記録]
    R --> S[ShouldProcess確認]
    S --> T[OutputFileName更新]
    T --> U[Alter実行]
    U --> V[Refresh実行]
    V --> W[PSCustomObject出力]
    W --> X{次のステップ?}
    X -->|Yes| Q
    X -->|No| P
    P -->|Yes| G
    P -->|No| Y{次のインスタンス?}
    Y -->|Yes| B
    Y -->|No| Z[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | ジョブ名必須 | Job パラメータは実質必須（未指定時は警告で終了） | 常時 |
| BR-002 | ステップ選択GUI | Step 未指定かつステップ数 > 1 の場合、Out-GridView で選択 | Step未指定時 |
| BR-003 | 全ステップ対象 | ステップ選択GUIでキャンセル時は全ステップが対象 | GUI表示後 |
| BR-004 | 出力ファイル書き込み権限 | 指定パスにSQL Serverサービスアカウントが書き込み可能である必要がある | 実行時 |

### 計算ロジック

該当なし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ステップ更新 | msdb.dbo.sysjobsteps | UPDATE | 出力ファイルパスの更新 |

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

#### msdb.dbo.sysjobsteps

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | output_file_name | OutputFile指定値 | OutputFileNameプロパティ経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | インスタンス接続失敗 | 接続情報を確認 |
| - | Warning | Job パラメータ未指定 | -Job パラメータを指定 |
| - | Warning | 指定したステップが見つからない | ステップ名を確認 |
| - | Stop-Function | 出力ファイル設定失敗 | パスの書き込み権限を確認 |

### リトライ仕様

リトライ機能なし。

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

SMOのAlter()メソッドによる暗黙的トランザクション。各ステップの更新は個別のトランザクション。

## パフォーマンス要件

特に定義なし。

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

- sysadmin権限が必要
- 出力ファイルパスはSQL Serverサービスアカウントがアクセス可能な場所に限定される
- WhatIf/Confirmパラメータによる事前確認が可能

## 備考

- Step 未指定時にOut-GridViewを使用するため、PowerShell ISEまたはWindowsで対話的に使用する必要がある
- 複数ステップの一括更新に対応

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Management.Smo.Agent.JobStep | SMO | ジョブステップオブジェクトのプロパティ（OutputFileName） |

**読解のコツ**: SMOのJobStepクラスにはOutputFileNameプロパティがあり、Alter()とRefresh()メソッドで変更を反映する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Set-DbaAgentJobOutputFile.ps1 | `public/Set-DbaAgentJobOutputFile.ps1` | 関数定義、パラメータ、processブロック構造 |

**主要処理フロー**:
1. **76-106行目**: CmdletBinding属性とパラメータ定義
2. **108-171行目**: インスタンス・ジョブ・ステップのループ処理

#### Step 3: ステップ選択ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Set-DbaAgentJobOutputFile.ps1 | `public/Set-DbaAgentJobOutputFile.ps1` | ステップ特定ロジック |

**主要処理フロー**:
- **124-130行目**: Step指定ありの場合のフィルタ
- **131-137行目**: Step未指定でステップ数 > 1 の場合のGUI選択
- **140-142行目**: ステップが見つからない場合のフォールバック

#### Step 4: 出力ファイル更新処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Set-DbaAgentJobOutputFile.ps1 | `public/Set-DbaAgentJobOutputFile.ps1` | 出力ファイル更新ロジック |

**主要処理フロー**:
- **144-148行目**: 現在の設定記録とログ出力
- **150-165行目**: ShouldProcess、更新、結果出力

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

```
Set-DbaAgentJobOutputFile
    │
    ├─ Connect-DbaInstance
    │
    ├─ JobServer.Jobs[$name] (ジョブ取得)
    │
    ├─ Job.JobSteps (ステップコレクション)
    │      ├─ Where-Object Name -in $Step (フィルタ)
    │      └─ Out-GridView (GUI選択)
    │
    ├─ JobStep.OutputFileName = $OutputFile (更新)
    │
    ├─ JobStep.Alter() (コミット)
    │
    └─ JobStep.Refresh() (リフレッシュ)
```

### データフロー図

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

SqlInstance ─────────▶ Connect-DbaInstance
      │                        │
Job名 ──────────────▶ ジョブオブジェクト取得
      │                        │
Step名（任意）────────▶ ステップ特定
      │                ├─ 指定あり: フィルタ
      │                └─ 指定なし: GUI or 全ステップ
      │                        │
OutputFile ──────────▶ OutputFileName更新
                              │
                              ▼
                         Alter()
                              │
                              ▼
                        Refresh()
                              │
                              ▼
                   PSCustomObject ───▶ [出力]
                   ├─ ComputerName
                   ├─ InstanceName
                   ├─ SqlInstance
                   ├─ Job
                   ├─ JobStep
                   ├─ OutputFileName
                   └─ OldOutputFileName
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Set-DbaAgentJobOutputFile.ps1 | `public/Set-DbaAgentJobOutputFile.ps1` | ソース | メイン関数 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
