> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/ja/dev-reference/runbook-output-data.md).

# Runbook 出力データ

runbook の結果を RealmJoin Portal で並べ替え・フィルター可能なテーブルとして表示し、構造化オブジェクトを出力する runbook を作成します。

## 概要

**出力データ** の構造化された対応物です **コンソール** runbook ジョブページ上のタブです。コンソールには実行の生の行ごとのテキストフィードが保持され、Output Data は同じ実行で出力されたオブジェクトをテーブルとして表示します。GUID などの長い値は、切り詰められる代わりに完全に表示され、 `…` PowerShell コンソールのフォーマッターによって切り詰められることはなく、幅の広い結果セットも折り返されずに読みやすく表示されます。

主な特徴:

* **設定も追加の権限も不要** — オブジェクトを出力するすべての runbook でこのタブが利用できます。有効化は不要で、runbook を開始できるユーザーにも影響しません。
* **事前整形されたテキストではなくオブジェクト** — テーブルは、runbook が出力ストリームに書き込んだ内容から生成されます。結果を次のもので事前整形する runbook は `Format-Table` まったく Output Data を出力しません。
* **インタラクティブなテーブル** — 各テーブルは、それぞれ独立して並べ替え、フィルター、ページング、Excel または CSV へのエクスポートができます。
* **入れ子のデータも調査可能なまま** — セル内のオブジェクトや配列は、読めない 1 つの文字列に平坦化されるのではなく、展開できます。
* **Console タブは変更されません** — 完全なテキスト出力は引き続き利用可能で、コピーもできます。これは通常、サービスチケットや ITIL チケットで必要なものです。

## クイック スタート

最小限の runbook は、テーブル名を持つマーカー オブジェクトを出力し、その後にデータを出力します：

```powershell
[PSCustomObject]@{ RjTableTitle = '非準拠デバイス' }
Write-Output $nonCompliantDevices
```

これにより、次のタイトルの 1 つのテーブルが生成されます **非準拠デバイス** Output Data タブには、デバイスごとに 1 行、プロパティごとに 1 列のテーブルが表示され、さらにそれへのリンクを含む簡潔な要約行が Console タブに表示されます。

## ポータルで Output Data を読む

からジョブを開き [Runbook Logs](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-logs.md) 、次に **出力データ** タブに切り替えます。 [Runbook ジョブの詳細](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-logs/runbook-job-details.md) そのページの他のタブについては

### テーブルとナビゲーション

runbook が出力するオブジェクトのセットごとに 1 つのテーブルになります。テーブルには次が含まれます：

* **タイトル** — runbook が設定した名前（ [テーブルに名前を付ける](#naming-a-table)）か、フォールバックの `Table 1`, `Table 2` などです。
* **サイドバーの項目** — すべてのテーブルが左側に一覧表示され、タイトルをクリックするとそのテーブルに移動します。
* **行数カウンター** — `12 / 340 行` は、テーブル全体のうち現在のフィルターに一致する行数を示します。

### フィルター

次の **フィルター…** テーブル上部のボックスは、入力したテキストを含む行だけを残します。このフィルターは、そのテーブルのすべての列に対する大文字小文字を区別しない部分文字列一致です。各テーブルは個別にフィルターされます。

### 並べ替え

列ヘッダーをクリックするとその列で並べ替えられ、もう一度クリックすると昇順/降順が反転します。矢印（`▲` / `▼`）が現在の列を示します。並べ替えは型を考慮します：

| 列の内容 | 並べ替え順                   |
| ---- | ----------------------- |
| 数値   | 数値順 — `2` 前に `10`.      |
| 日付   | 時系列順。                   |
| それ以外 | アルファベット順（大文字小文字を区別しない）。 |

空のセルが先に並びます。

### ページング

テーブルは 50 行ごとにページ分けされ、テーブル下部にページャーがあります。フィルターと並べ替えは、表示中のページだけでなく常にテーブル全体に適用されます。

### 入れ子のオブジェクトとリスト

入れ子のオブジェクトや配列を含むセルは、読めないテキストに平坦化されません：

* セルにはキャレット（`▸`）が表示されます。これをクリックすると、そのオブジェクトや配列が行の下にインラインで展開されます。
* 列ヘッダーには展開矢印があります。これをクリックすると列全体が独自のテーブルに展開され、各親行の入れ子値が行に展開され、参照列が親行番号へのリンクになります。新しいテーブルはページ下部とサイドバーの末尾に追加され、他のテーブルと同様にフィルター、並べ替え、エクスポートができます。

### エクスポート

各テーブルにはそれぞれ独自の **Excel にエクスポート** (`.xlsx`) および **CSV にエクスポート** ボタンがあります。エクスポートは現在のフィルターを反映し、一致する行だけを書き出し、ファイル名にはテーブルのタイトルを使用します。Excel へのエクスポートではシート名にもタイトルを使用し、31 文字を超えるタイトルでは失敗します。 [テーブルに名前を付ける](#naming-a-table).

ポータルからのエクスポートは、その場限りのケースをカバーします。runbook が単独で配信すべきレポートファイル、たとえばメール添付やダウンロードリンクとして配布する場合は、代わりに runbook 内で [Export-RjRbXlsx](https://docs.realmjoin.com/ja/dev-reference/report-functions/export-rjrbxlsx.md) と配信ヘルパーを使って作成してください。

## Console タブ

ジョブがテーブルを出力した場合、 **コンソール** タブは既定で圧縮表示になります。テーブルは PowerShell 風に描画されますが、切り詰められるため、ステータス行の可読性が保たれ、数百のオブジェクトを出力した runbook でもページが埋まりません。各テーブルの代わりに、コンソールには要約ボックスが表示されます：

```plaintext
╭─ Table ────────────────────────────────────────────╮
│ <table name> · <row count> rows                    │
╰───────────────────────────── → "Output Data" tab ──╯
```

連続して出力されたテーブルは 1 つのボックスを共有します：

```plaintext
╭─ Table ────────────────────────────────────────────╮
│ Devices                 · 3123 rows                │
│ Application credentials · 42 rows                  │
│ Large export sample     · 987654 rows              │
╰───────────────────────────── → "Output Data" tab ──╯
```

`→ "Output Data" tab` はリンクであり、対応するテーブルに切り替えます。

表示は 2 つのボタンで切り替えます：

* **完全な出力を表示** — 完全で切り詰められていないテキストに切り替えます。
* **圧縮テーブルを表示** — 元に戻します。

**クリップボードにコピー** どの表示でも、常に完全な生の出力をコピーします。

## runbook から Output Data を出力する

このタブは、runbook が出力するオブジェクトから作られます。そのため、整然としたテーブルにするには、runbook がオブジェクトを書き込み、テキストとして事前整形しないことが必要です。

### 整形済みテキストではなくオブジェクトを出力する

> **出力を次のものへパイプしない `Format-Table` または `Format-List`.** それらの cmdlet はデータではなく、フォーマット エンジンのレコードを出力します。ポータルはそれらを検出して非表示にし、出力の形式が不正だったことを示すヒントを表示します。PowerShell が、出力ストリームではなくホストに書き込まれた結果を自動整形する場合も同様です。

`Format-*` cmdlet はあくまで *表示*を制御するだけです。それらが使われていた目的には、Output Data で表示できるデータ上の対応があります。とくに列を選ぶのは `Select-Object` の役割です：

| 次のようにする代わりに                          | 使用してください                             |
| ------------------------------------ | ------------------------------------ |
| `$devices \| Format-Table Name, Id`  | `$devices \| Select-Object Name, Id` |
| `$devices \| Format-Table -AutoSize` | `Write-Output $devices`              |
| `$devices \| Format-List`            | `Write-Output $devices`              |

`Select-Object Name, Id` は、 `Format-Table Name, Id` で表示されるのと同じ列の選択になります。しかもオブジェクトを出力するため、列はフォーマット レコードとして破棄されず、Output Data タブに残ります：

```powershell
# 良い — 実際のオブジェクト、列は Select-Object で選択
$devices | Select-Object Name, Id, OperatingSystem, LastSeen

# 悪い — フォーマット レコード、Output Data から非表示
$devices | Format-Table Name, Id, OperatingSystem, LastSeen
```

選択されたプロパティは、結果のテーブルの列そのものです： `名前`, `Id`, `OperatingSystem` と `LastSeen`、デバイスごとに 1 行です。

### オブジェクトがテーブルになる仕組み

| 出力されたもの                | 次のようにレンダリングされます                                                       |
| ---------------------- | --------------------------------------------------------------------- |
| 1 つのオブジェクト             | 1 行 — そのプロパティが列になります。                                                 |
| 同じプロパティを持つ連続したオブジェクト   | 1 つのテーブル。                                                             |
| 異なるプロパティ セットを持つオブジェクト  | 新しいテーブルが始まります。                                                        |
| 単一のプレーン値（文字列、数値）       | テーブルではなく、コンソールのテキスト行になります。                                            |
| 次で始まる行 `##` の後にスペースが続く | コンソール表示のヘッダーです。                                                       |
| 入れ子のオブジェクトまたは配列        | セル内の JSON。グリッドで展開可能 — 参照 [入れ子のオブジェクトとリスト](#nested-objects-and-lists). |

### テーブルに名前を付ける

既定では、テーブルには `Table 1`, `Table 2` などというラベルが付けられます。テーブルに意味のある名前を付けるには、runbook はデータの直前にマーカー オブジェクトを出力します。このマーカーは、1 つのプロパティだけを持つオブジェクトで、その唯一のプロパティは `RjTableTitle`:

```powershell
[PSCustomObject]@{ RjTableTitle = '非準拠デバイス' }
Write-Output $nonCompliantDevices
```

すると、次のテーブルには **非準拠デバイス** というタイトルが付きます — 見出し、サイドバー、エクスポート ファイル名に反映されます。

* マーカー自体は **消費**されます。行としてもコンソール行としても表示されません。
* プロパティ名は **大文字小文字を区別しない** — `RjTableTitle`, `rjtabletitle` で、他の任意の大文字小文字表記でも機能します。
* 成功した解決済みキーのみを含む **空** タイトルは無視されるため、空のマーカーで既存の名前が消えることはありません。
* 名前が適用されるのは **次に** 出力されるテーブルであり、その間にステータス行が挟まっていても同様です。

このパターンを繰り返すと、1 回の実行で複数のテーブルに名前を付けられます：

```powershell
[PSCustomObject]@{ RjTableTitle = '準拠デバイス' }
Write-Output $compliant

[PSCustomObject]@{ RjTableTitle = '非準拠デバイス' }
Write-Output $nonCompliant
```

{% hint style="warning" %}
**テーブルのタイトルは 31 文字以内にしてください。** **Excel にエクスポート** はテーブルのタイトルをワークシート名として使いますが、Excel が受け付けるのは 1～31 文字で、次のいずれも含まない名前だけです。 `\ / ? * [ ] :` また、先頭や末尾がアポストロフィでないことも必要です。次のような長いタイトル `共有メールボックスを持つ無効なユーザー` （36 文字）では、エクスポートは次のエラーで失敗します。 *「データの読み込み中にエラーが発生しました: sheetName '共有メールボックスを持つ無効なユーザー' は無効です - 文字数は 1 以上 31 以下でなければなりません」*.

この制限には、グループ名や日付など実行時に挿入される値も含まれます。短くて意味のあるタイトルを選び、runbook が次のものを使って Excel ファイルも書き出す場合は [Export-RjRbXlsx](https://docs.realmjoin.com/ja/dev-reference/report-functions/export-rjrbxlsx.md#worksheet-names)、テーブルと対応するワークシートに同じ名前を使ってください。
{% endhint %}

## 動作と制限

### アーカイブ済みジョブ

Output Data は実行中のジョブでのみ利用できます。アーカイブ済みジョブには *「アーカイブ済みの実行からは構造化データを取得できません。」* — それらの結果は Console タブから読む必要があります。 [Runbook Logs](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-logs.md) 最近のジョブログとアーカイブ済みジョブログの違いについては

### 構造化出力のない runbook

*「この runbook からの構造化出力データはありません。」* は、テーブル形式のものが何も出力されなかったことを意味します。メッセージに情報アイコンが付いている場合、runbook はデータではなく PowerShell のフォーマット レコードを送信しています — 参照 [整形済みテキストではなくオブジェクトを出力する](#emit-objects-not-formatted-text).

### 単一値

単一のプレーン値（ステータス文字列やカウントなど）を出力する runbook は、その値を Console タブのテキスト行として保持します。テーブルになるのはオブジェクトだけなので、進捗メッセージやステータスメッセージがそれぞれ 1 行のテーブルになることはありません。

## 関連項目

* [Runbook ジョブの詳細](https://docs.realmjoin.com/ja/zi-dong-hua/runbooks/runbook-logs/runbook-job-details.md) — Console タブと Output Data タブをホストするジョブページ。
* [Export-RjRbXlsx](https://docs.realmjoin.com/ja/dev-reference/report-functions/export-rjrbxlsx.md) — ポータル外で配布するために、同じオブジェクトをスタイル付きの Excel ワークブックに書き出します。
* [Send-RjRbReportEmail](https://docs.realmjoin.com/ja/dev-reference/report-functions/send-rjrbreportemail.md) — レポート結果を管理者にメールで配信します。
* [runbook との連携](https://docs.realmjoin.com/ja/dev-reference/interacting-with-runbooks.md) — RealmJoin API を通じてジョブ出力をプログラムから読み取ります。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/ja/dev-reference/runbook-output-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
