Skip to content

Commit e3ed91f

Browse files
xuyushun441-sysos-zhuangclaude
authored
docs: sync public docs with framework 8.0→10.2 changes (#28)
Bring the ObjectOS docs in line with @objectstack 8.0 → 10.2.0: - build/views: migrate the inline chart example to the dataset-bound model (xAxisField/yAxisFields/aggregation/groupByField were removed from ListChart in 9.0, ADR-0021) and add the new `tree` list view type - configure/ai, resources/faq, resources/glossary: rename the MCP package @objectstack/plugin-mcp-server → @objectstack/mcp (renamed in 8.0) - configure/permissions: system object sys_department → sys_business_unit (renamed with no alias in 10.0, ADR-0057) - resources/support: bump the version example 4.0.4 → 10.2.0 Applied to the English source and all 6 locale variants (de/es/fr/ja/ko/zh-Hans). Code blocks are byte-identical across locales; prose deltas were translated per locale. Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent e8199e4 commit e3ed91f

42 files changed

Lines changed: 216 additions & 98 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/docs/build/views.de.mdx‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ view: {
6767
| `timeline` | Chronologischer Feed | `timeline: { startDateField, titleField }` |
6868
| `gantt` | Projektzeitachse + Abhängigkeiten | `gantt: { startDateField, endDateField, titleField }` |
6969
| `map` | Geografische Pins | `map: { locationField }` |
70-
| `chart` | Eingebettetes Diagramm | `chart: { chartType, xAxisField, yAxisFields }` |
70+
| `tree` | Selbstreferenzierende Hierarchie | `tree: { parentField, labelField }` |
71+
| `chart` | Eingebettetes Diagramm | `chart: { chartType, dataset }` |
7172

7273
### Allgemeine List-Optionen
7374

@@ -151,24 +152,38 @@ Bearbeitung.
151152
}
152153
```
153154

155+
### Tree
156+
157+
```ts
158+
{
159+
type: 'tree',
160+
tree: {
161+
parentField: 'parent_id', // self-lookup that builds the hierarchy
162+
labelField: 'name', // shown indented in the first column
163+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
164+
}
165+
}
166+
```
167+
168+
Für ein selbstreferenzierendes Objekt (Kategorien, Stücklisten, Organisationseinheiten, verschachtelte Kommentare) verschachtelt das Tree-Grid die Zeilen anhand ihres `parentField`-Zeigers.
169+
154170
### Chart (inline)
155171

172+
Eine `chart`-Listenansicht bindet ein benanntes **Dataset** — die semantische Analyseschicht (ADR-0021) — und wählt dessen Dimensionen und Kennzahlen **per Name**. Definieren Sie eine Kennzahl einmal, und jedes Diagramm, Dashboard und jeder Report, der dasselbe Dataset bindet, bleibt konsistent:
173+
156174
```ts
157175
{
158176
type: 'chart',
159177
chart: {
160-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
161-
xAxisField: 'created_at',
162-
yAxisFields: ['amount'],
163-
aggregation: 'sum',
164-
groupByField: 'status'
178+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
179+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
180+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
181+
values: ['ticket_count'] // dataset measure name(s) — the value axis
165182
}
166183
}
167184
```
168185

169-
Chart-Views sind für eingebettete Dashboards auf einem einzelnen Objekt
170-
gedacht — für umfangreichere, objektübergreifende Analysen verwenden Sie
171-
die dedizierte Reports-Oberfläche.
186+
Die Inline-Form `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` wurde in 9.0 entfernt — jedes Diagramm, Dashboard-Widget und jeder Report bindet jetzt ein Dataset. Für umfangreichere, objektübergreifende Analysen verwenden Sie die dedizierte Reports-Oberfläche.
172187

173188
## Form-View-Typen
174189

‎content/docs/build/views.es.mdx‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ view: {
6666
| `timeline` | Feed cronológico | `timeline: { startDateField, titleField }` |
6767
| `gantt` | Cronograma de proyecto + dependencias | `gantt: { startDateField, endDateField, titleField }` |
6868
| `map` | Pines geoespaciales | `map: { locationField }` |
69-
| `chart` | Gráfico incrustado | `chart: { chartType, xAxisField, yAxisFields }` |
69+
| `tree` | Jerarquía autorreferenciada | `tree: { parentField, labelField }` |
70+
| `chart` | Gráfico incrustado | `chart: { chartType, dataset }` |
7071

7172
### Opciones comunes de lista
7273

@@ -147,23 +148,38 @@ agrupado — con las mismas reglas de permisos que una edición manual.
147148
}
148149
```
149150

151+
### Tree
152+
153+
```ts
154+
{
155+
type: 'tree',
156+
tree: {
157+
parentField: 'parent_id', // self-lookup that builds the hierarchy
158+
labelField: 'name', // shown indented in the first column
159+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
160+
}
161+
}
162+
```
163+
164+
Para un objeto autorreferenciado (categorías, listas de materiales, unidades organizativas, comentarios anidados) el tree-grid anida las filas según su puntero `parentField`.
165+
150166
### Chart (en línea)
151167

168+
Una vista de lista `chart` vincula un **dataset** con nombre —la capa analítica semántica (ADR-0021)— y selecciona sus dimensiones y medidas **por nombre**. Define una métrica una vez y cada gráfico, panel e informe vinculado al mismo dataset se mantiene consistente:
169+
152170
```ts
153171
{
154172
type: 'chart',
155173
chart: {
156-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
157-
xAxisField: 'created_at',
158-
yAxisFields: ['amount'],
159-
aggregation: 'sum',
160-
groupByField: 'status'
174+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
175+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
176+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
177+
values: ['ticket_count'] // dataset measure name(s) — the value axis
161178
}
162179
}
163180
```
164181

165-
Las vistas de gráfico son para paneles en línea sobre un único objeto — para
166-
analíticas más ricas y entre objetos, usa la superficie dedicada de informes.
182+
La forma en línea `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` se eliminó en 9.0 — cada gráfico, widget de panel e informe ahora vincula un dataset. Para analíticas más ricas y entre objetos, usa la superficie dedicada de informes.
167183

168184
## Tipos de vista de formulario
169185

‎content/docs/build/views.fr.mdx‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ view: {
6666
| `timeline` | Flux chronologique | `timeline: { startDateField, titleField }` |
6767
| `gantt` | Échéancier de projet + dépendances | `gantt: { startDateField, endDateField, titleField }` |
6868
| `map` | Repères géospatiaux | `map: { locationField }` |
69-
| `chart` | Graphique intégré | `chart: { chartType, xAxisField, yAxisFields }` |
69+
| `tree` | Hiérarchie auto-référencée | `tree: { parentField, labelField }` |
70+
| `chart` | Graphique intégré | `chart: { chartType, dataset }` |
7071

7172
### Options de liste courantes
7273

@@ -147,23 +148,38 @@ champ de regroupement — mêmes règles d'autorisation qu'une modification manu
147148
}
148149
```
149150

151+
### Arbre
152+
153+
```ts
154+
{
155+
type: 'tree',
156+
tree: {
157+
parentField: 'parent_id', // self-lookup that builds the hierarchy
158+
labelField: 'name', // shown indented in the first column
159+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
160+
}
161+
}
162+
```
163+
164+
Pour un objet auto-référencé (catégories, nomenclatures, unités organisationnelles, commentaires imbriqués), la grille arborescente imbrique les lignes selon leur pointeur `parentField`.
165+
150166
### Graphique (intégré)
151167

168+
Une vue liste `chart` lie un **dataset** nommé — la couche analytique sémantique (ADR-0021) — et sélectionne ses dimensions et mesures **par leur nom**. Définissez une métrique une fois, et chaque graphique, tableau de bord et rapport lié au même dataset reste cohérent :
169+
152170
```ts
153171
{
154172
type: 'chart',
155173
chart: {
156-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
157-
xAxisField: 'created_at',
158-
yAxisFields: ['amount'],
159-
aggregation: 'sum',
160-
groupByField: 'status'
174+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
175+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
176+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
177+
values: ['ticket_count'] // dataset measure name(s) — the value axis
161178
}
162179
}
163180
```
164181

165-
Les vues de graphique servent aux tableaux de bord intégrés sur un seul objet —
166-
pour des analyses plus riches et inter-objets, utilisez la surface de rapports dédiée.
182+
La forme en ligne `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` a été supprimée en 9.0 — chaque graphique, widget de tableau de bord et rapport lie désormais un dataset. Pour des analyses plus riches et inter-objets, utilisez la surface de rapports dédiée.
167183

168184
## Types de vues de formulaire
169185

‎content/docs/build/views.ja.mdx‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ view: {
6565
| `timeline` | 時系列フィード | `timeline: { startDateField, titleField }` |
6666
| `gantt` | プロジェクトタイムライン + 依存関係 | `gantt: { startDateField, endDateField, titleField }` |
6767
| `map` | 地理空間ピン | `map: { locationField }` |
68-
| `chart` | 埋め込みチャート | `chart: { chartType, xAxisField, yAxisFields }` |
68+
| `tree` | 自己参照型の階層 | `tree: { parentField, labelField }` |
69+
| `chart` | 埋め込みチャート | `chart: { chartType, dataset }` |
6970

7071
### 共通のリストオプション
7172

@@ -146,23 +147,38 @@ view: {
146147
}
147148
```
148149

150+
### ツリー
151+
152+
```ts
153+
{
154+
type: 'tree',
155+
tree: {
156+
parentField: 'parent_id', // self-lookup that builds the hierarchy
157+
labelField: 'name', // shown indented in the first column
158+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
159+
}
160+
}
161+
```
162+
163+
自己参照型のオブジェクト（カテゴリ、部品表、組織単位、入れ子のコメント）では、ツリーグリッドが `parentField` ポインタに従って行を入れ子にします。
164+
149165
### チャート（インライン）
150166

167+
`chart` リストビューは、名前付きの **dataset**（セマンティック分析レイヤー、ADR-0021）をバインドし、そのディメンションとメジャーを**名前で**選択します。メトリックを一度定義すれば、同じ dataset をバインドするすべてのチャート、ダッシュボード、レポートが一貫します。
168+
151169
```ts
152170
{
153171
type: 'chart',
154172
chart: {
155-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
156-
xAxisField: 'created_at',
157-
yAxisFields: ['amount'],
158-
aggregation: 'sum',
159-
groupByField: 'status'
173+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
174+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
175+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
176+
values: ['ticket_count'] // dataset measure name(s) — the value axis
160177
}
161178
}
162179
```
163180

164-
チャートビューは、単一オブジェクト上のインラインダッシュボード向けです。より高度な
165-
オブジェクト横断分析には、専用のレポート画面を使用してください。
181+
インラインの `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` の形式は 9.0 で削除されました。すべてのチャート、ダッシュボードウィジェット、レポートは現在 dataset をバインドします。より高度なオブジェクト横断分析には、専用のレポート画面を使用してください。
166182

167183
## フォームビューの種類
168184

‎content/docs/build/views.ko.mdx‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ view: {
6565
| `timeline` | 시간순 피드 | `timeline: { startDateField, titleField }` |
6666
| `gantt` | 프로젝트 타임라인 + 의존성 | `gantt: { startDateField, endDateField, titleField }` |
6767
| `map` | 지리공간 핀 | `map: { locationField }` |
68-
| `chart` | 임베드 차트 | `chart: { chartType, xAxisField, yAxisFields }` |
68+
| `tree` | 자기 참조 계층 | `tree: { parentField, labelField }` |
69+
| `chart` | 임베드 차트 | `chart: { chartType, dataset }` |
6970

7071
### 공통 list 옵션
7172

@@ -146,23 +147,38 @@ view: {
146147
}
147148
```
148149

150+
### Tree
151+
152+
```ts
153+
{
154+
type: 'tree',
155+
tree: {
156+
parentField: 'parent_id', // self-lookup that builds the hierarchy
157+
labelField: 'name', // shown indented in the first column
158+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
159+
}
160+
}
161+
```
162+
163+
자기 참조 오브젝트(카테고리, BOM, 조직 단위, 중첩 댓글)의 경우 tree-grid는 `parentField` 포인터에 따라 행을 중첩합니다.
164+
149165
### Chart (인라인)
150166

167+
`chart` 리스트 뷰는 이름이 지정된 **dataset**(시맨틱 분석 레이어, ADR-0021)을 바인딩하고 그 디멘션과 측정값을 **이름으로** 선택합니다. 메트릭을 한 번 정의하면 동일한 dataset을 바인딩하는 모든 차트, 대시보드, 리포트가 일관되게 유지됩니다:
168+
151169
```ts
152170
{
153171
type: 'chart',
154172
chart: {
155-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
156-
xAxisField: 'created_at',
157-
yAxisFields: ['amount'],
158-
aggregation: 'sum',
159-
groupByField: 'status'
173+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
174+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
175+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
176+
values: ['ticket_count'] // dataset measure name(s) — the value axis
160177
}
161178
}
162179
```
163180

164-
Chart 뷰는 단일 오브젝트의 인라인 대시보드를 위한 것입니다 — 더 풍부한
165-
오브젝트 간 분석을 위해서는 전용 reports 표면을 사용하세요.
181+
인라인 `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` 형식은 9.0에서 제거되었습니다 — 모든 차트, 대시보드 위젯, 리포트는 이제 dataset을 바인딩합니다. 더 풍부한 오브젝트 간 분석을 위해서는 전용 reports 표면을 사용하세요.
166182

167183
## Form 뷰 타입
168184

‎content/docs/build/views.mdx‎

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ view: {
6565
| `timeline` | Chronological feed | `timeline: { startDateField, titleField }` |
6666
| `gantt` | Project timeline + dependencies | `gantt: { startDateField, endDateField, titleField }` |
6767
| `map` | Geospatial pins | `map: { locationField }` |
68-
| `chart` | Embedded chart | `chart: { chartType, xAxisField, yAxisFields }` |
68+
| `tree` | Self-referencing hierarchy | `tree: { parentField, labelField }` |
69+
| `chart` | Embedded chart | `chart: { chartType, dataset }` |
6970

7071
### Common list options
7172

@@ -146,23 +147,44 @@ field — same permission rules as a manual edit.
146147
}
147148
```
148149

150+
### Tree
151+
152+
```ts
153+
{
154+
type: 'tree',
155+
tree: {
156+
parentField: 'parent_id', // self-lookup that builds the hierarchy
157+
labelField: 'name', // shown indented in the first column
158+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
159+
}
160+
}
161+
```
162+
163+
For a self-referencing object (categories, BOMs, org units, nested
164+
comments) the tree-grid nests rows by their `parentField` pointer.
165+
149166
### Chart (inline)
150167

168+
A `chart` list view binds a named **dataset** — the semantic analytics layer
169+
(ADR-0021) — and selects its dimensions and measures **by name**. Define a
170+
metric once and every chart, dashboard, and report bound to the same dataset
171+
stays consistent:
172+
151173
```ts
152174
{
153175
type: 'chart',
154176
chart: {
155-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
156-
xAxisField: 'created_at',
157-
yAxisFields: ['amount'],
158-
aggregation: 'sum',
159-
groupByField: 'status'
177+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
178+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
179+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
180+
values: ['ticket_count'] // dataset measure name(s) — the value axis
160181
}
161182
}
162183
```
163184

164-
Chart views are for inline dashboards on a single object — for richer,
165-
cross-object analytics use the dedicated reports surface.
185+
The inline `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` shape
186+
was removed in 9.0 — every chart, dashboard widget, and report now binds a
187+
dataset. For richer, cross-object analytics use the dedicated reports surface.
166188

167189
## Form view types
168190

‎content/docs/build/views.zh-Hans.mdx‎

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ view: {
5959
| `timeline` | 按时间顺序的 feed | `timeline: { dateField, titleField }` |
6060
| `gantt` | 项目时间线 + 依赖 | `gantt: { startDateField, endDateField, titleField }` |
6161
| `map` | 地理 pin | `map: { locationField }` |
62-
| `chart` | 嵌入式图表 | `chart: { chartType, xAxisField, yAxisFields }` |
62+
| `tree` | 自引用层级 | `tree: { parentField, labelField }` |
63+
| `chart` | 嵌入式图表 | `chart: { chartType, dataset }` |
6364

6465
### 通用 list 选项
6566

@@ -141,22 +142,38 @@ view: {
141142
}
142143
```
143144

145+
### Tree
146+
147+
```ts
148+
{
149+
type: 'tree',
150+
tree: {
151+
parentField: 'parent_id', // self-lookup that builds the hierarchy
152+
labelField: 'name', // shown indented in the first column
153+
defaultExpandedDepth: 1 // optional — 0 = roots only, omit = expand all
154+
}
155+
}
156+
```
157+
158+
对于自引用对象(分类、BOM、组织单元、嵌套评论),树形表格会按 `parentField` 指针把行嵌套展示。
159+
144160
### Chart(内联)
145161

162+
`chart` 列表视图绑定一个具名 **dataset**(语义分析层,ADR-0021),并**按名称**选择它的维度和度量。度量只定义一次,绑定同一个 dataset 的每个图表、仪表板和报表都保持一致:
163+
146164
```ts
147165
{
148166
type: 'chart',
149167
chart: {
150-
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
151-
xAxisField: 'created_at',
152-
yAxisFields: ['amount'],
153-
aggregation: 'sum',
154-
groupByField: 'status'
168+
chartType: 'bar', // 'bar' | 'line' | 'pie' | 'area' | 'scatter'
169+
dataset: 'tickets_by_status', // a dataset declared with defineDataset(...)
170+
dimensions: ['status'], // dataset dimension name(s) — X / group / split
171+
values: ['ticket_count'] // dataset measure name(s) — the value axis
155172
}
156173
}
157174
```
158175

159-
完整的报表请用 [Reports](/docs/build/reports) 表面 —— chart 视图用于对象的内联仪表板。
176+
内联的 `xAxisField` / `yAxisFields` / `aggregation` / `groupByField` 形式已在 9.0 中移除 —— 现在每个图表、仪表板小组件和报表都绑定 dataset。完整的跨对象分析请使用专用的 reports 表面。
160177

161178
## Form 视图类型
162179

0 commit comments

Comments
 (0)