SpreadSheet: GEM側のスプレッドシートのドキュメントの充実化 - #97
Conversation
There was a problem hiding this comment.
Pull request overview
GEM（Generic Entity Manager）側のSpreadsheet機能について、操作・設定・定義項目のドキュメントを拡充し、利用者がAdminConsole設定から画面操作まで一連で理解できるようにするPRです。
Changes:
- Spreadsheet（GEM）の設定手順（作成、各タブ/セクションの設定、メニュー登録）を具体化
- Spreadsheet画面の操作説明（フィルタ、編集、行操作、Undo/Redo、保存、セル結合、エクスポート）を追記
- SpreadSheetDefinition 等の定義項目一覧と詳細説明（新規 definition.adoc）を追加し、索引（index.adoc）から参照可能に整理
Reviewed changes
Copilot reviewed 4 out of 19 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/setting.adoc | 作成/設定/表示方法（メニュー登録）を具体的に記述 |
| developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/operationguide.adoc | 画面構成〜各操作（保存/結合/出力含む）を詳細化 |
| developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/index.adoc | 概要の文言調整と definition.adoc の include 追加 |
| developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc | SpreadSheetDefinition 等の設定項目詳細を新規追加 |
Suppressed comments (1)
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:126
- サンプルのコメントが「dateプロパティ」となっていますが、実際に設定しているキーは
startDate_...なので、例の説明とコードが不一致です（読者がどのプロパティに対する例か誤解しやすい）。
// 検索日（dateプロパティ）の初期条件として、現在日時以降を設定する例
initCondMap.put("startDate_ope_0", "GE")
initCondMap.put("startDate_0", new java.text.SimpleDateFormat("yyyyMMdd").format(new Date()))
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| SpreadSheet定義の編集画面の `SpreadSheet属性` タブでは、以下のセクションを設定します。 | ||
| 各設定項目の詳細は、<<definition.adoc#spreadsheet_definition,Definition定義の詳細>>を参照してください。 |
| * セルレイアウト（静的設定）: 結合するセル範囲を行・列・行結合数・列結合数で固定値として定義します。 | ||
| * Expression（式設定）: ルールベースで結合条件（同値比較など）を定義します。 | ||
|
|
||
| 設定方法の詳細は<<definition.adoc#spreadsheet_featureflags_merge,セル結合設定>>を参照してください。 |
| 詳細は<<definition.adoc#spreadsheet_gridoptions,グリッドオプション>>を参照してください。 | ||
|
|
||
| |機能フラグ（featureFlags） | ||
| |グリッド上で許可する操作を指定します。 + | ||
| 詳細は<<definition.adoc#spreadsheet_featureflags,機能フラグ>>を参照してください。 |
| 列ごとにエディタタイプを指定することで、プロパティの型に応じた入力サポートを提供します。 | ||
|
|
||
| Spreadsheetの定義としてAdmin Console上で以下の属性を設定することができます。 | ||
| Spreadsheetの定義としてAdminConsole上で以下の属性を設定することができます。 |
There was a problem hiding this comment.
AdminConsole --> Admin Console
全体的に
| [[spreadsheet_structure]] | ||
| === 画面構成 | ||
|
|
||
| SpreadSheet画面は以下の要素で構成されます。 |
There was a problem hiding this comment.
SpreadSheet --> Spreadsheet
機能名ではこれで統一しましょう。
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 19 changed files in this pull request and generated 1 comment.
Suppressed comments (12)
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/setting.adoc:23
- この相互参照は
definition.html#spreadsheet_definitionへのリンクとして生成されますが、ビルド対象は**/index.adocのみです（build.gradle:41）。定義本文はindex.adocに include されるため、同一文書内のアンカーを直接参照しないと生成物でリンク切れになります。
各設定項目の詳細は、<<definition.adoc#spreadsheet_definition,Definition定義の詳細>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/operationguide.adoc:283
- この参照は生成されない
definition.htmlを指します。ビルド対象はindex.adocのみで、参照先はそこへ include されているため、同一文書内アンカーにしてください。
設定方法の詳細は<<definition.adoc#spreadsheet_featureflags_merge,セル結合設定>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:38
- これらの
definition.adoc#...参照は生成されないdefinition.htmlを指します（ビルド対象は**/index.adocのみ）。include 後の同一文書アンカーを参照してください。
詳細は<<definition.adoc#spreadsheet_gridoptions,グリッドオプション>>を参照してください。
|機能フラグ（featureFlags）
|グリッド上で許可する操作を指定します。 +
詳細は<<definition.adoc#spreadsheet_featureflags,機能フラグ>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:46
- これらのファイル付き参照は
definition.htmlへ変換されますが、その HTML はビルドされません。同じindex.adocに include されるアンカーを直接参照してください。
詳細は<<definition.adoc#spreadsheet_basic_defaultcond,デフォルト検索条件スクリプト>>を参照してください。
|グリッド初期化スクリプト（gridInitializationScript）
|グリッド生成後に実行する初期化JavaScriptをGroovyテンプレートで指定します。 +
詳細は<<definition.adoc#spreadsheet_basic_init,グリッド初期化スクリプト>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:54
- これらのファイル付き参照は生成対象外の
definition.htmlを指すためリンク切れになります。同一文書内アンカーとして参照してください。
詳細は<<definition.adoc#spreadsheet_filteritem,フィルタ項目>>を参照してください。
|列定義リスト（columnDefinitions）
|グリッドに表示する列を指定します。列定義は1つ以上必要です。 +
詳細は<<definition.adoc#spreadsheet_columndefinition,列定義>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:63
definition.adoc自体は HTML 生成対象ではないため、この参照はリンク切れになります。include 先の同一文書アンカーを直接参照してください。
詳細は<<definition.adoc#spreadsheet_interrupter,カスタム処理の組み込み>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:281
- これらの参照は生成されない
definition.htmlを指します。セル結合セクションは同じindex.htmlに include されるため、アンカーのみで参照してください。
詳細は<<definition.adoc#spreadsheet_featureflags_merge,セル結合設定>>を参照してください。
|セル結合式設定（mergeCellsExpression）
|ルールベースで結合条件をJSON形式で定義します。 +
詳細は<<definition.adoc#spreadsheet_featureflags_merge,セル結合設定>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:469
- このファイル付き参照は、ビルドされない
definition.htmlへのリンクになります。同一文書内アンカーを直接参照してください。
詳細は<<definition.adoc#spreadsheet_columndefinition_multivalue,多重度表示モード>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:476
- この参照先は
index.adocに include されますが、definition.adoc自体の HTML は生成されません。アンカーのみで参照しないとリンク切れになります。
詳細は<<definition.adoc#spreadsheet_editor,エディタ設定>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:130
nameの例にも条件件数がなく、説明されているキー形式を満たしていません。初期条件として機能するようnameConditionCountを設定してください。
initCondMap.put("name_ope_0", "IC")
initCondMap.put("name_0", "サンプル")
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:418
operationguide.adocは単独では HTML に変換されないため、このリンクは生成物でoperationguide.htmlを指して切れます。同じindex.html内のアンカーを参照してください。
指定できる演算子は、<<operationguide.adoc#spreadsheet_filter_operator,利用可能な比較演算子>>を参照してください。
developerguide/src/docs/asciidoc/genericentitymanager/spreadsheet/definition.adoc:126
- この例は直前で条件件数キーを必須の形式として説明しているのに
startDateConditionCountを設定していません。件数がないと_ope_0と値を初期条件として復元できないため、実行可能な例に件数も含めてください。
This issue also appears on line 129 of the same file.
initCondMap.put("startDate_ope_0", "GE")
initCondMap.put("startDate_0", new java.text.SimpleDateFormat("yyyyMMdd").format(new Date()))
| EntityDefinition definition, SpreadSheetDefinition spreadSheetDefinition, | ||
| Map<String, Object> row) { | ||
| // 登録用Entityに対する値の加工や追加設定を行います | ||
| entity.setValue("updateUser", request.getUser().getName()); |
概要
GEMに Spreadsheet を充実する。
動作確認
iplass-docs-internal で gradlew で生成されたhtmlの該当部分を確認
関連情報