@lotics/cli 0.315.7 → 0.315.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/src/cli.js +255 -43
- package/docs/agent_surface.md +1 -0
- package/docs/data_model.md +1 -1
- package/docs/design.md +6 -8
- package/package.json +1 -1
package/dist/src/cli.js
CHANGED
|
@@ -26680,7 +26680,7 @@ var tableLookupFieldSchema = tableFieldBaseSchema.extend({
|
|
|
26680
26680
|
"The type of the target lookup field (e.g. 'text', 'number', 'date'). Resolved from the linked table's field definition at read time."
|
|
26681
26681
|
),
|
|
26682
26682
|
lookup_field_notation: notationSchema.optional().describe(
|
|
26683
|
-
"How the looked-up figure reads, where the target lookup field holds a number
|
|
26683
|
+
"How the looked-up figure reads, where the target lookup field holds a number: as the target reads it, or, where the figure is read in each row's own unit or currency, in the select this table looks up through the same link. Resolved at write time."
|
|
26684
26684
|
),
|
|
26685
26685
|
lookup_field_format: zod_default.string().optional().describe(
|
|
26686
26686
|
"The format of the target lookup field (e.g. 'currency', 'percentage', 'datetime'). Resolved from the linked table's field definition at read time."
|
|
@@ -26828,6 +26828,18 @@ var tableFieldsInputSchema = zod_default.array(
|
|
|
26828
26828
|
tableAutonumberFieldSchema
|
|
26829
26829
|
])
|
|
26830
26830
|
);
|
|
26831
|
+
function lookupRowSelect(lookup, fields, selectKey) {
|
|
26832
|
+
const link = fields.find((field) => field.key === lookup.source_field_key);
|
|
26833
|
+
if (link?.type !== "select_record_link" || link.cardinality !== "one") return void 0;
|
|
26834
|
+
const alias2 = fields.find((field) => field.type === "lookup" && field.source_field_key === link.key && field.lookup_field_key === selectKey);
|
|
26835
|
+
return alias2?.key;
|
|
26836
|
+
}
|
|
26837
|
+
function lookupFigureSelect(lookup, fields, targetFields) {
|
|
26838
|
+
const target = targetFields.find((field) => field.key === lookup.lookup_field_key);
|
|
26839
|
+
const read = target === void 0 ? void 0 : notationRowSelect(fieldNotation(target));
|
|
26840
|
+
const select = read === void 0 ? void 0 : targetFields.find((field) => field.key === read.key);
|
|
26841
|
+
return read === void 0 || select?.type !== "select" || select.multi === true ? void 0 : lookupRowSelect(lookup, fields, read.key);
|
|
26842
|
+
}
|
|
26831
26843
|
var tableFieldCreateBaseSchema = zod_default.object({
|
|
26832
26844
|
name: zod_default.string().describe("Display name"),
|
|
26833
26845
|
description: zod_default.string().describe("Field description"),
|
|
@@ -32680,11 +32692,19 @@ function computedFieldReads(node, fieldsByEntity) {
|
|
|
32680
32692
|
...rollupFilterFieldRefs(field.filter, target)
|
|
32681
32693
|
];
|
|
32682
32694
|
}
|
|
32683
|
-
case "lookup":
|
|
32684
|
-
|
|
32695
|
+
case "lookup": {
|
|
32696
|
+
if (target === void 0) return [];
|
|
32697
|
+
const onTarget = fieldsByEntity.get(target);
|
|
32698
|
+
const readsFigure = onTarget?.get(field.lookup_field_alias)?.type !== "select";
|
|
32699
|
+
const selectLookups = !readsFigure ? [] : node.entity.fields.filter(
|
|
32700
|
+
(sibling) => sibling.type === "lookup" && sibling.source_field_alias === field.source_field_alias && onTarget?.get(sibling.lookup_field_alias)?.type === "select"
|
|
32701
|
+
);
|
|
32702
|
+
return [
|
|
32703
|
+
...selectLookups.map((sibling) => ({ entity_alias: node.entity.alias, field_alias: sibling.alias })),
|
|
32685
32704
|
{ entity_alias: target, field_alias: field.lookup_field_alias },
|
|
32686
32705
|
...field.order_by !== void 0 ? [{ entity_alias: target, field_alias: field.order_by.field_key }] : []
|
|
32687
32706
|
];
|
|
32707
|
+
}
|
|
32688
32708
|
}
|
|
32689
32709
|
}
|
|
32690
32710
|
function orderComputedFields(entities) {
|
|
@@ -33003,7 +33023,23 @@ function contractRollupSelect(entity, link, child, select) {
|
|
|
33003
33023
|
const parentSelect = entity.fields.find((field) => field.alias === lookup.lookup_field_alias);
|
|
33004
33024
|
return parentSelect?.type === "select" && parentSelect.multi !== true ? parentSelect.alias : void 0;
|
|
33005
33025
|
}
|
|
33026
|
+
function contractLookupSelect(entity, link, select, entities) {
|
|
33027
|
+
if (link.cardinality !== "one") return void 0;
|
|
33028
|
+
const held2 = entity.fields.find(
|
|
33029
|
+
(field) => field.type === "lookup" && field.source_field_alias === link.alias && field.lookup_field_alias === select
|
|
33030
|
+
);
|
|
33031
|
+
return held2 !== void 0 && singleSelectOptions(held2, entity, entities) !== void 0 ? held2.alias : void 0;
|
|
33032
|
+
}
|
|
33006
33033
|
function contractFigureSelect(field, entity, entities, hops = 0) {
|
|
33034
|
+
if (field.type === "lookup") {
|
|
33035
|
+
const link2 = entity.fields.find((candidate) => candidate.alias === field.source_field_alias);
|
|
33036
|
+
const target = linkTarget(entity, entities, field.source_field_alias);
|
|
33037
|
+
const shown = target?.fields.find((candidate) => candidate.alias === field.lookup_field_alias);
|
|
33038
|
+
if (hops >= RESULT_HOPS || link2?.type !== "select_record_link" || target === void 0 || shown === void 0) return void 0;
|
|
33039
|
+
const far = contractFigureSelect(shown, target, entities, hops + 1);
|
|
33040
|
+
const alias3 = far === void 0 ? void 0 : contractLookupSelect(entity, link2, far.alias, entities);
|
|
33041
|
+
return far === void 0 || alias3 === void 0 ? void 0 : { vocabulary: far.vocabulary, alias: alias3 };
|
|
33042
|
+
}
|
|
33007
33043
|
if (field.type !== "rollup") return statedFigureSelect(field);
|
|
33008
33044
|
const { operation, field_key } = field.aggregate_option;
|
|
33009
33045
|
if (hops >= RESULT_HOPS || field_key === void 0 || !keepsAggregatedUnit(operation)) return void 0;
|
|
@@ -33046,7 +33082,10 @@ function contractNotation(field, entity, entities, hops = 0) {
|
|
|
33046
33082
|
case "lookup": {
|
|
33047
33083
|
const target = linkTarget(entity, entities, field.source_field_alias);
|
|
33048
33084
|
const source = target?.fields.find((one) => one.alias === field.lookup_field_alias);
|
|
33049
|
-
|
|
33085
|
+
if (target === void 0 || source === void 0) return DECIMAL;
|
|
33086
|
+
const carried = contractNotation(source, target, entities, hops + 1);
|
|
33087
|
+
const select = contractFigureSelect(field, entity, entities);
|
|
33088
|
+
return select === void 0 ? carriedNotation(carried) : perRowNotation({ vocabulary: select.vocabulary, key: select.alias });
|
|
33050
33089
|
}
|
|
33051
33090
|
default:
|
|
33052
33091
|
return DECIMAL;
|
|
@@ -34002,12 +34041,12 @@ function validateContract(contract) {
|
|
|
34002
34041
|
const shownOn = entityByAlias.get(source.target_entity);
|
|
34003
34042
|
const shown = fieldByEntity.get(source.target_entity)?.get(field.lookup_field_alias);
|
|
34004
34043
|
const perRow = shown === void 0 || shownOn === void 0 ? void 0 : contractFigureSelect(shown, shownOn, contract.entities);
|
|
34005
|
-
if (perRow !== void 0) {
|
|
34044
|
+
if (perRow !== void 0 && contractLookupSelect(entity, source, perRow.alias, contract.entities) === void 0) {
|
|
34006
34045
|
errors.push({
|
|
34007
34046
|
severity: "error",
|
|
34008
34047
|
rule: "field.lookup",
|
|
34009
34048
|
path: `${fieldPath}.lookup_field_alias`,
|
|
34010
|
-
message: `"${field.lookup_field_alias}" on "${source.target_entity}" is read in each row's own ${perRow.vocabulary} ("${perRow.alias}"
|
|
34049
|
+
message: `"${field.lookup_field_alias}" on "${source.target_entity}" is read in each row's own ${perRow.vocabulary} ("${perRow.alias}" on "${source.target_entity}") \u2014 a lookup of it stands where this entity also looks up "${perRow.alias}" through the same one-row link "${source.alias}"`
|
|
34011
34050
|
});
|
|
34012
34051
|
}
|
|
34013
34052
|
if (field.order_by !== void 0 && !fieldsOnEntity(source.target_entity).has(field.order_by.field_key)) {
|
|
@@ -34169,13 +34208,13 @@ function fieldValueInfo(field) {
|
|
|
34169
34208
|
return { type: field.type };
|
|
34170
34209
|
}
|
|
34171
34210
|
}
|
|
34172
|
-
function withLookupMetadata(lookup, info) {
|
|
34173
|
-
const notation = info.notation === void 0 ? void 0 : carriedNotation(info.notation);
|
|
34174
|
-
const keys2 = notation === void 0 ? void 0 : keysOfNotation(notation);
|
|
34211
|
+
function withLookupMetadata(lookup, info, rowSelect) {
|
|
34212
|
+
const notation = info.notation === void 0 ? void 0 : rowSelect === void 0 ? carriedNotation(info.notation) : perRowNotation(rowSelect);
|
|
34213
|
+
const keys2 = notation === void 0 || rowSelect !== void 0 ? void 0 : keysOfNotation(notation);
|
|
34175
34214
|
const metadata = {
|
|
34176
34215
|
lookup_field_type: info.type,
|
|
34177
34216
|
lookup_field_notation: notation,
|
|
34178
|
-
lookup_field_format: keys2?.format ?? info.format,
|
|
34217
|
+
lookup_field_format: rowSelect !== void 0 ? void 0 : keys2?.format ?? info.format,
|
|
34179
34218
|
lookup_field_currency: keys2?.currency,
|
|
34180
34219
|
lookup_field_unit: keys2?.unit,
|
|
34181
34220
|
lookup_field_options: info.options,
|
|
@@ -34509,9 +34548,10 @@ function withReadValues(tables) {
|
|
|
34509
34548
|
for (let pass = 0; pass < SURFACE_HOPS; pass++) {
|
|
34510
34549
|
const byKey = new Map(current.flat().map((field) => [field.key, field]));
|
|
34511
34550
|
let changed = false;
|
|
34551
|
+
const before = current;
|
|
34512
34552
|
current = current.map(
|
|
34513
34553
|
(fields) => fields.map((field) => {
|
|
34514
|
-
const read = withReadValue(field, byKey);
|
|
34554
|
+
const read = withReadValue(field, byKey, fields, before);
|
|
34515
34555
|
if (read !== field) changed = true;
|
|
34516
34556
|
return read;
|
|
34517
34557
|
})
|
|
@@ -34520,14 +34560,20 @@ function withReadValues(tables) {
|
|
|
34520
34560
|
}
|
|
34521
34561
|
return current;
|
|
34522
34562
|
}
|
|
34563
|
+
function settledLookup(lookup, target, own2, tables) {
|
|
34564
|
+
const read = figureRowSelect(target);
|
|
34565
|
+
const shownOn = tables.find((fields) => fields.some((candidate) => candidate.key === target.key));
|
|
34566
|
+
const select = read === void 0 || shownOn === void 0 ? void 0 : lookupFigureSelect(lookup, own2, shownOn);
|
|
34567
|
+
return withLookupMetadata(lookup, fieldValueInfo(target), read === void 0 || select === void 0 ? void 0 : { vocabulary: read.vocabulary, key: select });
|
|
34568
|
+
}
|
|
34523
34569
|
function awaitsRead(field) {
|
|
34524
34570
|
return field.type === "lookup" && field.lookup_field_type === void 0 || field.type === "rollup" && field.aggregate_field_type === void 0;
|
|
34525
34571
|
}
|
|
34526
|
-
function withReadValue(field, byKey) {
|
|
34572
|
+
function withReadValue(field, byKey, own2, tables) {
|
|
34527
34573
|
if (!awaitsRead(field)) return field;
|
|
34528
34574
|
if (field.type === "lookup") {
|
|
34529
34575
|
const target2 = byKey.get(field.lookup_field_key);
|
|
34530
|
-
return target2 === void 0 || awaitsRead(target2) ? field :
|
|
34576
|
+
return target2 === void 0 || awaitsRead(target2) ? field : settledLookup(field, target2, own2, tables);
|
|
34531
34577
|
}
|
|
34532
34578
|
if (field.type !== "rollup") return field;
|
|
34533
34579
|
const { operation, field_key } = field.aggregate_option;
|
|
@@ -34671,9 +34717,11 @@ function syntheticField(entity, field, binding) {
|
|
|
34671
34717
|
}
|
|
34672
34718
|
case "lookup": {
|
|
34673
34719
|
const target = requireTarget(binding, entity, field.source_field_alias, at2);
|
|
34720
|
+
const rowSelect = perRowSelect(binding, entity, field, at2);
|
|
34674
34721
|
return {
|
|
34675
34722
|
...base,
|
|
34676
34723
|
type: "lookup",
|
|
34724
|
+
...rowSelect === void 0 ? {} : { lookup_field_notation: perRowNotation(rowSelect) },
|
|
34677
34725
|
source_field_key: requireField(binding, entity.alias, field.source_field_alias, at2),
|
|
34678
34726
|
lookup_field_key: requireField(binding, target.alias, field.lookup_field_alias, at2),
|
|
34679
34727
|
...field.order_by !== void 0 && {
|
|
@@ -34913,7 +34961,7 @@ var MODEL_RULES = {
|
|
|
34913
34961
|
sentence: "A rollup aggregates, through a link of its entity, a field of the linked entity by an operation a model declares and that field's type takes \u2014 never a figure read in each row's own unit or currency \u2014 filtered on fields of the linked entity."
|
|
34914
34962
|
},
|
|
34915
34963
|
"field.lookup": {
|
|
34916
|
-
sentence: "A lookup reads, through a link of its entity, a field of the linked entity \u2014
|
|
34964
|
+
sentence: "A lookup reads, through a link of its entity, a field of the linked entity \u2014 a figure read in each row's own unit or currency only where this entity looks up that row's select through the same one-row link \u2014 ordered by a field of it."
|
|
34917
34965
|
},
|
|
34918
34966
|
"field.computed-cycle": { sentence: "Computed fields never wait on each other in a loop: each is computed after what it reads." },
|
|
34919
34967
|
// ─── Views ───────────────────────────────────────────────────────────────────
|
|
@@ -35044,7 +35092,7 @@ var MODEL_RULES = {
|
|
|
35044
35092
|
sentence: `A register app's \`logs\` \u2014 at most ${APP_LOGS_MAX} \u2014 each list another entity under an alias of its own: never the app's own entity, one of its \`books\`' or another log's. A log is one list \u2014 a table or cards, with no \`tabs\`, no \`book\` column and no composed record \u2014 over an entity whose status states no owned \`stages\`, and stands in an app that states no \`scope\`. An act's alias is its own among the app's acts and its logs'. No record of the app or of a log lists the rows of an entity another of the app's lists is over: a link to one opens it on its own list. A list people work as a desk of its own is another app.`
|
|
35045
35093
|
},
|
|
35046
35094
|
"app.rates-in-passing": {
|
|
35047
|
-
sentence: "An app with no act of its own whose rows another app's lines copy a number off (`default_from` through a link) \u2014 the rates a quote is priced from \u2014 is worked only while that record is written: a block, a section or an act of that app, never an app of its own.",
|
|
35095
|
+
sentence: "An app with no act, log or tabs of its own whose rows another app's lines copy a number off (`default_from` through a link) \u2014 the rates a quote is priced from \u2014 is worked only while that record is written: a block, a section or an act of that app, never an app of its own.",
|
|
35048
35096
|
note: true
|
|
35049
35097
|
},
|
|
35050
35098
|
"app.row": { sentence: "An app's `row` states only what differs from `records`: a line that is not the title, a number for its figure, dates for its deadlines, a files picture no act makes documents into, or `false` for a figure, deadlines or picture the entity states and the app draws none of." },
|
|
@@ -35093,7 +35141,10 @@ var MODEL_RULES = {
|
|
|
35093
35141
|
"register.search": { sentence: "`search` names text, a code, or a link \u2014 matched by its row's title." },
|
|
35094
35142
|
"register.sort": { sentence: "Each `sort` key names a field of the register's rows that holds an order \u2014 never files \u2014 and no field twice." },
|
|
35095
35143
|
"register.tabs": {
|
|
35096
|
-
sentence: "A register's `tabs` each name a tab of their own, never a key a report already holds; a tab
|
|
35144
|
+
sentence: "A register's `tabs` each name a tab of their own, never a key a report already holds; a tab states one of `in` and `open` (dates of its rows, `open`'s two different) or `totals` (a child's rows windowed by the period); its `where` and `sort` hold as the register's do, and never narrow by the status, which its chips split. Only a table or cards reads tabs, and a band reading's `tab` names one of them."
|
|
35145
|
+
},
|
|
35146
|
+
"register.tab-totals": {
|
|
35147
|
+
sentence: "A tab's `totals` name a child linked to the register's entity by a one-row link (`via` where it has several), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column's `value` is a number of the child, its `where` holds over the child's selects and yes/nos, and a value read in each row's own unit or currency stands only where that select of the child looks up, through `via`, a single select of the register's entity. Only a table register stating no `books` has them, and no tab states `totals` beside `in` or `open`."
|
|
35097
35148
|
},
|
|
35098
35149
|
"register.group": {
|
|
35099
35150
|
sentence: "`group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 never the status (its chips); only a table groups, and a gantt into its lanes; grouping by the title needs a subtitle to lead each row."
|
|
@@ -35170,7 +35221,7 @@ var MODEL_RULES = {
|
|
|
35170
35221
|
"reading.period": { sentence: "A dashboard's `period` is the one it opens on, and its period stands only over a reading placed in time by `over`." },
|
|
35171
35222
|
// ─── The record ──────────────────────────────────────────────────────────────
|
|
35172
35223
|
"record.placed-once": {
|
|
35173
|
-
sentence: "A field, a block and an act each stand once on a record: the header draws the title, subtitle, image, status (or milestones), figure and folder, and a field's one other place is a section's `fields`, a files, text or statement block \u2014 save the image, which one files block may draw again, whole, the figure, which a statement draws as what it comes to, and rows one list prices and another compares (`compare`); two places whose `when`s never hold together (a select at options the other's lacks) each draw it."
|
|
35224
|
+
sentence: "A field, a block and an act each stand once on a record: the header draws the title, subtitle, image, status (or milestones), figure and folder, and a field's one other place is a section's `fields`, a files, text or statement block \u2014 save the image, which one files block may draw again, whole, the figure, which a statement draws as what it comes to, and rows one list prices and another compares (`compare`); two places whose `when`s never hold together (a select at options the other's lacks) each draw it, and a plain rows block (no `expect`, `only`, `of`, `under`, `pick`, `post`, `checklist` or `compare`) likewise."
|
|
35174
35225
|
},
|
|
35175
35226
|
"record.foot-total": {
|
|
35176
35227
|
sentence: "A rows block's foot totals the child's figure and each summed column over the rows it lists; the record's rollup summing that field over those rows (the same `where`) is that foot, never also one of a section's `fields`."
|
|
@@ -35435,20 +35486,19 @@ function settledTables(entities) {
|
|
|
35435
35486
|
const fields = t === void 0 ? void 0 : tables[t];
|
|
35436
35487
|
const field = fields?.[f];
|
|
35437
35488
|
if (t === void 0 || fields === void 0 || field === void 0) continue;
|
|
35438
|
-
const settled2 = settledField(field, fields, tables
|
|
35489
|
+
const settled2 = settledField(field, fields, tables);
|
|
35439
35490
|
tables = tables.map((one, index) => index === t ? one.map((candidate, position) => position === f ? settled2 : candidate) : one);
|
|
35440
35491
|
}
|
|
35441
35492
|
return tables;
|
|
35442
35493
|
}
|
|
35443
|
-
function settledField(field, own2,
|
|
35494
|
+
function settledField(field, own2, tables) {
|
|
35444
35495
|
if (field.type === "formula") {
|
|
35445
35496
|
const others = own2.filter((other) => other.key !== field.key);
|
|
35446
35497
|
return { ...field, formula: { ...field.formula, output_type: formulaOutputType2(field.formula, others) } };
|
|
35447
35498
|
}
|
|
35448
35499
|
if (field.type === "lookup") {
|
|
35449
|
-
const target =
|
|
35450
|
-
|
|
35451
|
-
return withLookupMetadata(field, fieldValueInfo(target));
|
|
35500
|
+
const target = tables.flat().find((candidate) => candidate.key === field.lookup_field_key);
|
|
35501
|
+
return target === void 0 ? field : settledLookup(field, target, own2, tables);
|
|
35452
35502
|
}
|
|
35453
35503
|
return field;
|
|
35454
35504
|
}
|
|
@@ -35507,7 +35557,7 @@ function computedTypeFindings(entities) {
|
|
|
35507
35557
|
}
|
|
35508
35558
|
|
|
35509
35559
|
// ../shared/src/schemas/app_spec_version.ts
|
|
35510
|
-
var APP_SPEC_VERSION =
|
|
35560
|
+
var APP_SPEC_VERSION = 24;
|
|
35511
35561
|
|
|
35512
35562
|
// ../shared/src/schemas/app_compose.ts
|
|
35513
35563
|
var fieldAlias = contractAliasSchema.describe("A field alias of the record's entity");
|
|
@@ -36007,6 +36057,18 @@ var registerPeriodSchema = zod_default.union([zod_default.enum(REGISTER_PERIODS)
|
|
|
36007
36057
|
var dashboardPeriodDaysSchema = zod_default.object({ days: zod_default.literal(DASHBOARD_PERIOD_DAYS).describe(`The last ${DASHBOARD_PERIOD_DAYS} days through today \u2014 the one span of days a dashboard opens on`) }).strict();
|
|
36008
36058
|
var dashboardPeriodSchema = zod_default.union([zod_default.enum(DASHBOARD_PERIODS), dashboardPeriodDaysSchema]);
|
|
36009
36059
|
var specSortSchema = zod_default.array(zod_default.object({ field: specColumnAliasSchema, desc: zod_default.literal(true).optional() }).strict()).min(1);
|
|
36060
|
+
var specTabTotalsSchema = zod_default.object({
|
|
36061
|
+
via: zod_default.string().min(1),
|
|
36062
|
+
read: zod_default.object({ query: zod_default.string().min(1) }).strict(),
|
|
36063
|
+
columns: zod_default.array(
|
|
36064
|
+
zod_default.object({
|
|
36065
|
+
alias: contractAliasSchema,
|
|
36066
|
+
label: zod_default.string().min(1),
|
|
36067
|
+
/** How the column's figure reads; absent for a count. */
|
|
36068
|
+
notation: notationSchemaOf(specColumnAliasSchema).optional()
|
|
36069
|
+
}).strict()
|
|
36070
|
+
).min(1)
|
|
36071
|
+
}).strict();
|
|
36010
36072
|
var specTabSchema = zod_default.object({
|
|
36011
36073
|
tab: contractAliasSchema,
|
|
36012
36074
|
label: zod_default.string().min(1),
|
|
@@ -36014,6 +36076,7 @@ var specTabSchema = zod_default.object({
|
|
|
36014
36076
|
zod_default.object({ kind: zod_default.literal("in"), field: specColumnAliasSchema }).strict(),
|
|
36015
36077
|
zod_default.object({ kind: zod_default.literal("open"), from: specColumnAliasSchema, to: specColumnAliasSchema }).strict()
|
|
36016
36078
|
]).optional(),
|
|
36079
|
+
totals: specTabTotalsSchema.optional(),
|
|
36017
36080
|
where: specNarrowingSchema.optional(),
|
|
36018
36081
|
sort: specSortSchema.optional()
|
|
36019
36082
|
}).strict();
|
|
@@ -37497,6 +37560,21 @@ function registerSortKeys(sort) {
|
|
|
37497
37560
|
}
|
|
37498
37561
|
var REGISTER_TABS_MAX = 5;
|
|
37499
37562
|
var sortSchema = zod_default.union([sortKeySchema, zod_default.array(sortKeySchema).min(1)]);
|
|
37563
|
+
var TOTALS_WINDOWS = ["before", "in", "through"];
|
|
37564
|
+
var REGISTER_TOTALS_COLUMNS_MAX = 6;
|
|
37565
|
+
var registerTabTotalsColumnSchema = zod_default.object({
|
|
37566
|
+
alias: alias.describe("The column's name: its address in the totals read"),
|
|
37567
|
+
label: zod_default.string().min(1).describe("What the column holds, in the reader's words"),
|
|
37568
|
+
value: fieldAlias2.optional().describe("A number of the child (stored, a formula or a rollup) summed over the rows; absent, the rows are counted. A figure read in each row's own unit or currency stands only where the child's select is a lookup, through `via`, of a single select of the register's entity"),
|
|
37569
|
+
where: conditionsHold("Only the child's rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed").optional(),
|
|
37570
|
+
window: zod_default.enum(TOTALS_WINDOWS).describe("Which of the child's rows, by `on`, the column adds: `before` those dated before the period's first day, `in` those from its first day through its last, `through` those on or before its last day")
|
|
37571
|
+
}).strict();
|
|
37572
|
+
var registerTabTotalsSchema = zod_default.object({
|
|
37573
|
+
rows: alias.describe("An entity of this model whose rows each belong to one row of the register's entity: the rows the columns add"),
|
|
37574
|
+
via: fieldAlias2.optional().describe("The child's one-row link to the register's entity, where it has more than one; absent, its only one"),
|
|
37575
|
+
on: fieldAlias2.describe("A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days"),
|
|
37576
|
+
columns: zod_default.array(registerTabTotalsColumnSchema).min(1).max(REGISTER_TOTALS_COLUMNS_MAX).describe("The figures drawn in place of the register's columns after each row's name, each under its own alias and label")
|
|
37577
|
+
}).strict();
|
|
37500
37578
|
var registerTabSchema = zod_default.object({
|
|
37501
37579
|
tab: alias.describe("The tab's name: its address, and the key its rows stand under in a report"),
|
|
37502
37580
|
label: zod_default.string().min(1).describe("What the tab holds, in the reader's words"),
|
|
@@ -37505,9 +37583,10 @@ var registerTabSchema = zod_default.object({
|
|
|
37505
37583
|
from: fieldAlias2.describe("The date a row begins on (stored, or a formula)"),
|
|
37506
37584
|
to: fieldAlias2.describe("The date a row ends on (stored, or a formula), empty while it is open")
|
|
37507
37585
|
}).strict().optional().describe("The tab holds the rows open at the period's end: begun before it, and not ended by then \u2014 what is in stock, out on hire or still owed at that moment"),
|
|
37586
|
+
totals: registerTabTotalsSchema.optional().describe("The tab lists every row the register lists; in place of the register's columns, each column draws one figure added over the child's rows that belong to the row, windowed by the period"),
|
|
37508
37587
|
where: narrowingHolds('Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`"me"`) \u2014 every entry ANDed').optional(),
|
|
37509
37588
|
sort: sortSchema.optional().describe("The order this tab's rows read in, as the register's `sort`; absent, the register's")
|
|
37510
|
-
}).strict().refine((tab) => tab.in
|
|
37589
|
+
}).strict().refine((tab) => [tab.in, tab.open, tab.totals].filter((one) => one !== void 0).length <= 1, { error: "a tab holds the rows dated `in` the period, those `open` at its end, or their `totals` \u2014 state one" });
|
|
37511
37590
|
var registerGanttSchema = zod_default.object({
|
|
37512
37591
|
start: fieldAlias2.describe("A date of this entity each row's bar starts at (a sailing, a hire's start, a task's start)"),
|
|
37513
37592
|
end: fieldAlias2.optional().describe("The date each row's bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity's first `due`"),
|
|
@@ -39585,6 +39664,120 @@ function checkExportTemplate(model, entity, tabs, template, path18) {
|
|
|
39585
39664
|
];
|
|
39586
39665
|
}
|
|
39587
39666
|
|
|
39667
|
+
// ../shared/src/schemas/app_model_totals.ts
|
|
39668
|
+
function totalsUnit(entities, register, child, via, value) {
|
|
39669
|
+
const field = fieldOf(child, value);
|
|
39670
|
+
const read = field === void 0 ? void 0 : contractFigureSelect(field, child, entities);
|
|
39671
|
+
if (read === void 0) return void 0;
|
|
39672
|
+
const select = fieldOf(child, read.alias);
|
|
39673
|
+
if (select?.type !== "lookup" || select.source_field_alias !== via) {
|
|
39674
|
+
return { refused: `"${value}" is read in the ${read.vocabulary} of "${read.alias}", which is no lookup through "${via}" \u2014 a figure is summed over one register row's rows only in that row's own ${read.vocabulary}` };
|
|
39675
|
+
}
|
|
39676
|
+
const held2 = fieldOf(register, select.lookup_field_alias);
|
|
39677
|
+
if (held2 === void 0 || !isSingleSelect(held2)) {
|
|
39678
|
+
return { refused: `"${value}" is read in the ${read.vocabulary} of "${read.alias}", which looks up "${select.lookup_field_alias}" \u2014 not a single select of "${register.alias}"` };
|
|
39679
|
+
}
|
|
39680
|
+
return { vocabulary: read.vocabulary, select: held2.alias };
|
|
39681
|
+
}
|
|
39682
|
+
function resolveTabTotals(model, register, totals) {
|
|
39683
|
+
const child = entityOf(model, totals.rows) ?? fail2(`resolveModelApp: totals read "${totals.rows}", which is not an entity \u2014 validate it first`);
|
|
39684
|
+
const link = childLink(child, register.alias, totals.via);
|
|
39685
|
+
if ("refused" in link) fail2(`resolveModelApp: totals of "${register.alias}" ${link.refused} \u2014 validate it first`);
|
|
39686
|
+
return {
|
|
39687
|
+
rows: child.alias,
|
|
39688
|
+
via: link.link,
|
|
39689
|
+
on: totals.on,
|
|
39690
|
+
columns: totals.columns.map((column) => {
|
|
39691
|
+
const unit = column.value === void 0 ? void 0 : totalsUnit(model.entities, register, child, link.link, column.value);
|
|
39692
|
+
if (unit !== void 0 && "refused" in unit) fail2(`resolveModelApp: totals column "${column.alias}" ${unit.refused} \u2014 validate it first`);
|
|
39693
|
+
return {
|
|
39694
|
+
alias: column.alias,
|
|
39695
|
+
label: column.label,
|
|
39696
|
+
...column.value === void 0 ? {} : { value: column.value },
|
|
39697
|
+
where: whenConditions(column.where),
|
|
39698
|
+
window: column.window,
|
|
39699
|
+
...unit === void 0 ? {} : { unit: unit.select }
|
|
39700
|
+
};
|
|
39701
|
+
})
|
|
39702
|
+
};
|
|
39703
|
+
}
|
|
39704
|
+
|
|
39705
|
+
// ../shared/src/schemas/app_model_validate_totals.ts
|
|
39706
|
+
var DATE_HOPS = 8;
|
|
39707
|
+
function dateRefusal(model, entity, name) {
|
|
39708
|
+
const field = fieldOf(entity, name);
|
|
39709
|
+
if (field === void 0) return `names "${name}", which is not a field of "${entity.alias}"`;
|
|
39710
|
+
const type = resolvedFieldType(field, entity, model.entities) ?? field.type;
|
|
39711
|
+
if (type !== "date") return `"${name}" is a ${type} field \u2014 a day places each row in time`;
|
|
39712
|
+
if (holdsMoment(field, entity, model.entities)) return `"${name}" holds a moment \u2014 a totals tab places a child row by a day: name a date field, not a moment`;
|
|
39713
|
+
let held2 = field;
|
|
39714
|
+
let owner = entity;
|
|
39715
|
+
for (let hop = 0; held2.type === "lookup" && hop < DATE_HOPS; hop += 1) {
|
|
39716
|
+
const link = fieldOf(owner, held2.source_field_alias);
|
|
39717
|
+
if (link !== void 0 && fieldHoldsSeveral(link)) return `"${name}" looks up a date through "${link.alias}", a link to several rows \u2014 a row is placed by one day`;
|
|
39718
|
+
const target = linkTarget(owner, model.entities, held2.source_field_alias);
|
|
39719
|
+
const next = target === void 0 ? void 0 : fieldOf(target, held2.lookup_field_alias);
|
|
39720
|
+
if (target === void 0 || next === void 0) return void 0;
|
|
39721
|
+
held2 = next;
|
|
39722
|
+
owner = target;
|
|
39723
|
+
}
|
|
39724
|
+
return held2.type === "date" && isRangeDateFormat(held2.format) ? `"${name}" holds a span of days \u2014 no window compares a span with one day` : void 0;
|
|
39725
|
+
}
|
|
39726
|
+
function checkLink(register, child, totals, at2, refuse) {
|
|
39727
|
+
const found = childLink(child, register.alias, totals.via, "totals add the rows that belong to one row of the register");
|
|
39728
|
+
if ("refused" in found) {
|
|
39729
|
+
refuse(totals.via === void 0 ? `${at2}.rows` : `${at2}.via`, found.refused);
|
|
39730
|
+
return void 0;
|
|
39731
|
+
}
|
|
39732
|
+
const link = fieldOf(child, found.link);
|
|
39733
|
+
if (link !== void 0 && fieldHoldsSeveral(link)) refuse(`${at2}.via`, `names "${link.alias}", a link to several rows \u2014 each row belongs to one row of "${register.alias}"`);
|
|
39734
|
+
return found.link;
|
|
39735
|
+
}
|
|
39736
|
+
function checkColumn(model, register, child, via, column, index, names, at2, refuse) {
|
|
39737
|
+
const where = `${at2}.columns.${index}`;
|
|
39738
|
+
const sameAlias = names.aliases.get(column.alias);
|
|
39739
|
+
if (sameAlias !== void 0) refuse(`${where}.alias`, `"${column.alias}" is column ${sameAlias} already \u2014 each column has an alias of its own`);
|
|
39740
|
+
else if (column.alias === via) refuse(`${where}.alias`, `"${column.alias}" is the link the totals are read by \u2014 name the column otherwise`);
|
|
39741
|
+
else names.aliases.set(column.alias, index);
|
|
39742
|
+
const sameLabel2 = names.labels.get(column.label);
|
|
39743
|
+
if (sameLabel2 !== void 0) refuse(`${where}.label`, `"${column.label}" is column ${sameLabel2}'s label already \u2014 each column has a label of its own`);
|
|
39744
|
+
else names.labels.set(column.label, index);
|
|
39745
|
+
if (column.value !== void 0) {
|
|
39746
|
+
const value = fieldOf(child, column.value);
|
|
39747
|
+
const type = value === void 0 ? void 0 : resolvedFieldType(value, child, model.entities) ?? value.type;
|
|
39748
|
+
if (value === void 0) refuse(`${where}.value`, `names "${column.value}", which is not a field of "${child.alias}"`);
|
|
39749
|
+
else if (type !== "number") refuse(`${where}.value`, `"${column.value}" is a ${type} field \u2014 a column sums a number of "${child.alias}"; leave \`value\` out to count the rows`);
|
|
39750
|
+
else if (via !== void 0) {
|
|
39751
|
+
const unit = totalsUnit(model.entities, register, child, via, column.value);
|
|
39752
|
+
if (unit !== void 0 && "refused" in unit) refuse(`${where}.value`, unit.refused);
|
|
39753
|
+
}
|
|
39754
|
+
}
|
|
39755
|
+
return checkWhen(model.entities, child, column.where, `${where}.where`, "offer");
|
|
39756
|
+
}
|
|
39757
|
+
function checkTabTotals(model, app, register, tab, path18) {
|
|
39758
|
+
const totals = tab.totals;
|
|
39759
|
+
if (totals === void 0) return [];
|
|
39760
|
+
const at2 = `${path18}.totals`;
|
|
39761
|
+
const findings = [];
|
|
39762
|
+
const refuse = (where, message2) => {
|
|
39763
|
+
findings.push(error51("register.tab-totals", where, message2));
|
|
39764
|
+
};
|
|
39765
|
+
const layout = app.register?.layout ?? "table";
|
|
39766
|
+
if (layout !== "table") refuse(at2, `stands on a ${layout} \u2014 totals are drawn in a table's rows`);
|
|
39767
|
+
if ((app.books ?? []).length > 0) refuse(at2, "stands in an app with `books`, whose list reads several tables \u2014 totals add the child rows of one entity's rows");
|
|
39768
|
+
const child = entityOf(model, totals.rows);
|
|
39769
|
+
if (child === void 0) {
|
|
39770
|
+
refuse(`${at2}.rows`, `reads "${totals.rows}", which this model does not declare`);
|
|
39771
|
+
return findings;
|
|
39772
|
+
}
|
|
39773
|
+
const via = checkLink(register, child, totals, at2, refuse);
|
|
39774
|
+
const dated = dateRefusal(model, child, totals.on);
|
|
39775
|
+
if (dated !== void 0) refuse(`${at2}.on`, dated);
|
|
39776
|
+
const names = { aliases: /* @__PURE__ */ new Map(), labels: /* @__PURE__ */ new Map() };
|
|
39777
|
+
for (const [index, column] of totals.columns.entries()) findings.push(...checkColumn(model, register, child, via, column, index, names, at2, refuse));
|
|
39778
|
+
return findings;
|
|
39779
|
+
}
|
|
39780
|
+
|
|
39588
39781
|
// ../shared/src/schemas/app_model_resolved.ts
|
|
39589
39782
|
function blockOwnFields(block) {
|
|
39590
39783
|
switch (block.kind) {
|
|
@@ -39866,6 +40059,7 @@ function appWritePlan(given, app) {
|
|
|
39866
40059
|
remove: true
|
|
39867
40060
|
});
|
|
39868
40061
|
}
|
|
40062
|
+
const adding = resolvedBlocks(app.record).flatMap((one) => one.kind === "rows" || one.kind === "agenda" ? [one] : []);
|
|
39869
40063
|
for (const block of resolvedBlocks(app.record)) {
|
|
39870
40064
|
if (block.kind !== "rows" && block.kind !== "agenda" && block.kind !== "timeline") continue;
|
|
39871
40065
|
const under = block.kind === "rows" ? block.under : void 0;
|
|
@@ -39884,7 +40078,8 @@ function appWritePlan(given, app) {
|
|
|
39884
40078
|
}
|
|
39885
40079
|
const update = saved(child, [block.via, ...under === void 0 ? [] : [under.field]]);
|
|
39886
40080
|
if (block.kind === "rows" || block.kind === "agenda") {
|
|
39887
|
-
|
|
40081
|
+
const asked2 = unique2(adding.filter((one) => one.entity === block.entity && one.via === block.via).flatMap((one) => one.create ?? []));
|
|
40082
|
+
plan.set(child.alias, { ...asked2.length === 0 ? {} : { create: added(child.alias, asked2), parent: block.via }, stamps: [], update, remove: removes });
|
|
39888
40083
|
continue;
|
|
39889
40084
|
}
|
|
39890
40085
|
const asked = new Set(block.create ?? []);
|
|
@@ -39994,6 +40189,11 @@ function appDrawnFields(given, app) {
|
|
|
39994
40189
|
for (const reading of [...app.register.readings, ...resolvedBlocks(app.record).flatMap((block) => block.kind === "reading" ? [block.reading] : [])]) {
|
|
39995
40190
|
if (reading.kind === "progress" && reading.measured !== void 0) add(reading.measured.entity, [reading.measured.via, reading.measured.on, reading.measured.share]);
|
|
39996
40191
|
}
|
|
40192
|
+
for (const tab of app.register.tabs) {
|
|
40193
|
+
const totals = tab.totals;
|
|
40194
|
+
if (totals === void 0) continue;
|
|
40195
|
+
add(totals.rows, [totals.via, totals.on, ...totals.columns.flatMap((column) => [...column.value === void 0 ? [] : [column.value], ...column.where.map((one) => one.field)])]);
|
|
40196
|
+
}
|
|
39997
40197
|
if (app.register.plan !== void 0) add(app.register.plan.place.entity, placeFields(app.register.plan.place));
|
|
39998
40198
|
const lanes = app.register.lanes;
|
|
39999
40199
|
if (lanes?.loads !== void 0) add(lanes.entity, lanes.loads.map((load) => load.against));
|
|
@@ -40140,6 +40340,8 @@ function ownFields(app, record2) {
|
|
|
40140
40340
|
// A tab narrows, bounds and orders the rows by columns the read returns.
|
|
40141
40341
|
...app.register.tabs.flatMap((tab) => [
|
|
40142
40342
|
...tab.term === void 0 ? [] : tab.term.kind === "in" ? [tab.term.field] : [tab.term.from, tab.term.to],
|
|
40343
|
+
// A totals column read in each row's own unit is drawn with the select holding it.
|
|
40344
|
+
...(tab.totals?.columns ?? []).flatMap((column) => column.unit === void 0 ? [] : [column.unit]),
|
|
40143
40345
|
...tab.where.map((one) => one.field),
|
|
40144
40346
|
...(tab.sort ?? []).map((key) => key.field)
|
|
40145
40347
|
]),
|
|
@@ -40458,6 +40660,9 @@ function movesQueryAlias(entity) {
|
|
|
40458
40660
|
function tabQueryAlias(entity, tab) {
|
|
40459
40661
|
return `${listQueryAlias(entity)}_${tab}`;
|
|
40460
40662
|
}
|
|
40663
|
+
function tabTotalsQueryAlias(entity, tab) {
|
|
40664
|
+
return `${entity}_totals_${tab}`;
|
|
40665
|
+
}
|
|
40461
40666
|
var REVIEW_ALIASES = {
|
|
40462
40667
|
activity: "record_activity",
|
|
40463
40668
|
activityUndo: "record_activity_undo"
|
|
@@ -40986,11 +41191,12 @@ function checkQueries(model, app, at2) {
|
|
|
40986
41191
|
}
|
|
40987
41192
|
if (!isDashboardApp(app)) {
|
|
40988
41193
|
for (const [index, tab] of (app.register?.tabs ?? []).entries()) {
|
|
40989
|
-
const name = tabQueryAlias(app.entity, tab.tab);
|
|
40990
41194
|
const path18 = `${at2}.register.tabs.${index}.tab`;
|
|
40991
|
-
const
|
|
40992
|
-
|
|
40993
|
-
|
|
41195
|
+
for (const name of [tabQueryAlias(app.entity, tab.tab), ...tab.totals === void 0 ? [] : [tabTotalsQueryAlias(app.entity, tab.tab)]]) {
|
|
41196
|
+
const held2 = taken.get(name);
|
|
41197
|
+
if (held2 !== void 0) findings.push(error51("app.generated-name", path18, `is read as "${name}", already the name of ${held2} \u2014 rename the tab, or what takes its read's name`));
|
|
41198
|
+
else findings.push(...generated(name, path18, "is read as"));
|
|
41199
|
+
}
|
|
40994
41200
|
}
|
|
40995
41201
|
}
|
|
40996
41202
|
for (const [alias2, workflow] of Object.entries(app.workflows ?? {})) {
|
|
@@ -42242,7 +42448,7 @@ function noteBoxSize(model, app) {
|
|
|
42242
42448
|
return [];
|
|
42243
42449
|
}
|
|
42244
42450
|
function noteRatesInPassing(model, app) {
|
|
42245
|
-
if ((app.acts ?? []).length > 0) return [];
|
|
42451
|
+
if ((app.acts ?? []).length > 0 || (app.logs ?? []).length > 0 || (app.register?.tabs ?? []).length > 0) return [];
|
|
42246
42452
|
const pricers = registerApps(model).flatMap((other) => {
|
|
42247
42453
|
if (other.alias === app.alias) return [];
|
|
42248
42454
|
const copy = recordBlocks(other.record).flatMap((block) => {
|
|
@@ -42561,7 +42767,7 @@ function resolveModelApp(given, written) {
|
|
|
42561
42767
|
tabs: (app.register?.tabs ?? []).map((tab) => {
|
|
42562
42768
|
const keys2 = statedSort(tab.sort);
|
|
42563
42769
|
const term = tab.in !== void 0 ? { kind: "in", field: tab.in } : tab.open === void 0 ? void 0 : { kind: "open", ...tab.open };
|
|
42564
|
-
return { tab: tab.tab, label: tab.label, ...term === void 0 ? {} : { term }, where: narrowingConditions(tab.where), ...keys2 === void 0 ? {} : { sort: keys2 } };
|
|
42770
|
+
return { tab: tab.tab, label: tab.label, ...term === void 0 ? {} : { term }, ...tab.totals === void 0 ? {} : { totals: resolveTabTotals(model, entity, tab.totals) }, where: narrowingConditions(tab.where), ...keys2 === void 0 ? {} : { sort: keys2 } };
|
|
42565
42771
|
}),
|
|
42566
42772
|
...app.register?.period === void 0 ? {} : { period: app.register.period },
|
|
42567
42773
|
layout: registerLayout,
|
|
@@ -44625,8 +44831,8 @@ function checkApp(model, app, at2) {
|
|
|
44625
44831
|
if (tabs.length > 0 && !["table", "cards"].includes(app.register?.layout ?? "table")) {
|
|
44626
44832
|
findings.push(error51("register.tabs", `${at2}.register.tabs`, `a ${app.register?.layout} reads its own window \u2014 tabs stand over a table or cards`));
|
|
44627
44833
|
}
|
|
44628
|
-
if (app.register?.period !== void 0 && !tabs.some((tab) => tab.in !== void 0 || tab.open !== void 0)) {
|
|
44629
|
-
findings.push(error51("register.tabs", `${at2}.register.period`, "opens a period no tab reads \u2014 a period stands over tabs dated `in` it
|
|
44834
|
+
if (app.register?.period !== void 0 && !tabs.some((tab) => tab.in !== void 0 || tab.open !== void 0 || tab.totals !== void 0)) {
|
|
44835
|
+
findings.push(error51("register.tabs", `${at2}.register.period`, "opens a period no tab reads \u2014 a period stands over tabs dated `in` it, `open` at its end, or adding their `totals`"));
|
|
44630
44836
|
}
|
|
44631
44837
|
const named = /* @__PURE__ */ new Set();
|
|
44632
44838
|
const reportKeys = APP_EXPORT_REPORT_KEYS;
|
|
@@ -44643,6 +44849,7 @@ function checkApp(model, app, at2) {
|
|
|
44643
44849
|
dated(tab.open.to, `${path18}.open.to`);
|
|
44644
44850
|
if (tab.open.from === tab.open.to) findings.push(error51("register.tabs", `${path18}.open`, `opens and closes on "${tab.open.from}" \u2014 a row is open between two dates`));
|
|
44645
44851
|
}
|
|
44852
|
+
findings.push(...checkTabTotals(model, app, entity, tab, path18));
|
|
44646
44853
|
findings.push(...checkNarrowing(model.entities, entity, tab.where, `${path18}.where`));
|
|
44647
44854
|
const status = display?.status?.field;
|
|
44648
44855
|
if (status !== void 0 && tab.where?.[status] !== void 0) {
|
|
@@ -44789,11 +44996,13 @@ function checkApp(model, app, at2) {
|
|
|
44789
44996
|
if (listed !== void 0 && listed === display.status?.history) {
|
|
44790
44997
|
findings.push(error51("record.history", path18, `reads "${listed}", the record's status history \u2014 never a section: its Activity shows each move; drop the block`));
|
|
44791
44998
|
}
|
|
44792
|
-
const identity = blockIdentity(block);
|
|
44793
|
-
const first2 = identity === void 0 ? void 0 : blocksPlaced.get(identity);
|
|
44794
|
-
if (first2 !== void 0) findings.push(error51("record.placed-once", path18, `places the same block a second time on the record (it is already in ${first2}) \u2014 a block is read once`));
|
|
44795
|
-
else if (identity !== void 0) blocksPlaced.set(identity, `the section "${section.title}"`);
|
|
44796
44999
|
const shown2 = [section.when, block.when].flatMap((one) => one === void 0 ? [] : [one]);
|
|
45000
|
+
const identity = blockIdentity(block);
|
|
45001
|
+
const plain = isPlainRows(block);
|
|
45002
|
+
const earlier = identity === void 0 ? [] : blocksPlaced.get(identity) ?? [];
|
|
45003
|
+
if (earlier.length > 0 && !(plain && earlier.every((one) => one.plain && neverTogether(one.shown, shown2)))) {
|
|
45004
|
+
findings.push(error51("record.placed-once", path18, `places the same block a second time on the record (it is already in ${earlier[0].home}) \u2014 a block is read once; lists shown under conditions that never hold together each state a \`when\` apart from the other's`));
|
|
45005
|
+
} else if (identity !== void 0) blocksPlaced.set(identity, [...earlier, { home: `the section "${section.title}"`, plain, shown: shown2 }]);
|
|
44797
45006
|
findings.push(...checkBlock(model, app, entity, block, path18, (name, where, fieldPath) => place(name, where, fieldPath, shown2), app.checks ?? []));
|
|
44798
45007
|
if (!isRowsBlock(block)) continue;
|
|
44799
45008
|
const child = entityOf(model, block.rows);
|
|
@@ -45156,6 +45365,9 @@ function neverTogether(one, other) {
|
|
|
45156
45365
|
)
|
|
45157
45366
|
);
|
|
45158
45367
|
}
|
|
45368
|
+
function isPlainRows(block) {
|
|
45369
|
+
return isRowsBlock(block) && [block.expect, block.only, block.of, block.under, block.pick, block.post, block.checklist, block.compare].every((one) => one === void 0);
|
|
45370
|
+
}
|
|
45159
45371
|
function blockIdentity(block) {
|
|
45160
45372
|
if (isRowsBlock(block)) {
|
|
45161
45373
|
const where = Object.entries(block.where ?? {}).map(([field, held2]) => `${field}=${typeof held2 === "boolean" ? String(held2) : [...held2].sort().join(",")}`).sort().join("&");
|
|
@@ -46641,8 +46853,8 @@ async function saveSignedLinks(links, dir) {
|
|
|
46641
46853
|
}
|
|
46642
46854
|
|
|
46643
46855
|
// src/version.ts
|
|
46644
|
-
var VERSION = "0.315.
|
|
46645
|
-
var APP_SDK_VERSION = "0.123.
|
|
46856
|
+
var VERSION = "0.315.9";
|
|
46857
|
+
var APP_SDK_VERSION = "0.123.8";
|
|
46646
46858
|
|
|
46647
46859
|
// src/timezone.ts
|
|
46648
46860
|
function machineTimezone() {
|
|
@@ -46658,16 +46870,16 @@ function machineTimezone() {
|
|
|
46658
46870
|
import { spawn as spawn2 } from "node:child_process";
|
|
46659
46871
|
|
|
46660
46872
|
// docs/design.md
|
|
46661
|
-
var design_default = "# Designing an app\n\nStart here to build an app. This page is the method and the choice of treatment for each thing a job\nreads; every key it names is a key of `model.json`, and the page of the `model` reference stating a\ntreatment's keys stands beside it in \xA7 Treatments. A treatment worked through in an app of a complete model\nis a page at `examples/<treatment>` \u2014 `lotics docs`, or the `docs` tool.\n\nA model states COMPOSITION \u2014 which fields, lists and acts each job's screen holds. How each piece looks is\nthe platform's, one way per concept, and no key changes it. What the model leaves unnamed is never drawn,\nand a list the model leaves as a table is drawn as one, even where a calendar, a face or a picture would\nanswer the reader at a glance. That is the most common failure of a model, so the apply refuses an app leaving\nout a treatment it requires \u2014 a register's readings, a record's sections and children, its status moves, a picture,\nrows in time, a template's act \u2014 until the model states it or declines it.\n\n## The method\n\n1. **People and jobs, before any table.** Name each person by the work they do, then each JOB in one\n sentence: who does it, what exists when it is done, the record it moves. The sentence is the app's\n `name` and `description`. A job is a desk a person works every day from its own list; one app per job,\n each one working register over one entity \u2014 an app per table, or one app holding every table, is no job's\n screen. What was brought into that register's rows or done to them \u2014 the files imported, the runs of a\n batch \u2014 is read beside it as a log of the same app (`logs`, at most three), never an app of its own.\n A job is the record it moves and the rhythm it moves at \u2014 the first list it opens on. What that record\n owns (a vehicle's papers, its services, its fines) is sections, blocks and acts of it, never an app;\n work over another record or at another rhythm (the week's dispatch runs, beside each vehicle's file) is\n another app, even when one person works both.\n A list worked only in passing on the way through another job \u2014 the rates a quote is priced from, the\n transfers its receipts are matched to, the statement sent from its records \u2014 is a block, a section or an\n act of that job's app, never an app of its own. A small business usually lands at four to six.\n2. **The entities the jobs touch.** A status is a state the work sits in, six options or fewer: a touch\n (\"called\") is a row of a log, a money fact (\"paid in full\") a formula the figure shows. A quantity is a\n number with its `unit`, never words in a text field; a quantity of several kinds is child rows, one per\n kind, totalled at the foot of their block.\n3. **How each row is recognised** \u2014 a `records` entry for every entity an app lists, opens or picks: its\n `title` (who or what it is, never a code \u2014 the code is a `subtitle`), up to two `subtitle` fields the job\n reads at first glance, its `image`, its `party`, its `status` and which options are `closed`, its\n `figure`, its `due` dates.\n4. **Each app's composition** \u2014 the register's `columns` in the order the job reads them, as many as fit a\n desk (one that does not fit is drawn nowhere in the row; what is read only on the way deeper is the\n record's), the `filters` it narrows by every day (at most 3, each a field the rows show, or a formula yes/no of fields they show), its `layout`\n and `readings`; the record's `sections` in the order the work reaches them, each one's `fields`, `blocks`\n and `acts`; the `checks` that warn or refuse. A rule the business states \u2014 a field needed before an act,\n a quantity bounded, a picker narrowed, a duplicate reused \u2014 is the model's (an act's `requires`, a check's\n `blocks`, `write_rules`), and every write re-checks it; a check without `blocks` only warns.\n5. **What a person would ask an agent in each app.** Write the asks down per app \u2014 every act, each list\n narrowed the way a person narrows it, one record with its lines and papers, every figure, data brought\n in \u2014 and beside each the query or workflow of the app that answers it (`agent_surface`). What the screen\n reads and does is generated. An ask no screen makes is declared: a read in `queries` (`model/queries`),\n a write in `workflows` (`model/workflows`). A figure an agent calls states its `alias`. An ask with\n nothing to answer it is a gap in the model, closed before the apply. An app is built to be run by an agent:\n every flow a person works can be driven end to end through its workflows, the person is asked only where\n their judgement or authority is needed, and the screens show what was done and let a person do or put back\n any step by hand.\n6. **A treatment for every list and every entity** \u2014 the next section. Choose it from what the rows ARE,\n before writing any register.\n7. **Plan, apply, look.** The `check_model` tool (`lotics model check` on the CLI) checks the\n whole model beside the workspace's rows and writes nothing \u2014 the patch adopting each app's decisions in\n `designs`, and the app's body as they leave it its `draft`; `apply_model` (`lotics model apply`) mints each app live. Then look at each app \u2014\n \xA7 Look at it \u2014 and judge it against \xA7 The visual bar. A correction is a change to the model, applied again.\n\n## Treatments\n\nA finding naming a section below is a treatment the model left out. A decided one refuses the apply, and the\ncheck gives each app it refuses a patch stating its decided treatments: merge the patches in the order the check gives\nthem, or state why the app stays as it is in its `declines` (`model/declines`), under the key the finding names \u2014\nthen check again. A note refuses nothing.\n\n| The rows are | The treatment | Its keys |\n|---|---|---|\n| People or organisations | `records.<entity>.party`, with a photo or logo as its `image` | `model/records` |\n| Things with a photo, a scan or a paper | `records.<entity>.image`; `layout: \"cards\"` where the picture is how a row is found | `model/records`, `model/cards` |\n| Read by their day | `layout: \"calendar\"`; on a record, an `agenda` block | `model/calendar`, `model/timeline-and-agenda` |\n| Booked on a resource | `layout: \"lanes\"` with `lanes`, and `write_rules` `no_overlap` | `model/lanes`, `model/write-rules` |\n| A plan of spans | `layout: \"gantt\"` with `gantt` | `model/gantt` |\n| Stood at a place \u2014 pallets, bins | `layout: \"plan\"`; places state `plan_place` | `model/plan` |\n| Who did what on which day | `layout: \"roster\"` with `roster` | `model/roster` |\n| A log of what happened | a `timeline` block | `model/timeline-and-agenda` |\n| Opened to be worked on | the record's `sections`, in the order the work reaches them \u2014 `at` where it moves in steps | `model/record-page` |\n| A record whose page is its own arrangement of pieces the app already states | `record.compose` | `model/composed-page` |\n| Rows that each belong to another row | a `rows` block on that row's record; a `list` block where read-only, stating `fields` for rows another app works | `model/blocks`, `model/list-block` |\n| Moving through a status | an act per move, `status.history`, and the register's `readings` | `model/acts`, `model/status`, `model/readings` |\n| Steps people drop out of between | a `funnel` block on the record whose child rows count them | `model/reading-blocks` |\n| A record's own numbers nobody keys, read at a glance | a `figures` block of two to eight tiles | `model/reading-blocks` |\n| Counted over a period | the register's `tabs` over one `period`; an `open` tab's `where` reads only what was true at the period's end, never a status the row moves on from | `model/tabs` |\n| Papers a case gathers | a rows block with `expect`; the papers made, an act's `templates` | `model/blocks`, `model/papers-and-recordings` |\n| Rows that are each a place a record is sent | a rows block with `expect` on the link to those places and `post`: each ticked, the post written there and read as its feed shows it | `model/publish-desk` |\n| Papers an agent reads, where the owner asked for one | an act's `intake` with `fills` | `model/papers-and-recordings` |\n| Calls and visits | an act's `record` | `model/papers-and-recordings` |\n| Changes a workflow proposes that a person approves row by row \u2014 a price list applied, a statement matched to what is owed | an act's `workflow` with `review`, its body returning a changeset in `data.review` | `model/acts` |\n| Documents covering lines | a rows block with `under` | `model/blocks` |\n| Rows on file a record takes in | a rows block with `pick` | `model/blocks` |\n| One owner's question across jobs | a dashboard app | `model/dashboards` |\n\n### Faces and pictures\n\n#### Party\n\n`records.<entity>.party` is `\"person\"` where the rows are people (a contact, a patient, a driver) and\n`\"organization\"` where they are companies (a customer, a supplier, a carrier). Every surface drawing one of\nits rows \u2014 the register's row, a link's chip, a picker's option, the record's header \u2014 then draws a face:\nits `image` (a photo, a logo), else its initials. Without it, a person is drawn as a thing. A workspace\nmember is a `select_member` field, and is drawn by their face already. Worked: `examples/party`.\n\n#### Image\n\n`records.<entity>.image` names the files field that pictures a row \u2014 a product's photo, a damage photo, a\nscan, a receipt. Every row of it then leads with its picture, or its paper's preview, wherever it is drawn;\na link to it previews the file. Never a field an act keeps the paper it makes in (`into`). Register\n`layout: \"cards\"` where the picture is how a row is found. A files field the record keeps as a folder of\npapers is a `files` block, read whole. Worked: `examples/cards`.\n\n#### A link opens its row\n\nOn a record, a link to one row opens its peek: a drawer on a desk, a sheet on a phone, reading the\nrow's face \u2014 its mark, name, status, the line under it and its figure by its field's name \u2014 and nothing to edit. A link read in a\nrow's cell or on its line opens from its name; a link the record keeps as a field rests as its picker, and\nits way out stands at the field's label where the row has somewhere to go. The peek's one act leaves for\nthe app whose register is that entity's rows \u2014 the first, in the model's order, that the member\ncan open \u2014 at the row's address, or goes to the row inside this app where the entity is the app's own,\none of its books' or a log's, in that list \u2014 a log's rows only from their own app. With no such app the peek has no act, and a link answered in what an act asks opens\nno peek. The model states none of it: give the entity an app of its own and\nits links lead there. The app opened decides what the member reads of the row; a row it withholds\nlands them on its not-found.\n\n### Rows in time\n\nRows that each stand on a day, or hold a run of days or hours, are read where they stand in time \u2014 never\nas two date columns. A row holds a span when its `records` line (title and subtitle) holds two dates, its\n`records.frees` names the day it ends, or `write_rules.<entity>.no_overlap` books it on a row its `by` links to (a\nchair, a machine). A `no_overlap` by a person or a value alone keeps one row at a time each \u2014 a member's periods in\nturn \u2014 read by what they hold.\n\n#### Calendar\n\n`register.layout: \"calendar\"`: the rows by their day \u2014 a month, a week, a day or a list; an entry at its\nhour where its date holds one, over its span where its line holds a second date. An entry pressed opens a card on\nit: the row, Delete, its acts, Reschedule (the day alone moves; its hour and its length stay) and Open. Worked:\n`examples/calendar`.\n\n#### Lanes\n\n`register.layout: \"lanes\"` with `lanes` naming a one-row link whose target's rows are the lanes (a chair, a\nmachine, a room), each drawn even when empty: every row a block from the first date on its line to the\nsecond, and a free stretch adds a row there. `loads` reads what a lane carries against what it holds. A\n`no_overlap` `by` the same link refuses two rows on one resource at once. Worked: `examples/lanes`.\n\n#### Gantt\n\n`register.layout: \"gantt\"` with `gantt.start` (and `end`, else the entity's first `due`): one bar a row over\nits run of days \u2014 a shipment, a hire, a task of a project \u2014 read against today. `gantt.milestones` marks\ndates on the bar, `planned` the plan under it, `progress` how far it is done, `after` the rows it waits on;\nthe register's `group` is its lanes. Worked: `examples/gantt`.\n\n#### Roster\n\n`register.layout: \"roster\"` with `roster` naming the child whose rows fill the days \u2014 one link back to the\nregister's entity and a date on its line: what each row did on each day (shifts, runs, attendance). With\n`expect` (and `of`) the columns are the options of a select instead of days: which papers each row holds.\nWorked: `examples/roster`.\n\n#### Agenda\n\nAn `agenda` block on a record: a child's planned entries by day, soonest first, today marked, each with its\npicture; within a day by the hour, or by a single select of the part of the day. `start` counts Day 1 from a\ndate of the record (a trip, a course).\n\n#### Timeline\n\nA `timeline` block on a record: a child read as a log of dated entries, newest first, with a composer \u2014 the\ncalls, visits and notes about the record, each with who and when, and its files where the child's `image`\nnames them. Entries planned ahead are an `agenda`; the status's moves are its history. Worked:\n`examples/party`.\n\n### Moves and numbers\n\n#### Moves\n\nRows a status stages towards its `closed` options move by acts: each moves one option on to the next (`when` the\nstatus holds it, `set` to the next), at the foot of the section whose work it ends. A status with nothing closed is a\ncondition a person sets. A value decided as a row reaches an outcome \u2014 why it was lost, refused, voided \u2014 is that\nact's `asks`, never a field the reader must remember to fill. An act reaching past the workspace \u2014 sending an invoice\nto a service, a letter by mail \u2014 runs its `workflow`, and what the workflow keeps from the answer (an invoice's id,\nits link) is named in `writes`, the act's as what it sets is. A stage the work only steps aside into from one step\nand leaves only back to it \u2014 a pause, a repair \u2014 is a detour: its option and its section stand before that step,\nentered by its own act; listed after, it reads as the work's next step.\n\n#### Stages\n\nName each job's work plan by its shape: a status a person sets; a pipeline, where who holds the row and for how long\nmatter; or tasks, where only how many are done counts (`records.<entity>.task`). A pipeline states each stage once in\n`records.<entity>.status.stages` \u2014 its `owner` (a member field, a link's member field, or a `role`) and its target\n`within` days \u2014 and the server holds it: only the owner's acts move the row on, and a level an amount skips stands\nnamed with why. Late rows, rows due soon, a warning the line draws and rows waiting on the reader stand first in a\nregister; a register whose job is a strict order, a first-come queue, states `register.attention: false`.\n\n#### History\n\n`records.<entity>.status.history` names a child the app's own writes append one row to per status move: its\nlink to the row, the new status, the moment and who. It keeps when each row entered each status and who\nmoved it \u2014 what the rail reads. A record's activity shows every move as a change, so `record.history: true` adds\nnothing \u2014 and beside `record.activity: false`, which shows them nowhere, it is\nrefused. Worked: `examples/approval`.\n\n#### Readings\n\n`register.readings` stand above the rows and read the rows in view. Lead with the job's headline number \u2014\nits exception as a formula's yes/no in a `metric`'s `where` (what is late, what is short; the rows draw it where every field of its own row it reads is drawn, at that width), never a stage the\nstatus chips already count \u2014 then at most the mix (`breakdown`) and the movement (`trend`), varied by job.\nA `pivot` reads on a dashboard. A dashboard app (`dashboard`) answers one owner's question across jobs, each\nreading windowed by the period the reader picks, and a `list` reading hands over the rows to act on. A\ndashboard of many readings states `tabs` (2 to 5) and each reading the `tab` it stands under, so one sheet draws at a time. A\nrecord's `metric`, `breakdown` and `trend` blocks read its own child rows. Worked: `examples/approval`, `examples/dashboard`.\n\n#### Funnel\n\nA `funnel` block reads a record's child rows as steps, each a number column summed over them \u2014 a week's channels\nfrom impressions to bookings, an order's lines from ordered to shipped. It states how much of the first step\neach later one keeps, the share lost between two neighbours, and the last over the first. State two to eight\n`steps` in one unit; where the path turns \u2014 reach, then conversion \u2014 state two blocks one straight after the\nother, so the second's bars are read over its own first step: they draw on one grid, every bar starting at one\nedge and every value ending at another, each under its own label. A step no row holds a number in reads as not measured, so leave a count empty\nrather than typing a zero nobody measured.\n\n#### Priced lines\n\nA quote's items, an estimate's works, a repair sheet's damages are lines priced off a book: an entity whose\n`records` names each item, puts the code people type on its line and its price as its `figure`. The line links to\nit, asks the link and its quantities in its block's `create`, and copies the price (`default_from`), so the quote\nkeeps what was quoted when the book moves. A line's amount is a formula, the record's total a rollup over the rows\nthe block shows \u2014 what is not paid for is a second rollup, never a filter on the first, so each group subtotals.\nGroup the lines by the parts the record is quoted in (a container, a room, a leg), a field the line asks. The book\nis its keeper's desk, an app of its own.\n\n### The record\n\n#### Sections\n\n`record.sections`, in the order the work reaches them: the fields people write, a `files` block per paper the record\nkeeps, a block per child, the acts at each one's foot. A register laid out in time (calendar, lanes, roster) opens the\ndefault record: every field a person writes. `record.compose` is not for a record a standard section order would\ndo, and never for behaviour, which belongs in an act.\n\n#### Children\n\nRows that each belong to one row of another entity (a one-row link to it) are drawn under that row: a `rows` block on\nits record, a `timeline` where they are a log, an `agenda` where they are planned on a day and within it, a roster of\nthem, or lanes of them by that link. Which children a record lists is the author's \u2014 one of them at least. A block\nlisting only some of them narrows by its `where`: a select (one leg's fees), or a yes/no \u2014 a formula's for what is\nstill owed \u2014 on a block that adds no rows. Rows on\nfile before the row they come to belong to \u2014 a job's cost lines before the supplier bill over them \u2014 are picked into\nit: a rows block with `pick`, often with `create: false` and `remove: false`.\n\n### Papers\n\n#### Expect\n\nA rows block with `expect` naming the child's title \u2014 a single select of kinds, or a one-row link to a\ncatalog: one line per kind, the ones not yet filled standing empty, filled in place. `of` narrows the kinds\nto the record's own multi-select of those it needs. The papers a case gathers, the fees a record knows it\nowes. Worked: `examples/case`.\n\n`only` lists the kinds a block holds a line for, so each kind stands in the section whose job it is, once. The act making a paper (`paper: \"<child>.<kind>\"`) is its line's button while it applies, the upload in the \u22EF.\n\n#### Templates\n\nA paper the business makes is an act's `template`, kept in the record's files field `into` \u2014 or several at\nonce, `templates`: listed where the act stands, each made one as its file, each not yet made a placeholder,\nthe reader ticking which to make. Worked: `examples/case`.\n\n#### Intake\n\nA paper the business is brought and reads is an act's `intake`: the press takes the papers, an agent reads\nthem, and each is filed as the line of its kind in the child the record `expect`s, while `fills` writes what\nthey state into the record's fields \u2014 a single link as a row the agent finds among those the app reads \u2014 shown before it is saved. Worked: `examples/case`.\n\nAn agent act \u2014 an `intake`, a `record`'s `fills` \u2014 spends a run on every press, so it is stated only where the\nowner asked for an agent to do that job; otherwise a paper brought is its `expect` line, and a person types what it states.\n\n#### Under\n\nA rows block with `under`: the documents that cover lines (an invoice over its fee lines) stand as headings\nover the lines they cover, and a line no document covers offers to make one. A document entered as it arrives over lines\nalready on file (a supplier bill) picks them with `pick` instead; choose one per document.\n\n### Calls\n\n#### Record act\n\nAn act's `record`: the press records a call, visit or meeting \u2014 audio, transcript, screen where captured \u2014 and\nfiles it as a new row of the record's `timeline` child (`into`), stamped `at` and `by`; `fills` lets an agent fill\nthat row's fields from the transcript, where the owner asked. Worked: `examples/calls`.\n\n## The visual bar\n\n- A person shows a face, a thing its picture, a file its preview, a plan its days on a time axis, a\n quantity a meter (`records.limits`) or a chart, a register its `readings` under its title, and long text\n reads whole (a `text` block).\n- Every app states its tile's colour (`theme.color`), apart from the workspace's other apps where it can be,\n so the launcher tells the desks apart before their names are read.\n- Every category the job reads is coloured: each select option's `color`, and a `mark` where a brand or a\n glyph names it \u2014 on every option of a select read down a column (how it was paid, the channel, the mode).\n- Someone is a face wherever they are read. A person is a member field and a party a row of an entity stating\n `party`; where a select's options name people or organisations who are neither, every option's `mark` is\n its face (`{\"kind\": \"avatar\", \"name\": \"person\"}`), never a colour dot.\n- Every files field is drawn somewhere \u2014 a section's `fields`, a `files` block, the `image`, or where the\n act making it stands.\n- The paperwork is the proof of the work, so every paper the job takes in and every document it issues has a\n place on the record, in the section where that work happens: a files field per purpose (what arrived, what\n was issued to the customer, to the carrier, to the authority), each kept visible after the stage that made it,\n and a source \u2014 a screenshot, an email, a sheet \u2014 on the row whose figure came from it.\n- A screen with none of these is bland, and bland is a finding: text drawn where a treatment above exists\n is a change to the model.\n\n## Look at it\n\nAfter an apply, the `screenshot_app` tool draws each app as its people see it \u2014 the register, and a record\nby its `path` \u2014 at a desk's width and a phone's, one screen a shot, naming the columns a table left off at\neach width: `screen` names which screen of a long record. From the CLI, `-o <dir>` saves the shots. Beside the shots, its `verdict` is what a plan of the workspace's\nmodel finds of the app now, beside its rows: what the next apply would refuse it for and the notes on it, the\n`patch` adopting the decisions among them, and the app's body as the patch leaves it (`draft`). Judge each shot\nagainst \xA7 The visual bar, change the model, and apply again. The `rollback_app` tool returns an app to an earlier\nversion; the tables and rows stay as they are.\n";
|
|
46873
|
+
var design_default = "# Designing an app\n\nStart here to build an app. This page is the method and the choice of treatment for each thing a job\nreads; every key it names is a key of `model.json`, and the page of the `model` reference stating a\ntreatment's keys stands beside it in \xA7 Treatments. A treatment worked through in an app of a complete model\nis a page at `examples/<treatment>` \u2014 `lotics docs`, or the `docs` tool.\n\nA model states COMPOSITION \u2014 which fields, lists and acts each job's screen holds. How each piece looks is\nthe platform's, one way per concept, and no key changes it. What the model leaves unnamed is never drawn,\nand a list the model leaves as a table is drawn as one, even where a calendar, a face or a picture would\nanswer the reader at a glance. That is the most common failure of a model, so the apply refuses an app leaving\nout a treatment it requires \u2014 a register's readings, a record's sections and children, its status moves, a picture,\nrows in time, a template's act \u2014 until the model states it or declines it.\n\n## The method\n\n1. **People and jobs, before any table.** Name each person by the work they do, then each JOB in one\n sentence: who does it, what exists when it is done, the record it moves. The sentence is the app's\n `name` and `description`. A job is a desk a person works every day from its own list; one app per job,\n each one working register over one entity \u2014 an app per table, or one app holding every table, is no job's\n screen. What was brought into that register's rows or done to them \u2014 the files imported, the runs of a\n batch \u2014 is read beside it as a log of the same app (`logs`, at most three), never an app of its own.\n A job is the record it moves and the rhythm it moves at \u2014 the first list it opens on. What that record\n owns (a vehicle's papers, its services, its fines) is sections, blocks and acts of it, never an app;\n work over another record or at another rhythm (the week's dispatch runs, beside each vehicle's file) is\n another app, even when one person works both.\n A list worked only in passing on the way through another job \u2014 the rates a quote is priced from, the\n transfers its receipts are matched to, the statement sent from its records \u2014 is a block, a section or an\n act of that job's app, never an app of its own. A small business usually lands at four to six.\n2. **The entities the jobs touch.** A status is a state the work sits in, six options or fewer: a touch\n (\"called\") is a row of a log, a money fact (\"paid in full\") a formula the figure shows. A quantity is a\n number with its `unit`, never words in a text field; a quantity of several kinds is child rows, one per\n kind, totalled at the foot of their block.\n3. **How each row is recognised** \u2014 a `records` entry for every entity an app lists, opens or picks: its\n `title` (who or what it is, never a code \u2014 the code is a `subtitle`), up to two `subtitle` fields the job\n reads at first glance, its `image`, its `party`, its `status` and which options are `closed`, its\n `figure`, its `due` dates.\n4. **Each app's composition** \u2014 the register's `columns` in the order the job reads them, as many as fit a\n desk (one that does not fit is drawn nowhere in the row; what is read only on the way deeper is the\n record's), the `filters` it narrows by every day (at most 3, each a field the rows show, or a formula yes/no of fields they show), its `layout`\n and `readings`; the record's `sections` in the order the work reaches them, each one's `fields`, `blocks`\n and `acts`; the `checks` that warn or refuse. A rule the business states \u2014 a field needed before an act,\n a quantity bounded, a picker narrowed, a duplicate reused \u2014 is the model's (an act's `requires`, a check's\n `blocks`, `write_rules`), and every write re-checks it; a check without `blocks` only warns.\n5. **What a person would ask an agent in each app.** Write the asks down per app \u2014 every act, each list\n narrowed the way a person narrows it, one record with its lines and papers, every figure, data brought\n in \u2014 and beside each the query or workflow of the app that answers it (`agent_surface`). What the screen\n reads and does is generated. An ask no screen makes is declared: a read in `queries` (`model/queries`),\n a write in `workflows` (`model/workflows`). A figure an agent calls states its `alias`. An ask with\n nothing to answer it is a gap in the model, closed before the apply. An app is built to be run by an agent:\n every flow a person works can be driven end to end through its workflows, the person is asked only where\n their judgement or authority is needed, and the screens show what was done and let a person do or put back\n any step by hand.\n6. **A treatment for every list and every entity** \u2014 the next section. Choose it from what the rows ARE,\n before writing any register.\n7. **Plan, apply, look.** The `check_model` tool (`lotics model check` on the CLI) checks the\n whole model beside the workspace's rows and writes nothing \u2014 the patch adopting each app's decisions in\n `designs`, and the app's body as they leave it its `draft`; `apply_model` (`lotics model apply`) mints each app live. Then look at each app \u2014\n \xA7 Look at it \u2014 and judge it against \xA7 The visual bar. A correction is a change to the model, applied again.\n\n## Treatments\n\nA finding naming a section below is a treatment the model left out. A decided one refuses the apply, and the\ncheck gives each app it refuses a patch stating its decided treatments: merge the patches in the order the check gives\nthem, or state why the app stays as it is in its `declines` (`model/declines`), under the key the finding names \u2014\nthen check again. A note refuses nothing.\n\n| The rows are | The treatment | Its keys |\n|---|---|---|\n| People or organisations | `records.<entity>.party`, with a photo or logo as its `image` | `model/records` |\n| Things with a photo, a scan or a paper | `records.<entity>.image`; `layout: \"cards\"` where the picture is how a row is found | `model/records`, `model/cards` |\n| Read by their day | `layout: \"calendar\"`; on a record, an `agenda` block | `model/calendar`, `model/timeline-and-agenda` |\n| Booked on a resource | `layout: \"lanes\"` with `lanes`, and `write_rules` `no_overlap` | `model/lanes`, `model/write-rules` |\n| A plan of spans | `layout: \"gantt\"` with `gantt` | `model/gantt` |\n| Stood at a place \u2014 pallets, bins | `layout: \"plan\"`; places state `plan_place` | `model/plan` |\n| Who did what on which day | `layout: \"roster\"` with `roster` | `model/roster` |\n| A log of what happened | a `timeline` block | `model/timeline-and-agenda` |\n| Opened to be worked on | the record's `sections`, in the order the work reaches them \u2014 `at` where it moves in steps | `model/record-page` |\n| A record whose page is its own arrangement of pieces the app already states | `record.compose` | `model/composed-page` |\n| Rows that each belong to another row | a `rows` block on that row's record; a `list` block where read-only, stating `fields` for rows another app works | `model/blocks`, `model/list-block` |\n| Moving through a status | an act per move, `status.history`, and the register's `readings` | `model/acts`, `model/status`, `model/readings` |\n| Steps people drop out of between | a `funnel` block on the record whose child rows count them | `model/reading-blocks` |\n| A record's own numbers nobody keys, read at a glance | a `figures` block of two to eight tiles | `model/reading-blocks` |\n| Counted over a period | the register's `tabs` over one `period`; a tab's `totals` for a child's sums before, during and through it; an `open` tab's `where` reads only what was true at the period's end, never a status the row moves on from | `model/tabs` |\n| Papers a case gathers | a rows block with `expect`; the papers made, an act's `templates` | `model/blocks`, `model/papers-and-recordings` |\n| Rows that are each a place a record is sent | a rows block with `expect` on the link to those places and `post`: each ticked, the post written there and read as its feed shows it | `model/publish-desk` |\n| Papers an agent reads, where the owner asked for one | an act's `intake` with `fills` | `model/papers-and-recordings` |\n| Calls and visits | an act's `record` | `model/papers-and-recordings` |\n| Changes a workflow proposes that a person approves row by row \u2014 a price list applied, a statement matched to what is owed | an act's `workflow` with `review`, its body returning a changeset in `data.review` | `model/acts` |\n| Documents covering lines | a rows block with `under` | `model/blocks` |\n| Rows on file a record takes in | a rows block with `pick` | `model/blocks` |\n| One owner's question across jobs | a dashboard app | `model/dashboards` |\n\n### Faces and pictures\n\n#### Party\n\n`records.<entity>.party` is `\"person\"` where the rows are people (a contact, a patient, a driver) and\n`\"organization\"` where they are companies (a customer, a supplier, a carrier). Every surface drawing one of\nits rows \u2014 the register's row, a link's chip, a picker's option, the record's header \u2014 then draws a face:\nits `image` (a photo, a logo), else its initials. Without it, a person is drawn as a thing. A workspace\nmember is a `select_member` field, and is drawn by their face already. Worked: `examples/party`.\n\n#### Image\n\n`records.<entity>.image` names the files field that pictures a row \u2014 a product's photo, a damage photo, a\nscan, a receipt. Every row of it then leads with its picture, or its paper's preview, wherever it is drawn;\na link to it previews the file. Never a field an act keeps the paper it makes in (`into`). Register\n`layout: \"cards\"` where the picture is how a row is found. A files field the record keeps as a folder of\npapers is a `files` block, read whole. Worked: `examples/cards`.\n\n#### A link opens its row\n\nOn a record, a link to one row opens its peek: a drawer on a desk, a sheet on a phone, reading the\nrow's face \u2014 mark, name, status, line and its figure by its field's name \u2014 and nothing to edit. A link read in a\nrow's cell or on its line opens from its name; a link the record keeps as a field rests as its picker, and\nits way out stands at the field's label where the row has somewhere to go. The peek's one act leaves for\nthe app whose register is that entity's rows \u2014 the first, in the model's order, that the member\ncan open \u2014 at the row's address, or goes to the row inside this app where the entity is the app's own,\none of its books' or a log's, in that list \u2014 a log's rows only from their own app. With no such app the peek has no act, and a link answered in what an act asks opens\nno peek. The model states none of it: give the entity an app of its own and\nits links lead there. The app opened decides what the member reads of the row; a row it withholds\nlands them on its not-found.\n\n### Rows in time\n\nRows that each stand on a day, or hold a run of days or hours, are read where they stand in time \u2014 never\nas two date columns. A row holds a span when its `records` line (title and subtitle) holds two dates, its\n`records.frees` names the day it ends, or `write_rules.<entity>.no_overlap` books it on a row its `by` links to (a\nchair, a machine). A `no_overlap` by a person or a value alone keeps one row at a time each \u2014 a member's periods in\nturn \u2014 read by what they hold.\n\n#### Calendar\n\n`register.layout: \"calendar\"`: the rows by their day \u2014 a month, a week, a day or a list; an entry at its\nhour where its date holds one, over its span where its line holds a second date. An entry pressed opens a card on\nit: the row, Delete, its acts, Reschedule (the day alone moves; its hour and its length stay) and Open. Worked:\n`examples/calendar`.\n\n#### Lanes\n\n`register.layout: \"lanes\"` with `lanes` naming a one-row link whose target's rows are the lanes (a chair, a\nmachine, a room), each drawn even when empty: every row a block from the first date on its line to the\nsecond, and a free stretch adds a row there. `loads` reads what a lane carries against what it holds. A\n`no_overlap` `by` the same link refuses two rows on one resource at once. Worked: `examples/lanes`.\n\n#### Gantt\n\n`register.layout: \"gantt\"` with `gantt.start` (and `end`, else the entity's first `due`): one bar a row over\nits run of days \u2014 a shipment, a hire, a task of a project \u2014 read against today. `gantt.milestones` marks\ndates on the bar, `planned` the plan under it, `progress` how far it is done, `after` the rows it waits on;\nthe register's `group` is its lanes. Worked: `examples/gantt`.\n\n#### Roster\n\n`register.layout: \"roster\"` with `roster` naming the child whose rows fill the days \u2014 one link back to the\nregister's entity and a date on its line: what each row did on each day (shifts, runs, attendance). With\n`expect` (and `of`) the columns are the options of a select instead of days: which papers each row holds.\nWorked: `examples/roster`.\n\n#### Agenda\n\nAn `agenda` block on a record: a child's planned entries by day, soonest first, today marked, each with its\npicture; within a day by the hour, or by a single select of the part of the day. `start` counts Day 1 from a\ndate of the record (a trip, a course).\n\n#### Timeline\n\nA `timeline` block on a record: a child read as a log of dated entries, newest first, with a composer \u2014 the\ncalls, visits and notes about the record, each with who and when, and its files where the child's `image`\nnames them. Entries planned ahead are an `agenda`; the status's moves are its history. Worked:\n`examples/party`.\n\n### Moves and numbers\n\n#### Moves\n\nRows a status stages towards its `closed` options move by acts: each moves one option on to the next (`when` the\nstatus holds it, `set` to the next), at the foot of the section whose work it ends. A status with nothing closed is a\ncondition a person sets. A value decided as a row reaches an outcome \u2014 why it was lost, refused, voided \u2014 is that\nact's `asks`, never a field the reader must remember to fill. An act reaching past the workspace \u2014 sending an invoice\nto a service, a letter by mail \u2014 runs its `workflow`, and what the workflow keeps from the answer (an invoice's id,\nits link) is named in `writes`, the act's as what it sets is. A stage the work only steps aside into from one step\nand leaves only back to it \u2014 a pause, a repair \u2014 is a detour: its option and its section stand before that step,\nentered by its own act; listed after, it reads as the work's next step.\n\n#### Stages\n\nName each job's work plan by its shape: a status a person sets; a pipeline, where who holds the row and for how long\nmatter; or tasks, where only how many are done counts (`records.<entity>.task`). A pipeline states each stage once in\n`records.<entity>.status.stages` \u2014 its `owner` (a member field, a link's member field, or a `role`) and its target\n`within` days \u2014 and the server holds it: only the owner's acts move the row on, and a level an amount skips stands\nnamed with why. Late rows, rows due soon, a warning the line draws and rows waiting on the reader stand first in a\nregister; a register whose job is a strict order, a first-come queue, states `register.attention: false`.\n\n#### History\n\n`records.<entity>.status.history` names a child the app's own writes append one row to per status move: its\nlink to the row, the new status, the moment and who. The rail reads it. A record's activity shows every move as a change, so `record.history: true` adds\nnothing \u2014 and beside `record.activity: false`, which shows them nowhere, it is\nrefused. Worked: `examples/approval`.\n\n#### Readings\n\n`register.readings` stand above the rows and read the rows in view. Lead with the job's headline number \u2014\nits exception as a formula's yes/no in a `metric`'s `where` (what is late, what is short), never a stage the\nstatus chips already count \u2014 then at most the mix (`breakdown`) and the movement (`trend`), varied by job.\nA `pivot` reads on a dashboard. A dashboard app (`dashboard`) answers one owner's question across jobs, each\nreading windowed by the period the reader picks, and a `list` reading hands over the rows to act on. A\ndashboard of many readings states `tabs` (2 to 5) and each reading the `tab` it stands under, so one sheet draws at a time. A\nrecord's `metric`, `breakdown` and `trend` blocks read its own child rows. Sums of each row's child rows are a tab's `totals`. Worked: `examples/approval`, `examples/dashboard`.\n\n#### Funnel\n\nA `funnel` block reads a record's child rows as steps, each a number column summed over them \u2014 a week's channels\nfrom impressions to bookings, an order's lines from ordered to shipped. It states how much of the first step\neach later one keeps, the share lost between two neighbours, and the last over the first. State two to eight\n`steps` in one unit; where the path turns \u2014 reach, then conversion \u2014 state two blocks one straight after the\nother, so the second's bars are read over its own first step: they draw on one grid, every bar starting at one\nedge and every value ending at another, each under its own label. A step no row holds a number in reads as not measured: leave it empty, never a zero nobody measured.\n\n#### Priced lines\n\nA quote's items, an estimate's works, a repair sheet's damages are lines priced off a book: an entity whose\n`records` names each item, puts the code people type on its line and its price as its `figure`. The line links to\nit, asks the link and its quantities in its block's `create`, and copies the price (`default_from`), so the quote\nkeeps what was quoted when the book moves. A line's amount is a formula, the record's total a rollup over the rows\nthe block shows \u2014 what is not paid for is a second rollup, never a filter on the first, so each group subtotals.\nGroup the lines by the parts the record is quoted in (a container, a room, a leg), a field the line asks. The book\nis its keeper's desk, an app of its own.\n\n### The record\n\n#### Sections\n\n`record.sections`, in the order the work reaches them: the fields people write, a `files` block per paper the record\nkeeps, a block per child, the acts at each one's foot. A register laid out in time (calendar, lanes, roster) opens the\ndefault record: every field a person writes. `record.compose` is not for a record a standard section order would\ndo, and never for behaviour, which belongs in an act.\n\n#### Children\n\nRows that each belong to one row of another entity (a one-row link to it) are drawn under that row: a `rows` block on\nits record, a `timeline` where they are a log, an `agenda` where they are planned on a day and within it, a roster of\nthem, or lanes of them by that link. Which children a record lists is the author's \u2014 one of them at least. A block\nlisting only some of them narrows by its `where`: a select (one leg's fees), or a yes/no \u2014 a formula's for what is\nstill owed \u2014 on a block that adds no rows. Rows on\nfile before the row they come to belong to \u2014 a job's cost lines before the supplier bill over them \u2014 are picked into\nit: a rows block with `pick`, often with `create: false` and `remove: false`.\n\n### Papers\n\n#### Expect\n\nA rows block with `expect` naming the child's title \u2014 a single select of kinds, or a one-row link to a\ncatalog: one line per kind, the ones not yet filled standing empty, filled in place. `of` narrows the kinds\nto the record's own multi-select of those it needs. The papers a case gathers, the fees a record knows it\nowes. Worked: `examples/case`.\n\n`only` lists the kinds a block holds a line for, so each kind stands in the section whose job it is, once. The act making a paper (`paper: \"<child>.<kind>\"`) is its line's button while it applies, the upload in the \u22EF.\n\n#### Templates\n\nA paper the business makes is an act's `template`, kept in the record's files field `into` \u2014 or several at\nonce, `templates`: listed where the act stands, each made one as its file, each not yet made a placeholder,\nthe reader ticking which to make. Worked: `examples/case`.\n\n#### Intake\n\nA paper the business is brought and reads is an act's `intake`: the press takes the papers, an agent reads\nthem, and each is filed as the line of its kind in the child the record `expect`s, while `fills` writes what\nthey state into the record's fields \u2014 a single link as a row the agent finds among those the app reads \u2014 shown before it is saved. Worked: `examples/case`.\n\nAn agent act \u2014 an `intake`, a `record`'s `fills` \u2014 spends a run on every press, so it is stated only where the\nowner asked for an agent to do that job; otherwise a paper brought is its `expect` line, and a person types what it states.\n\n#### Under\n\nA rows block with `under`: the documents that cover lines (an invoice over its fee lines) stand as headings\nover the lines they cover, and a line no document covers offers to make one. A document entered as it arrives over lines\nalready on file (a supplier bill) picks them with `pick` instead; choose one per document.\n\n### Calls\n\n#### Record act\n\nAn act's `record`: the press records a call, visit or meeting \u2014 audio, transcript, screen where captured \u2014 and\nfiles it as a new row of the record's `timeline` child (`into`), stamped `at` and `by`; `fills` lets an agent fill\nthat row's fields from the transcript, where the owner asked. Worked: `examples/calls`.\n\n## The visual bar\n\n- A person shows a face, a thing its picture, a file its preview, a plan its days on a time axis, a\n quantity a meter (`records.limits`) or a chart, a register its `readings` under its title, and long text\n reads whole (a `text` block).\n- Every app states its tile's colour (`theme.color`), apart from the workspace's other apps where it can be,\n so the launcher tells the desks apart before their names are read.\n- Every category the job reads is coloured: each select option's `color`, and a `mark` where a brand or a\n glyph names it \u2014 on every option of a select read down a column (how it was paid, the channel, the mode).\n- Someone is a face wherever they are read. A person is a member field and a party a row of an entity stating\n `party`; where a select's options name people or organisations who are neither, every option's `mark` is\n its face (`{\"kind\": \"avatar\", \"name\": \"person\"}`), never a colour dot.\n- Every files field is drawn somewhere \u2014 a section's `fields`, a `files` block, the `image`, or where the\n act making it stands.\n- The paperwork is the proof of the work, so every paper the job takes in and every document it issues has a\n place on the record, in the section where that work happens: a files field per purpose (what arrived, what\n was issued to the customer, to the carrier, to the authority), each kept visible after the stage that made it,\n and a source \u2014 a screenshot, an email, a sheet \u2014 on the row whose figure came from it.\n- A screen with none of these is bland, and bland is a finding: text drawn where a treatment above exists\n is a change to the model.\n\n## Look at it\n\nAfter an apply, the `screenshot_app` tool draws each app as its people see it \u2014 the register, and a record\nby its `path` \u2014 at a desk's width and a phone's, one screen a shot, naming the columns a table left off at\neach width: `screen` names which screen of a long record. From the CLI, `-o <dir>` saves the shots. Beside the shots, its `verdict` is what a plan of the workspace's\nmodel finds of the app now, beside its rows: what the next apply would refuse it for and the notes on it, the\n`patch` adopting the decisions among them, and the app's body as the patch leaves it (`draft`). Judge each shot\nagainst \xA7 The visual bar, change the model, and apply again. The `rollback_app` tool returns an app to an earlier\nversion; the tables and rows stay as they are.\n";
|
|
46662
46874
|
|
|
46663
46875
|
// src/model_reference.md
|
|
46664
|
-
var model_reference_default = '# The Lotics workspace model (`model.json`)\n\nOne JSON file describing a workspace: its tables, fields, options, views, roles,\nfirst rows, how a row of each table is recognised, and the apps over them. Each \xA7\nis its own page at `model/<section>` \u2014 `lotics docs`, or the `docs` tool. Which treatment each job\'s\nscreen needs: the `design` reference. Each treatment worked through in an app of a complete model: the\n`examples` reference.\n\n**What a model composes with**\n\n- **Entities and fields** (\xA7 Entity, \xA7 Field) \u2014 the tables, their columns, options and links.\n- **Records** (\xA7 Records, then \xA7 Status) \u2014 how a row of each entity is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per entity\n and read by every surface that draws one of its rows.\n- **Write rules** (\xA7 Write rules) \u2014 what a write finds, bounds and picks among.\n- **Apps** (\xA7 Apps, then a page each: \xA7 Logs, \xA7 Workflows, \xA7 Queries, \xA7 Register, \xA7 Layouts, \xA7 Tabs, \xA7 Export, \xA7 Readings,\n \xA7 Averages and bands, \xA7 Dashboards, \xA7 Record page, \xA7 Blocks, \xA7 Composed page, \xA7 Publish desk, \xA7 Timeline and agenda, \xA7 Statements, \xA7 Reading blocks, \xA7 List block, \xA7 Tasks, \xA7 Acts,\n \xA7 Papers and recordings, \xA7 Checks) \u2014 one\n working register over one entity and the record each row opens, with the logs beside it:\n which fields go where, the acts, and the checks that guard them \u2014 or a dashboard of readings.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no key here changes it.\n A screen the job needs and no key states is a `lotics report` \u2014 the job, what the model\n drew, the word wanted \u2014 never keys bent to approximate it.\n\n**The working order**\n\n1. Name the people and each one\'s JOB \u2014 the work they alone decide or write.\n2. The entities and fields those jobs touch, and a `records` entry for every entity an\n app lists, opens or picks.\n3. One app per job in `apps[]` \u2014 the record a person moves and the rhythm they move it at, its own list; what that record owns is its sections, blocks and acts, and work over another record or at another rhythm is another app, even for the same person \u2014 each one working register over one entity; a list worked only in passing is a section of the app it serves, and the log of what was brought into the register\'s rows is a log beside it (`logs`).\n4. `lotics model apply model.json` \u2014 the file is checked first, every problem in one run;\n then the tables, then a new version of every app, live\n (`lotics setup model.json --email you@company.com` where no account exists yet).\n5. Change the file and apply it again; `lotics model pull -o model.json` writes what the\n workspace holds, and each apply of that file sends only what it changes. `apply_model` takes\n a `patch` in place of `model`: a JSON merge patch (RFC 7396) over the workspace\'s model, each\n list whose items carry an `alias` written as an object keyed by it \u2014\n `{ "apps": { "desk": { "acts": { "close": null } } } }` removes one act. Where an aliased item\n stands is a move beside the patch, `"moves": [{ "at": "apps.desk.acts.close", "after": "hold" }]`\n (or `"first": true`), placed once the patch merged \u2014 built into an app\'s acts, and a select\'s\n options (`entities.<entity>.fields.<field>.options.<option>`) reordered on its table, the plan\n saying each order it writes; a table\'s\n fields and views and the apps themselves keep the workspace\'s order. A patch whose every key and\n move lies inside one app\'s body leaves the tables as they stand and builds that app, beside any\n other app whose build reads what it changed. A `null` removes only\n what an apply writes as the model states it \u2014 anything inside an app, a `records` entry\n (`"records": { "<entity>": null }`), a write rule, an entity\'s `singular` and `writes`, a\n field\'s `default`, `required` and `writes`, a text field\'s `format`, a number\'s `notation`, a field itself, which leaves its table where no row holds a value in it and nothing reads it \u2014 and is refused\n anywhere else, a table, view, role, template or app among them; one naming\n nothing the model holds changes nothing. A `null` on a select\'s option is taken, as\n leaving it out of a whole model is: the model stops stating it, so each app is built without it, its\n table keeps it and its rows still read, and the apply notes it \u2014 `update_table` removes one, rebuilding\n the apps without it first, refused only while an app\'s model states it or another reader names it. A\n field `update_table` deletes goes the same way, its values with it and its place in the table\'s views (columns, filters, sorts, summary); only an omission or `null` in\n `apply_model` is value-protected. An edit of a table reaches each model-built app shortly after, as the\n platform building it again from its model; one it cannot build unharmed is warned of by `get_model`. `get_model` with `app` reads one app and the\n entities it reads.\n Rolling an app back (`lotics run rollback_app`) restores its earlier version \u2014 table\n changes and data writes stay.\n\n## The rules\n\n- **At least one entity, at most 50.** More tables than that is a data model\n being designed, not applied \u2014 apply the rest in a second call.\n- **An existing table is adopted.** `lotics model apply` binds an entity whose `label`\n already names a table in the workspace, and adds the fields, options and\n views it is missing. No stored value is ever changed or deleted: a field it\n adopts takes the model\'s `default` and `required`, a text field\'s `format`, and\n the `notation` it reads in, where that only relabels \u2014 a date\'s format and a unit\n converting its figures are left. A computed field\'s definition follows the model: a formula\'s expression,\n notation and options, a rollup\'s link, aggregation and filter, a\n lookup\'s link, field and order, and an autonumber\'s `template` (new rows only \u2014\n existing numbers keep theirs). A check and the apply name each one that changes.\n Applying the same model twice changes nothing the second time.\n- **A field the file stops stating leaves its table** \u2014 one an earlier apply stated,\n or one the pulled file stated \u2014 where that loses nothing: no row holds a value in\n it, and nothing outside the model\'s own apps reads it (a formula, rollup or\n lookup, a figure\'s unit, a `default_from` copy, a unique set, a query, an agent,\n a table check or a workflow body of the workspace). Otherwise nothing is applied,\n and the refusal names the field, how many rows hold a value and what reads it:\n state the field again to keep it, or clear those rows and stop those readers. A\n field of the table no model ever stated stays as it is, and so does one a read\n of the workspace\'s model leaves out \u2014 `get_model` and `lotics model pull` name\n each in their findings \u2014 since no file made from that read could state it.\n `lotics model check` names each field the apply would take off.\n- **A label the file changes is a rename.** A field\'s `label`, a select option\'s\n `label` and a table\'s `description` are written onto the table as the file states\n them, each named by a check and by the apply. A table\'s own name, a template\'s and\n a role\'s are reported where they differ and left; a table is deleted on the CLI by\n `lotics run delete_table`, or by a member in Lotics (\xA7 What a run remembers).\n- **An app\'s labels decide its language.** A model names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese, and `model apply` notes a label written the other way from the rest\n of its app\'s. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two.\n- **Rows land only where every bound table is empty.** One table already holding\n records and no rows are written anywhere: sample rows landing among a\n customer\'s real ones cannot be told apart from them.\n- **`lotics model apply` checks all of it before anything is written**, and\n reports every problem in one run rather than the first. Each section of this\n page ends its keys with the rules the check enforces there, one sentence each\n under an id; a finding names its rule\'s id (`[register.filter]`), and\n `model/<rule id>` is that one rule\'s page.\n\n<!-- generated:start rules-model -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `model.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `model.retired` | `field_roles`, `table_workflows` and `connections` are no longer part of a model: `records` states how a row is recognised, and an app\'s own writes do what a table automation did. |\n| `model.names-declared` | Every alias a key names is declared: an entity of this model, a field of the entity the key reads, an option of the select it names, an act of the app, a template or an app of this model. |\n| `model.tables` | A model declares at least one table and at most 50; apply the rest as a second model. |\n| `model.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per model and 2000 documents attached \u2014 a real data set belongs in an import. |\n| `model.language` | *Noted, never refused:* A label or description written in the other language than the rest of its app\'s labels \u2014 with or without diacritics. |\n| `model.alias-unique` | An alias is unique where it is named: entities, roles and templates in the model, fields and views in their entity, options in their select. |\n| `model.label-unique` | A label is unique where apply finds it by label: entities, roles and templates in the model, fields and views in their entity, options in their select \u2014 and no view takes its entity\'s own label, which names the whole-table grid apply makes. |\n| `model.template-sha` | A template\'s `content_sha256`, where stated, is the 64-character lowercase hex sha256 of its content. |\n| `model.template-kind` | An act\'s paper and a register\'s `export` are made from an html or an excel template, never an email one. |\n| `model.template-act` | *Refused until adopted or declined:* In a model stating apps none of whose acts runs an authored `workflow`, every html or excel template is made by an act (`template`, `templates`) or filled by a register\'s `export` \u2014 the patch adds the act to the app over the entity whose fields it prints most. |\n| `model.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n\n<!-- generated:end rules-model -->\n\n## Top level\n\nEvery table of keys on this page is generated from the schema `model apply`\nparses the file with, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### Model file\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entities` | list of [Entity](#entity) | yes | The tables this model creates, with their fields, options and views |\n| `roles` | list of [Role](#role) | no | Workspace groups to create; members are added to them afterwards |\n| `templates` | list of [Template](#template) | no | Document templates: html and email inline, excel made from an uploaded workbook |\n| `rows` | map of alias \u2192 list of [Row](#row) | no | First records, keyed by entity alias \u2014 written only where every table they land in is empty |\n| `records` | map of alias \u2192 [Record](#record) \\| `null` | no | How a row of each entity is recognised, keyed by entity alias. Every entity an app lists, opens or picks has one; `null` removes the entry its table holds |\n| `write_rules` | map of alias \u2192 [Entity write rules](#entity-write-rules) | no | Entity alias \u2192 what a write of that entity finds, bounds and picks among |\n| `apps` | list of ([App](#app) \\| [Dashboard app](#dashboard-app)) | no | The apps this workspace will have \u2014 each one working register over an entity, with the logs that stand beside it, or a dashboard of readings |\n\n<!-- generated:end top-level -->\n\n**A model carries no** `fixtures`, `knowledge` or `knowledge_expects`, and no\n`word` / `pdf-form` template: file content is uploaded to the workspace, never\nstated in a model \u2014 an `excel` template names its uploaded workbook by `file_id`. `apps` here is what an agent states to make an app,\nnever built code. An unknown top-level key is an error, never ignored.\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how the file cross-references\nitself; they are never shown to anyone. `label` is what a person sees.\n\nLabels must be unique within their namespace \u2014 two entities, two fields on one\nentity, two options on one field, two views on one entity, two roles or two\ntemplates cannot share a label, because `apply` matches by label.\n\n## Entity\n\n<!-- generated:start entity -->\n\n#### Entity\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable entity alias, unique within the contract |\n| `label` | text | yes | The table\'s name in the workspace, which apply names it |\n| `singular` | text | no | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | no | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `writes` | `false` | no | false: no app opens or edits this table\'s rows. Direct writes follow the table\'s access, as on any table |\n| `fields` | list of [Field](#field) (at least one) | yes | The table\'s columns |\n| `read_scope` | [Read scope](#read-scope) | no | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list of list of alias (at least one) (at least one) | no | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, or a link of cardinality "one"). A create or update landing a second row with the same values is refused. |\n| `views` | list of [View](#view) | no | Saved views, in the order they are listed; with none, the table still opens on its default grid |\n\n#### Read scope\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option)) (at least one) | yes | A row is readable when ANY of these holds |\n\n#### Read scope by role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `member_of` | alias | yes | A role alias: whoever is in the group it binds to reads the row |\n\n#### Read scope by member\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `through` | list of alias (1\u20133) | no | select_record_link aliases from this entity outward, each of cardinality "one" \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias | yes | A select_member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"` | yes | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `through` | list of alias (1\u20133) | no | select_record_link aliases from this entity outward, each of cardinality "one" \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias | yes | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one) | yes | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end entity -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | An entity a create is mounted over \u2014 a register that adds, a rows block \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.required-cycle` | Required links never wait on each other in a loop: no row of the loop could be created first. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a declared role (`member_of`) or a field of its entity reached through one-row links: `"self"` a member field, options a single select declares. |\n| `entity.unique` | A `unique` set names two fields or more of its entity once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; one field alone is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this entity holding ONE value \u2014 text, number, date, a single select, a link\nof cardinality `"one"` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. `model apply` REFUSES a model where a table\nsome create opens \u2014 a register\'s own, or a record section\'s add \u2014 states none.\n\n**`writes: false` says no app opens, edits or files these rows** \u2014 a log of what\nthe system sent, a copy of what another system holds. A record listing them\nkeeps the section and opens each row at rest, with no Add; a screen over the\nentity operates at most the rows its record owns; a party of it is picked, never\nfound or minted; and the generator writes no create and no update for it, and\nnever notes it as created nowhere. It shapes the apps, not who may write: a\ndirect write \u2014 the records API, the chat agent, an import \u2014 follows the table\'s\naccess, as on any table. A `lifecycle` on it is refused \u2014 a row walked\nthrough stages is worked by a person \u2014 and so is a publish desk over it (a rows\nblock\'s `post`), whose ticks make its rows. Absent,\napps open and edit the rows; `true` is not a value.\n\n**`read_scope` is a ROW rule, enforced by the platform.** It is resolved at\napply into the table\'s own row filters, so an app, a workflow reading for a\nviewer, and the API all answer the same rows \u2014 a per-record visibility field the\napp merely honours is a convention, not a gate. A `"self"` clause reads a column\nof one member or several, and every role alias and option alias a clause names\nmust be one this model declares. `apply` writes the rule onto a table it\nCREATES; a table it adopted that ALREADY CARRIES a rule keeps that one, because\nthe rule is the workspace\'s own statement about its rows \u2014 and a run whose model\nstates a different rule reports the entity rather than leaving the claim silent.\n\n**An app may state that its sharing is its read gate: `"reads": "shared"`.** An\napp reads as its owner, so the rule reaches a viewer only as the predicate every\nquery and editor guard of every app over the entity carries \u2014 right for a desk of\none\'s own rows, wrong for a desk whose audience its sharing already decides, where\nwidening the rule meant a role group nobody remembers to fill. Stated on an APP,\nits queries, pickers and guards carry no entity\'s rule and whoever the app is\nshared with reads and writes every row it draws; every other app and the table\'s\nown filters keep the rule. Share it deliberately. Refused on an app none of whose\ntables states a `read_scope`.\n\n**A row rule is never inherited.** A child read under a private record states\nits own: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink of `"cardinality": "one"`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the entity it names is created first, and entities\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A stored field\'s `writes: false` says no person keys it in an app** \u2014 a post\'s\nid a publishing workflow brings back, a count a sync fills. Every app draws it\nread wherever it is placed, no add or act asks it, no paper fills it, and the\ngenerator writes it in no create and no update; a statement line reads it as a\nfigure no person keys, and beside `default_from` it is copied when the row is\nmade and never keyed. It shapes the apps, not who may write: a workflow, the\nrecords API, the chat agent and an import write it as the table\'s access allows.\nA formula, a rollup, a lookup, an autonumber and a date `derive_from` stamps take\nno such key \u2014 no one keys them already. Absent, a person keys the field; `true`\nis not a value.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"select_member"` \\| `"select_record_link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"` | yes | What the field holds \u2014 each type takes the further keys its own section lists |\n| `alias` | alias | yes | Stable local alias, unique within the entity |\n| `label` | text | yes | The field\'s name in the workspace, which apply names it |\n| `description` | text | no | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | no | Refuse a record whose cell for this field is empty. Apply writes it onto the field, and every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | text | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `unique` | boolean | no | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` | no | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | number | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `notation` | [notation](#number) | no | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nThe keys `notation` replaced \u2014 `format`, `currency`, `unit`, `unit_field` and\n`currency_field`, on a number or in a formula, and a formula\'s `format: "link"`\nfor `link: true` \u2014 are no longer read. A field stating them naming another\nreading than its `notation` (a decimal, where it states none) is refused, and the\nfinding names the `notation` to write in their place: `"format": "currency",\n"currency": "USD"` becomes `"notation": { "style": "currency", "currency": "USD" }`.\nWrite `notation`.\n\nAn ABSENT number is drawn absent \u2014 the one exception is a\n`sum` or count rollup the plan reads as a **`measure`**: that is the thing\naccumulated toward a bound, so nothing accumulated yet is zero and the meter\ndraws it. The same rollup read as an `amount` keeps its blank, and so does every\nother role: nothing added to what a row is WORTH means unpriced, not free. A\nformula reading only such sums and counts, and reading zero where each does\n(`{received} - {refunded}`), is one too. A `min`, an `avg`, a percentage of\nnothing and every other formula stay blank in any role, because none of them has\nan answer to give. This is why the pair on one\nscreen reads two ways \u2014 what has come in against what is owed \u2014 and why a\nmeasure\'s own LIMIT, an amount, leaves an unquoted row out of the count rather\nthan reporting it as nothing collected. **AND WHERE THAT LIMIT IS ABSENT \u2014 OR\nZERO \u2014 THERE IS NO LEVEL AT ALL**: a level is a reading AGAINST a bound, so a row\nthat states no bound, or a bound of nothing, draws nothing \u2014 cell, fact and all \u2014\nrather than a numerator whose whole meaning was the comparison. "Collected 0"\nbeside a blank total reads as money against a job worth nothing, and "0 of 0"\nagainst a count of nothing owed claims a comparison nobody can make. A measure the model gives no limit is a plain figure\nand is unaffected. A share is stored in percent units \u2014 68.1 is 68.1 % \u2014 and the\ncolumn, the fact behind it, the meter it is judged by and the figure over the\nregister all say so.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own in `formula.notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`lotics run update_table`. `model apply` never makes it: the model states the\nworkspace\'s unit until then. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit, a\nchart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this entity \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused, as is any lookup of such a figure (its\nunit lives on the other row). A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | text | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. A date string in the field\'s format. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `format` | `"date"` \\| `"datetime"` \\| `"date_range"` \\| `"datetime_range"` | no | Whether the field holds a day or a moment, alone or as a span |\n| `timezone` | text | no | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | no | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | boolean | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | list of alias | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. Option alias(es) this field declares \u2014 one for single-select. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `options` | list of [Select option](#select-option) (at least one) | yes | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | no | Allow multiple selections |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable local alias, unique within the field |\n| `label` | text | yes | Display label for the option |\n| `color` | [colour](#select) | no | The colour the option\'s badge is drawn in; absent, the platform gives it one no sibling option holds |\n| `mark` | [mark](#select) | no | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, kiotviet, misa, lark, payos}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n\n<!-- generated:end field-select -->\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another entity. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `apply` writes the\nmarks onto the table, sets one an adopted option lacks, and reports one it wears\ndifferently rather than overwrite it. The glyphs:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, facebook, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, instagram, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, linkedin, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, twitter, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### `select_member`\n\nA person picker over the workspace\'s members. No default: a model cannot name\nmembers of a workspace that does not exist yet. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-select_member -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `multi` | boolean | no | Allow multiple selections |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-select_member -->\n\n### `select_record_link`\n\n<!-- generated:start field-select_record_link -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `target_entity` | alias | yes | Alias of the entity this field links to |\n| `sync_both_ways` | boolean | no | Create a paired link field on the target entity for bidirectional sync |\n| `paired_field_alias` | alias | no | The pair edge of a bidirectional link: the field alias ON THE TARGET ENTITY that is this link\'s sync partner. Both sides of a pair carry it, each naming the other. Apply creates whichever side it reaches first WITH the pairing (the platform auto-creates the partner) and binds the partner alias to the auto-created field \u2014 without this edge the two contract fields would be created independently and collide with the auto-created partner. |\n| `cardinality` | `"one"` \\| `"many"` | no | How many linked records this field holds. Default \'many\'. \'one\' holds a single row and needs no partner; where the link IS paired, the partner side holds many. |\n| `display_field_aliases` | list of alias | no | Not taken: a link shows the row it names by the target\'s own title (`records.<entity>.title`), so a link states no display fields |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-select_record_link -->\n\nA two-way link is declared on BOTH sides, each naming the other as its\n`paired_field_alias`; the pair must be symmetric or the model is refused.\n\n**A single-valued link needs no partner.** `"cardinality": "one"` on its own is a\nlink that holds one row \u2014 one customer on an invoice, one project on a device \u2014\nand nothing is created on the target. The mirror invariant belongs to a PAIRED\nlink: pair a link when the target\'s own record should list what points at it, and\nleave it unpaired when it should not. Either way the record plan draws the\nrelation as a section on the side it points at, so an unpaired link costs the\ntarget nothing.\n\n### `files`\n\nA row attaches documents to it (\xA7 Rows). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n<!-- generated:start field-files -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n\n<!-- generated:end field-files -->\n\n### `formula`\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `formula` | [Formula](#formula) | yes | Formula config. The expression references other fields on the SAME entity by alias in braces, e.g. `{quantity} * {unit_price}`. |\n\n#### Formula\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `expression` | text | yes | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `notation` | [notation](#number) | no | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | no | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | no | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | no | What the expression YIELDS \u2014 the kind the platform infers at write time, declared here so the offline checks can read it. `notation` beside it is how a number result reads, not what it is. Ignored on the wire (the platform re-infers it); `lotics model pull` writes the inferred value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a model has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the copy writes that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up from another\nentity is tested there, in a formula of its own, and that result looked up.\n\n**The language.** The offline check and the platform compute a formula with one\nengine, and the check refuses a call or a name it cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- Strings: upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\')\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), differenceInCalendarDays(later,earlier), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this entity.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `source_field_alias` | alias | yes | Alias of a select_record_link field on this entity to roll up from |\n| `aggregate_option` | [aggregation](#rollup) | yes | Aggregation operation. Its `field_key` names a field alias on the linked entity. |\n| `filter` | [filter](#views) group | no | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n\n<!-- generated:end field-rollup -->\n\n`aggregate_option` is `{ "operation": \u2026, "field_key": \u2026 }` \u2014 `field_key` a field\nalias on the linked entity (`count` may omit it), and `operation` one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `source_field_alias` | alias | yes | Alias of a select_record_link field on this entity to look up through |\n| `lookup_field_alias` | alias | yes | Alias of the field on the linked entity to display |\n| `order_by` | [Lookup order](#lookup-order) | no | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field_key` | text | yes | A field alias on the linked entity the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"` | yes | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `prefix` | text | no | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | no | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | no | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n\n<!-- generated:end field-autonumber -->\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its entity names \u2014 a link no copy fills \u2014 into a field of the same type, date format and notation that `derive_from` does not stamp: a lookup only through a one-row link, a link only into one to the same entity, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so an add sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.writes` | A stored field\'s `writes: false` says no person keys it in an app \u2014 a workflow or an integration writes it: every app draws it read, no add (`create`) or act asks it and no paper fills it, and a required one takes a `default` or a `default_from` where an app adds its rows; never on a date `derive_from` stamps, which is read already. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.option-colors` | *Noted, never refused:* Two options of one select hold the same colour, so a plan, a badge or a dot cannot tell them apart. Drop the colour from all but one and the platform gives each a colour no sibling holds, or name distinct colours. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a declared entity: its `paired_field_alias` a link on it naming this one back \u2014 and of two paired links at most one reads one row. |\n| `field.link-display` | *Noted, never refused:* A link states no display fields: every link shows the row it names by the one field its entity\'s table names its rows by (`records.<entity>.title`, else what the table states). A file stating `display_field_aliases` has it ignored. |\n| `field.formula` | A formula parses, reads fields of its own entity by alias, names an option as `{field:option}` of one a select declares, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type`, else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its entity, a field of the linked entity by an operation a model declares and that field\'s type takes \u2014 never a figure read in each row\'s own unit or currency \u2014 filtered on fields of the linked entity. |\n| `field.lookup` | A lookup reads, through a link of its entity, a field of the linked entity \u2014 never one read in each row\'s own unit or currency \u2014 ordered by a field of it. |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Views\n\nSaved views live under the entity they belong to. Every field reference is a\nfield ALIAS on that entity.\n\n<!-- generated:start views -->\n\n#### View\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable view alias, unique within the entity |\n| `label` | text | yes | Display name of the view |\n| `description` | text | no | The view\'s description, written onto the view in the workspace |\n| `columns` | list of [View column](#view-column) (at least one) | no | The columns the view shows, in this order and no others; absent, every field |\n| `filters` | [filter](#views) | no | The rows the view keeps |\n| `sort` | [sort](#views) | no | The order the view reads its rows in |\n| `summary` | map of text \u2192 text | no | Field alias \u2192 the operation its footer cell states |\n| `frozen_columns` | integer \\| `null` | no | How many leading columns stay in place while the rest scroll |\n\n#### View column\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field_alias` | alias | yes | A field of this entity |\n| `visibility` | `"visible"` \\| `"hidden"` | yes | Field visibility state: \'visible\' = shown to everyone, \'hidden\' = not shown by default but members can toggle |\n| `width` | number | no | The column\'s width, in pixels |\n\n<!-- generated:end views -->\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "type": "select", "field_key": "tier", "operator": "has_any_of",\n"value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition\'s `type` is the field\'s type and its `operator` is\none that type admits \u2014 `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-view -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `view.fields` | A view\'s columns, summary, sort and filters name fields of its entity. |\n\n<!-- generated:end rules-view -->\n\n## Roles\n\nA role becomes a workspace group.\n\n<!-- generated:start roles -->\n\n#### Role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable role alias, bound to a workspace group when the model is applied |\n| `label` | text | yes | The group\'s name in the workspace |\n\n<!-- generated:end roles -->\n\n## Templates\n\nAn `html` or `email` template carries its content inline, and `{{name}}` in it is filled\nfrom the workflow\'s data; an `excel` template names an uploaded workbook by its `file_id`,\nfilled with the register\'s report by its `export` alone.\n\nInline content is refused where it holds a script, a frame, a `<link>`, an inline event handler or a\n`javascript:` URL; an `html` one may be a fragment, kept as written and printed as a whole document. An apply brings a\ntemplate it made before to the content the model states, and leaves one it adopted by its label as\nits owner wrote it.\n\n<!-- generated:start templates -->\n\n#### Template\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"html"` \\| `"email"` \\| `"excel"` | yes | html is a page a workflow renders to a PDF; email is a message a workflow sends; excel is a workbook a register\'s export fills |\n| `alias` | alias | yes | Stable template alias, unique within the contract |\n| `label` | text | yes | The template\'s name in the workspace |\n\n<!-- generated:end templates -->\n\n### `html` and `email`\n\n<!-- generated:start template-inline -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `content` | text | yes | Inline template content; placeholders reference field aliases |\n| `content_sha256` | text | no | sha256 (64-char lowercase hex) of the utf-8 content; derived where the template is written when absent |\n| `locale` | `"vi"` \\| `"en"` | no | The language its figures, dates and amounts in words print in; absent prints in the organization\'s |\n\n<!-- generated:end template-inline -->\n\n### `excel`\n\n<!-- generated:start template-excel -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `file_id` | text | yes | The uploaded .xlsx (`fil_\u2026`) the template is made from; its markers read what the export fills it with |\n\n<!-- generated:end template-excel -->\n\nA paper that has to look like a counterparty produced it \u2014 an official letter,\nan acceptance minute, a supplier\'s bill \u2014 is the same `html` template with a\nshell around the body: a letterhead, a reference line, a seal and a signature\nblock, and paper grain over everything. One shell, many bodies; the data is the\nonly thing that changes, so a workflow can re-issue it over any record.\n\n```jsonc\n{ "alias": "cong_van", "label": "C\xF4ng v\u0103n", "type": "html",\n "content": "\u2026the page below, as one JSON string\u2026" }\n```\n\n```html\n<style>\n .sheet{position:relative;width:718px;padding:44px 58px 30px;background:#fbfaf6;color:#111;font:14.2px/1.5 \'Liberation Serif\',serif}\n .grain{position:absolute;inset:0;opacity:.34;mix-blend-mode:multiply;background:url("data:image/svg+xml;utf8,<svg xmlns=\'http://www.w3.org/2000/svg\' width=\'140\' height=\'140\'><filter id=\'f\'><feTurbulence baseFrequency=\'.9\' numOctaves=\'2\'/><feColorMatrix values=\'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .35 0\'/></filter><rect width=\'140\' height=\'140\' filter=\'url(%23f)\'/></svg>")}\n .top{display:flex;text-align:center;font-size:13.4px} .top>div{flex:1} .u{display:inline-block;border-bottom:1px solid #111;font-weight:700}\n .ref{display:flex;text-align:center;font-size:13.4px;margin-top:6px} .ref>div{flex:1} .ref .r{font-style:italic}\n h1{text-align:center;font-size:15.6px;margin:26px 0 18px} p{text-align:justify;text-indent:26px;margin:0 0 9px}\n .sig{display:flex;margin-top:20px} .sig .l{flex:1} .sig .r{width:290px;text-align:center;position:relative}\n .sig .nm{font-weight:700;margin-top:96px} .seal{position:absolute;left:4px;top:8px;width:166px;height:166px;opacity:.66;mix-blend-mode:multiply;transform:rotate(-17deg)}\n </style>\n <div class=\'sheet\'><div class=\'grain\'></div>\n <div class=\'top\'><div><b>{{issuer_parent}}</b><br><span class=\'u\'>{{issuer}}</span></div>\n <div><b>C\u1ED8NG H\xD2A X\xC3 H\u1ED8I CH\u1EE6 NGH\u0128A VI\u1EC6T NAM</b><br><span class=\'u\'>\u0110\u1ED9c l\u1EADp - T\u1EF1 do - H\u1EA1nh ph\xFAc</span></div></div>\n <div class=\'ref\'><div>S\u1ED1: {{number}}</div><div class=\'r\'>{{place}}, ng\xE0y {{day}} th\xE1ng {{month}} n\u0103m {{year}}</div></div>\n <h1>{{title}}</h1>\n <p>K\xEDnh g\u1EEDi: {{recipient}}.</p>\n {{{body}}}\n <div class=\'sig\'><div class=\'l\'><b>N\u01A1i nh\u1EADn:</b><br>- Nh\u01B0 tr\xEAn;<br>- L\u01B0u VT.</div>\n <div class=\'r\'><img class=\'seal\' src=\'{{seal_url}}\'><b>{{signer_title}}</b><div class=\'nm\'>{{signer}}</div></div></div>\n </div>\n```\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) \u2014 never a files field or a computed select. On one record it is\nhanded, too, the rows of each child the record draws as `rows` whose alias the\ntemplate names, listed under that alias for `{{#each <alias>}}` in place of the\nrecord\'s own link to them: every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. Over\nseveral rows the rows are listed under the entity\'s alias, for\n`{{#each <alias>}}`, without their child rows.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals |\n| `{{date issued_on}}` | `14/09/2026`; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\n## Rows\n\nFirst records, keyed by entity alias. Up to 200 rows per entity and 2000 across\nthe model, attaching at most 2000 documents between them \u2014 a real data set\nbelongs in an import, not a model.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `ref` | text | yes | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value | yes | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its entity. |\n| `rows.required` | A row states every field its entity requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.distinct` | Open rows of an entity a register lists read apart: no two state the same title and the same line under it, and an autonumber on the line reads every row apart. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<entity>:<ref>"` of a row of the linked entity in this file for a link, `"self"` for a member, a relative path beside the file or a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\nA `files` cell attaches documents: paths relative to this file (no `..`, never\nabsolute), which the check proves exist and `apply` uploads into the workspace\nbefore any row is written \u2014 a paperwork business seeds its papers with its\nrows. The server accepts only `fil_` ids of files this workspace owns, which is\nwhat the upload leaves behind. After a run that wrote rows, the WORKSPACE holds\nwhich record each row became, under the row\'s own `<entity>:<ref>`:\n`delete_records` over them is how a seeded set is reset, and applying again\nre-dates it.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `select_record_link` | `"<entity-alias>:<ref>"` naming another row in this file \u2014 `"customer:acme"`, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `select_member` | `"self"` only \u2014 the person applying the model |\n| `files` | paths beside this file \u2014 `["scans/pccc_letter.png"]` \u2014 uploaded by `model apply`/`setup` before the model is sent; or `fil_` ids of files already in this workspace |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe model is applied, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of each entity is RECOGNISED \u2014 once per entity, keyed by\nentity alias \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every entity an app lists, opens or picks has one.\n\n```jsonc\n"records": {\n "visit": {\n "title": "container_no",\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n },\n // A release order read against what it allows: a meter wherever it shows.\n "release": { "title": "release_no", "figure": "issued", "limits": { "issued": "units" } },\n // A dossier\'s stage is the last date it reached \u2014 no stored select.\n "dossier": { "title": "applicant", "status": { "milestones": ["received_on", { "field": "appraised_on", "when": { "kind": ["loan"] } }, "signed_on"], "closed": ["signed_on"] } },\n // A site owes a diary page each day it works, from breaking ground through handover.\n "site": { "title": "name", "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n}\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `title` | alias | yes | The field that names a row \u2014 the first thing every surface shows: who or what it is, a link naming it by the linked row (a job read by its customer). Any field but a button or a yes/no; the table\'s own setting, which every link to it shows |\n| `subtitle` | list of alias (1\u20132) | no | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): one line at a desk, wrapping to a second on a phone |\n| `image` | alias | no | A files field that pictures the row \u2014 never one an act keeps the document it makes in |\n| `mark` | alias | no | A single select whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. Never beside `image` or `party`, and never the status field |\n| `description` | alias | no | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` | no | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | no | The stage a row moves through \u2014 a single select or its milestone dates \u2014 drawn as a badge beside its title |\n| `figure` | alias | no | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | no | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | no | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | no | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | no | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue |\n| `frees` | alias | no | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | no | A yes/no of the row (stored, or a formula: an invoice paid in full) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A dashboard\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | no | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `cadence` | list of [Cadence](#cadence) (at least one) | no | The rows of a child each row owes one of a day, on the days of the week listed (a site\'s diary page, Monday to Saturday) \u2014 one entry a child, never owed on a day still to come. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | no | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n| `scan` | `"text"` \\| `"iso6346"` | no | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands |\n| `place` | [Place](#place) | no | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | no | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | no | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | no | Each row is a place on a picture (a spot on a container\'s drawing, a room on a plan): a record listing rows that link to these by a single link draws that picture over them, a numbered pin at each listed row\'s place, each row led by its number, the row opened lit on it and a pin pressed opening its row |\n\n#### Cadence\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entity` | alias | yes | The child entity owed: each of its rows stands on one row of this entity by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one) | yes | The days of the week one is owed on, each listed \u2014 `mon` to `sun` |\n| `from` | alias | no | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | no | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n\n#### Place\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `address` | alias | yes | A text field: the address, as people write it |\n| `latitude` | alias | yes | A number field: degrees north, negative south |\n| `longitude` | alias | yes | A number field: degrees east, negative west |\n| `accuracy` | alias | no | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `photos` | list of alias (at least one) | yes | Files fields of this row holding photos taken on site |\n| `place` | alias | no | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number | yes | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `on` | alias | yes | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias | yes | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias | yes | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an act keeps the documents it makes in (`into`). |\n| `records.mark` | `mark` is a single select, never the status field, and never beside `image` or `party` \u2014 a list keeps one lead slot \u2014 nor on the folder an app works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a section\'s too. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `today` a date or a moment (never a span), `me` a member \u2014 and an add that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, or a formula) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 lists each day of the week once, and `from` and `until` are two different days of this entity. |\n| `records.scan` | A title read off a photo (`scan`) is a text field the row stores. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.plan_place` | A `plan_place` names `kind`, `sheet` and `reach_from` as single selects, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image`, and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. |\n| `records.picture` | *Refused until adopted or declined:* Rows an app draws that each hold one files field no act makes, no call is filed into, no files block keeps and no list compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it \u2014 a code a\n person chose among them; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the entity says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, or the\nmilestone dates it reaches \u2014 drawn as a badge beside its title wherever the row is.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | no | The single select that is the row\'s state \u2014 or `milestones` instead |\n| `milestones` | list of (alias \\| [Milestone](#milestone)) (at least 2) | no | Dates in the order the work reaches them, instead of a stored select: the stage is the last one filled, ticking one stamps today, and clearing one clears every later one |\n| `closed` | list of alias (at least one) | no | Options (or milestones) that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `history` | alias | no | A child entity every status change appends one row to (its link to this entity, the new status, the moment and who) \u2014 written by the app\'s own writes, never a table automation; a row the model seeds opens it at its status, the day the rows land, unless the model states its rows; with `field` only |\n| `stages` | map of alias \u2192 [Stage](#stage) | no | Option alias \u2192 who owns that stage and how long it should take: the owner alone presses the acts offered there, refused on the server for anyone else. The status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it; with `field` only |\n\n#### Milestone\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A date field: the stage is reached on the day it holds |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | yes | The stage applies only while each named select holds one of these options, and each named stored yes/no is this value; otherwise the row skips it |\n\n#### Stage\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `owner` | text \\| [Stage role](#stage-role) | yes | Who owns the stage: a member field of the row, `link.field` read through a one-row link, or `{ role }` \u2014 a group |\n| `within` | integer | no | Whole days the stage should take from the moment the row entered it |\n\n#### Stage role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `role` | alias | yes | A role of the model\'s `roles`: every member of the group it binds to owns the stage |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, `closed` naming options of it \u2014 or its `milestones`. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.history-derived` | A `history` the model does not declare is derived and keeps one entity\'s moves, labelled by that entity ("L\u1ECBch s\u1EED <entity label>", or "<entity label> history"): no declared table holds that label, and the entity has no other field under the link it adds. |\n| `records.history-scope` | A status history reads by its record\'s `read_scope`, answered through its one-row link to the record within the links a row rule reaches \u2014 or it states its own. |\n| `records.milestones` | Milestones are dates a person ticks, each named once; `closed` names some of them, and a deadline (`due`) is never one. |\n| `records.milestone-add` | An add asks the first milestone at most \u2014 each after it is ticked in order. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link, or a declared role, on an option that does not end the work; a role\'s stage needs the status `history` with who moved the row. A status with stages moves only by acts that `set` one of its options \u2014 no save writes it, and no act asks it, sets it otherwise or writes it from a workflow \u2014 and the moment its row entered its stage is kept in `<status>_since`, derived beside it, which nothing else writes. |\n| `records.history-note` | *Noted, never refused:* A record, never a task, whose stored status an act of its app moves, with no `history`: when a row entered each status and who moved it is kept nowhere. |\n| `records.detour-note` | *Noted, never refused:* A stage the work only steps aside into \u2014 not where a row starts, entered from one step alone that also moves the work on without it, and left by its own moves only back to that step (a pause, a repair) \u2014 is a detour: its option and the section staged at it stand before that step\'s, else the work reads it as its next step, and the act moving the work into it leads that section \u2014 never a correction waiting in a \u22EF. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them. A `history` entity gets one row per move \u2014 its link to this\n entity, the new status (a select holding the same option aliases, or text), the\n moment and who \u2014 appended by the app\'s own writes that move the status, never by a\n table automation. A `history` the model does not declare is derived, and needs no\n `records` entry of its own.\n- **Milestones** are the alternative to a stored select: dates in the order the work\n reaches them, the stage being the last one filled (never stored). A milestone with a\n `when` applies only while its select holds those options and its stored yes/no that\n value; otherwise the row skips it.\n The record draws them as one block where ticking stamps today and clearing one clears\n every later one; every save and act re-checks that a date comes after each earlier one\n that applies. `closed` names the milestones that end the work. A register\'s add may ask\n the first milestone, never a later one; an act may stamp one, never clear it.\n\n## Write rules\n\n`write_rules` is what a WRITE meets, keyed by entity alias; each entity\'s is held\nby its table. Every generated write of an\napp (`create_<entity>`, `update_<entity>`, each act) re-checks these on the\nserver; the screen only mirrors them. An `options_where` holds beyond the apps:\nevery save of the link \u2014 the grid, a record\'s form, an import, a workflow, the\nAPI \u2014 is refused where it names a row the narrowing does not admit, and every\npicker of the link offers only the rows it admits.\n\n```jsonc\n"write_rules": {\n // A customer is RECOGNISED by their address. An add that names one \u2014 from the\n // customers register or from a picker\'s "new" \u2014 reuses the row it matches and\n // opens one only where nothing does, so the book never grows a second Acme.\n "customer": { "natural_key": ["email"] },\n "order_line": {\n "fields": {\n // A line of nothing is not a line. Refused on create and on update.\n "quantity": { "min": 1, "max": 9999 },\n // Shipped inside its order\'s window: a bound read off the row a link names\n // is held from both sides \u2014 moving the order\'s dates never strands a line.\n "ships_on": { "min": "order.placed_on", "max": "order.due_on" },\n // Nothing is sold off an empty shelf. Every picker of the link reads only\n // the rows that answer this, and every save refuses the same rows again.\n "product": {\n "options_where": {\n "node_type": "group", "logic": "and",\n "children": [{ "node_type": "condition", "type": "number",\n "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n },\n // One booking per room at a time, while it is held: a create or a save whose\n // span overlaps another held booking of the same room is refused.\n "booking": {\n "fields": { "ends_on": { "min": "starts_on" } },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n}\n```\n\n<!-- generated:start write-rules -->\n\n#### Entity write rules\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `natural_key` | list of alias (at least one) | no | The field aliases a row of this entity is RECOGNISED by. A write that names a row of this entity by these values reuses the row it finds, minting one only where nothing matches. |\n| `fields` | map of alias \u2192 [Field write rule](#field-write-rule) | no | Field alias \u2192 what that field\'s value is bounded by or picked among |\n| `no_overlap` | [No overlap](#no-overlap) | no | No two rows hold overlapping spans \u2014 a create or update that would is refused |\n\n#### Field write rule\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `min` | number \\| text | no | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | no | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n| `options_where` | [filter](#views) | no | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET entity\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | no | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both entities to the same entity. It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `suggest` | text | no | A text field whose control offers, as the reader types, the distinct values a text field of a catalog holds \u2014 `<entity alias>.<field alias>` (a damage position\'s code among the codes on file); any text is still written |\n\n#### No overlap\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | alias | yes | The stored date (or datetime) a row\'s span starts on |\n| `to` | alias | yes | The stored date (or datetime) a row\'s span ends on \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of alias (at least one) | no | Fields two rows share to compete for a span (the same employee, the same room); absent, every row |\n| `while` | map of alias \u2192 list of alias (at least one) | no | Only rows at these options of these selects hold their span (running, not closed); absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the entity\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number or a date \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names `<entity>.<field>`, a stored text field of a declared entity; the app reads that entity, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links this entity and the link\'s target both hold to one entity. |\n| `write.options-where` | `options_where` narrows a link by an `and` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap` | `no_overlap` spans two date fields; `by` names values rows share \u2014 a link, a person, one option, a text or a number; `while` names single selects by their options. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the entity\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `min` or `max` naming a field is read off the row as the save would leave it,\n and one naming `<link>.<field>` off the row the link names \u2014 the link\'s side\n re-checks its own rows when that bound moves.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both entities hold to one\n entity; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n moving what the two compare, on either row, is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the contract carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (\xA7 `text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## Apps\n\nAn app is ONE working register over one entity and the record each row opens, with the\nlogs that stand beside it (`logs`) \u2014 or a dashboard of readings. The author states COMPOSITION \u2014 which fields go where; the runtime owns\nhow each thing looks, one treatment per concept. Nothing is drawn that the app does not\nname, and each fact appears once on a record. What the vocabulary has no word for is an\nact\'s own `workflow`, or a workflow the app declares beside its acts (`workflows`).\n\n```jsonc\n"apps": [{\n "alias": "gate", "name": "Gate in and out", "entity": "visit",\n "register": { "columns": ["service"], "filters": ["customer", "service"] },\n "record": {\n "sections": [\n { "title": "In", "fields": ["customer", "service"], "blocks": [{ "rows": "fee", "columns": ["amount"] }] },\n { "title": "Out", "at": ["in_yard"], "fields": ["release", "seal"], "blocks": [{ "files": ["photos"] }], "acts": ["gate_out"] }\n ]\n },\n "acts": [{ "alias": "gate_out", "label": "Gate out", "when": { "stage": ["in_yard"] },\n "requires": ["release", "seal"], "set": { "stage": "gone", "left_on": "now" }, "confirm": true }],\n "checks": [{ "field": "unpaid", "blocks": ["gate_out"] }]\n}]\n```\n\nThe keys below are the app\'s own. Each part it composes is a page of its own: `model/logs`, `model/workflows`, `model/queries`, `model/register`,\n`model/layouts`, `model/tabs`, `model/export`, `model/readings`, `model/averages-and-bands`, `model/dashboards`, `model/record-page`,\n`model/blocks`, `model/composed-page`, `model/publish-desk`, `model/timeline-and-agenda`, `model/statements`, `model/reading-blocks`, `model/list-block`, `model/tasks`, `model/acts`,\n`model/papers-and-recordings`, `model/checks`.\n\n<!-- generated:start apps -->\n\n#### App\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The app\'s name within the model \u2014 what `--from model.json#<alias>` picks |\n| `name` | text | yes | The job, in the words of the people who do it |\n| `description` | text | no | What the job is for, in a sentence |\n| `icon` | text | no | A lucide icon name the launcher tile draws |\n| `theme` | [Theme](#theme) | no | The launcher tile\'s colour |\n| `labels` | map of alias \u2192 text | no | A field alias of the app\'s entity (a book\'s field lined up by alias takes it too) \u2192 the words this app\'s screens show for it. The column keeps its own name; each label is non-empty, has no `{` or `}`, and differs from every other field\'s shown label |\n| `entity` | alias | yes | The entity whose rows this job works \u2014 the register\'s rows |\n| `books` | list of [Book](#book) (at least one) | no | Other entities the register reads as one list with `entity`\'s rows, each opened, edited and acted on in its own table: the same app over each, its fields lined up with `entity`\'s. Only a table, cards or a plan |\n| `scope` | alias | no | A required one-row link of the entity: the app works inside one row of the linked entity at a time (a project, a branch), picked from a list of them, and every row it reads, counts and adds is that row\'s |\n| `reads` | `"shared"` | no | Every member reads every row, whatever the entity\'s read scope |\n| `writes` | `"children"` \\| `false` | no | `children`: the reader adds and edits the record\'s child rows but not the record\'s own fields. `false`: the reader adds, edits and deletes nothing in the app \u2014 no add, no save, no Delete. Either way the app\'s acts still move a record |\n| `row` | [Row display](#row-display) | no | How this job reads the entity\'s rows where it reads them otherwise than `records` (a cashier\'s figure is what is owed): the subtitle, figure and image stated replace the entity\'s wherever this app draws its rows \u2014 the register, a card, the record\'s header, a calendar, lane or roster entry. The title stays the entity\'s |\n| `register` | [Register](#register) | no | The rows: which columns and filters, the order, how a row is added |\n| `record` | [Record page](#record-page) | no | What a row opens: the door, its sections, and the Activity its head opens \u2014 its saves, and its comments where stated |\n| `acts` | list of [Act](#act) | no | What the reader does to a record \u2014 each a press with its conditions and its write |\n| `checks` | list of [Check](#check) | no | Formulas that warn while they stand, or refuse the acts and saves they name |\n| `logs` | list of [Log](#log) (1\u20133) | no | The lists that stand beside the app\'s register, at most 3: each over another entity, read as a log of what was brought into the register\'s rows or done to them (the files imported, the runs of a batch), with the page a row of it opens. Each is one more entry among the app\'s lists, picked on the line under the title beside the register\'s own rows and counting its rows at an open option of its stored status, and opens as a register of its own inside this app \u2014 its reads, acts and workflows the app\'s. Only the organization\'s own members are shown a log and may read or act on it: a visitor through a public link, and a member of another organization, is not. `reads: "shared"` lifts no row rule of an entity only a log reads. Each list keeps its own records\' activity (`record.activity`). No other app\'s link and no dashboard list opens a row in a log. Never over an entity whose status states owned `stages`; never in an app that states `scope` |\n| `workflows` | map of alias \u2192 [Workflow](#workflow) | no | Workflows of the app no act runs, by alias \u2014 called through the app (`run_app_workflow`, its API) by an agent or a service: each states what it takes and hands back, and its body is set on the app (`set_app_workflow`) and kept by every apply. The screen draws nothing for one |\n| `queries` | map of alias \u2192 [Query](#query) | no | Reads of the app no screen draws, by alias \u2014 called through the app (`run_app_query`, its API) by an agent or a service: each states the rows it reads, what narrows them and what a call may state. The screen draws nothing for one |\n| `declines` | map of text \u2192 text | no | Decided rules this app stays outside of, each with why in a line: by id, and `records.picture:<entity>` and `model.template-act:<template>` with what they fire on. Read by the apply\'s check alone, never by the app |\n\n#### Theme\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `color` | [colour](#select) | yes | The tile\'s colour |\n\n#### Row display\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `subtitle` | list of alias (1\u20132) | no | Up to two fields read under the title in this app, in place of the entity\'s |\n| `figure` | alias \\| `false` | no | The one number a row stands for in this app, in place of the entity\'s; a `limits` bound on it reads as its meter; false, the app draws none |\n| `due` | list of alias (at least one) \\| `false` | no | Dates that are deadlines in this app, in place of the entity\'s; false, the app counts none down |\n| `image` | alias \\| `false` | no | A files field that pictures a row in this app, in place of the entity\'s; false, the app draws none |\n| `status` | `false` | no | false: the rows\' stage is not this app\'s to show \u2014 no badge on a row or in its head, no status chips or counts \u2014 where the entity states one |\n\n#### Book\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entity` | alias | yes | Another entity whose rows the register reads beside its own \u2014 the same job over another table (a legacy ledger, a second branch\'s book) |\n| `fields` | map of alias \u2192 alias | no | A field of the app\'s entity \u2192 the field of this entity holding the same fact, where their aliases differ; a field the app reads lines up by its own alias otherwise, and one this entity lacks is blank on its rows and drops from what they open \u2014 an act, check or add needing it is not offered on them. Options line up by alias |\n\n<!-- generated:end apps -->\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.alias-unique` | An app\'s alias is unique among the model\'s apps, and an act\'s among its app\'s acts. |\n| `app.icon` | An app\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.theme` | An app states its launcher tile colour (`theme.color`); an app without one is drawn on a grey tile that tells it from no other. |\n| `app.labels` | An app\'s `labels` each name a field of the app\'s entity, say it in words that are not empty and hold no `{` or `}`, and differ from every other field\'s shown label. |\n| `app.records-entry` | Every entity an app lists, opens or picks \u2014 its own, a block\'s, a linked row\'s, a document\'s \u2014 has a `records` entry. |\n| `app.reads-shared` | `reads: "shared"` stands only where a table the app\'s register or its record reads states a `read_scope` \u2014 a table only a log reads keeps its rule. |\n| `app.writes-children` | An app that writes only the record\'s children (`writes: "children"`) adds no row of its own entity. |\n| `app.writes-none` | An app that writes nothing (`writes: false`) adds no row, so neither its register nor a block states a `create` list, and no block stands its lines `under` a document a person makes. |\n| `app.scope` | `scope` is a required one-row link of the app\'s entity, the same on every row the app lists \u2014 never a column, filter, search field, group, `where`, `opens`, section field or add question. |\n| `app.when` | A `when` holds single selects to options and yes/nos to `true` or `false`, stored or a formula of one (a formula with `options` is a select) \u2014 a milestone\'s `when` only a stored select or yes/no, read before any formula over it is computed. |\n| `app.asked-written` | What an add, an act or `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a section\'s field, an add\'s question or an act\'s ask: those rows are the record\'s own, read as a `rows` block. |\n| `app.create-asks` | An add asks fields of a table people write \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | An add (`create`) asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.books` | A register app\'s `books` each name another entity once \u2014 never the app\'s own \u2014 whose fields line up with the app\'s by alias, else by `fields` (a field the app reads, or one a report prints \u2192 one of the book\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each book holds the title, the status, the folder (`scope`), what `where` keeps and every check locking the rows; the register is a table, cards or a plan, whose `at`, `across` and `up` line up like any field. Two books holding a field of their own under one alias hold it as one kind of value. A report\'s `books` each name the app\'s entity or one of its books, once, and one of them holds each field its `where` and `per` narrow by. `register.book` reads a register that has books. |\n| `app.book-option-kin` | *Noted, never refused:* A book\'s option labelled as one of the app\'s, under another alias, reads apart from it: the register lists both and counts each on its own. |\n| `app.book-lacks` | *Noted, never refused:* A book lacking a field the app\'s record, an act or an add reads: what reads it drops from the book\'s rows \u2014 an act, a block, a section, the add. A field only a report prints, held by a book as another kind of value, prints blank on its rows. |\n| `app.rates-in-passing` | *Noted, never refused:* An app with no act of its own whose rows another app\'s lines copy a number off (`default_from` through a link) \u2014 the rates a quote is priced from \u2014 is worked only while that record is written: a block, a section or an act of that app, never an app of its own. |\n| `app.row` | An app\'s `row` states only what differs from `records`: a line that is not the title, a number for its figure, dates for its deadlines, a files picture no act makes documents into, or `false` for a figure, deadlines or picture the entity states and the app draws none of. |\n| `app.files-shown` | Every files field is drawn by some app over its entity \u2014 a section\'s `fields`, a `files` block, a column, the `image`, or where an act making its papers into it (`into`) stands, a section naming the act: the made paper reads under the act, one per template \u2014 or by an app reading its rows as one of its `books`, there by the book\'s own field. A files field no app should draw is left out of the model: the apply takes it off its table where no row holds a file in it and nothing reads it. |\n| `app.tasks` | *Noted, never refused:* A task entity an app lists whose rows no write of the app moves to a closed option (its ring stands disabled), or that an act ticks done and none moves back. |\n| `app.declines` | `declines` names decided rules that fire on the app, each with why the app stays as it is: by id, and `records.picture:<entity>` and `model.template-act:<template>`, said once per entity and per template, with what they fire on. |\n\n<!-- generated:end rules-app -->\n\n`writes: "children"` is a desk that adds and edits a record\'s child rows and never\nthe record itself; `writes: false` is a desk that reads \u2014 it adds, edits and deletes\nno row, its logs\' included, and only its acts write. `reads: "shared"` lifts every read scope the app\'s tables state \u2014\nrefused where none of them states one.\n\n`scope` names a required one-row link of the entity: the app works inside ONE row of\nthe linked entity at a time \u2014 a project, a branch, a season. With no folder remembered\nit opens on the list of them, each with how many of the app\'s rows it holds; inside,\nevery read, count and reading narrows to that one, an add files its row under it,\nand the record states its folder in the header. A scope narrows\nthe view; who may read what stays the entity\'s `read_scope`. The folder link is never a\ncolumn, a filter, a search field, a fact or an add\'s question.\n\nAn app whose job reads its rows otherwise than the entity\'s `records` restates them in\nits own `row` \u2014 the cashier\'s figure is what is still owed, its line the service and the\nday. The subtitle, figure and image it states replace the entity\'s wherever that app\ndraws a row of it; every other app reads `records`, and the title is the entity\'s.\n\n### Declines\n\nA rule the check marks *Refused until adopted or declined* is a treatment the apply requires unless the app\ndeclines it. The apply refuses an app missing one and hands it a patch stating it: merge the patch, or state in the app\'s `declines`\nwhy the app stays as it is, under the key the finding names \u2014 the rule\'s id, or `records.picture:<entity>` and\n`model.template-act:<template>` with what they fire on. A decline naming a rule that is not decided, or one no\nrows of the model could fire, is refused. Only the apply\'s check reads `declines`; the app never does. Which\ntreatment each rule stands for: the `design` reference.\n\n```jsonc\n"declines": { "register.span": "The yard plans by the day each hire is due back, never by its run of days" }\n```\n\n## Logs\n\n`logs` are the lists that stand beside the app\'s register: each over another entity, read as a log\nof what was brought into the register\'s rows or done to them \u2014 a supplier\'s price lists imported\ninto a catalogue of parts, the runs of a nightly batch \u2014 with the page a row of it opens. Here a\nline names its part by an optional one-row link, so a held line\'s part is picked where the line\nstands, and its old price is read against its new one.\n\n```jsonc\n"apps": [{\n "alias": "catalogue", "name": "Catalogue", "entity": "part",\n "register": { "columns": ["price"], "search": ["name", "code"] },\n "logs": [{\n "alias": "price_lists", "name": "Price lists", "entity": "price_list",\n "register": { "columns": ["read", "changed", "held"], "create": false, "remove": false },\n "record": { "door": "page", "sections": [\n { "title": "Held", "blocks": [{ "rows": "list_line", "where": { "outcome": ["held"] }, "columns": ["part", "why"],\n "compare": { "before": "old_price", "after": "new_price" }, "edits": ["part", "new_price"], "create": false }] },\n { "title": "Written", "blocks": [{ "rows": "list_line", "where": { "outcome": ["changed", "applied"] },\n "columns": ["part"], "compare": { "before": "old_price", "after": "new_price" }, "create": false }] }\n ] },\n "acts": [{ "alias": "apply_line", "label": "Apply", "of": "list_line", "when": { "outcome": ["held"] },\n "requires": ["part", "new_price"], "set": { "outcome": "applied" } }]\n }]\n}]\n```\n\nEach log is one more entry among the app\'s lists, picked on the line under the title (folding into one picker where its line cannot seat it), after one entry for the working register\'s own\nrows under the entity\'s label \u2014 counting the log\'s rows at an open option of its stored status; a log\nwhose entity states no status with `closed` options says no number, and a row holding no\nstatus is not counted. Picking the entry opens the log as a register of its own inside the\napp: its own columns, filters, search, order, add and pages, each row opening its own\nrecord with its sections, blocks and acts. Its reads, acts and workflows are the app\'s \u2014\none launcher tile, one roster.\n\n**Who reads a log.** The organization\'s own members, alone. A visitor through the app\'s\npublic link, and a member of another organization, is shown no entry for it, no address\nof it and no way into its rows, and its reads and acts are refused them. `reads: "shared"`\nis the app\'s statement of what its register and its record read: an entity only a log\nreads keeps its `read_scope`. Each list keeps its own records\' activity (`record.activity`)\n\u2014 a register stating `activity: false` shows none though a log keeps its own. A row of a\nlog opens from its own app: no other app\'s link, and no dashboard `list`, opens one there.\nThe designer\'s notes and decisions judge the app\'s register, never a log.\n\n**A log, or another app.** Decide it from the job. A list is a log of this register where\nits rows are what happened TO the register\'s rows \u2014 a file brought in, a batch run, a sync \u2014\nand are read by the same people in passing, to see what changed and to settle what could\nnot be placed. A list people work every day as a desk of their own \u2014 its own queue, its own\ndeadlines, its own people \u2014 is another app\'s register: a second working register is always\nanother app. The limits keep the difference:\n\n- at most three logs to an app, and none beside `scope`: a log reads every row of its entity;\n- a log is one list \u2014 a table or cards, no `tabs`, no `book` column, no `compose` \u2014 and\n states only its `alias`, `name`, `entity`, `register`, `record`, `acts` and `checks`;\n- its entity is never the app\'s own, one of its `books`\' or another log\'s, and never one\n whose status states owned `stages`: the rows waiting on a member are read off registers;\n- an act\'s alias is its own among the app\'s acts and its logs\';\n- no record of the app lists the rows of an entity another of its lists is over: a link to\n one of them opens it on its own list.\n\nA log\'s own rows are usually a claim of what the system did: state `writes: false` on the\nfields a workflow fills, `"create": false` and `"remove": false` on its register, and let\nits lines \u2014 which people do settle \u2014 be written in place (`edits`) and by their acts. An\napp stating `writes: false` writes none of its logs\' rows either: there, only acts write.\n\n<!-- generated:start apps-logs -->\n\n#### Log\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The log\'s name within the app \u2014 its place in the app\'s address, and unique among the app\'s logs |\n| `name` | text | yes | What the people who read the log call it, as its entry among the app\'s lists reads |\n| `entity` | alias | yes | The entity whose rows the log lists \u2014 never the app\'s own, one of its `books`\' or another log\'s |\n| `register` | [Register](#register) | no | The log\'s rows: which columns and filters, the order, how a row is added \u2014 a table or cards, with no `tabs` |\n| `record` | [Record page](#record-page) | no | What a row of the log opens: the door, its sections, and the Activity its head opens |\n| `acts` | list of [Act](#act) | no | What the reader does to a row of the log or to a child row its record lists \u2014 each alias unique among the app\'s acts and its logs\' |\n| `checks` | list of [Check](#check) | no | Formulas of the log\'s rows that warn while they stand, or refuse the acts and saves they name |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.logs` | A register app\'s `logs` \u2014 at most 3 \u2014 each list another entity under an alias of its own: never the app\'s own entity, one of its `books`\' or another log\'s. A log is one list \u2014 a table or cards, with no `tabs`, no `book` column and no composed record \u2014 over an entity whose status states no owned `stages`, and stands in an app that states no `scope`. An act\'s alias is its own among the app\'s acts and its logs\'. No record of the app or of a log lists the rows of an entity another of the app\'s lists is over: a link to one opens it on its own list. A list people work as a desk of its own is another app. |\n\n<!-- generated:end apps-logs -->\n\n## Workflows\n\nA job no press of the screen starts \u2014 an agent or a service handing the app a file, or a list of\nrows to reconcile a table against \u2014 is a workflow the app declares in `workflows`, by alias. The\nmodel states what it takes and what it hands back; a table is named by its entity and a select by\n`<entity>.<field>`, bound to this workspace\'s own at apply. The screen draws nothing for one: it is\ncalled through the app, by `run_app_workflow` or the app\'s API. On an app shared by a public link it\nruns only for someone who holds the app \u2014 a member it is shared with, or a key that reaches it \u2014 and a\nvisitor\'s call is refused as an alias the app does not have.\n\n```jsonc\n"workflows": {\n "reconcile_fees": {\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": {\n "service": { "type": "select", "field": "fee.service" },\n "amount": { "type": "number" }\n } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n }\n}\n```\n\nIts body is set on the app, never stated in the model: `set_app_workflow` with the app, the alias\nand the `source`, leaving `inputs` and `outputs` out \u2014 the body is checked against what the model\ndeclares. Every apply keeps that body and holds what it takes, what it hands back and its\ndescription to the model. To change what a workflow takes or hands back, change the model first:\nthe apply keeps the body where it still meets the change, and where it does not the workflow\nstands on no body again until `set_app_workflow` sets one that does.\nWith no body it refuses every call, and each apply says so. A workflow the model stops declaring is\narchived with its alias, as one bound on the app by hand that the model never declared is.\n\n<!-- generated:start apps-workflows -->\n\n#### Workflow\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `description` | text | yes | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | no | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | no | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n\n#### Workflow value\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"` | yes | What the value is |\n| `description` | text | no | What the value is for, read by whoever calls the workflow |\n| `required` | `false` | no | false: the value may be left out; absent, it is always there |\n| `multi` | `true` | no | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | no | The entity a `record_link` names a row of |\n| `field` | text | no | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of alias (at least one) | no | The values a `select` takes, where no field holds them |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | no | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | no | What each item of an `array` is |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.workflow-value` | A value a declared workflow (`workflows`) takes or hands back states what its type needs and nothing another type does: a `record_link` its `entity`, a `select` its `options` or the `field` holding them \u2014 never both \u2014 an `object` its `fields`, an `array` its `items`; `multi` stands on a `record_link`, `select`, `member` or `file`; an output is never a `member` or a `file`; and a value nests at most 8 deep. |\n| `app.generated-name` | A name the app generates is taken by nothing its model states. No declared workflow and no act\'s `workflow` is `record_activity` or `record_activity_undo`, unless the record states `activity: false`. No declared query, no reading\'s `alias` \u2014 a log\'s as it is read, `<entity>_<alias>` \u2014 and no tab\'s read (`<entity>_list_<tab>`) is the name of a read the app generates, of a declared query or of a reading. |\n\n<!-- generated:end apps-workflows -->\n\n## Queries\n\nAn app generates a query for everything its screen reads (`lotics docs agent_surface` lists them). A question\nthe screen never asks \u2014 one a caller asks the app through `run_app_query` or its API \u2014 is declared in\n`queries`, by alias, in the model\'s own aliases: the entity whose rows it reads, the fields each row\nreturns or the figure they add up to, and what narrows them.\n\n```jsonc\n"queries": {\n "fees_unbilled": {\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n },\n "fees_by_service": {\n "description": "What was charged per service: how many fees and their amount.",\n "rows": "fee",\n "reading": { "value": "amount", "by": "service" }\n }\n}\n```\n\nAn entry of `where` holds what a reading\'s `where` holds \u2014 a select\'s options, a yes/no\'s value, `"me"` on a\nmember field \u2014 or a value the call states: `{ "param": "<name>" }`, an object, which none of those is. A\nrequired param is always stated; one stating `required: false` may be left out, and the condition reading it\nthen narrows nothing. A query reads under its entity\'s read scope, as every read of the app does, and its\nown entity as its list reads it: kept by the register\'s `where`, and inside the row `scope` names \u2014 a param\nthe app adds to the query, `<linked entity>_id`. A `reading` returns one row for all the rows it reads, or\none per value of `by` or per day of `over`. The screen draws nothing for a query, and an apply compiles it\nwith the rest of the app: no body is set. An apply writes the queries the model compiles and no other:\na query set on the app outside the model (`set_app_queries`, on the CLI or in chat) is removed by the next apply, whose plan and\nanswer note it; declared under its alias in `queries`, it is the model\'s.\n\nA query reads one table: on an app that states `books`, whose list reads several, it names a book\'s own\nentity, never the app\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number\n\u2014 and never a number read in each row\'s own unit or currency, where one figure is a different amount on\neach row, nor a date holding a span.\n\nEvery reading of the app \u2014 a dashboard\'s, a register\'s band\'s, a record\'s block \u2014 is a query too, returning\nits groups. It is called by its place, `dashboard_reading_<n>`, `register_reading_<n>` or\n`block_reading_<n>`, counted from 0, so a reading moved is called by another name. One that states `alias`\nis called by it wherever it stands. A log\'s reading is called by the log\'s entity before either name:\n`<entity>_register_reading_<n>`, or `<entity>_<alias>`. A register\'s reading placed in time (`over`) takes `from` and `to`,\neach left out at will; one above a register with tabs reads its `tab`\'s rows, or every tab\'s where it\nstates none:\n\n```jsonc\n{ "metric": "visit", "value": "fees", "where": { "paid": false }, "label": "Unpaid", "alias": "fees_unpaid" }\n```\n\n<!-- generated:start apps-queries -->\n\n#### Query\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `description` | text | yes | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 [Workflow value](#workflow-value) | no | What a call states, by name, each read by an entry of `where` \u2014 a `number`, `boolean`, `date`, `select`, `record_link`, `member`, holding one. `required: false`: the call may leave it out, and the condition reading it narrows nothing |\n| `rows` | alias | yes | The entity whose rows it reads, under that entity\'s read scope unless the app reads `shared`. The app\'s own entity is read as its list reads it: kept by the register\'s `where`, and inside the row the app\'s `scope` names, which the call states |\n| `fields` | list of alias (at least one) | no | The fields each row returns, by alias. A query states `fields` or `reading`, one of the two |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"` \\| [Query param](#query-param) \\| [Query range](#query-range)) | no | Only the rows meeting every entry, by field: a select holding one of these options, a yes/no this value, a member field holding the reader (`"me"`) \u2014 or what the call states: `{ "param": "<name>" }` on a select, a yes/no, a one-row link, a member or a number, and `{ "from": { "param" }, "to": { "param" } }` on a date or a number, either end alone |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order the rows return in; absent, the order the entity\'s list reads in. Only with `fields` |\n| `limit` | integer | no | The most rows returned. Only with `fields` |\n| `reading` | [Query reading](#query-reading) | no | The rows counted or summed instead of returned: one row for all of them, or one per value of `by` or per day of `over`, each carrying its `by` field or `__day`, `__count`, and `__sum` where `value` is stated |\n\n#### Query reading\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged: summed over the rows holding one, beside how many hold one. Never with `by` or `over` |\n| `by` | alias | no | The single select, one-row link, member or yes/no each row is counted under \u2014 one row returned per value |\n| `over` | alias | no | A date: one row returned per day of it. Never with `by` |\n\n#### Query param\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `param` | text | yes | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | [Query param](#query-param) | no | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | no | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n#### A reading\'s name\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | no | On any reading \u2014 a dashboard\'s, a register\'s band\'s, a record\'s block: the name its query is called by (`run_app_query`), its own among the app\'s readings and queries; absent, its place names it \u2014 `dashboard_reading_<n>`, `register_reading_<n>`, `block_reading_<n>`, counted from 0 \u2014 so a reading moved is called by another name |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.query` | A declared query (`queries`) reads one entity\'s rows as `fields` or as a `reading`, one of the two \u2014 never the app\'s own entity where the app states `books`, whose list reads several tables; `sort` and `limit` stand with `fields`; a `reading` splits by `by` or by the day of `over`, never both, and averages only with neither; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.surface-described` | *Noted, never refused:* A value a declared workflow takes, and a param a declared query takes, that states no `description`: the one line a caller reads to fill it. |\n| `reading.alias` | A reading\'s `alias` is its own among the app\'s readings and declared queries, a log\'s read by its entity before it (`<entity>_<alias>`); the work against its plan above a register states none \u2014 it reads the register\'s own rows. |\n\n<!-- generated:end apps-queries -->\n\n## Register\n\n```jsonc\n"register": { "columns": ["service", "release"], "filters": ["customer", "service"], "create": ["container_no", "customer"] }\n```\n\nEach of `filters` is also an optional param of the register\'s list query, `<entity>_list`, typed as its\nfield: `customer_is` and `service_is` here, a date as `<field>_from` and `<field>_to`, a number as\n`<field>_min` and `<field>_max`. A call stating none of them reads every row the list reads. A filter on\na looked-up link or member, on a number read in each row\'s own unit or currency, on a date holding a span,\nand every filter of an app that states `books` is no param: a call narrows by those with `filters`.\n\n<!-- generated:start apps-register -->\n\n#### Register\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `columns` | list of alias | no | Fields read as columns after the row\'s title \u2014 on a calendar\'s entry or a lane\'s block, its facts after its title; never what the row draws itself (its subtitle, image, status, figure, or the bound its figure\'s meter reads against), which the runtime places. At most 5 besides the row\'s name, status, deadlines and figure: a table draws every column and folds the last stated onto the name\'s line as it narrows, so more is refused |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | no | The fields the reader narrows the rows by every day, in that order \u2014 each earns its place by that daily use, so none to 3 is normal and 3 is a cap, never a quota (a select, a member, a link, a date, a yes/no, a number as a range, or its `tiers` where the business narrows by those bands daily) \u2014 each on a desk\'s line; a phone\'s one Filters sheet holds them. Never the status (its chips); each a field the rows show \u2014 a column, or a part of the row \u2014 or a formula whose every field of its row it reads they show. A threshold the business names ("large orders") is a formula yes/no here; a column\'s header sorts by a day or an amount |\n| `book` | `true` | no | With `books`: a column naming the table each row is of, and a filter by it |\n| `search` | list of alias (at least one) | no | The fields the search box matches (a link by its row\'s title); a pasted list searches each line and names the lines no row matched. Absent, every word of the row |\n| `group` | alias | no | The field the rows open grouped by, the reader\'s grouping starting there \u2014 a period\'s rows read under each period, one per person; absent, ungrouped |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order rows open in: one key, or a list of keys most significant first, each breaking the ties of the ones before it (a select orders by its options\' order); absent, the first deadline soonest first, else the newest first |\n| `layout` | `"table"` \\| `"cards"` \\| `"calendar"` \\| `"roster"` \\| `"lanes"` \\| `"gantt"` \\| `"plan"` | no | `cards` for rows read by their picture; `calendar` for rows read by their day \u2014 a month, a week, a day or a list, an entry at its hour where its date holds one and over its span where its line holds a second date; `roster` for what each row did on each day of a week or a month (who worked which shift, which vehicle ran), or with `expect` which of a set each row holds; `lanes` for rows booked on a resource over time (an appointment in its chair, a hire on its machine); `gantt` for rows each planned over a run of days, one bar a row on one axis of time (a shipment from its sailing to its arrival, a hire from its start to its return, a task of a project) \u2014 its dates in `gantt`, its lanes the register\'s `group`; `plan` for things that stand at a place (items at their places) \u2014 drawn on a plan of the places, a bay\'s rows and tiers in its card, and in 3D \u2014 the place each stands at in `plan`; absent, a table |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the rows whose select holds one of these options and whose yes/no (stored, or a formula) is this value \u2014 read so on the server and never offered as a chip: the rows this app works of an entity other apps read whole (the purchases, of orders both ways). A row added here holds a select\'s one option and a stored yes/no\'s value |\n| `opens` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | The view the register opens on: each entry a narrowing on a field the rows show (or a formula of fields they show) that stands as a chip the reader may take away (the rows still owed), `"me"` a member field holding the reader (the rows mine). One on the status replaces the chips\' opening on the open work \u2014 `"me"` on a status whose `stages` have owners opens on the rows waiting on the reader |\n| `remove` | `false` | no | The app edits its records and offers no Delete on them (a row\'s \u22EF, its record\'s \u22EF) \u2014 a desk correcting a date of records another app makes and closes; absent, a record the app writes is deleted where it stands |\n| `create` | list of alias (at least one) \\| `false` | no | The fields asked when a row is added; absent, the title, the subtitle and figure no default fills, the natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `readings` | list of ([Metric](#metric) \\| [Breakdown](#breakdown) \\| [Trend](#trend) \\| [Pivot](#pivot) \\| [Progress](#progress)) (at least one) | no | Readings of the register\'s own entity above its rows, over the rows in view \u2014 the search, the status and the filters narrow them, but a picture\'s own field, read as the register opens on it. A press on a breakdown\'s part, a pivot\'s cell or a figure with `where` narrows the rows by its field, as a filter does |\n| `attention` | `false` | no | false: a table\'s or cards\' rows keep the register\'s own order (a first-come queue), and no column names whose step each row stands at; absent, those needing attention open first \u2014 those at a step the reader owns, then overdue, then due within 3 days, then those whose line states a warning \u2014 each part in that order, until the reader picks another |\n\n#### Tiered filter\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one) | yes | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Sort key\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | The field rows are ordered by |\n| `desc` | `true` | no | Latest or largest first; absent, soonest or smallest first |\n\n<!-- generated:end apps-register -->\n\n<!-- generated:start rules-register -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.column-drawn` | A column never names what the row draws itself \u2014 its title, subtitle, image, status, figure, or the bound its figure\'s meter reads against \u2014 and names a field once. |\n| `register.columns-budget` | A register\'s stated columns, each at the width of its kind, fit the room a desk leaves beside its name and the row\'s own status, deadline and figure. |\n| `register.filter` | A filter names a select, a member, a link, a date, a yes/no or a number of the register\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status (its chips), nor one `where` fixes. |\n| `register.filter-split` | *Noted, never refused:* A filter on a field a breakdown or pivot in the band splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `register.filter-unshown` | A filter, a narrowing the register `opens` on, and a press in its band (a breakdown\'s part, a pivot\'s cell, a figure\'s `where`) name a field its rows show \u2014 a column; the row\'s title, the line under it, its picture, status or figure, a meter\'s bound, or the unit or currency a drawn figure is read in; a deadline; a warning its line says; the group or lane it stands under \u2014 or a formula, drawn where every field of its own row it reads is (through other formulas too; one reading no field is drawn nowhere). A narrowing to the reader (`"me"`) needs none. |\n| `register.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `register.search` | `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `register.sort` | Each `sort` key names a field of the register\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `register.group` | `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 never the status (its chips); only a table groups, and a gantt into its lanes; grouping by the title needs a subtitle to lead each row. |\n| `register.readings-own` | A register\'s `readings` read its own entity; another entity\'s stand on a dashboard. |\n| `register.readings-bands` | A register reading that bands a number by `tiers` has that field with the same tiers among the register\'s `filters`: a press on a band narrows the rows by that filter. |\n| `register.readings-restate` | A register\'s metric never sums the row\'s figure or counts the rows without a `where`: the summary line totals the figure and the status chips count the rows. |\n| `register.where-opens` | `where` and `opens` hold the register\'s own selects and yes/nos, and `opens` a member field holding the reader (`"me"`) \u2014 or, on a status whose `stages` have owners, the rows waiting on the reader; a field `where` fixes is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. |\n| `register.band-pivot` | *Noted, never refused:* A pivot in a register\'s band: its grid reads on a dashboard, and the band leads with a `metric`. |\n| `register.headline` | *Refused until adopted or declined:* A register over rows that move (a status, a deadline) or carry money, laid out as a table, cards or a gantt, states `readings` \u2014 the patch splits the rows by a field they show and reads them over a date. |\n| `register.span` | *Refused until adopted or declined:* Rows that each span a run of days or hours \u2014 two dates on their line, a `frees`, or a `no_overlap` booking them on what its `by` links to \u2014 are drawn in time by some register over them (a calendar, lanes, a gantt or a roster) \u2014 the patch adds an app over them laid out as lanes on what each one books, else as a gantt. |\n| `register.remove` | A register\'s `remove: false` hides the Delete its records would offer, so it stands only where the app writes its records. |\n| `register.attention` | `attention: false` keeps a table\'s or cards\' rows in the register\'s own order \u2014 a first-come queue; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n\n<!-- generated:end rules-register -->\n\nThe status is always the chips, with\ncounts, opening on the rows not closed (every row on a calendar or a lanes board, whose\nwindow of time narrows them) \u2014 never one of `filters`. `filters` are the ones a reader\nnarrows by every day \u2014 none to three, never a quota \u2014 in order of use, each a field the\nrows show (a column, a part of the row) or a formula yes/no, drawn where every field of\nits own row it reads is drawn, at that width \u2014 each on the line\nwith the search and the chips, the grouping one\nchip at its end; a member filter offers "mine". A date filters by a range of days \u2014 of\nminutes on a `datetime` field, its end not held, so back-to-back shifts read each row\nonce \u2014 and can keep the rows holding no date too (in the yard at a moment: in before it,\nout after it or not yet). A number filters by a range typed in its\nunit or currency \u2014 a figure read in each row\'s own, in the one picked beside it \u2014 with a\nslider over a percent or a figure against a constant `limits`; `{ "field", "tiers" }`\noffers the bands its breakpoints cut in place of a range (`[1000, 5000]` on a weight in\nkg: under 1.000 kg, 1.000\u20135.000 kg, 5.000 kg and over), refused on a figure read in each\nrow\'s own unit. A threshold with a name is a formula yes/no, never a range. A\ncolumn the row already draws is refused. `sort` is one key or a list of keys, most\nsignificant first, each breaking the ties of the ones before it \u2014 a shipping line in its\nselect\'s option order, then the arrival day soonest first:\n`[{ "field": "shipping_line" }, { "field": "arrived_on" }]`; a header\'s press leads them.\nAbsent `sort`, rows open soonest deadline first where the row has a `due`, else newest first. `search` names the fields\nthe search box matches \u2014 a link by its row\'s title \u2014 and a pasted list searches each\nline, naming the lines no row matched; absent, it matches every word of the row.\n\n`where` keeps the rows the app works, read so on the server and never a chip: a\npurchase desk over orders of both directions states `"where": { "direction":\n["purchase"] }`, and a row added there is written holding the one option (a select kept\nat several is asked among them). `opens` is the view the register opens on, each entry a\nchip the reader may take away: a cashier opens on `"opens": { "owes": true }`. Both take\na select\'s options or a yes/no\'s value, stored or a formula; `opens` on the status is\nthe chips\' opening choice. `opens` also takes `"me"` on a member field \u2014 `"opens": {\n"assignee": "me" }` opens on the rows assigned to whoever reads, the server reading the\nreader, never the page; `where` refuses it, since it fixes the rows for every reader\n(who may read a row at all is the entity\'s `read_scope`).\n\nHow the rows are laid out is \xA7 Layouts, tabs over a period \xA7 Tabs, the report \xA7 Export, and the band above\nthe rows \xA7 Readings.\n\n## Layouts\n\n`layout` is how the register draws its rows \u2014 one of the pages below; absent, a table. Each reads what the\nrows already state (their `records` line, status and dates), and the keys a layout adds stand on its page.\nWhich one a job needs: the `design` reference.\n\n### Table\n\nAbsent `layout`, each row is one line: the entity\'s `records` entry \u2014 its picture or mark, title and the line under it\n\u2014 then the status, the `columns`, and the figure at the right; the title, the status and a column of days or\namounts sort the rows by their header. A table groups its rows by `group` (a gantt draws it as its lanes); a\ntable or cards reads `tabs` and `books`.\n\n### Cards\n\n`layout: "cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the app\'s\n`row.image`: its title and the line under it, its status and what needs the reader (a deadline, a warning),\nthen its figure and the register\'s `columns` at its foot. Cards are for rows found by their picture (a\nproduct, a vehicle, a damage photo); rows with no picture read better as a table.\n\n### Calendar\n\n`layout: "calendar"` places each row on its day \u2014 a month, a week, a day or a list (a\nphone reads the list or a day): at its hour where the date holds one, over its span\nwhere the row\'s line holds a second date after it, its line\'s other words and the\nregister\'s `columns` after its title. The calendar reads the window in view, and its\ncount and the status chips count that window, opening on every row.\n\n### Lanes\n\n`layout: "lanes"` with `lanes` naming a one-link draws each row of the linked entity as\na lane (a chair, a machine, a room), empty ones too, and each register row as a block\nfrom the first date on its line to the second: over the hours of one day where the first\nholds its hour, else over the days of one day, a week or a month. A block reads the row\'s\nname and the first of its `columns`; a free stretch between blocks adds a row there, its\nlane and its start set, and its end where the next block bounds it. A phone lists each\nlane\'s blocks and free stretches in clock order. Rows naming no lane stand first, in a lane\nof their own; where the app writes the link, each block moves to another lane from its menu.\nInside a folder (`scope`), the lanes are the ones whose own one-link names that folder \u2014 a\nbranch\'s rooms, never every branch\'s. A span\'s end holds its day unless `records` names it\nthe day the row `frees`.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each\nblock\'s number and reads it against the lane row\'s own, at most two. A lane holds its\nblocks while they stand, so it reads the most they add up to at one time in the window \u2014\na day\'s rows together \u2014 named, past its bound, by how much and on which day or at which\nhour. The two are in one unit, or two of one dimension (kg against t); a block then reads\nwhat it adds, and the move menu reads each lane as it would stand with the block on it.\nA bound a single row must keep (no parcel heavier than its van) is a `write_rules` `max`\nthrough the link, which refuses the move.\n\n<!-- generated:start apps-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `lanes` | alias | no | With `layout: "lanes"`: a one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty. A row is a block from the first date on its line to the second \u2014 within one day by the hour where the first holds one, else by the day over one day, a week or a month; a free stretch between blocks adds a row there, its lane, its start and the end the stretch reaches filled |\n| `loads` | map of alias \u2192 alias | no | With `lanes`: what a lane carries against what it holds, at most 2 \u2014 a number of this entity each block adds (a weight) to a number of the lane\'s row it is held within (a payload), in one unit or two of one dimension. Each lane reads the most its blocks add up to at one time in the window \u2014 a day\'s rows together \u2014 and names by how much and when a lane runs over |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.lanes` | `layout: "lanes"` and `lanes` go together: `lanes` is a one-row link to an entity with a `records` entry, the rows name a date on their line, a block\'s two ends are read alike (two days or two moments), and `loads` needs `lanes`. |\n| `register.loads` | `loads` names one to 2 numbers a block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension. |\n\n<!-- generated:end apps-lanes -->\n\n### Gantt\n\n`layout: "gantt"` with `gantt` draws each register row as one bar on one axis of time:\n`{ "start": "etd", "end": "eta", "milestones": ["cut_off"], "planned": { "end": "booked_eta" },\n"progress": "done", "after": "waits_on" }`. `end` defaults to the entity\'s first `due`, and an\nentity with neither is refused; `start` and `end` are two dates of the row, both days or both\nmoments, and each planned date is read as `start` is. `progress` is a percent (0\u2013100) \u2014 absent, a\nrow whose record lists its tasks fills to how many are done;\n`after` is a link to rows of the same entity, one or several, each ending before the row\nstarts. The bars stand in the lanes of the register\'s `group`. Where the app writes the\nrow and a person writes a bar\'s date, the bar is dragged through the row\'s save, which then\nwrites those two dates though no section places them; a computed date, one an act sets, or\nan app with `writes: "children"` drags nothing.\n\n<!-- generated:start apps-gantt -->\n\n#### Gantt keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `gantt` | [Gantt bar](#gantt-bar) | no | With `layout: "gantt"`: the dates and facts each row\'s bar is drawn from |\n\n#### Gantt bar\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | yes | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | no | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | no | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | no | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | no | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | no | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | no | The date the row was planned to start at |\n| `end` | alias | no | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.gantt` | `layout: "gantt"` and `gantt` go together: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each milestone another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end apps-gantt -->\n\n### Plan\n\n`layout: "plan"` draws things that stand at a place \u2014 pallets in a\nwarehouse \u2014 on a plan of the places. The places are the rows of an entity whose `records`\nstates a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet of the\nplan); `plan` names the one-link of the register\'s rows to a place and, for an item in a bay,\nthe row (`across`) and the tier (`up`) it stands in, counted from 1. A bay is drawn as its rows\nand tiers, an area with a count, a landmark as a labelled frame; the reader sees a plan, one\nbay enlarged, and the same plan in 3D. The register may read other tables as `books`: one plan\nof every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking\nit out (those above it where the place is `stacked`, and those in the rows between it and the side\n`reach_from` says the bay is taken from) \u2014 counted over every present row whatever the reader narrows by, so the list,\nits export and an agent\'s read all carry it; `<entity>_plan_load` counts the rows each place holds.\nA write that sets the place, row or tier is refused on the server unless it clears all three,\nor places the item at a free cell of a bay \u2014 resting on a present item where the place is\n`stacked`, a boolean of the place: racks, shelves, platforms and building floors state none and\nhold an item at any tier \u2014 or at an area. A plan opens on every row its `where` keeps, with no\nstatus chip narrowing it. On a desk a press opens a row\'s record in the panel beside the plan, whatever the record\'s `door`; a phone opens a sheet.\n\n```jsonc\n"records": { "bay": { "title": "code", "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } } }\n"register": { "layout": "plan", "plan": { "at": "bay", "across": "row", "up": "tier" }, "filters": ["line"] }\n```\n\n<!-- generated:start apps-plan -->\n\n#### Plan keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `plan` | [Plan](#plan) | no | With `layout: "plan"`: the place each row stands at, and in a bay its row and tier |\n\n#### Plan\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `at` | alias | yes | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias | yes | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias | yes | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | no | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | no | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; in books, the select is matched by option alias, and a book lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | no | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; in books, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A single select of this entity |\n| `option` | alias | yes | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A single select of this entity |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box) | yes | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `across` | number | yes | The box\'s width across the bay\'s rows |\n| `along` | number | yes | The box\'s depth along them |\n| `up` | number | yes | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `kind` | alias | yes | A single select, options aliased exactly `bay`, `area`, `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | no | A single select: the plan sheet it is on |\n| `x` | alias | yes | A number field: left edge, in cells |\n| `y` | alias | yes | A number field: top edge, in cells |\n| `width` | alias | no | A number field: an area\'s frame width, in cells |\n| `depth` | alias | no | A number field: an area\'s frame depth, in cells |\n| `across` | alias | yes | A number field: a bay\'s rows |\n| `up` | alias | yes | A number field: a bay\'s most tiers |\n| `reach_from` | alias | no | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | no | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | no | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `across` | alias | yes | A number field: the width of one cell across the rows |\n| `along` | alias | yes | A number field: the depth of one cell along the place |\n| `up` | alias | yes | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.plan` | `layout: "plan"` and `plan` go together: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan has no `tabs`, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `register.plan-mark` | A plan\'s `mark` names a single select of the row and an option of it by alias: a row holding that option says its label on its box and is hatched in the option\'s colour, which the legend names by its label. A book that holds the select must hold it as a single select with that option; a book lacking it never marks its rows (`app.book-lacks`). |\n| `register.plan-size` | A plan\'s `size` names a single select of the row and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box, any other at its place\'s cell. A book that holds the select must hold it as a single select; a book lacking it draws its rows at their places\' cells (`app.book-lacks`). |\n| `register.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end apps-plan -->\n\n### Roster\n\n`layout: "roster"` draws the register\'s rows down the side and the days of a week or a\nmonth across; `roster` names the entity whose rows fill the days \u2014 each stands on one\nregister row by its single link to it, and on the first date of its line (a shift on a\nperson\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s status, else the first single select on its line (a\nshift\'s kind), several rows their count; a week\'s cells say their words and one more\nfact of the line, a month\'s keep their marks. A day holding none stays empty: nothing\nwas due, which is never an absence. A filled cell opens its row; an empty one adds a row\nthere, the register row and the day set, asking what any add of it asks \u2014 unless no\napp writes those rows (`writes: false`). With `expect` (a single select of those\nrows) the columns are its options in place of days \u2014 a checklist of papers \u2014 and `of`\n(this entity\'s multi-select) names the ones each row expects: a gap among them reads as\none and adds its row, the others stand blank, and each row reads what it holds of them,\n`2/3`. Over days, a roster reads the `cadence` its entity\'s `records` states for its\nrows (a site\'s diary page, Monday to Saturday from breaking ground to handover): a past\nday owed with none is marked missing in the danger tone and counted, today\'s is still\ndue and offered to add, each row reads the days it holds of those owed, and the days\nthe cadence lists none on are quiet. A roster states no `columns` and needs no\n`readings`: its legend counts each state in view.\n\n```jsonc\n"register": { "layout": "roster", "roster": "run", "filters": ["operator"] }\n"register": { "layout": "roster", "roster": "diary_page" }\n```\n\n<!-- generated:start apps-roster -->\n\n#### Roster keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `roster` | alias | no | With `layout: "roster"`: the entity whose rows fill the days \u2014 one single link to this entity, and a date on its row line (`records` title or subtitle). A cell reads its row\'s status, else the first single select on its line, several rows a mark each, the cell read by the one latest in that select\'s options; a row whose line holds a second date after the first fills every day to it; a day with none stays empty, never an absence \u2014 unless this entity\'s `records` `cadence` owes one of them there |\n| `expect` | alias | no | With `roster`: a single select of the roster\'s rows whose options are the columns in place of days \u2014 each cell the row holding that option, read by its status, an empty one added there (a checklist of papers per case); the roster then has no period |\n| `of` | alias | no | With `expect`: this entity\'s own multi-select holding the options each row expects \u2014 its other columns stand blank on that row, never added. Its options are among `expect`\'s |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.roster` | `layout: "roster"` and `roster` go together: the roster\'s entity has one single link to this one and a date on its line, a roster draws no `columns`, `expect` needs `roster` and `of` needs `expect`. |\n| `register.roster-expect` | A roster\'s `expect` is a single select of its rows, and `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n\n<!-- generated:end apps-roster -->\n\n## Tabs\n\nA register reporting a period \u2014 what stands at its end beside what came and went during it (the stock, the\nhires out, the tickets open) \u2014 reads its rows as `tabs` over one `period` the reader picks above them: an\n`open` tab holds the rows open at the period\'s end, an `in` tab the rows dated within it, each with its count\nand each a sheet of the report. Never date chips set by hand, and never a tab per status, which the chips split.\n\n```jsonc\n"register": { "period": "month", "tabs": [\n { "tab": "in_yard", "label": "In the yard", "open": { "from": "arrived_on", "to": "left_on" } },\n { "tab": "arrived", "label": "Arrived", "in": "arrived_on" },\n { "tab": "left", "label": "Left", "in": "left_on" }\n] }\n```\n\n<!-- generated:start apps-tabs -->\n\n#### Tabs keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tabs` | list of [Register tab](#register-tab) (2\u20135) | no | The lists the register reads its rows as, each a tab with its count over one period the reader picks above them \u2014 the stock at its end beside the arrivals and departures during it, a report\'s sheets; each keeps the register\'s filters and search. Absent, one list. Not with a calendar, roster or lanes, which read their own window |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | no | With `tabs`: the period they open on \u2014 `today`, `week`, `month`, `quarter` or `year` so far, or `{ days }`, the last that many days through now (a night shift running past midnight reads two); absent, this month so far |\n\n#### Register tab\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tab` | alias | yes | The tab\'s name: its address, and the key its rows stand under in a report |\n| `label` | text | yes | What the tab holds, in the reader\'s words |\n| `in` | alias | no | A date (stored, or a formula): the tab holds the rows dated within the register\'s period, from its start through its last day, or up to its last minute \u2014 the arrivals of a period |\n| `open` | [Tab open](#tab-open) | no | The tab holds the rows open at the period\'s end: begun before it, and not ended by then \u2014 what is in stock, out on hire or still owed at that moment |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`"me"`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order this tab\'s rows read in, as the register\'s `sort`; absent, the register\'s |\n\n#### Tab open\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | alias | yes | The date a row begins on (stored, or a formula) |\n| `to` | alias | yes | The date a row ends on (stored, or a formula), empty while it is open |\n\n#### Period days\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `days` | integer | yes | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.tabs` | A register\'s `tabs` each name a tab of their own, never a key a report already holds; a tab\'s `in` and `open` dates are dates of its rows, `open`\'s two different; its `where` and `sort` hold as the register\'s do, and never narrow by the status, which its chips split. Only a table or cards reads tabs, and a band reading\'s `tab` names one of them. |\n\n<!-- generated:end apps-tabs -->\n\n## Export\n\n`export` saves the register as its report \u2014 the title, a line per chip, the search and\nthe moment it was exported, the readings, and every row in view, at most 20,000 of them.\n`export: true` saves it as a workbook, the readings on a sheet before the rows. A list\nstates the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the\nmoment it was made), `dates` (each date filter\'s `from` and `to` by field, a day or a\nmoment as the filter bounds the rows) and the rows under the entity\'s alias (an html one\nmade a PDF, an `excel` one a workbook; absent, the workbook). A report\'s `filename` names\nits file in the template grammar over the same keys but the rows \u2014\n`"Stock {{dates.arrived.to | format:\\"dd.MM.yyyy\\"}}"`; absent, the template\'s name, or\nthe label. A report of some rows (`where`), or of one value the reader picks (`per`: one\nline\'s file), is made of the register as those chips would narrow it; the screen keeps the chips and rows it shows.\n\n<!-- generated:start apps-export -->\n\n#### Export keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `export` | `true` \\| list of [Register report](#register-report) (at least one) | no | The rows in view saved as the register\'s report \u2014 its title, a line per thing narrowing the rows, the readings and every row: `true`, one workbook of the register\'s columns; a list, the reports a reader picks from one export menu |\n\n#### Register report\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `label` | text | yes | The report\'s name, in the reader\'s words \u2014 its entry in the export menu and its file\'s title |\n| `description` | text | no | What the report holds, under its name in the menu |\n| `template` | alias | no | A template filled with the report \u2014 `title`, `lines`, `readings`, `at` (when it was made), `dates` (each date filter\'s `from` and `to`, by field), `period` (the tabs\' `from` and `to`), `per` (the value picked), every row in view (at most 20,000) under the entity\'s alias, and each tab\'s under its name: an html one made a PDF, an excel one a workbook; absent, the workbook of the register\'s columns, a sheet per tab |\n| `filename` | text | no | The file\'s name, in the template grammar over one value each \u2014 `title`, `at`, `dates.<field>.from` or `.to` of a date filter, `period.from` or `.to` with tabs, `per` with a `per`, `lines \\| lookup:<n>` \u2014 `Stock {{per}} {{period.to \\| format:"dd.MM.yyyy"}}`; absent, the template\'s name, or the report\'s title |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | The rows the report is of, set on the register as the chips they are before its file is made \u2014 the screen shows what the file holds |\n| `per` | alias | no | A select, a member or a one-link the reader picks one value of from the menu \u2014 the rows narrowed to it, as its chip, and one file of that value |\n| `books` | list of alias (at least one) | no | The rows of these books only \u2014 each the app\'s `entity` or one of its `books`; absent, every book\'s |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.export-report` | A register\'s reports each have their own label; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `register.export-template` | A template an export fills reads at its root only `title`, `lines`, `readings`, `at`, `dates` and its rows under the register entity\'s alias \u2014 an entity named none of those \u2014 and is the document of no act. |\n\n<!-- generated:end apps-export -->\n\n## Readings\n\nA reading is one number, or one picture of numbers, over rows. Where it stands decides\nwhich rows: a dashboard reads every row, a register\'s `readings` the rows in view, a\nrecord\'s reading block the child rows under the record. The picture is the runtime\'s,\nchosen from what the reading means \u2014 no key picks a chart.\n\n```jsonc\n{ "metric": "visit", "value": "fees", "where": { "paid": false }, "over": "arrived_on", "label": "Unpaid" }\n{ "metric": "payment", "value": "days_to_pay", "average": true, "over": "paid_on", "better": "down", "label": "Average days to pay" }\n{ "metric": "payment", "value": "late_share", "average": true, "label": "Share paid late" }\n{ "breakdown": "visit", "by": "line" }\n{ "trend": "visit", "over": "arrived_on", "value": "fees" }\n{ "pivot": "visit", "rows": "size", "columns": "line" }\n{ "breakdown": "invoice", "by": { "field": "days_late", "tiers": [1, 31, 61] }, "value": "owed" }\n{ "pivot": "invoice", "rows": "supplier", "columns": { "field": "days_late", "tiers": [1, 31, 61] }, "value": "owed" }\n{ "list": "visit", "where": { "stage": ["in_yard"] }, "columns": ["line"], "app": "gate", "label": "In the yard" }\n{ "list": "task", "where": { "assignee": "me" }, "label": "My tasks" }\n{ "progress": "work_item", "planned": { "start": "plan_start", "end": "plan_end" }, "done": "complete",\n "finished": "accepted_on", "measured": { "rows": "logged_qty", "on": "day", "share": "share_of_item" },\n "weight": "value", "label": "Progress against plan" }\n```\n\nA reading\'s `alias` names the query it is read by (`model/queries`).\n\nA reading\'s `where` keeps rows by a select\'s options, a yes/no\'s value, or `"me"` on a\nmember field \u2014 the rows that name whoever reads, read so on the server.\n\nA metric averaging its `value` (`average: true`) and a split by a number\'s `tiers` are\n`model/averages-and-bands`.\n\n`progress` reads one parent\'s work against its plan \u2014 a register\'s band over a folder, or a record\'s\nblock \u2014 never a dashboard\'s every row: the share of the work planned and the share done, cumulative day by\nday, today\'s two at its foot. Each row is a part of the work, its plan spread evenly over its planned days\nand weighing its `weight` (its value) or, absent, its planned days. Its share done today is `done`, a\npercent the server computes; on an earlier day, its `done` from its `finished` day on, before it what its\n`measured` rows add up to by then \u2014 each row\'s own share of it, a percent the server computes.\n\n<!-- generated:start apps-readings -->\n\n#### Metric\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `metric` | alias | yes | The entity whose rows are counted, or summed, into one number |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged, not summed: its sum over the rows holding one, divided by how many hold one \u2014 a row holding none is no part of it. Under a period each period reads its own average, and its change compares two averages; where no row holds one it reads no figure, never 0, and no change. A share is an average too: a number formula that is 100 on the rows that count and 0 on the others, in percent notation, reads as the share of rows that count |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `target` | number | no | The number it is read against, where no `limits` bounds its value (a bounded value is read against the sum of its bound) |\n| `better` | `"up"` \\| `"down"` | no | Which way its change over the recent periods `over` reads is good; absent, a sum\'s rise and a count kept by `where` falling |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n\n#### Breakdown\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `breakdown` | alias | yes | The entity whose rows are split into parts |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) each row is counted under \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the `by` field\'s label |\n\n#### Trend\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `trend` | alias | yes | The entity whose rows are counted, or summed, per period |\n| `over` | alias | yes | The date each row falls on \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link |\n| `ahead` | `true` | no | Counts forward: the current period first, then the ones after it, over the rows dated today or later (arrivals by their ETA); absent, the periods up to today |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the value\'s label, else the entity\'s |\n\n#### Pivot\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `pivot` | alias | yes | The entity whose rows are counted, or summed, in a grid |\n| `rows` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) down the side \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `columns` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) across the top \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the two fields\' labels |\n\n#### Progress\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `progress` | alias | yes | The entity whose rows are the parts of the work, read as the share of it planned and the share done, day by day |\n| `planned` | [Progress planned](#progress-planned) | yes | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | yes | A number of the row the server computes: its share done today, in percent (0\u2013100) |\n| `finished` | alias | no | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `measured` | [Progress measured](#progress-measured) | no | Before a row is finished, its share done on a day is what these add up to by then, never past its `done`; absent, a row stands at nothing until it is finished, and at its `done` today |\n| `weight` | alias | no | A number of the row: what it weighs in the whole \u2014 its value, its share of the contract; a row holding none weighs nothing. Absent, each row weighs its planned days |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n\n#### Progress planned\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | yes | A date of the row: the first day of its planned work |\n| `end` | alias | yes | A date of the row: the last day of its planned work |\n\n#### Progress measured\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | The entity whose rows record the work as it is done, each through its one-row link to a row of the reading |\n| `on` | alias | yes | A date of those rows (their own, or a lookup): the day each records its work |\n| `share` | alias | yes | A number of those rows the server computes: the share of its row each adds, in percent |\n\n#### List\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `list` | alias | yes | The entity whose rows are listed, each in its `records` anatomy |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `columns` | list of alias | no | Fields read after each row\'s title |\n| `app` | alias | no | An app of this model over the same entity that works its rows: a dashboard row opens there, a record\'s list row has "Open in" to it |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n\n<!-- generated:end apps-readings -->\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A reading sums a number, never a percent \u2014 percents do not add up; a metric\'s `average` reads one. |\n| `reading.average` | `average` averages a metric\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by`, `rows` and `columns` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a pivot crosses two different fields. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s `where` keeps rows by a select\'s options, a yes/no\'s `true` or `false`, or a member field holding the reader (`"me"`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.list-app` | A list\'s `app` is a register app of this model over the list\'s own entity. |\n| `reading.progress` | The work against its plan reads dates of its rows for `planned` and `finished`, a number for `done` and `weight`, and rows `measured` through a one-row link to them, by a date of theirs and a number of theirs. |\n\n<!-- generated:end rules-reading -->\n\nA reading counts its rows, or sums the number `value` names \u2014 never a percent. `by`,\n`rows` and `columns` split the rows by one value each: a single select, a one-row link,\none member, or a yes/no \u2014 stored or a formula, its parts read as its label and the\nothers. `over` is a date, the row\'s own (stored or a formula) or its parent\'s through a\nlookup over a one-link: a trend\'s periods, a metric\'s recent periods beside its number,\nand what a dashboard\'s period windows. `ahead: true` reads a trend forward from the\ncurrent period over the rows still to come. `where` keeps rows whose select holds one\nof the options, or whose yes/no is the value, every entry ANDed \u2014 a band leads with the\njob\'s exception as a formula\'s yes/no (what is late, what is short; drawn by the fields it reads), never a stage the\nstatus chips already count. A metric summing a value `limits` bounds reads against the\nsum of its bound (`10 / 14`); `target` reads one against a number nothing bounds. A\nmetric\'s change is green where it moves the good way: a sum\'s rise, a count kept by\n`where` falling; `better` states the other way where that reads wrong \u2014 money going out\n(`"better": "down"`). A register reads only its own entity; a `list` stands on a\ndashboard, or in a record\'s `blocks` (\xA7 List block).\n\n`readings` read the register\'s own rows above them: the rows in view, so the search,\nthe status and the filters narrow each one, but a picture\'s own field, which it reads as\nthe register opens on it. A table, cards or a gantt over rows that move or carry money states\nthem (`register.headline`); elsewhere they stand where a picture answers something the rows\ncannot. They stand under the title in one compact\nband: lead with the job\'s headline number (a `metric`), then at most the mix (a\n`breakdown`) and the movement (a `trend`) \u2014 a `pivot` stands under the band as a whole table, every line and its totals, and a\n`breakdown` by a number\'s `tiers` of three breakpoints or more under it too, every band a bar. A picture\nstands only where it splits the rows in view into two parts or more, one of them\nholding two rows or more; a split whose rows\nall fall in one part, and a lone figure with no picture beside it, are said on the\nsummary line instead, so a band stands only holding a picture or two figures. The summary line already totals the\nfigure over the rows in view and the status chips count them, so a `metric` summing the\nfigure, or counting the rows of an entity with a status, is refused unless its `where`\nnarrows it.\n\n## Averages and bands\n\nWhat a [reading](#readings) averages, and how it splits its rows by a number.\n\nA metric\'s `value` is summed; with `average: true` it is averaged \u2014 its sum over the rows the reading\nkeeps, divided by how many of them hold a value, so a row holding none is no part of it. It reads in the\nvalue field\'s own notation, and a figure each row reads in its own unit averages per unit as it sums per\nunit. Under a dashboard\'s period it is the average over the period so far, its shape each recent period\'s\nown average, and its change this period\'s average against the one before\'s \u2014 never a sum of averages.\nWhere no row holds a value there is nothing to average: it reads a dash, never 0, with no change against\nthe period before, and a period holding no row is no point of its shape. A\nplain `target` is the number it is read against; a value `limits` bounds is refused, since its bound is a\nsum.\n\nA share is an average too, so it takes no key of its own: a number formula that is `100` on the rows\nthat count and `0` on the others (`if({paid_on} > {due_on}, 100, 0)`), in percent notation, averaged, is\nthe share of rows that count \u2014 "share paid late". A percent is averaged, never summed. Only a `metric`\naverages: a `breakdown`, a `trend` and a `pivot` count their rows or sum `value`.\n\nA breakdown\'s `by` and a pivot\'s `rows` and `columns` each take, in place of a field, a number by its\n`tiers` \u2014 `{ "field", "tiers" }`, the shape a register\'s [tiered filter](#tiered-filter) takes \u2014 and\nsplit the rows by the bands those breakpoints cut: under the first, from each up to the next, from the\nlast up, a figure on a breakpoint in the band above it. `[1, 31, 61]` over days late reads not due,\n1\u201330, 31\u201360 and over 60 \u2014 the aged report, parties down the side and the bands across. Every band is\ndrawn in the bands\' own order, one holding no row at zero, never ranked by size; each is worded in the\nfield\'s own notation, as the filter\'s chip words it, and rows holding no number stand apart. A band of a\nfigure whose definition makes every value whole \u2014 a rollup that counts, a formula that is\n`differenceInCalendarDays(later, earlier)` \u2014 cut at whole breakpoints reads to the last one it holds, so\nno figure stands in two bands\' words; every other figure, a stored number of days or of a counted noun\ntoo, reads between its breakpoints, since it may hold 14.5. The number is stored, a formula or a rollup, or a lookup of one through\none-row links, read in one unit on every row. On a register a band is a door: a press\nnarrows the rows to it through the filter of the same field and tiers, which the register\'s `filters`\nstate too \u2014 the rows holding no number are no band, so no door; on a dashboard and in a record\'s block\nit opens nothing. A register\'s band seats four bars:\na split by one or two breakpoints stands in it, and one by three or more stands whole under it, as a\npivot does, so every band keeps its bar and its name.\n\n## Dashboards\n\nA dashboard is `{ "alias", "name", "dashboard": [readings] }` with no entity, register\nor record: each reading reads every row of its entity, and one period the reader picks\nat the title \u2014 this month, last month, this or last quarter or year, or any days \u2014 windows\neach reading placed in time: one still running so far, one that closed whole, its change\nread against the period before it. A reading placed in no time reads the rows as they\nstand now, and its head says so. `period` is the one it opens on; absent, the month. A\ntrend holding few periods so far is led in by the ones just before it, so no period opens\non one bar.\n`tabs` (2 to 5, each `{ "tab", "label" }`) split a long dashboard into sheets: every\nreading then states the `tab` it stands under, a strip under the title picks one (the first\nopen), and only its readings are drawn. A reading is called by the same name with or without\ntabs. A `list` reading lists rows, each opening in its `app`. The readings answer the one\nquestion the dashboard\'s owner asks, in the order they ask it \u2014 rows to act on lead where\nthe answer is rows; no order of kinds is the rule.\n\n```jsonc\n// The depot owner\'s morning question: which boxes are past their free days, whose are they, is it growing?\n{ "alias": "overview", "name": "Depot overview", "dashboard": [\n { "list": "visit", "where": { "overdue": true }, "columns": ["line"], "app": "gate", "label": "Past free days" },\n { "breakdown": "visit", "by": "line", "where": { "overdue": true }, "label": "Past free days by line" },\n { "trend": "visit", "over": "arrived_on", "where": { "overdue": true }, "label": "Past free days, by arrival" }\n] }\n```\n\n<!-- generated:start apps-dashboard -->\n\n#### Dashboard app\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The app\'s name within the model \u2014 what `--from model.json#<alias>` picks |\n| `name` | text | yes | The job, in the words of the people who do it |\n| `description` | text | no | What the job is for, in a sentence |\n| `icon` | text | no | A lucide icon name the launcher tile draws |\n| `theme` | [Theme](#theme) | no | The launcher tile\'s colour |\n| `reads` | `"shared"` | no | Every member reads every row, whatever the entity\'s read scope |\n| `dashboard` | list of ([Metric](#metric) \\| [Breakdown](#breakdown) \\| [Trend](#trend) \\| [Pivot](#pivot) \\| [List](#list)) (at least one) | yes | The readings, in order \u2014 each over every row of its entity, windowed by the one period the reader picks |\n| `tabs` | list of [Dashboard tab](#dashboard-tab) (2\u20135) | no | The sheets the readings stand on, a strip under the title, the first open: each reading of `dashboard` then states the `tab` it stands under, and only the open tab\'s readings are drawn and read. Absent, every reading stands in one grid |\n| `period` | `"month"` \\| `"quarter"` \\| `"year"` \\| [Dashboard period days](#dashboard-period-days) | no | The period the dashboard opens on, before the reader picks another \u2014 `month`, `quarter` or `year` so far, or `{ days: 30 }`, the last 30 days through today; absent, this month so far. Needs a reading placed in time by `over` |\n| `workflows` | map of alias \u2192 [Workflow](#workflow) | no | Workflows of the app no act runs, by alias \u2014 called through the app (`run_app_workflow`, its API) by an agent or a service: each states what it takes and hands back, and its body is set on the app (`set_app_workflow`) and kept by every apply. The screen draws nothing for one |\n| `queries` | map of alias \u2192 [Query](#query) | no | Reads of the app no screen draws, by alias \u2014 called through the app (`run_app_query`, its API) by an agent or a service: each states the rows it reads, what narrows them and what a call may state. The screen draws nothing for one |\n\n#### Dashboard tab\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tab` | alias | yes | The tab\'s name: its address (`?tab=`), and what each reading\'s `tab` names |\n| `label` | text | yes | What the tab holds, in the reader\'s words |\n\n#### Dashboard period days\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `days` | `30` | yes | The last 30 days through today \u2014 the one span of days a dashboard opens on |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.period` | A dashboard\'s `period` is the one it opens on, and its period stands only over a reading placed in time by `over`. |\n| `reading.tabs` | A dashboard\'s `tabs` each name a tab of their own, and every reading of its `dashboard` states the `tab` it stands under: a tab no reading names, a reading naming a tab not declared, or one naming none is refused; without `tabs`, no reading states a `tab`. |\n\n<!-- generated:end apps-dashboard -->\n\n## Record page\n\n```jsonc\n"record": {\n "door": "page",\n "sections": [\n { "title": "Details", "fields": ["size", "line", "built_on"] },\n { "title": "Gate in", "at": ["arriving", "in_yard"], "fields": ["arrived_on", "truck"],\n "blocks": [{ "rows": "fee", "where": { "leg": ["in"] }, "expect": "kind", "columns": ["amount", "paid_by"] }],\n "acts": ["gate_in_paper"] },\n { "title": "Sell to a buyer", "description": "Moves the container to the buyer\'s stock once it has left.", "acts": ["sell"] }\n ]\n}\n```\n\n<!-- generated:start apps-record -->\n\n#### Record page\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `door` | `"page"` \\| `"drawer"` \\| `"beside"` | no | A page for work read at length; a drawer for rows worked one after another from the register; `beside` for rows worked one after another while the list stays in view \u2014 the register\'s list and the open record side by side, over a table register alone. Each stacks its sections, and from three sections on navigates them \u2014 a page by a rail, a drawer by a strip pinned over its scroll; absent, a page where a section has `at` or is a `page`, the record has more than three sections or one stands beside the rest (`side`), else a drawer |\n| `sections` | list of [Section](#section) (at least one) | no | The record in the order its work reaches it \u2014 each section its fields, then its blocks, then its acts. Absent, one section of every field a person writes that no other place shows |\n| `comments` | `true` | no | People comment on the record: its comments \u2014 who wrote what and when, with a composer \u2014 stand in its Activity, opened from its head; stated only where the job\'s people discuss a record or the owner asks for one. Absent, no one comments |\n| `history` | `true` | no | Draws nothing of its own: the record\'s Activity shows every move of the status as a change, when and who \u2014 refused beside `activity: false`, which shows the moves nowhere; noted beside Activity, and refused there in a later release. The entity\'s `status.history` is written either way |\n| `activity` | `false` | no | false: the app\'s records show no activity \u2014 the door in each record\'s head and the panel of its saves and comments beside it; where `comments` is stated, the door opens the comments alone. Absent, every record shows it |\n| `compose` | [piece](#composed-page) | no | The record\'s page stated as a tree of finished pieces instead of `sections`, on a page door \u2014 for a page that is its own arrangement of what the app already states: each node names a piece of the catalog (`use`) and binds by name to a field of the entity, an act of the app or a child entity; it holds no condition and no computed value |\n\n#### Section\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `title` | text | yes | What the section is, in the reader\'s words \u2014 its heading, and its name on the record\'s rail or tab |\n| `description` | text | no | One sentence under the title: what the section is for, or what its act does |\n| `at` | list of alias (at least one) | no | Options of the record\'s status (or its milestones) during which this section is the work now \u2014 a step of the path the record moves through: its rail item reads now while the status holds one and this app has work there, done once the record\'s history says it went through one \u2014 or it is a step of the path before where that history opens (with none, where the record stands) that no act moves the work past \u2014 and it stands before the section that is the work now, and waiting otherwise; a section every option of which ends the work, past the path\'s end or entered by its own act, is an exit: no item and nothing drawn until the record stands in it, then set apart after the steps and never one; A page opened from the register opens at it. It never locks what the section holds: its fields are written as the write rules and checks allow at any stage. An act it names is offered during these alone: its `when` holds the status to them, or on milestones it stamps the step after one of them \u2014 a detour and an exit are sections of their own, a detour stated before the step it returns to |\n| `fields` | list of alias (at least one) | no | The record\'s own fields in this section, in the order they are read \u2014 never one the header draws: the row\'s title, subtitle, image, status or figure |\n| `blocks` | list of [block](#blocks) (at least one) | no | What the section holds besides its own fields, under them, in order |\n| `acts` | list of alias (at least one) | no | Acts of this app drawn under the section\'s fields, their asks as more of them and what each lacks said above its button; the header draws no act, so every act of the record itself is named by one section \u2014 an act of a child (`of`) stands on the child\'s row and is never named here. Where a status move stands is `record.move-home`\'s \u2014 an exit\'s, in the header\'s \u22EF. A correction \u2014 `danger` and not one of its step\'s outcomes (no other status move offered at the same moment) \u2014 waits in the section heading\'s \u22EF, and one no section names in the header\'s \u22EF; every other act is named by a section |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n| `side` | `true` | no | The section the rest are worked from, drawn in a pane beside them rather than in their scroll \u2014 the photos looked at, the pool picked from, the paper typed off; at most one on a record, which opens on a page door. It holds what any section holds |\n| `page` | `true` | no | A page of its own, off the record\'s scroll: its own heading and a way back, reached from the record\'s rail after the scroll\'s sections, or from a link at its place where the record has no rail \u2014 for what makes the record worse stacked in it: a long list of related rows, a workspace of its own. Only on a page door, never a step (`at`). Holding only one `text` block over a markdown field, it reads as a document: a 680px column, saved as it is written \u2014 whether it is saved said at its foot |\n\n<!-- generated:end apps-record -->\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A field, a block and an act each stand once on a record: the header draws the title, subtitle, image, status (or milestones), figure and folder, and a field\'s one other place is a section\'s `fields`, a files, text or statement block \u2014 save the image, which one files block may draw again, whole, the figure, which a statement draws as what it comes to, and rows one list prices and another compares (`compare`); two places whose `when`s never hold together (a select at options the other\'s lacks) each draw it. |\n| `record.foot-total` | A rows block\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also one of a section\'s `fields`. |\n| `record.fact-restates` | A section\'s field never looks up what its link already reads where it stands: the linked row\'s title beside the link, the figure or bound its meter reads on the header\'s line. |\n| `record.section-holds` | A section holds fields, blocks or acts. |\n| `record.sections` | *Refused until adopted or declined:* A register laid out as a table, cards or a gantt states its record\'s `sections` \u2014 the patch holds the fields people write, a files block per paper, a block per child and the record\'s acts. |\n| `record.header-budget` | *Refused until adopted or declined:* A record\'s head says what the row is and where it stands \u2014 its title, line, picture and status \u2014 and at most two more facts, one of them a deadline at most; the rest stands in a section, unless the app declines with why its job reads more at a glance. |\n| `record.children` | *Refused until adopted or declined:* An entity some app records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a block on its record, a roster of them, lanes of them by that link, or an app over them working in one of its rows at a time (`scope`) \u2014 the patch lists each under the record. |\n| `record.at` | `at` names options of the record\'s stored status, or its milestones; a record with no status has no steps. |\n| `record.at-once` | A stage is the work of one section: two sections naming one option of the status, or one milestone, in `at` hold some field to values apart in their `when` \u2014 a `when` holding the status keeps its section off the options it leaves out. |\n| `record.section-page` | A section is a `page` only on a page door \u2014 never a drawer\'s or one beside the list \u2014 and never a step (`at`), its title naming an address no other page shares (a letter or a digit at least), and never every section. |\n| `record.side` | At most one section stands beside the rest (`side`), on a page door, and never also a page of its own. |\n| `record.beside` | A `door: "beside"` record opens beside a table register \u2014 never a board, cards or a calendar, which draw no list to stand beside. |\n| `record.history` | `record.history` names a status history the entity records (`status.history`), on a record whose Activity is on \u2014 its Activity shows each move, so beside `activity: false` the key draws nothing; no block reads that history. |\n| `record.history-activity` | *Noted, never refused:* `record.history: true` beside a record whose Activity is on: Activity shows every status move as a change already, so the key adds nothing \u2014 a later release refuses it. |\n| `record.section-acts` | A section\'s `acts` name acts of the record itself: an act of a child (`of`) stands on the child\'s row, and one over the register\'s rows (`on`) on the register. |\n| `record.act-in-section` | Every act of the record stands in the `acts` of the section whose work it is; only a correction no section owns \u2014 `danger`, and no other status move offered at the same moment \u2014 or an act an agent runs for the person (a `workflow` or an `intake` moving no status), left off every section, waits in the header\'s \u22EF. |\n| `record.move-home` | A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step it passes anyway; one offered at several steps, or moving back into a detour, stands in the section `at` the status it enters. |\n| `record.act-staged` | An act at a staged section\'s foot is offered only during that section\'s steps: its `when` holds the status to options the section names \u2014 on milestones, it stamps the step after one of them. |\n| `record.act-hidden` | An act is never offered only while its section\'s `when` hides the section. |\n| `record.field-edit` | An act that only writes one field of its record, not the status, from the one input it asks is that field\'s edit: the field rests in the section\'s `fields` as a control. |\n\n<!-- generated:end rules-record -->\n\nThe record is its `sections`, stacked in the order the work reaches them. A section is\nits fields, the acts under them, then its blocks \u2014 the acts at its foot instead where one\nreads what a block holds or none of its fields \u2014 and holds at least one of them. From\nthree sections on, the record is navigated by their titles: a page by a rail that jumps\nto each (a strip of the same names on a phone), a drawer by the same strip pinned over its scroll;\nwith fewer, the sections just stack. `description` is one sentence under the title.\n`at` names the status options (or the milestones) during which the section is the work\nnow \u2014 only on a record that truly moves through those stages: the rail marks it done,\nnow or waiting (an item of no `at` is its title alone), and the section stands even holding\nnothing yet \u2014 it never hides a field, locks it or gates an act, and a record opens at its\nhead. `page: true` makes a section a page of its own under the\nrecord\'s, off its scroll, with a way back \u2014 rarely, for a long related list or a workspace\nof its own that would make the record worse stacked; never on a drawer or a step. The\nheader draws no act: every act on the record is named by the section whose work it is, and one no section names is refused, naming its likely\nsection \u2014 only a correction no section owns waits in the header\'s \u22EF beside Delete. An act\nmoving the status and offered at ONE step (its `when`) stands at that step\'s foot when it\nmoves the work forward \u2014 to the next step, or to an exit later in the status\'s options\n(Reject beside Approve) \u2014 or back to a step the work passes anyway. One offered at SEVERAL\nsteps, or moving back into a detour, is named by the section it enters: a detour draws it and its\ngaps alone while it waits. A detour \u2014 a stage the work only steps aside into from one step and\nleaves only back to it (a pause, a repair) \u2014 stands before that step, its option and its section\nalike; listed after, the work reads it as its next step, and the check notes it with the move\nlisting it before. A `danger` act is a correction \u2014 waiting in the \u22EF of what it acts\non: its section\'s heading, its row, the header\'s where no section names it \u2014 unless it moves\nthe status while another status move is offered at the same moment; then it is one of that\nstep\'s outcomes, a button. Cancel offered at Held and at Confirmed, beside Confirm, is an\noutcome into an exit: state `{ "title": "Cancelled", "at": ["cancelled"], "fields": ["reason"],\n"acts": ["cancel"] }`. An exit stands only once the record is in it, its reason there and its\nrail item apart from the path; until then Cancel waits in the header\'s \u22EF. Every record\nopens its activity from its head \u2014 each save field by field, each move among them, and each\ncomment, with one composer \u2014 unless `activity: false`. `comments: true` lets people comment\n\u2014 opt-in: state it only where the job\'s people discuss a record; with `activity: false` the\ndoor opens the comments alone, and with neither no door stands. An edit in the activity \u2014 never\nthe record\'s making or an undo \u2014 carries Undo for a member who may write the\nrecord, in an app that saves it (none with `writes: false`): each field goes back where the\nrecord still holds what the edit wrote, the rest named with why. Unless `activity: false`, its\norganization\'s members get generated workflows: `record_activity` (`record_id`, `after?`) hands\nback `entries` \u2014 each with `undoable` and `undone` \u2014 and `next?`; in such an app,\n`record_activity_undo` (`record_id`, `entry_id`) hands back `reverted` and `kept`. No other\nworkflow takes either alias. `history: true` draws nothing of its own \u2014 each move is already\nin the activity: noted, refused beside\n`activity: false` (the moves would show nowhere), and refused everywhere in a later release.\n\nA field, a block and an act is each placed ONCE on a record \u2014 the header, one section;\na second place is refused. The header draws the entity\'s `records` title, subtitle,\nimage, status (or milestones) and figure, so none of them is named again in a section\'s\n`fields` or the register\'s `columns` \u2014 save the image, which one `files` block may draw\nagain, whole at reading size (an incident\'s photo, a scan), the header keeping its mark. Refused too: a section holding nothing, an `at`\non a record with no status, and a section\'s act that is a child\'s or runs over the\nregister\'s rows.\nA table, cards or a gantt states its record\'s `sections` (`record.sections`); absent them \u2014 a register laid\nout in time, or one declining the rule \u2014 one section holds every field a person writes that the header does\nnot show. An editable field rests as its control and saves as it changes; everything\nelse is plain text. A section or a block with `when` is shown only while each named\nselect of the record holds one of its options. The one layout serves every entity: a\ncustomer or a product is sections without `at`.\n\n## Blocks\n\n```jsonc\n"blocks": [\n { "rows": "fee", "columns": ["kind", "amount"] },\n { "rows": "fee", "where": { "leg": ["out"] }, "columns": ["kind", "amount"], "under": "invoice" },\n { "rows": "cost", "via": "bill", "create": false, "remove": false, "pick": true },\n { "files": ["photos", "papers"] },\n { "text": "remarks", "when": { "stage": ["held"] } },\n { "statement": [{ "field": "subtotal" }, { "field": "vat", "op": "plus" }, { "field": "total", "op": "equals" }] }\n]\n```\n\n<!-- generated:start apps-blocks -->\n\n#### Rows block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | A child entity whose rows belong to this record |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `columns` | list of alias | no | The child\'s fields read as columns after its title \u2014 never what its row draws (subtitle, image, status, figure, or the bound its figure\'s meter reads against), though an `expect` block\'s figure is a column, filled in place. |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, its picture, the subtitle and figure no default fills, the block\'s columns, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the child rows whose single select holds one of these options, or whose yes/no (stored, or a formula) is this value \u2014 every entry ANDed, read so on the server; a row added here holds the selects\' (one leg\'s fees, of a record holding both legs\'). Each select is one the child requires, so no row stands in no block |\n| `expect` | alias | no | The child\'s title when the record holds one row per value of it \u2014 a single select (one per option, in order) or a one-row link to a catalog (one per row the link may point at): a value not yet filled reads as its own empty line, and no value holds two rows. The block\'s `columns` name at least one field a person fills in place, unless it states `post`, whose lines are ticked |\n| `of` | alias | no | With `expect` on a select: the record\'s own multi-select holding the options this record expects a line for \u2014 the options it holds, in order, rather than every option. Its options are among the title\'s |\n| `only` | list of alias (at least one) | no | With `expect` on a select: the options this block holds a line for, so each paper kind stands in its own section, one place per kind. Never with `of` |\n| `under` | alias | no | The child\'s one-link to a document that covers its rows (an invoice over its fee lines), whose many-link points back and which links to this record: each document stands as a heading over the lines it covers; a filled line no document covers says so on its own row with a make for one document over it, and two or more waiting take a combined make in the block\'s heading. Never also a rows block of the document |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | no | The child\'s fields the reader narrows the block\'s rows by, as a register\'s `filters` \u2014 none to 3, each a field its rows show (a column, or a part of the row) or a formula of fields they show, its status among them where the business narrows by it \u2014 never on a task list, whose status chips narrow it |\n| `search` | list of alias (at least one) | no | The child\'s fields the block\'s search box matches (a link by its row\'s title), a pasted list line by line; absent, the block has no search box |\n| `group` | alias | no | The child\'s field the block\'s rows open grouped by, as a register\'s `group` \u2014 the reader\'s grouping starting there; absent, ungrouped |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order the block\'s rows open in, as a register\'s `sort` \u2014 within each group where the block groups them; absent, the child\'s first deadline soonest first, else the newest first |\n| `edits` | list of alias (1\u20132) | no | The child\'s fields each line holds as its control, written where the line stands (a quote line\'s sell price, the customer a line is matched to) \u2014 a number, a date, words, one option or a one-row link the row\'s save writes, each a column or the figure, at most 2; a link\'s control is its picker, offering the rows the field\'s own rules admit; every other value reads, and the row opens to write it |\n| `remove` | `false` | no | This list offers no Delete on its rows (its open row and \u22EF); they are deleted where another list of them or their own record offers it \u2014 e.g. lines that are a selection of rows kept elsewhere |\n| `pick` | `true` | no | The block also picks rows of the child that no record holds through `via` yet \u2014 those naming what this record names in each link `via`\'s `same` compares, and holding the block\'s `where` \u2014 and links them here; a row picked leaves the block from its \u22EF, unlinked and kept. `via` is an optional one-row link a person writes, and the record holds the many-link paired with it |\n| `checklist` | [Checklist](#checklist) | no | The child\'s rows, which are tasks, read as a checklist of checks: each one\'s mark \u2014 passed at a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column its note, on its own line), and on a line under its title its photo and its clause; never grouped nor written in place |\n| `compare` | [Compare](#compare) | no | This list reads each row\'s before against its after. Two files fields (a repair\'s damage and its repair, a check failed and redone): once the before holds a photo, the two stand side by side at one size, each row read in full as a card \u2014 on a checklist, whose `photo` is the before, the after beside it on its line \u2014 and an after not taken yet is the camera\'s tile adding it while the row\'s work is open; a list of the same rows without it stays a table. Two value fields of one type \u2014 text, a number, a date or a single select (a price before a sheet and after it): the list stays a table and the pair is one column under the after\'s label \u2014 the before struck, an arrow, the after \u2014 an empty before read as added and an empty after as removed; the after is its control where `edits` names it, and neither is also a column. Never with `expect` |\n| `post` | [Post](#post) | no | This list is a publish desk: with `expect` on a one-row link to a catalog of destinations, every destination the link admits is a line a person ticks \u2014 a tick makes its row from its key alone, an untick deletes it until its status is `closed` \u2014 and the line chosen reads beside the list as the post that destination\'s feed will show, with its words to copy, the block\'s `columns` as its facts and the row\'s acts. Never with `under`, `pick`, `checklist`, `compare` or a `create` list |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Checklist\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `photo` | alias | no | The child\'s files field holding the photo each row is checked by |\n| `clause` | alias | no | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | no | Options of the child\'s status a row stands failed at \u2014 none of them `closed` |\n\n#### Compare\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `before` | alias | yes | A field of the block\'s rows holding what stood before: a files field (the photo of the place before the work \u2014 the damage surveyed, the check failed), or a value \u2014 text, a number, a date or a single select (the price a row held before a sheet changed it) |\n| `after` | alias | yes | Another field of the block\'s rows, of the same type as `before`, holding what stands after: the photo of the same place once the work is done, or the value the row holds now |\n\n#### Files block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `files` | list of alias (at least one) | yes | Files fields of this record, read as pictures and documents |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Text block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `text` | alias | yes | A long text field read as prose |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n<!-- generated:end apps-blocks -->\n\n<!-- generated:start rules-block -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.child-link` | A block reads a child linked to the record; `via` names the link where the child links more than once. |\n| `block.column-drawn` | A child block\'s column never names what the child\'s row draws (title, subtitle, image, status, figure, or the bound its figure\'s meter reads against) nor its link back, and names a field once; an `expect` block\'s figure is its filled-in-place column. |\n| `block.columns-budget` | A child block\'s stated columns, each at the width of its kind, fit the room a desk leaves beside its name and the row\'s own status, deadline and figure. |\n| `block.title-back` | Where a child\'s title is its link back to the record a block lists it under, its first other subtitle names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `block.where` | A rows block\'s `where` names single selects the child requires, by options they hold \u2014 one held at a single option is never also a column \u2014 and the child\'s yes/nos by value. A yes/no is never held: a block adds rows only at a stored one\'s start, and never picks, expects or stands lines under documents. |\n| `block.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `block.under-once` | Documents drawn over their lines (`under`) are never listed again as a block of their own. |\n| `block.edits` | A rows block\'s `edits` name at most two of the child\'s columns or its figure that the row\'s own save writes \u2014 a number, a date, a few words, one option or a one-row link, never the block\'s `via` nor a link it must name alike (`write_rules`\' `same`) \u2014 never on an `expect` block. |\n| `block.remove` | A rows block\'s `remove: false` hides the Delete its rows would offer, so it stands only where the app writes those rows. |\n| `block.compare` | A rows block\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select). Never with `expect`. Over files on a `checklist`, `before` is the check\'s `photo`. Over values: neither side is a column or something the row draws already (title, line, figure, status, deadline), two numbers share a notation, no column is long text, never on a `checklist`. |\n| `block.checklist` | A rows block\'s `checklist` reads a task entity\'s rows as checks \u2014 never expected, under documents, grouped, edited in place or picked together by an act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`. |\n| `block.pick` | A rows block\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no act writes, no other rule compares rows by and no `under` block stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor in an app writing only the record\'s children or nothing. |\n| `block.narrow` | A rows block\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back to the record or a select its `where` holds at one option, nor on an `expect` block; an `under` block is grouped by its documents. |\n| `block.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the block; the block\'s `columns` name at least one field a person fills in place \u2014 unless it states `post`, whose lines are ticked \u2014 and its `create` takes the file where the child is pictured by one. |\n| `block.expect-fills` | An expected line is made from its key and its first filled column \u2014 a `post` block\'s from its key alone, by its tick \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `block.expect-of` | A block\'s `of` or `only` needs `expect` on a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one block per option; an act\'s `paper` is drawn in one. |\n| `block.field-kind` | A files block names files fields of the record, and a text block a text field. |\n| `block.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `block.under-note` | *Noted, never refused:* Rows holding a paper that cover another block\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `block.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no act files a call into or `fills`: the lines still missing read as what a record needs. |\n\n<!-- generated:end rules-block -->\n\nAn add in a block fills the link to this record, never asking it, and a rows block opens each row in a drawer.\nUnder `under` the uncovered lines come first; a document made over\none line starts its figure at the line\'s amount, the heading\'s make covering those ticked in its dialog. `pick` (a\nsupplier bill picking the job\'s cost lines) offers none until the record names each link `via`\'s `same` compares,\nlinks at most 200 ticked, and saves the record: a check locking it refuses, and one refusing a row\'s edits refuses\nthat row. Where the child is pictured by a file a person brings (its `records` `image`), an `expect` line not yet\nfilled is a placeholder naming the paper whose upload makes the row; a catalog link\'s values are the rows its\n`options_where` admits, and the add offers only values not yet held. A field starting from the catalog row\n(`default_from`) shows that value as its hint, taken with one press. A block narrowed by a select\'s `where` expects\nits lines once per value among them (one leg\'s fees beside the other\'s), its foot totalled by the record\'s sum\nnarrowed alike. An `agenda` and a `timeline` are set out under \xA7 Timeline and agenda, a `statement` under\n\xA7 Statements.\n\nA rows block whose `create` asks only numbers, single selects, texts with `suggest` and one-row links (one link at\nleast; no `expect`, `under`, `pick`, checklist or `post`) is also added to by one typed line, its words searching\nthe link\'s rows by title and `records` subtitle \u2014 state there the code people type \u2014 and what it does not ask\ncoming off the row picked (`default_from`).\n\n## Composed page\n\nA record whose page is its own arrangement of what the app already states \u2014 a piece of writing under its title, a\nbrief beside its figures \u2014 states `compose` instead of `sections`: a tree of finished pieces, each named by `use`.\n\n```jsonc\n"record": { "door": "page", "compose": {\n "use": "Column", "children": [\n { "use": "Bar", "children": [\n { "use": "Status" },\n { "use": "Field", "field": "audience" },\n { "use": "Act", "act": "send_for_review" },\n { "use": "Copy", "field": "body", "as": "plain" } ] },\n { "use": "Title" },\n { "use": "Document", "field": "body" },\n { "use": "Group", "title": "Reviews", "children": [\n { "use": "Rows", "child": "review", "create": false },\n { "use": "Act", "act": "ask_reviewer" } ] } ] } }\n```\n\nA node binds by name: a `field` is a field of the record\'s entity, an `act` an act of the app, a `child` an entity\nlinking to the record. What a name binds is read and written exactly as a section naming it would be \u2014 a `Field` and\na `Document` are saved through the record\'s own save, an `Act` runs its workflow, a `Rows` reads the child\'s rows \u2014\nso a tree adds no write of its own. It holds no condition and no computed value: a piece that does not apply on a\nrow (a field its entity\'s `applies` leaves out, an act its `when` does not offer, rows with nothing in them and no\nadd) draws nothing, by the rule that leaves it out of a section, and anything that must depend on the row is an act\'s\n`when` or a field\'s formula, never the tree.\n\nThe first `Act` the page itself draws is its primary and every other one secondary; a `danger` act reads so wherever it\nstands. A `Copy` and a `Document` naming one field copy what is on screen \u2014 the words typed and not yet saved among\nthem. The record\'s chrome stays the runtime\'s: the way back, its Activity and its \u22EF with Delete share the row over\nthe tree, and the head draws no title and no status of its own \u2014 the tree\'s `Title` and `Status` do.\n\n<!-- generated:start apps-compose -->\n\n#### Column piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Column"` | yes | The page\'s reading column, 680px: its pieces stacked in order from one left edge |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces stacked in it, in the order they are read |\n\n#### Bar piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Bar"` | yes | One row of small things on one control height, in two zones: what the record is \u2014 a status, a field\'s control \u2014 from its left edge, what is done to it \u2014 an act, a copy \u2014 ending on its right edge, taking a row of their own under it where the row runs out of room |\n| `children` | list of [piece](#composed-page) (at least one) | yes | Its pieces, each zone\'s in order; a `Field` directly in it is its control alone on one line, named by its label where it holds nothing; an `Act` that destroys or corrects is not drawn here \u2014 it stands in the record\'s \u22EF |\n\n#### Group piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Group"` | yes | A titled stack, headed once by `title` |\n| `title` | text | yes | Its heading, in the reader\'s words; holding one `Rows`, it carries their count and their add, and the group\'s `Act`s end its line |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces under the heading, in order |\n\n#### Panel piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Panel"` | yes | What a reader does not need while writing: nothing in the page, one entry of the record\'s \u22EF named by `title` that opens its pieces in a panel beside the page \u2014 a sheet on a phone; directly in the root `Column` alone |\n| `title` | text | yes | Its entry in the \u22EF and the panel\'s name, in the reader\'s words; an `Act` directly in it ends that name\'s row |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces in the panel, in order: `Rows`, `Field`, `Act`, `Group`, `Document` \u2014 never `Title`, `Status`, `Bar`, `Copy` or another `Panel` |\n\n#### Title piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Title"` | yes | The record\'s title (`records.<entity>.title`) as the page\'s heading, written in place where a person writes it; one a page |\n\n#### Status piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Status"` | yes | The record\'s status (`records.<entity>.status`) as a record\'s head draws it: moved by hand, by its acts\' moves, or read |\n\n#### Field piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Field"` | yes | A field of the record under its label, as a section\'s `fields` draws it |\n| `field` | alias | yes | The field drawn \u2014 never the title or the status, which `Title` and `Status` draw; once a page |\n\n#### Document piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Document"` | yes | A markdown text field written in place with no box, saved as it is written \u2014 whether it is saved said at its foot |\n| `field` | alias | yes | A text field with `format: "markdown"`; once a page |\n\n#### Act piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Act"` | yes | An act of the app on the record as its button: its `when`, what it lacks, its asks and its confirmation as everywhere; the first `Act` the page itself draws is its primary |\n| `act` | alias | yes | An act of this app on the record \u2014 never one `of` a child\'s rows, which stands on its row; once a page |\n\n#### Rows piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Rows"` | yes | A child entity\'s rows under the record, as a rows block lists them, each row\'s own acts on it |\n| `child` | alias | yes | A child entity linking to the record; once a page |\n| `create` | `false` | no | false, rows are not added here \u2014 an act of the page makes them |\n\n#### Copy piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Copy"` | yes | A button copying a field\'s words as the page holds them now \u2014 what is typed in its `Document` and not yet saved among them |\n| `field` | alias | yes | The text field copied |\n| `as` | `"plain"` \\| `"raw"` | yes | `plain`, its markdown marks gone; `raw`, as stored |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.compose` | A record\'s `compose` is stated instead of `sections`, on a page door, by an app of one book whose records have no steps (`status.milestones`, `status.stages`) and no picture (`image`) \u2014 a composed page draws neither. Each name is a field of the entity, an act of the app on the record or a child entity linked to it; one `Title`, and each field, act and child drawn once \u2014 a field by `Field` or `Document`, never the title or the status, which `Title` and `Status` draw. The first `Act` the page itself draws is its next step and every other one secondary; an `Act` is a button alone, never one making a set of papers. A `Bar` is one row on one control height, in two zones \u2014 its `Status` and `Field`s from its left edge, its `Act`s and `Copy`s ending on its right edge \u2014 and holds no `Rows` and no `Document`; a `Field` directly in it is its control alone on one line, named by its label where it holds nothing; an `Act` in it that destroys or corrects what is done (`danger`, or a move back) is not drawn there \u2014 it stands in the record\'s \u22EF. A `Panel` draws nothing in the page: it is one entry of the record\'s \u22EF, named by its `title`, opening its pieces in a panel beside the page; it stands directly in the root `Column`, holds `Rows`, `Field`, `Act`, `Group` and `Document` \u2014 never `Title`, `Status`, `Bar`, `Copy` or another `Panel` \u2014 and an `Act` directly in it ends the panel\'s name, secondary. A `Group` is headed once, by its `title`: holding one `Rows`, that heading carries the rows\' count and their add in place of the rows\' own, and the `Act`s the group holds end its line. A `Copy` takes a text field\'s words as the page holds them now, a `Document`\'s words not yet saved among them; a field a `Copy` alone names is read, never written. |\n\n<!-- generated:end apps-compose -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s\nportals \u2014 are a rows block that `expect`s the child\'s one-row link to the catalog of those places and states `post`:\n\n```jsonc\n{ "rows": "posting", "expect": "board", "columns": ["posted_link", "refusal"],\n "post": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page",\n "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per\nlanguage, say), each its editor between the list and the preview, saved as any field of the record is and drawn\nnowhere else on it. The preview is `text` read over what is on screen: where `text` is a formula of the child, the\ndesk computes that same formula over what is typed \u2014 a body before it is saved, the line\'s own column \u2014 so the post\nmoves as it is written, and a place not ticked previews the words its row would hold. For that the formula reads only\nwhat a screen holds whole: stored values of its row, the record through lookups over the link back to it, the place\nthrough lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup through another link or the\nclock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture (its `records` `image`), else\nthe mark of the network it is on where `networks` names one, else none. `group`, another single select of the place,\nstands the lines under its options in their order: a kind holding a ticked line is open, one holding none folded to\nits heading and its count \u2014 the first open where nothing is ticked \u2014 and a place of no kind comes last. A tick makes\nthe line\'s row from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick\ndeletes it until the row\'s status is `closed`: what went out is not taken back. It asks first only where a person\nwrote on the row \u2014 its status moved off its first option, or one of the block\'s `columns` a person writes filled. One line is worked beside the list \u2014 the one\npressed, else the first ticked \u2014 and read as the post that place\'s feed shows: `text` is the child\'s words for that\nplace, `media` and `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a\nfeed. A place on an option not named reads its words on a plain card. Under the bodies stand the block\'s `columns` a\nperson writes of the line\'s row (words for that place alone); under the post, the press copying its words beside\nthe acts `of` the child \u2014 never a second primary: the section\'s own act is that \u2014 then what the row\'s line and the\nblock\'s `columns` hold that nobody writes there (the link it went out at, why it was refused), each drawn only once\nit holds a value. A value an act or a workflow fills is stated as that act\'s, so the desk never offers it as an\nempty box. Where the block\'s box seats three columns they are the list, what is written and\nthe post; narrower, what is written stands over the post; narrower still the list stands alone and a line opens in\nplace. Sending is an\nordinary act of the record, named in the section\'s `acts`.\n\n<!-- generated:start apps-post -->\n\n#### Post\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `bodies` | list of alias (1\u20133) | no | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias | yes | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias | yes | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | no | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias | yes | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | no | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"` | yes | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.post` | A rows block\'s `post` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, `checklist`, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end apps-post -->\n\n## Timeline and agenda\n\nTwo blocks read a child\'s rows by their day: a `timeline` logs what happened, newest first; an `agenda` plans\nwhat is to come on a time axis.\n\n```jsonc\n"blocks": [\n { "timeline": "note" },\n { "agenda": "booking", "columns": ["guide"], "start": "arrival" }\n]\n```\n\n<!-- generated:start apps-timeline-agenda -->\n\n#### Timeline block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `timeline` | alias | yes | A child entity read as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands as a rows block\'s row (entries planned ahead are an `agenda`) \u2014 never the record\'s status history: its Activity shows each move |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, the subtitle and figure no default fills, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Agenda block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `agenda` | alias | yes | A child entity read as planned entries on a time axis: by day, soonest first, each entry with its picture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or subtitle); within a day entries follow a datetime there, else the first single select after the date \u2014 its options in the day\'s order |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `columns` | list of alias | no | The child\'s facts read on an entry\'s line after its title \u2014 never what its line already draws (subtitle, image, status, figure) |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, its picture, the subtitle and figure no default fills, the block\'s columns, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `start` | alias | no | The record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2); absent, the weekday and the date alone |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.timeline` | A timeline\'s child holds a date to place its entries by. |\n| `block.agenda` | An agenda\'s child names a date on its row line (`records` title or subtitle); `start` is a date of the record. |\n| `block.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a `timeline` draws them as a log, newest first. |\n| `block.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: an `agenda` draws them by day. |\n\n<!-- generated:end apps-timeline-agenda -->\n\nAn entry with no day yet is a plan, listed first and dated in place; a timeline\'s moment is its child\'s first date,\nand who its member field.\n\n## Statements\n\nA `statement` block draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s\ntotal, a payslip\'s net \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first\nstating no `op`, the last an `equals`. Every figure is a field the server computes or a person writes; the screen adds\nnothing up. A line\'s `parts` lists the rows its figure carries, each read from its own row, and that figure is what\nthey add up to \u2014 a formula, rollup or lookup, or the server\'s copy when the record is made (`default_from`), which\nnothing writes after. A claim\'s "certified before" is the contract\'s certified total copied when the claim is made\n(`made_at`, a moment the record `starts` at `today`), over the claims certified (`certified_at`, an act\'s `now`)\nbefore that moment, each at the figure its certifying act froze (`certified_value`, set to\n`{ "formula": "{claim_value}" }`, which the contract\'s total sums) \u2014 so they always add up to it, as a signed\ncertificate does, after a percent is edited or the contract varied.\n\n```jsonc\n{ "statement": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus",\n "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] },\n "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] } }\n```\n\n<!-- generated:start apps-statement -->\n\n#### Statement block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `statement` | list of [Statement line](#statement-line) (at least 3) | yes | A figure built from figures of the record, read as a statement: each line its operator, its label and its figure, the figures on one right edge, in the order stated \u2014 the last an `equals`, what it all comes to, drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line\'s figure is a control where the app writes it |\n| `title` | text | no | The block\'s heading; absent, the label of what the statement comes to |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Statement line\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | no | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | no | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | no | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias | yes | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | no | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | no | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the rows whose single select holds one of these options, or whose yes/no (stored, or a formula) is this value \u2014 read so on the server |\n| `columns` | list of alias (1\u20132) | yes | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias | yes | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end apps-statement -->\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A statement\'s lines are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `equals` \u2014 each `equals` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no add asks and no save or act writes, or a stored number stating `writes: false` \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an act fills, the server copies or the model states no person keys (`writes: false`), never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Reading blocks\n\nA `metric`, `breakdown`, `trend`, `pivot` or `progress` block on a record is a reading (\xA7 Readings) of a child\nentity\'s rows under it, read only \u2014 `via` names the link where the child has more than one.\n\nA `figures` block reads the record\'s own numbers instead, each a tile under its field\'s label: two to eight\nnumbers of the record no person keys \u2014 a formula, a rollup, a lookup through links to one row, or a stored number\nstating `writes: false` (what a workflow or an integration writes). A number a person keys is a field of the\nsection, where it is written. A tile holding nothing reads as not measured, never 0 \u2014 a sum or a count of\nnothing yet reads 0; a stored 0 reads 0.\n\nMetric blocks and a `figures` block standing one straight after another in a section draw as one strip: four\ntiles to a line on a desk, two on a phone.\n\nA `funnel` block reads the same rows as steps people drop out of between: each of its `steps` a number column\nof the child, summed over the rows under the record, drawn in order with the share each keeps of the one before.\nFunnel blocks standing one straight after another in a section draw on one grid \u2014 one name column, one bar origin\nand one value column \u2014 each under its own `label`, its bars over its own first step.\n\n```jsonc\n"blocks": [\n { "metric": "fee", "value": "amount", "label": "Fees" },\n { "breakdown": "fee", "by": "kind" },\n { "trend": "fee", "over": "charged_on", "value": "amount" },\n { "pivot": "fee", "rows": "kind", "columns": "method" },\n { "progress": "task", "planned": { "start": "plan_start", "end": "plan_end" }, "done": "complete", "label": "Progress" },\n { "funnel": "channel_week", "steps": ["impressions", "clicks", "bookings"], "label": "Reach to booking" },\n { "figures": ["sessions", "bookings", "calls", "ad_spend"] }\n]\n```\n\n<!-- generated:start apps-reading-blocks -->\n\n#### Metric block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `metric` | alias | yes | The entity whose rows are counted, or summed, into one number |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged, not summed: its sum over the rows holding one, divided by how many hold one \u2014 a row holding none is no part of it. Under a period each period reads its own average, and its change compares two averages; where no row holds one it reads no figure, never 0, and no change. A share is an average too: a number formula that is 100 on the rows that count and 0 on the others, in percent notation, reads as the share of rows that count |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `target` | number | no | The number it is read against, where no `limits` bounds its value (a bounded value is read against the sum of its bound) |\n| `better` | `"up"` \\| `"down"` | no | Which way its change over the recent periods `over` reads is good; absent, a sum\'s rise and a count kept by `where` falling |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Breakdown block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `breakdown` | alias | yes | The entity whose rows are split into parts |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) each row is counted under \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the `by` field\'s label |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Trend block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `trend` | alias | yes | The entity whose rows are counted, or summed, per period |\n| `over` | alias | yes | The date each row falls on \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link |\n| `ahead` | `true` | no | Counts forward: the current period first, then the ones after it, over the rows dated today or later (arrivals by their ETA); absent, the periods up to today |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the value\'s label, else the entity\'s |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Pivot block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `pivot` | alias | yes | The entity whose rows are counted, or summed, in a grid |\n| `rows` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) down the side \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `columns` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) across the top \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the two fields\' labels |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Progress block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `progress` | alias | yes | The entity whose rows are the parts of the work, read as the share of it planned and the share done, day by day |\n| `planned` | [Progress planned](#progress-planned) | yes | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | yes | A number of the row the server computes: its share done today, in percent (0\u2013100) |\n| `finished` | alias | no | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `measured` | [Progress measured](#progress-measured) | no | Before a row is finished, its share done on a day is what these add up to by then, never past its `done`; absent, a row stands at nothing until it is finished, and at its `done` today |\n| `weight` | alias | no | A number of the row: what it weighs in the whole \u2014 its value, its share of the contract; a row holding none weighs nothing. Absent, each row weighs its planned days |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Funnel block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `funnel` | alias | yes | A child entity whose rows each count the same steps, a column a step (a week\'s channels, each with its impressions, clicks and bookings): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. A step no row holds a number in reads as not measured, never as zero |\n| `steps` | list of alias (2\u20138) | yes | The child\'s numbers summed, in order, first step to last \u2014 2 to 8, each stored, a formula or a rollup, all in one notation, never a percent |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Figures block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `figures` | list of alias (2\u20138) | yes | Numbers of this record no person keys, in order, each a tile under its field\'s label \u2014 2 to 8: a formula, a rollup, a lookup, or a stored number stating `writes: false`. A tile holding nothing reads as not measured, never 0 \u2014 a sum or a count of nothing yet reads 0 |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.funnel` | A funnel\'s `steps` are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `block.figures` | A `figures` block\'s tiles are 2 to 8 numbers of the record no person keys \u2014 a formula, a rollup, a lookup through links to one row, or a stored number stating `writes: false` \u2014 each placed once on the record. |\n\n<!-- generated:end apps-reading-blocks -->\n\n## List block\n\nA `list` block puts rows of an entity beside the record, read only \u2014 nothing in it is added, edited or removed, and\nno workflow is made for the list itself (a `rows` block lists and edits a child\'s rows). An act `of` its entity\n(`acts[].of`) stands in each row\'s \u22EF and works that one row; a field it `requires` is one it `asks`. It reads the rows linked to the\nrecord through the list entity\'s one link to it (`via` where it has several). With `same`, a one-row link of the\nrecord\'s entity, it reads the rows sharing that link\'s row with the record, the record left out \u2014 a credit\nnote\'s other notes of its party; the list entity holds one link to that row\'s entity (`via` where it has several).\nA record whose `same` link is empty lists nothing and says so. `where`, `columns`, `label` and `app` read as\non a dashboard\'s list; the heading counts every row, and every row is drawn. A row opens as a record: the\nlist\'s entity is the app\'s own, a book\'s or a log\'s, opening its record here, or `app` names the register app that\nworks it, which opens it (`block.list-opens`).\n`same` stands in a record\'s `blocks` only.\n\n```jsonc\n"blocks": [\n { "list": "visit", "label": "Service visits", "columns": ["engineer"], "app": "visits" },\n { "list": "order", "same": "customer", "label": "Customer\'s other open orders", "where": { "stage": ["draft", "confirmed"] } }\n]\n```\n\n<!-- generated:start apps-list-block -->\n\n#### List block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `list` | alias | yes | The entity whose rows are listed, each in its `records` anatomy |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `columns` | list of alias | no | Fields read after each row\'s title |\n| `app` | alias | no | An app of this model over the same entity that works its rows: a dashboard row opens there, a record\'s list row has "Open in" to it |\n| `same` | alias | no | In a record\'s `blocks` only, read-only: a one-row link of the record \u2014 the rows sharing its row with this record, the record left out, by the list entity\'s one link to that row\'s entity (`via` where several). Absent, the rows linked to this record |\n| `fields` | list of alias (at least one) | no | In a record\'s `blocks` only, read-only: fields of the listed entity a row shows, in this order, when it is opened in place under itself \u2014 one row open at a time. Absent, a row opens in the record\'s drawer |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `via` | alias | no | The list entity\'s link to this record \u2014 with `same`, to the entity that link points at \u2014 where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.list` | A `list` block, read-only, lists the rows of an entity that link to the record by its one link to it (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row with the record \u2014 the record left out \u2014 by the list entity\'s one link to that row\'s entity (`via` where it has several). `same` and `fields` stand in a record\'s `blocks`, never on a dashboard. `fields` \u2014 at least one, each a field of the listed entity named once, never its title nor one of the `columns` \u2014 are what a row shows, read-only, when it is opened in place. |\n| `block.list-opens` | A `list` block\'s row opens in the record\'s drawer as a record: its entity is one a list of the app draws \u2014 the app\'s own, a book\'s, or a log\'s (`logs`) \u2014 or the list\'s `app` names the register app that works it. |\n\n<!-- generated:end apps-list-block -->\n\n## Tasks\n\nAn entity whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is\nwork someone finishes. Every table of its rows draws it alike \u2014 a rows block of the record it\nbelongs to, its own register, the rows filed under one of its rows (its steps) \u2014 each row led by a\nring. Ticking the ring moves the row to a closed option by the one write the app already has for\nthat move \u2014 the act of that entity setting a closed option (its first preferred), offered on an\nopen row and asking nothing, else its own save where people write the status \u2014 stamping what\nthat act stamps and appending the status history. Unticking runs the act moving a closed row\nback (its `when` holding a closed option), else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled, never hidden, and the check notes it. The status is moved\nin place on the row by the same moves; every other field is edited where the row opens. A\nfiles column reads on a task\'s line as how many files it holds. An act `of` the child with\n`on: "rows"` completes several at once: the list\'s heading offers to select rows, and the act\nruns on those picked. A block with `expect` or `under` draws its own lines, never rings. A record listing rows of a\ntask entity filed under it by a link holding one row says how much of that work is done \u2014 those rows at a closed\noption of all, every one the reader may read, every such block\'s rows counted as one \u2014 wherever its row is drawn: a\nmeter on its head, a column of its register\'s rows, a card\'s foot, a calendar entry, a gantt\'s or a lane\'s bar; a\ngantt of task rows grouped by the row they are filed under says that row\'s on each group\'s head. No rollup is stated\nfor it.\n\n```json\n{\n "entities": [\n {\n "alias": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": [\n { "alias": "name", "label": "Name", "type": "text", "required": true },\n { "alias": "lead", "label": "Lead", "type": "select_member" }\n ]\n },\n {\n "alias": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": [\n { "alias": "title", "label": "Title", "type": "text", "required": true },\n {\n "alias": "project",\n "label": "Project",\n "type": "select_record_link",\n "target_entity": "project",\n "cardinality": "one",\n "required": true\n },\n { "alias": "assignee", "label": "Assignee", "type": "select_member" },\n {\n "alias": "status",\n "label": "Status",\n "type": "select",\n "required": true,\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ],\n "default": ["todo"]\n },\n { "alias": "due", "label": "Due", "type": "date", "format": "date" },\n { "alias": "done_on", "label": "Done on", "type": "date", "format": "date" }\n ]\n }\n ],\n "records": {\n "project": { "title": "name" },\n "task": {\n "title": "title",\n "subtitle": ["assignee"],\n "status": { "field": "status", "closed": ["done"] },\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" }\n }\n },\n "apps": [\n {\n "alias": "projects",\n "name": "Projects",\n "theme": { "color": "blue" },\n "entity": "project",\n "record": {\n "sections": [{ "title": "Work", "fields": ["lead"], "blocks": [{ "rows": "task", "columns": ["due"] }] }]\n },\n "acts": [\n { "alias": "complete", "label": "Complete", "of": "task", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } },\n { "alias": "reopen", "label": "Reopen", "of": "task", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } },\n { "alias": "complete_all", "label": "Complete", "of": "task", "on": "rows", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } }\n ]\n },\n {\n "alias": "my_tasks",\n "name": "My tasks",\n "theme": { "color": "teal" },\n "entity": "task",\n "register": {\n "opens": { "assignee": "me" },\n "readings": [{ "metric": "task", "where": { "status": ["todo"] }, "label": "Open" }]\n },\n "record": {\n "door": "drawer",\n "sections": [{ "title": "Task", "fields": ["project", "due"], "acts": ["finish", "undo"] }]\n },\n "acts": [\n { "alias": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } },\n { "alias": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n}\n```\n\n## Acts\n\n```jsonc\n"acts": [{\n "alias": "gate_out", "label": "Gate out",\n "when": { "stage": ["in_yard"] }, "requires": ["release", "seal"],\n "asks": ["seal", { "input": "note", "label": "Note", "type": "long_text" }],\n "set": { "stage": "gone", "left_on": "now", "left_by": "me", "remark": "input:note" },\n "confirm": true\n}]\n```\n\n<!-- generated:start apps-acts -->\n\n#### Act\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The act\'s name within its app \u2014 its workflow is `act_<alias>` |\n| `label` | text | yes | The verb, as the reader says it |\n| `on` | `"record"` \\| `"rows"` \\| `"view"` | no | `rows` runs on the rows ticked in the register \u2014 with `of`, on the child rows ticked together in a rows block of the record; `view` on every row the register shows (offered while the view is narrowed to its `when`; it states no `requires`); absent, on one record (its page and its row\'s menu) |\n| `of` | alias | no | A rows or list block\'s child entity the act works on: offered on each child row \u2014 or, `on: "rows"`, on the rows ticked together in a rows block \u2014 its conditions and its write that row\'s |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | The act works only while each named select holds one of these options, and each named yes/no (stored, or a formula) is this value |\n| `requires` | list of alias (at least one) | no | Fields that must be filled first, each drawn where the act stands (its section\'s fields, a block\'s, or the act\'s asks \u2014 never the header alone); a blocked act names each one missing |\n| `recommends` | list of alias (at least one) | no | Fields the act runs without and reads when filled: while one is empty, the act says what it will leave blank |\n| `asks` | list of (alias \\| [Asked input](#asked-input)) (at least one) | no | What the reader states when pressing it \u2014 fields of the record (written by the act) or inputs |\n| `set` | map of alias \u2192 (text \\| number \\| boolean \\| `null` \\| [Set formula](#set-formula)) | no | What the act writes: an option alias, a value, `"now"`, `"me"` or `"input:<name>"` \u2014 each the act\'s outcome, read-only elsewhere; or `{ "formula": \u2026 }`, computed over each acted row as it stands when the act runs and written then (a sell price at cost and markup): a starting value, which a person may change after and the act never recomputes |\n| `workflow` | alias | no | An authored workflow (src/workflows/<alias>.ts) the act runs after its checks, for what `set` cannot say |\n| `writes` | list of alias (at least one) | no | With `workflow`, fields of the acted row its body writes (an id kept from a service\'s answer) \u2014 the act\'s, as what `set` states is |\n| `template` | alias | no | A document template the act makes a file from \u2014 an html one made a PDF, an excel one a workbook; over several rows, one file of them all, the rows listed under the entity\'s alias |\n| `templates` | list of [Act template](#act-template) (at least 2) | no | Several papers the act makes into `into` (a case\'s forms), instead of one `template`: listed where the act stands \u2014 each made one as its file, each not yet made as a placeholder \u2014 the reader ticks which to make, one press making those, each replacing its own last paper |\n| `into` | alias | no | The record\'s files field the made document is kept in \u2014 remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | no | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | no | A child the record lists in a rows block whose rows are its papers: the press takes papers, an agent reads them, and each is filed as a row of this child \u2014 its kind the child\'s title, its file in the child\'s files field |\n| `record` | [Recording](#recording) | no | The press records a call, visit or meeting through the host \u2014 Stop ends it \u2014 and files it as a new row of a child the record lists: its audio, its screen where captured, its transcript |\n| `sign` | [Signature](#signature) | no | The press opens a pad the signer signs on, beside what the act asks, and the act keeps the signature as a picture with who signed, when and the witness \u2014 read on the record as one signature, and handed to the paper the act makes |\n| `fills` | list of text (at least one) | no | With `intake`, what the papers read may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child whose rows the papers add \u2014 shown before and after, saved where it differs; a single link is filled with a row the app reads. With `record`, fields of the new row an agent fills from the transcript, saved as they come |\n| `review` | `true` | no | With `workflow`: the workflow only proposes \u2014 its body reads and returns a changeset of the act\'s table in `data.review` \u2014 and the platform writes the rows of it the reader ticks in the act\'s dialog (`approved`). Over every row in view it is handed no rows |\n| `confirm` | `true` | no | The press asks first; the question lists every active warning |\n| `danger` | `true` | no | The act destroys or cannot be undone |\n\n#### Asked input\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `input` | alias | yes | A value the act asks for that is not a field of the record |\n| `label` | text | yes | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"` | yes | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | no | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | no | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | no | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | no | The act is refused without it |\n| `default` | alias | no | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `formula` | text | yes | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n<!-- generated:end apps-acts -->\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Refused until adopted or declined:* Rows a stored status stages towards `closed` options are moved by an act of some app over them, or by its authored `workflow` \u2014 the patch moves each open option to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an act `set`s \u2014 an option, a value, `now`, `me`, an input \u2014 or its workflow `writes` is the act\'s outcome: read-only everywhere else and never asked by an add (`create`); a required one takes a `default`. A field an act computes by a `formula` is a starting value, which a person may change after. |\n| `act.writes` | `writes` stands beside `workflow` and names stored fields of the acted row, each once, that no `set` of the act and no other act over the rows states. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status or a milestone; a bound a write rule holds the field to is checked on the computed value as the act runs. |\n| `act.of` | An act\'s `of` names a child the record lists in a rows or list block; it works on the one row pressed \u2014 or, `on: "rows"`, on the rows ticked together where the record lists it as tasks \u2014 never on the rows in view. |\n| `act.writes-line-key` | An act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.view` | An act over every row in view (`on: "view"`) writes (`set`), makes a document or runs a workflow, and states no `requires`. |\n| `act.requires-drawn` | Every field an act `requires` is drawn where the act stands \u2014 its section\'s fields, a block\'s, its asks, or an unstaged section\'s where its own is unstaged \u2014 never the header alone. |\n| `act.requires-written` | A field an act requires that only an act writes is written by an act offered together with it, or asked by the act itself. |\n| `act.recommends` | A field an act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `"now"` on a date, `"me"` on a member, `"input:<name>"` of an input the act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.set-milestone` | An act stamps a milestone, never clears one \u2014 unticking clears it and every later one. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.history-copy` | What a status move asks is copied onto the history\'s field of the same name, which holds the same kind of value. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field\'s, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. A `file` input is read by the act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an act over the record, the ticked rows or every row in view, in an app over one entity \u2014 never beside `books`, `set`, `template`, `templates`, `intake`, `record`, `sign`, `confirm` or `of`, and it asks inputs only, none named `approved`. Its workflow is that act\'s alone, run by no other act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n\n<!-- generated:end rules-act -->\n\nAn act whose `when` does not hold is not offered \u2014 each select named holding one of its\noptions, each yes/no named (stored, or a formula: a period that has ended) its `true` or\n`false`; every one that holds stands at the\nfoot of the section naming it in `acts` \u2014 a correction in that section heading\'s \u22EF, one\nof a child row on its row (a correction in the row\'s \u22EF). An act\'s `requires` are fields\nits section draws \u2014 its `fields`, a block\'s, the act\'s `asks`, or those of another section\nwith no `at` where its own has none; one shown only in the header or a staged section\nelsewhere is refused. One whose `requires` are\nempty is offered disabled, naming each; one whose `recommends` are empty names what\nit will leave blank and still presses; one a standing check blocks is offered\ndisabled in the check\'s words. The generated `act_<alias>` workflow re-checks all three on the\nserver, writes `set` and what was asked, and appends the status history where the\nact moves the status. A field an act asks is read-only everywhere else. A `select` input\noffers its own options and is written into a select holding the same option aliases; a `link` input picks one row of its `entity`\nand a `member` input one person, each written into a field of its kind. A field an act\nboth `requires` and `asks` never disables the press \u2014 the act asks it, required.\n\nA `file` input is one uploaded file, handed to the act\'s authored `workflow` as its file id (a sheet is read\nfrom it by `excel_get_rows` in a workflow); nothing else reads it, so `set` never writes it into a field, and it starts empty.\n\n`review: true`, beside an authored `workflow`, makes the workflow one that only proposes, and the platform the one\nthat writes. Its body calls only steps that read, and proposes the same for the same inputs and rows \u2014 one that writes,\nany agent, an app agent or a wait is refused where it is saved, applied and run \u2014 and returns in `data.review` a\nchangeset of the act\'s table: `{ "version": 1, "table_id", "creates": [{ "key", "data" }], "updates": [{ "record_id",\n"data" }] }`, `data` holding only the fields that change, by field key, as `update_records` takes them \u2014 no computed\nfield, no file \u2014 each row with an optional `note` and `ticked`, and `unplaced: [{ "title", "note"? }]` for what matched\nnothing. A create\'s `key` is the body\'s own text naming the same line on every run, unique among the creates; so a\nrepeated confirm adds no second row, the body also writes it into a `unique` field. A record is updated once; at most\n2000 rows. Anything else is refused with what is wrong, and nothing is written.\n\nA call without `approved` answers the proposal, a `sha` on each row, and writes nothing, whoever makes it. A call with\n`approved: { "updates": [{ "record_id", "sha" }], "creates": [{ "key", "sha" }] }` \u2014 the `sha` copied from the proposal \u2014\nruns the body again, and the platform writes the named rows of THAT call\'s proposal, with its values,\nnever the caller\'s, each only where it proposes what was read \u2014 an update only of a record the act ran on \u2014 through\nthe ordinary record writes, as steps of the run, every row checked first and all written in one transaction or none:\neach record\'s Activity shows it and, in a workflow, `undo_record_changes` with the run\'s id puts it back. A row no\nlonger proposed, proposed otherwise (`changed`), changing nothing, gone, locked or holding a unique value another row\nholds is left and named; the status each written row moved to, or a made row holds, is recorded in its history by the\nsame run. What is proposed stays the body\'s: match against what the rows hold now, so a row written is proposed no\nmore.\n\nThe dialog asks what the act asks, lists the proposal to tick as one table \u2014 what matched nothing first, then a column\nfor each field any row changes, its value now against proposed, a linked row or a member by name \u2014 and confirms the\nrows left ticked; a row changed since it was read is listed again. Over every row in view the act\nis handed no rows: its body reads the rows it may change, whatever the view, bound by no count of rows; it states no\n`when`, over an entity no row rule keeps to some readers. `review` is refused beside `books`, `set`, `template`,\n`templates`, `intake`, `record`, `sign`, `confirm`, `of`, an ask of a field, and an input named `approved`. A body:\n`lotics docs workflows`.\n\n`on: "view"` runs on every row the register shows \u2014 its search, status and filters \u2014\neach row checked before any is written. `of` names a rows block\'s child entity: the\nact is offered on each child row (its menu and its drawer), its `when`, `requires`,\n`set` and checks are the child\'s, it runs on that row, and a check of the record that\nlocks the child rows locks it too. With `on: "rows"` it runs on the child rows ticked\ntogether in the record\'s task list (\xA7 Tasks) \u2014 every row checked before any is written;\nit is refused where the record lists no tasks of that child.\n\nWhat an act makes, reads, records or has signed is set out under \xA7 Papers and recordings.\n\n## Papers and recordings\n\nBeside what it writes, an act makes papers from templates (`template`, `templates`), reads papers brought into the\nrecord (`intake`), records a call or a visit (`record`) and takes a signature on the device (`sign`).\n\n<!-- generated:start apps-papers -->\n\n#### Act template\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `template` | alias | yes | A document template the act makes a paper of, kept in `into` \u2014 an html one made a PDF, an excel one a workbook |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `into` | alias | yes | A child the record lists in a timeline or rows block, linking back to it by a single link: each recording is filed as a new row of it |\n| `audio` | alias | yes | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias | yes | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | no | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | no | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | no | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `into` | alias | yes | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias | yes | Who signed: a text field the signer types their name into (someone with no seat in the workspace \u2014 a driver, the owner\'s supervisor), or a member field set to the person pressing, who signs as themselves |\n| `at` | alias | yes | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | no | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.into` | `into` is a files field of the one record the act is pressed on, beside its `template` or `templates`. |\n| `act.files-written` | An act\'s `writes` never names a files field of the record: a file an act makes is a paper \u2014 the record states its papers (an `expect` block over a child pictured by its files field) and the act names its slot with `paper`. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template`, `asks`, `of` or an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a rows block that expects its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the act runs on one record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them. |\n| `act.record` | `record` names a child the record draws in a timeline or a rows block with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a rows block with no `expect`, `under` or `where`, filled in the fields that block adds \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a milestone, a field an act writes or a link `same` narrows; a link\'s row is one the app reads of its entity. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. |\n| `act.sign` | `sign` runs on one record, never a child\'s row: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the act does not also ask, set or `writes`, and no other act signs into `into`. |\n\n<!-- generated:end apps-papers -->\n\n`template` makes a document from the row as the act left it and\nkeeps it in `into`; over several rows it makes one document of them all, the rows\nlisted under the entity\'s alias, and hands it back. `templates` instead names a set of\npapers kept in `into`, listed where the act stands \u2014 each made one as its file, each\nnot made yet as a placeholder \u2014 those whose `when` holds ticked to start; the press\nmakes the ticked ones (sent in `templates`), each replacing the file its template made\nbefore (the file whose `document_template_id` is that template \u2014 never a file a person\nput there), and the set downloads as one archive (`archive_<alias>`).\n\n`intake` reads papers: the press takes files, an agent (`act_<alias>` among the app\'s\nagents) reads them, and each is filed as the record\'s line of its kind in the named\nchild \u2014 that child\'s title \u2014 or a new line, its file in the child\'s one files field.\nWhat they state of each field `fills` names is shown beside what the row holds; the save\nwrites only what differs \u2014 the record\'s fields, `<link>.<field>` on the row a required\none-row link names, a child\'s rows (one found by the child\'s `natural_key` changed, else\nadded) \u2014 each refused as its own save is, and nothing written while one refuses. A single\nlink among them is filled with a row the agent finds through the app\'s read of the rows\nit may name \u2014 narrowed as its picker is \u2014 and an id naming no row of its entity is refused\nbefore the run ends; a link `same` narrows is not filled.\n\n```jsonc\n{ "alias": "read_papers", "label": "Read papers", "intake": "customer_paper", "fills": ["phone", "contact.email", "branch"] }\n```\n\n`sign` takes a signature on the device in front of the signer: the press opens a pad in a\nsheet with what the act asks \u2014 the signer\'s name, where `by` is a text field they type it\ninto \u2014 and the act keeps the picture in `into` in place of any before it, `at` stamped with\nthe server\'s time and the person pressing in `witness` (a member `by` is the person\npressing, signing as themselves). The record reads `into` as one signature \u2014 the stroke,\nwho signed, as what, when and before whom \u2014 and the act\'s paper is handed the picture under\n`into`\'s name, an html template printing it by its url (`{{#each signature}}<img src="{{url}}">{{/each}}`).\n\n```jsonc\n{ "alias": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir",\n "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Checks\n\n```jsonc\n"checks": [{ "field": "release_warning" }, { "field": "unpaid", "blocks": ["gate_out"] }, { "field": "locked", "blocks": ["edit"] }]\n```\n\n<!-- generated:start apps-checks -->\n\n#### Check\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A yes/no or text formula of the record (or of the child `of` names): true or non-empty means the check stands; its label is its short name on a row\'s line, and a text formula\'s words are the sentence the record and a tooltip say |\n| `of` | alias | no | A rows block\'s child entity this check is a formula of: standing on a child row, it refuses what it blocks of that row |\n| `blocks` | `"all"` \\| list of (alias \\| `"edit"` \\| `"delete"`) (at least one) | no | Acts, "edit" (the saves and the Delete), "delete" (the Delete alone) or "all" that the standing check refuses; absent, it only warns |\n| `resolve` | alias | no | An act of this app, on the rows the check stands on, that clears it: the check\'s line links to the act where it stands, and the act keeps its own conditions |\n\n<!-- generated:end apps-checks -->\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A check\'s `field` is a yes/no or text formula of the record, or of the child `of` names. |\n| `check.of` | A check\'s `of` names a child the record lists in a rows block. |\n| `check.not-placed` | A check\'s field is never also placed on the record \u2014 the line under the header says it. |\n| `check.blocks` | A check of the record blocks its acts, `"edit"`, `"delete"` or `"all"`; a check of a child blocks that row\'s saves, its Delete, the acts `of` that child, or all \u2014 never the record\'s acts. |\n| `check.resolve` | `resolve` names an act of this app on the rows the check stands on, pressed on one row, not refused by the check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\nA check is a yes/no or text formula of the record: it stands while true or\nnon-empty, and a text formula\'s words are what the reader sees. Without `blocks`\nit warns; with them it refuses the acts named, `"edit"` the record\'s own saves (and\nits Delete), `"delete"` its Delete alone, or `"all"` \u2014 on the server, in every write it\nnames. A check `of` a rows block\'s child stands on each child row: it refuses that\nrow\'s saves (`edit`), its Delete (`delete`), the acts `of` that child it names, or\n`all` of them \u2014 never the record\'s acts. A warning reading the figure of a meter that\n`gates` marks against its bound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s\nline says it in the check\'s tone (the most severe of several, and how many more), while\nits words whole are the row\'s tooltip and stand under the record\'s header. So label it\nas the reader names the problem, in a few words, and let a text formula say the\nsentence. The compiler records the fields a formula reads: a row drawing each of them\nas a control says nothing of the check on its line (the empty control says it), and a\ncheck with no `resolve` links to the first of them the record draws.\n\n## What a run remembers\n\nThe WORKSPACE remembers what each entity, field, select option, role and\ntemplate alias became here, plus which record each first row landed on and the\nfile each document path was uploaded as. The model file itself holds no live id\n\u2014 it is the portable half, and the same file applies to a demo workspace and to\na customer\'s \u2014 so the join lives where the things it names live, and one model\napplied to two workspaces holds two bindings that know nothing of each other.\n\nIt is the workspace\'s and not the file\'s because a model file is never\ncommitted: memory kept beside it is one author\'s disk, absent for a teammate, on\na second machine or after a delete \u2014 and every one of those goes quietly back to\nbinding by label, which is what grows the second table.\n\nEvery later apply binds through it: it takes the remembered id first and falls\nback to a label only for an alias nothing has bound \u2014 a field you have just\nadded, or a workspace nothing has applied this model to. That is what makes a\nrelabel on EITHER side a rename rather than one thing the workspace lacks and\none the model lacks: `apply` binds the thing it has always meant, gives a field\nor a select\'s option the label the file states, and reports the move of a table,\na template or a role \u2014 which side is right there is yours to decide, not a reason\nto refuse the run.\n\nA bound target the workspace no longer holds IS a refusal, by name: re-binding\nto whatever carries that label today is how the model comes to point at\nsomebody else\'s table. On the CLI, `lotics run restore_table` puts a deleted table back.\n\n`lotics model pull` writes a workspace that already works as a model file \u2014 the\nstarting point for another business\'s model, never a source of truth: it carries\none business\'s words and stops describing that workspace the moment either\nchanges.\n\n## A complete model\n\n```json\n{\n "entities": [\n {\n "alias": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": [\n { "alias": "name", "label": "Name", "type": "text", "required": true },\n { "alias": "logo", "label": "Logo", "type": "files" },\n {\n "alias": "tier",\n "label": "Tier",\n "type": "select",\n "options": [\n { "alias": "standard", "label": "Standard", "color": "slate" },\n { "alias": "gold", "label": "Gold", "color": "amber" }\n ],\n "default": ["standard"]\n },\n {\n "alias": "orders",\n "label": "Orders",\n "type": "select_record_link",\n "target_entity": "order",\n "cardinality": "many",\n "sync_both_ways": true,\n "paired_field_alias": "customer"\n },\n {\n "alias": "total_ordered",\n "label": "Total ordered",\n "type": "rollup",\n "source_field_alias": "orders",\n "aggregate_option": { "operation": "sum", "field_key": "amount" }\n }\n ],\n "views": [\n {\n "alias": "gold",\n "label": "Gold customers",\n "filters": {\n "node_type": "condition",\n "type": "select",\n "field_key": "tier",\n "operator": "has_any_of",\n "value": ["gold"]\n },\n "sort": [{ "field_key": "name", "order": "asc" }]\n }\n ]\n },\n {\n "alias": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": [\n { "alias": "code", "label": "Order no.", "type": "text", "unique": true },\n { "alias": "placed_on", "label": "Placed on", "type": "date", "format": "date" },\n {\n "alias": "amount",\n "label": "Amount",\n "type": "number",\n "notation": { "style": "currency", "currency": "VND" }\n },\n {\n "alias": "total",\n "label": "Total with VAT",\n "type": "formula",\n "formula": { "expression": "{amount} * 1.1", "notation": { "style": "currency", "currency": "VND" } }\n },\n {\n "alias": "customer",\n "label": "Customer",\n "type": "select_record_link",\n "target_entity": "customer",\n "cardinality": "one",\n "sync_both_ways": true,\n "paired_field_alias": "orders"\n },\n { "alias": "note", "label": "Note", "type": "text" }\n ]\n }\n ],\n "roles": [{ "alias": "sales", "label": "Sales" }],\n "records": {\n "customer": { "title": "name", "image": "logo", "party": "organization", "figure": "total_ordered" },\n "order": { "title": "customer", "subtitle": ["code", "placed_on"], "figure": "amount", "starts": { "placed_on": "today" } }\n },\n "apps": [\n {\n "alias": "customers",\n "name": "Customers",\n "theme": { "color": "blue" },\n "entity": "customer",\n "register": {\n "columns": ["tier"],\n "readings": [{ "breakdown": "customer", "by": "tier", "value": "total_ordered" }]\n },\n "record": {\n "sections": [\n { "title": "Account", "fields": ["tier"] },\n { "title": "Orders", "blocks": [{ "rows": "order", "columns": ["total"], "create": ["code", "amount"] }] }\n ]\n }\n },\n {\n "alias": "orders",\n "name": "Orders",\n "theme": { "color": "violet" },\n "entity": "order",\n "register": {\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "readings": [{ "trend": "order", "over": "placed_on", "value": "amount" }]\n },\n "record": { "door": "drawer", "sections": [{ "title": "Order", "fields": ["note"] }] }\n }\n ],\n "rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } },\n { "ref": "bluebird", "fields": { "name": "Bluebird Foods", "tier": "standard" } }\n ],\n "order": [\n {\n "ref": "so_1001",\n "fields": {\n "code": "SO-1001",\n "placed_on": "@month-start+2",\n "amount": 4200000,\n "customer": "customer:acme"\n }\n },\n {\n "ref": "so_1002",\n "fields": {\n "code": "SO-1002",\n "placed_on": "@today-3",\n "amount": 1150000,\n "customer": "customer:bluebird"\n }\n }\n ]\n }\n}\n```\n\nEach app of this file, as its reader will see it:\n\n```\nApp customers \u2014 "Customers" over Customers (customer)\n Register \u2014 table (default), newest first (default)\n row [Logo] \xB7 Name \xB7 figure Total ordered\n columns Tier\n filters \u2014\n readings "Tier" \u2014 Total ordered summed per Tier, over the rows in view (default)\n add Name (default)\n Record \u2014 a drawer (default)\n header image Logo \xB7 title Name \xB7 figure Total ordered\n checks \u2014\n header \u22EF Delete\n sections 1. "Account"\n fields Tier\n 2. "Orders"\n block Orders (default) \u2014 rows of Orders through Customer; columns Total with VAT; add asks Order no., Amount\n thread \u2014\n history \u2014\n acts \u2014\n Reads Customers, Orders\n\nApp orders \u2014 "Orders" over Orders (order)\n Register \u2014 table (default), newest first (default)\n row Customer \xB7 under it Order no., Placed on \xB7 figure Amount\n columns \u2014\n filters Customer\n readings "Amount" \u2014 Amount summed per period by Placed on, over the rows in view (default)\n add Order no., Customer, Placed on \u2014 starting Placed on at today\n Record \u2014 a drawer\n header title Customer \xB7 subtitle Order no., Placed on \xB7 figure Amount\n checks \u2014\n header \u22EF Delete\n sections 1. "Order"\n fields Note\n thread \u2014\n history \u2014\n acts \u2014\n Reads Orders, Customers\n\n```\n\nEach `(default)` is a value the model left to the system: the door a record opens\nthrough \u2014 a drawer, since neither record has a stage or more than three sections \u2014 the\norder rows open in, and what an add asks. The order\'s one section holds every field a\nperson writes that the header does not already show. The customer\'s orders\nare a block in its "Orders" section, never its own `Orders` link as a field as well:\none fact, one place. An order is titled by its customer and read by its number under\nit; the block names what its add asks, since a subtitle or a figure is never asked by\ndefault. `Total ordered` is a rollup, so it is read and never asked; the\norders app\'s record opens in a drawer, because its rows are worked one after another.\n';
|
|
46876
|
+
var model_reference_default = '# The Lotics workspace model (`model.json`)\n\nOne JSON file describing a workspace: its tables, fields, options, views, roles,\nfirst rows, how a row of each table is recognised, and the apps over them. Each \xA7\nis its own page at `model/<section>` \u2014 `lotics docs`, or the `docs` tool. Which treatment each job\'s\nscreen needs: the `design` reference. Each treatment worked through in an app of a complete model: the\n`examples` reference.\n\n**What a model composes with**\n\n- **Entities and fields** (\xA7 Entity, \xA7 Field) \u2014 the tables, their columns, options and links.\n- **Records** (\xA7 Records, then \xA7 Status) \u2014 how a row of each entity is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per entity\n and read by every surface that draws one of its rows.\n- **Write rules** (\xA7 Write rules) \u2014 what a write finds, bounds and picks among.\n- **Apps** (\xA7 Apps, then a page each: \xA7 Logs, \xA7 Workflows, \xA7 Queries, \xA7 Register, \xA7 Layouts, \xA7 Tabs, \xA7 Export, \xA7 Readings,\n \xA7 Averages and bands, \xA7 Dashboards, \xA7 Record page, \xA7 Blocks, \xA7 Composed page, \xA7 Publish desk, \xA7 Timeline and agenda, \xA7 Statements, \xA7 Reading blocks, \xA7 List block, \xA7 Tasks, \xA7 Acts,\n \xA7 Papers and recordings, \xA7 Checks) \u2014 one\n working register over one entity and the record each row opens, with the logs beside it:\n which fields go where, the acts, and the checks that guard them \u2014 or a dashboard of readings.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no key here changes it.\n A screen the job needs and no key states is a `lotics report` \u2014 the job, what the model\n drew, the word wanted \u2014 never keys bent to approximate it.\n\n**The working order**\n\n1. Name the people and each one\'s JOB \u2014 the work they alone decide or write.\n2. The entities and fields those jobs touch, and a `records` entry for every entity an\n app lists, opens or picks.\n3. One app per job in `apps[]` \u2014 the record a person moves and the rhythm they move it at, its own list; what that record owns is its sections, blocks and acts, and work over another record or at another rhythm is another app, even for the same person \u2014 each one working register over one entity; a list worked only in passing is a section of the app it serves, and the log of what was brought into the register\'s rows is a log beside it (`logs`).\n4. `lotics model apply model.json` \u2014 the file is checked first, every problem in one run;\n then the tables, then a new version of every app, live\n (`lotics setup model.json --email you@company.com` where no account exists yet).\n5. Change the file and apply it again; `lotics model pull -o model.json` writes what the\n workspace holds, and each apply of that file sends only what it changes. `apply_model` takes\n a `patch` in place of `model`: a JSON merge patch (RFC 7396) over the workspace\'s model, each\n list whose items carry an `alias` written as an object keyed by it \u2014\n `{ "apps": { "desk": { "acts": { "close": null } } } }` removes one act. Where an aliased item\n stands is a move beside the patch, `"moves": [{ "at": "apps.desk.acts.close", "after": "hold" }]`\n (or `"first": true`), placed once the patch merged \u2014 built into an app\'s acts, and a select\'s\n options (`entities.<entity>.fields.<field>.options.<option>`) reordered on its table, the plan\n saying each order it writes; a table\'s\n fields and views and the apps themselves keep the workspace\'s order. A patch whose every key and\n move lies inside one app\'s body leaves the tables as they stand and builds that app, beside any\n other app whose build reads what it changed. A `null` removes only\n what an apply writes as the model states it \u2014 anything inside an app, a `records` entry\n (`"records": { "<entity>": null }`), a write rule, an entity\'s `singular` and `writes`, a\n field\'s `default`, `required` and `writes`, a text field\'s `format`, a number\'s `notation`, a field itself, which leaves its table where no row holds a value in it and nothing reads it \u2014 and is refused\n anywhere else, a table, view, role, template or app among them; one naming\n nothing the model holds changes nothing. A `null` on a select\'s option is taken, as\n leaving it out of a whole model is: the model stops stating it, so each app is built without it, its\n table keeps it and its rows still read, and the apply notes it \u2014 `update_table` removes one, rebuilding\n the apps without it first, refused only while an app\'s model states it or another reader names it. A\n field `update_table` deletes goes the same way, its values with it and its place in the table\'s views (columns, filters, sorts, summary); only an omission or `null` in\n `apply_model` is value-protected. An edit of a table reaches each model-built app shortly after, as the\n platform building it again from its model; one it cannot build unharmed is warned of by `get_model`. `get_model` with `app` reads one app and the\n entities it reads.\n Rolling an app back (`lotics run rollback_app`) restores its earlier version \u2014 table\n changes and data writes stay.\n\n## The rules\n\n- **At least one entity, at most 50.** More tables than that is a data model\n being designed, not applied \u2014 apply the rest in a second call.\n- **An existing table is adopted.** `lotics model apply` binds an entity whose `label`\n already names a table in the workspace, and adds the fields, options and\n views it is missing. No stored value is ever changed or deleted: a field it\n adopts takes the model\'s `default` and `required`, a text field\'s `format`, and\n the `notation` it reads in, where that only relabels \u2014 a date\'s format and a unit\n converting its figures are left. A computed field\'s definition follows the model: a formula\'s expression,\n notation and options, a rollup\'s link, aggregation and filter, a\n lookup\'s link, field and order, and an autonumber\'s `template` (new rows only \u2014\n existing numbers keep theirs). A check and the apply name each one that changes.\n Applying the same model twice changes nothing the second time.\n- **A field the file stops stating leaves its table** \u2014 one an earlier apply stated,\n or one the pulled file stated \u2014 where that loses nothing: no row holds a value in\n it, and nothing outside the model\'s own apps reads it (a formula, rollup or\n lookup, a figure\'s unit, a `default_from` copy, a unique set, a query, an agent,\n a table check or a workflow body of the workspace). Otherwise nothing is applied,\n and the refusal names the field, how many rows hold a value and what reads it:\n state the field again to keep it, or clear those rows and stop those readers. A\n field of the table no model ever stated stays as it is, and so does one a read\n of the workspace\'s model leaves out \u2014 `get_model` and `lotics model pull` name\n each in their findings \u2014 since no file made from that read could state it.\n `lotics model check` names each field the apply would take off.\n- **A label the file changes is a rename.** A field\'s `label`, a select option\'s\n `label` and a table\'s `description` are written onto the table as the file states\n them, each named by a check and by the apply. A table\'s own name, a template\'s and\n a role\'s are reported where they differ and left; a table is deleted on the CLI by\n `lotics run delete_table`, or by a member in Lotics (\xA7 What a run remembers).\n- **An app\'s labels decide its language.** A model names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese, and `model apply` notes a label written the other way from the rest\n of its app\'s. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two.\n- **Rows land only where every bound table is empty.** One table already holding\n records and no rows are written anywhere: sample rows landing among a\n customer\'s real ones cannot be told apart from them.\n- **`lotics model apply` checks all of it before anything is written**, and\n reports every problem in one run rather than the first. Each section of this\n page ends its keys with the rules the check enforces there, one sentence each\n under an id; a finding names its rule\'s id (`[register.filter]`), and\n `model/<rule id>` is that one rule\'s page.\n\n<!-- generated:start rules-model -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `model.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `model.retired` | `field_roles`, `table_workflows` and `connections` are no longer part of a model: `records` states how a row is recognised, and an app\'s own writes do what a table automation did. |\n| `model.names-declared` | Every alias a key names is declared: an entity of this model, a field of the entity the key reads, an option of the select it names, an act of the app, a template or an app of this model. |\n| `model.tables` | A model declares at least one table and at most 50; apply the rest as a second model. |\n| `model.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per model and 2000 documents attached \u2014 a real data set belongs in an import. |\n| `model.language` | *Noted, never refused:* A label or description written in the other language than the rest of its app\'s labels \u2014 with or without diacritics. |\n| `model.alias-unique` | An alias is unique where it is named: entities, roles and templates in the model, fields and views in their entity, options in their select. |\n| `model.label-unique` | A label is unique where apply finds it by label: entities, roles and templates in the model, fields and views in their entity, options in their select \u2014 and no view takes its entity\'s own label, which names the whole-table grid apply makes. |\n| `model.template-sha` | A template\'s `content_sha256`, where stated, is the 64-character lowercase hex sha256 of its content. |\n| `model.template-kind` | An act\'s paper and a register\'s `export` are made from an html or an excel template, never an email one. |\n| `model.template-act` | *Refused until adopted or declined:* In a model stating apps none of whose acts runs an authored `workflow`, every html or excel template is made by an act (`template`, `templates`) or filled by a register\'s `export` \u2014 the patch adds the act to the app over the entity whose fields it prints most. |\n| `model.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n\n<!-- generated:end rules-model -->\n\n## Top level\n\nEvery table of keys on this page is generated from the schema `model apply`\nparses the file with, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### Model file\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entities` | list of [Entity](#entity) | yes | The tables this model creates, with their fields, options and views |\n| `roles` | list of [Role](#role) | no | Workspace groups to create; members are added to them afterwards |\n| `templates` | list of [Template](#template) | no | Document templates: html and email inline, excel made from an uploaded workbook |\n| `rows` | map of alias \u2192 list of [Row](#row) | no | First records, keyed by entity alias \u2014 written only where every table they land in is empty |\n| `records` | map of alias \u2192 [Record](#record) \\| `null` | no | How a row of each entity is recognised, keyed by entity alias. Every entity an app lists, opens or picks has one; `null` removes the entry its table holds |\n| `write_rules` | map of alias \u2192 [Entity write rules](#entity-write-rules) | no | Entity alias \u2192 what a write of that entity finds, bounds and picks among |\n| `apps` | list of ([App](#app) \\| [Dashboard app](#dashboard-app)) | no | The apps this workspace will have \u2014 each one working register over an entity, with the logs that stand beside it, or a dashboard of readings |\n\n<!-- generated:end top-level -->\n\n**A model carries no** `fixtures`, `knowledge` or `knowledge_expects`, and no\n`word` / `pdf-form` template: file content is uploaded to the workspace, never\nstated in a model \u2014 an `excel` template names its uploaded workbook by `file_id`. `apps` here is what an agent states to make an app,\nnever built code. An unknown top-level key is an error, never ignored.\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how the file cross-references\nitself; they are never shown to anyone. `label` is what a person sees.\n\nLabels must be unique within their namespace \u2014 two entities, two fields on one\nentity, two options on one field, two views on one entity, two roles or two\ntemplates cannot share a label, because `apply` matches by label.\n\n## Entity\n\n<!-- generated:start entity -->\n\n#### Entity\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable entity alias, unique within the contract |\n| `label` | text | yes | The table\'s name in the workspace, which apply names it |\n| `singular` | text | no | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | no | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `writes` | `false` | no | false: no app opens or edits this table\'s rows. Direct writes follow the table\'s access, as on any table |\n| `fields` | list of [Field](#field) (at least one) | yes | The table\'s columns |\n| `read_scope` | [Read scope](#read-scope) | no | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list of list of alias (at least one) (at least one) | no | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, or a link of cardinality "one"). A create or update landing a second row with the same values is refused. |\n| `views` | list of [View](#view) | no | Saved views, in the order they are listed; with none, the table still opens on its default grid |\n\n#### Read scope\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option)) (at least one) | yes | A row is readable when ANY of these holds |\n\n#### Read scope by role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `member_of` | alias | yes | A role alias: whoever is in the group it binds to reads the row |\n\n#### Read scope by member\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `through` | list of alias (1\u20133) | no | select_record_link aliases from this entity outward, each of cardinality "one" \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias | yes | A select_member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"` | yes | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `through` | list of alias (1\u20133) | no | select_record_link aliases from this entity outward, each of cardinality "one" \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias | yes | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one) | yes | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end entity -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | An entity a create is mounted over \u2014 a register that adds, a rows block \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.required-cycle` | Required links never wait on each other in a loop: no row of the loop could be created first. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a declared role (`member_of`) or a field of its entity reached through one-row links: `"self"` a member field, options a single select declares. |\n| `entity.unique` | A `unique` set names two fields or more of its entity once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; one field alone is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this entity holding ONE value \u2014 text, number, date, a single select, a link\nof cardinality `"one"` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. `model apply` REFUSES a model where a table\nsome create opens \u2014 a register\'s own, or a record section\'s add \u2014 states none.\n\n**`writes: false` says no app opens, edits or files these rows** \u2014 a log of what\nthe system sent, a copy of what another system holds. A record listing them\nkeeps the section and opens each row at rest, with no Add; a screen over the\nentity operates at most the rows its record owns; a party of it is picked, never\nfound or minted; and the generator writes no create and no update for it, and\nnever notes it as created nowhere. It shapes the apps, not who may write: a\ndirect write \u2014 the records API, the chat agent, an import \u2014 follows the table\'s\naccess, as on any table. A `lifecycle` on it is refused \u2014 a row walked\nthrough stages is worked by a person \u2014 and so is a publish desk over it (a rows\nblock\'s `post`), whose ticks make its rows. Absent,\napps open and edit the rows; `true` is not a value.\n\n**`read_scope` is a ROW rule, enforced by the platform.** It is resolved at\napply into the table\'s own row filters, so an app, a workflow reading for a\nviewer, and the API all answer the same rows \u2014 a per-record visibility field the\napp merely honours is a convention, not a gate. A `"self"` clause reads a column\nof one member or several, and every role alias and option alias a clause names\nmust be one this model declares. `apply` writes the rule onto a table it\nCREATES; a table it adopted that ALREADY CARRIES a rule keeps that one, because\nthe rule is the workspace\'s own statement about its rows \u2014 and a run whose model\nstates a different rule reports the entity rather than leaving the claim silent.\n\n**An app may state that its sharing is its read gate: `"reads": "shared"`.** An\napp reads as its owner, so the rule reaches a viewer only as the predicate every\nquery and editor guard of every app over the entity carries \u2014 right for a desk of\none\'s own rows, wrong for a desk whose audience its sharing already decides, where\nwidening the rule meant a role group nobody remembers to fill. Stated on an APP,\nits queries, pickers and guards carry no entity\'s rule and whoever the app is\nshared with reads and writes every row it draws; every other app and the table\'s\nown filters keep the rule. Share it deliberately. Refused on an app none of whose\ntables states a `read_scope`.\n\n**A row rule is never inherited.** A child read under a private record states\nits own: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink of `"cardinality": "one"`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the entity it names is created first, and entities\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A stored field\'s `writes: false` says no person keys it in an app** \u2014 a post\'s\nid a publishing workflow brings back, a count a sync fills. Every app draws it\nread wherever it is placed, no add or act asks it, no paper fills it, and the\ngenerator writes it in no create and no update; a statement line reads it as a\nfigure no person keys, and beside `default_from` it is copied when the row is\nmade and never keyed. It shapes the apps, not who may write: a workflow, the\nrecords API, the chat agent and an import write it as the table\'s access allows.\nA formula, a rollup, a lookup, an autonumber and a date `derive_from` stamps take\nno such key \u2014 no one keys them already. Absent, a person keys the field; `true`\nis not a value.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"select_member"` \\| `"select_record_link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"` | yes | What the field holds \u2014 each type takes the further keys its own section lists |\n| `alias` | alias | yes | Stable local alias, unique within the entity |\n| `label` | text | yes | The field\'s name in the workspace, which apply names it |\n| `description` | text | no | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | no | Refuse a record whose cell for this field is empty. Apply writes it onto the field, and every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | text | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `unique` | boolean | no | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` | no | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | number | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `notation` | [notation](#number) | no | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nThe keys `notation` replaced \u2014 `format`, `currency`, `unit`, `unit_field` and\n`currency_field`, on a number or in a formula, and a formula\'s `format: "link"`\nfor `link: true` \u2014 are no longer read. A field stating them naming another\nreading than its `notation` (a decimal, where it states none) is refused, and the\nfinding names the `notation` to write in their place: `"format": "currency",\n"currency": "USD"` becomes `"notation": { "style": "currency", "currency": "USD" }`.\nWrite `notation`.\n\nAn ABSENT number is drawn absent \u2014 the one exception is a\n`sum` or count rollup the plan reads as a **`measure`**: that is the thing\naccumulated toward a bound, so nothing accumulated yet is zero and the meter\ndraws it. The same rollup read as an `amount` keeps its blank, and so does every\nother role: nothing added to what a row is WORTH means unpriced, not free. A\nformula reading only such sums and counts, and reading zero where each does\n(`{received} - {refunded}`), is one too. A `min`, an `avg`, a percentage of\nnothing and every other formula stay blank in any role, because none of them has\nan answer to give. This is why the pair on one\nscreen reads two ways \u2014 what has come in against what is owed \u2014 and why a\nmeasure\'s own LIMIT, an amount, leaves an unquoted row out of the count rather\nthan reporting it as nothing collected. **AND WHERE THAT LIMIT IS ABSENT \u2014 OR\nZERO \u2014 THERE IS NO LEVEL AT ALL**: a level is a reading AGAINST a bound, so a row\nthat states no bound, or a bound of nothing, draws nothing \u2014 cell, fact and all \u2014\nrather than a numerator whose whole meaning was the comparison. "Collected 0"\nbeside a blank total reads as money against a job worth nothing, and "0 of 0"\nagainst a count of nothing owed claims a comparison nobody can make. A measure the model gives no limit is a plain figure\nand is unaffected. A share is stored in percent units \u2014 68.1 is 68.1 % \u2014 and the\ncolumn, the fact behind it, the meter it is judged by and the figure over the\nregister all say so.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own in `formula.notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`lotics run update_table`. `model apply` never makes it: the model states the\nworkspace\'s unit until then. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit (past three units a total the runtime draws over a set of rows \u2014\nsummary line, group totals and feet, a dashboard\'s table foot \u2014\nstates the count alone; a reading an author states draws every unit), a chart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this entity \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused. A lookup of such a figure stands only\nwhere its entity also looks up the figure\'s select through the same one-link,\nand reads in that lookup; otherwise it is refused. A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | text | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. A date string in the field\'s format. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `format` | `"date"` \\| `"datetime"` \\| `"date_range"` \\| `"datetime_range"` | no | Whether the field holds a day or a moment, alone or as a span |\n| `timezone` | text | no | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | no | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | boolean | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `default` | list of alias | no | Value pre-filled into a new record when none is supplied for this field. Applied on create only \u2014 existing records are never backfilled. Option alias(es) this field declares \u2014 one for single-select. |\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `options` | list of [Select option](#select-option) (at least one) | yes | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | no | Allow multiple selections |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable local alias, unique within the field |\n| `label` | text | yes | Display label for the option |\n| `color` | [colour](#select) | no | The colour the option\'s badge is drawn in; absent, the platform gives it one no sibling option holds |\n| `mark` | [mark](#select) | no | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, kiotviet, misa, lark, payos}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n\n<!-- generated:end field-select -->\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another entity. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `apply` writes the\nmarks onto the table, sets one an adopted option lacks, and reports one it wears\ndifferently rather than overwrite it. The glyphs:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, facebook, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, instagram, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, linkedin, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, twitter, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### `select_member`\n\nA person picker over the workspace\'s members. No default: a model cannot name\nmembers of a workspace that does not exist yet. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-select_member -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `multi` | boolean | no | Allow multiple selections |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-select_member -->\n\n### `select_record_link`\n\n<!-- generated:start field-select_record_link -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n| `target_entity` | alias | yes | Alias of the entity this field links to |\n| `sync_both_ways` | boolean | no | Create a paired link field on the target entity for bidirectional sync |\n| `paired_field_alias` | alias | no | The pair edge of a bidirectional link: the field alias ON THE TARGET ENTITY that is this link\'s sync partner. Both sides of a pair carry it, each naming the other. Apply creates whichever side it reaches first WITH the pairing (the platform auto-creates the partner) and binds the partner alias to the auto-created field \u2014 without this edge the two contract fields would be created independently and collide with the auto-created partner. |\n| `cardinality` | `"one"` \\| `"many"` | no | How many linked records this field holds. Default \'many\'. \'one\' holds a single row and needs no partner; where the link IS paired, the partner side holds many. |\n| `display_field_aliases` | list of alias | no | Not taken: a link shows the row it names by the target\'s own title (`records.<entity>.title`), so a link states no display fields |\n| `default_from` | text | no | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-select_record_link -->\n\nA two-way link is declared on BOTH sides, each naming the other as its\n`paired_field_alias`; the pair must be symmetric or the model is refused.\n\n**A single-valued link needs no partner.** `"cardinality": "one"` on its own is a\nlink that holds one row \u2014 one customer on an invoice, one project on a device \u2014\nand nothing is created on the target. The mirror invariant belongs to a PAIRED\nlink: pair a link when the target\'s own record should list what points at it, and\nleave it unpaired when it should not. Either way the record plan draws the\nrelation as a section on the side it points at, so an unpaired link costs the\ntarget nothing.\n\n### `files`\n\nA row attaches documents to it (\xA7 Rows). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n<!-- generated:start field-files -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `writes` | `false` | no | false: no person keys this field in an app \u2014 a workflow or an integration writes it. Every app draws it read, no add or act asks it and no paper fills it. Direct writes follow the table\'s access, as on any field |\n\n<!-- generated:end field-files -->\n\n### `formula`\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `formula` | [Formula](#formula) | yes | Formula config. The expression references other fields on the SAME entity by alias in braces, e.g. `{quantity} * {unit_price}`. |\n\n#### Formula\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `expression` | text | yes | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `notation` | [notation](#number) | no | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | no | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | no | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | no | What the expression YIELDS \u2014 the kind the platform infers at write time, declared here so the offline checks can read it. `notation` beside it is how a number result reads, not what it is. Ignored on the wire (the platform re-infers it); `lotics model pull` writes the inferred value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a model has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the copy writes that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up from another\nentity is tested there, in a formula of its own, and that result looked up.\n\n**The language.** The offline check and the platform compute a formula with one\nengine, and the check refuses a call or a name it cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- Strings: upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\')\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), differenceInCalendarDays(later,earlier), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this entity.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `source_field_alias` | alias | yes | Alias of a select_record_link field on this entity to roll up from |\n| `aggregate_option` | [aggregation](#rollup) | yes | Aggregation operation. Its `field_key` names a field alias on the linked entity. |\n| `filter` | [filter](#views) group | no | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n\n<!-- generated:end field-rollup -->\n\n`aggregate_option` is `{ "operation": \u2026, "field_key": \u2026 }` \u2014 `field_key` a field\nalias on the linked entity (`count` may omit it), and `operation` one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `source_field_alias` | alias | yes | Alias of a select_record_link field on this entity to look up through |\n| `lookup_field_alias` | alias | yes | Alias of the field on the linked entity to display |\n| `order_by` | [Lookup order](#lookup-order) | no | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field_key` | text | yes | A field alias on the linked entity the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"` | yes | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `prefix` | text | no | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | no | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | no | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n\n<!-- generated:end field-autonumber -->\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its entity names \u2014 a link no copy fills \u2014 into a field of the same type, date format and notation that `derive_from` does not stamp: a lookup only through a one-row link, a link only into one to the same entity, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so an add sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.writes` | A stored field\'s `writes: false` says no person keys it in an app \u2014 a workflow or an integration writes it: every app draws it read, no add (`create`) or act asks it and no paper fills it, and a required one takes a `default` or a `default_from` where an app adds its rows; never on a date `derive_from` stamps, which is read already. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.option-colors` | *Noted, never refused:* Two options of one select hold the same colour, so a plan, a badge or a dot cannot tell them apart. Drop the colour from all but one and the platform gives each a colour no sibling holds, or name distinct colours. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a declared entity: its `paired_field_alias` a link on it naming this one back \u2014 and of two paired links at most one reads one row. |\n| `field.link-display` | *Noted, never refused:* A link states no display fields: every link shows the row it names by the one field its entity\'s table names its rows by (`records.<entity>.title`, else what the table states). A file stating `display_field_aliases` has it ignored. |\n| `field.formula` | A formula parses, reads fields of its own entity by alias, names an option as `{field:option}` of one a select declares, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type`, else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its entity, a field of the linked entity by an operation a model declares and that field\'s type takes \u2014 never a figure read in each row\'s own unit or currency \u2014 filtered on fields of the linked entity. |\n| `field.lookup` | A lookup reads, through a link of its entity, a field of the linked entity \u2014 a figure read in each row\'s own unit or currency only where this entity looks up that row\'s select through the same one-row link \u2014 ordered by a field of it. |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Views\n\nSaved views live under the entity they belong to. Every field reference is a\nfield ALIAS on that entity.\n\n<!-- generated:start views -->\n\n#### View\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable view alias, unique within the entity |\n| `label` | text | yes | Display name of the view |\n| `description` | text | no | The view\'s description, written onto the view in the workspace |\n| `columns` | list of [View column](#view-column) (at least one) | no | The columns the view shows, in this order and no others; absent, every field |\n| `filters` | [filter](#views) | no | The rows the view keeps |\n| `sort` | [sort](#views) | no | The order the view reads its rows in |\n| `summary` | map of text \u2192 text | no | Field alias \u2192 the operation its footer cell states |\n| `frozen_columns` | integer \\| `null` | no | How many leading columns stay in place while the rest scroll |\n\n#### View column\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field_alias` | alias | yes | A field of this entity |\n| `visibility` | `"visible"` \\| `"hidden"` | yes | Field visibility state: \'visible\' = shown to everyone, \'hidden\' = not shown by default but members can toggle |\n| `width` | number | no | The column\'s width, in pixels |\n\n<!-- generated:end views -->\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "type": "select", "field_key": "tier", "operator": "has_any_of",\n"value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition\'s `type` is the field\'s type and its `operator` is\none that type admits \u2014 `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-view -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `view.fields` | A view\'s columns, summary, sort and filters name fields of its entity. |\n\n<!-- generated:end rules-view -->\n\n## Roles\n\nA role becomes a workspace group.\n\n<!-- generated:start roles -->\n\n#### Role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | Stable role alias, bound to a workspace group when the model is applied |\n| `label` | text | yes | The group\'s name in the workspace |\n\n<!-- generated:end roles -->\n\n## Templates\n\nAn `html` or `email` template carries its content inline, and `{{name}}` in it is filled\nfrom the workflow\'s data; an `excel` template names an uploaded workbook by its `file_id`,\nfilled with the register\'s report by its `export` alone.\n\nInline content is refused where it holds a script, a frame, a `<link>`, an inline event handler or a\n`javascript:` URL; an `html` one may be a fragment, kept as written and printed as a whole document. An apply brings a\ntemplate it made before to the content the model states, and leaves one it adopted by its label as\nits owner wrote it.\n\n<!-- generated:start templates -->\n\n#### Template\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"html"` \\| `"email"` \\| `"excel"` | yes | html is a page a workflow renders to a PDF; email is a message a workflow sends; excel is a workbook a register\'s export fills |\n| `alias` | alias | yes | Stable template alias, unique within the contract |\n| `label` | text | yes | The template\'s name in the workspace |\n\n<!-- generated:end templates -->\n\n### `html` and `email`\n\n<!-- generated:start template-inline -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `content` | text | yes | Inline template content; placeholders reference field aliases |\n| `content_sha256` | text | no | sha256 (64-char lowercase hex) of the utf-8 content; derived where the template is written when absent |\n| `locale` | `"vi"` \\| `"en"` | no | The language its figures, dates and amounts in words print in; absent prints in the organization\'s |\n\n<!-- generated:end template-inline -->\n\n### `excel`\n\n<!-- generated:start template-excel -->\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `file_id` | text | yes | The uploaded .xlsx (`fil_\u2026`) the template is made from; its markers read what the export fills it with |\n\n<!-- generated:end template-excel -->\n\nA paper that has to look like a counterparty produced it \u2014 an official letter,\nan acceptance minute, a supplier\'s bill \u2014 is the same `html` template with a\nshell around the body: a letterhead, a reference line, a seal and a signature\nblock, and paper grain over everything. One shell, many bodies; the data is the\nonly thing that changes, so a workflow can re-issue it over any record.\n\n```jsonc\n{ "alias": "cong_van", "label": "C\xF4ng v\u0103n", "type": "html",\n "content": "\u2026the page below, as one JSON string\u2026" }\n```\n\n```html\n<style>\n .sheet{position:relative;width:718px;padding:44px 58px 30px;background:#fbfaf6;color:#111;font:14.2px/1.5 \'Liberation Serif\',serif}\n .grain{position:absolute;inset:0;opacity:.34;mix-blend-mode:multiply;background:url("data:image/svg+xml;utf8,<svg xmlns=\'http://www.w3.org/2000/svg\' width=\'140\' height=\'140\'><filter id=\'f\'><feTurbulence baseFrequency=\'.9\' numOctaves=\'2\'/><feColorMatrix values=\'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .35 0\'/></filter><rect width=\'140\' height=\'140\' filter=\'url(%23f)\'/></svg>")}\n .top{display:flex;text-align:center;font-size:13.4px} .top>div{flex:1} .u{display:inline-block;border-bottom:1px solid #111;font-weight:700}\n .ref{display:flex;text-align:center;font-size:13.4px;margin-top:6px} .ref>div{flex:1} .ref .r{font-style:italic}\n h1{text-align:center;font-size:15.6px;margin:26px 0 18px} p{text-align:justify;text-indent:26px;margin:0 0 9px}\n .sig{display:flex;margin-top:20px} .sig .l{flex:1} .sig .r{width:290px;text-align:center;position:relative}\n .sig .nm{font-weight:700;margin-top:96px} .seal{position:absolute;left:4px;top:8px;width:166px;height:166px;opacity:.66;mix-blend-mode:multiply;transform:rotate(-17deg)}\n </style>\n <div class=\'sheet\'><div class=\'grain\'></div>\n <div class=\'top\'><div><b>{{issuer_parent}}</b><br><span class=\'u\'>{{issuer}}</span></div>\n <div><b>C\u1ED8NG H\xD2A X\xC3 H\u1ED8I CH\u1EE6 NGH\u0128A VI\u1EC6T NAM</b><br><span class=\'u\'>\u0110\u1ED9c l\u1EADp - T\u1EF1 do - H\u1EA1nh ph\xFAc</span></div></div>\n <div class=\'ref\'><div>S\u1ED1: {{number}}</div><div class=\'r\'>{{place}}, ng\xE0y {{day}} th\xE1ng {{month}} n\u0103m {{year}}</div></div>\n <h1>{{title}}</h1>\n <p>K\xEDnh g\u1EEDi: {{recipient}}.</p>\n {{{body}}}\n <div class=\'sig\'><div class=\'l\'><b>N\u01A1i nh\u1EADn:</b><br>- Nh\u01B0 tr\xEAn;<br>- L\u01B0u VT.</div>\n <div class=\'r\'><img class=\'seal\' src=\'{{seal_url}}\'><b>{{signer_title}}</b><div class=\'nm\'>{{signer}}</div></div></div>\n </div>\n```\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) \u2014 never a files field or a computed select. On one record it is\nhanded, too, the rows of each child the record draws as `rows` whose alias the\ntemplate names, listed under that alias for `{{#each <alias>}}` in place of the\nrecord\'s own link to them: every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. Over\nseveral rows the rows are listed under the entity\'s alias, for\n`{{#each <alias>}}`, without their child rows.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals |\n| `{{date issued_on}}` | `14/09/2026`; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\n## Rows\n\nFirst records, keyed by entity alias. Up to 200 rows per entity and 2000 across\nthe model, attaching at most 2000 documents between them \u2014 a real data set\nbelongs in an import, not a model.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `ref` | text | yes | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value | yes | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its entity. |\n| `rows.required` | A row states every field its entity requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.distinct` | Open rows of an entity a register lists read apart: no two state the same title and the same line under it, and an autonumber on the line reads every row apart. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<entity>:<ref>"` of a row of the linked entity in this file for a link, `"self"` for a member, a relative path beside the file or a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\nA `files` cell attaches documents: paths relative to this file (no `..`, never\nabsolute), which the check proves exist and `apply` uploads into the workspace\nbefore any row is written \u2014 a paperwork business seeds its papers with its\nrows. The server accepts only `fil_` ids of files this workspace owns, which is\nwhat the upload leaves behind. After a run that wrote rows, the WORKSPACE holds\nwhich record each row became, under the row\'s own `<entity>:<ref>`:\n`delete_records` over them is how a seeded set is reset, and applying again\nre-dates it.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `select_record_link` | `"<entity-alias>:<ref>"` naming another row in this file \u2014 `"customer:acme"`, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `select_member` | `"self"` only \u2014 the person applying the model |\n| `files` | paths beside this file \u2014 `["scans/pccc_letter.png"]` \u2014 uploaded by `model apply`/`setup` before the model is sent; or `fil_` ids of files already in this workspace |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe model is applied, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of each entity is RECOGNISED \u2014 once per entity, keyed by\nentity alias \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every entity an app lists, opens or picks has one.\n\n```jsonc\n"records": {\n "visit": {\n "title": "container_no",\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n },\n // A release order read against what it allows: a meter wherever it shows.\n "release": { "title": "release_no", "figure": "issued", "limits": { "issued": "units" } },\n // A dossier\'s stage is the last date it reached \u2014 no stored select.\n "dossier": { "title": "applicant", "status": { "milestones": ["received_on", { "field": "appraised_on", "when": { "kind": ["loan"] } }, "signed_on"], "closed": ["signed_on"] } },\n // A site owes a diary page each day it works, from breaking ground through handover.\n "site": { "title": "name", "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n}\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `title` | alias | yes | The field that names a row \u2014 the first thing every surface shows: who or what it is, a link naming it by the linked row (a job read by its customer). Any field but a button or a yes/no; the table\'s own setting, which every link to it shows |\n| `subtitle` | list of alias (1\u20132) | no | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): one line at a desk, wrapping to a second on a phone |\n| `image` | alias | no | A files field that pictures the row \u2014 never one an act keeps the document it makes in |\n| `mark` | alias | no | A single select whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. Never beside `image` or `party`, and never the status field |\n| `description` | alias | no | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` | no | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | no | The stage a row moves through \u2014 a single select or its milestone dates \u2014 drawn as a badge beside its title |\n| `figure` | alias | no | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | no | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | no | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | no | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | no | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue |\n| `frees` | alias | no | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | no | A yes/no of the row (stored, or a formula: an invoice paid in full) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A dashboard\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | no | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `cadence` | list of [Cadence](#cadence) (at least one) | no | The rows of a child each row owes one of a day, on the days of the week listed (a site\'s diary page, Monday to Saturday) \u2014 one entry a child, never owed on a day still to come. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | no | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n| `scan` | `"text"` \\| `"iso6346"` | no | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands |\n| `place` | [Place](#place) | no | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | no | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | no | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | no | Each row is a place on a picture (a spot on a container\'s drawing, a room on a plan): a record listing rows that link to these by a single link draws that picture over them, a numbered pin at each listed row\'s place, each row led by its number, the row opened lit on it and a pin pressed opening its row |\n\n#### Cadence\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entity` | alias | yes | The child entity owed: each of its rows stands on one row of this entity by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one) | yes | The days of the week one is owed on, each listed \u2014 `mon` to `sun` |\n| `from` | alias | no | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | no | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n\n#### Place\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `address` | alias | yes | A text field: the address, as people write it |\n| `latitude` | alias | yes | A number field: degrees north, negative south |\n| `longitude` | alias | yes | A number field: degrees east, negative west |\n| `accuracy` | alias | no | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `photos` | list of alias (at least one) | yes | Files fields of this row holding photos taken on site |\n| `place` | alias | no | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number | yes | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `on` | alias | yes | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias | yes | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias | yes | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an act keeps the documents it makes in (`into`). |\n| `records.mark` | `mark` is a single select, never the status field, and never beside `image` or `party` \u2014 a list keeps one lead slot \u2014 nor on the folder an app works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a section\'s too. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `today` a date or a moment (never a span), `me` a member \u2014 and an add that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, or a formula) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 lists each day of the week once, and `from` and `until` are two different days of this entity. |\n| `records.scan` | A title read off a photo (`scan`) is a text field the row stores. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.plan_place` | A `plan_place` names `kind`, `sheet` and `reach_from` as single selects, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image`, and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. |\n| `records.picture` | *Refused until adopted or declined:* Rows an app draws that each hold one files field no act makes, no call is filed into, no files block keeps and no list compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it \u2014 a code a\n person chose among them; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the entity says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, or the\nmilestone dates it reaches \u2014 drawn as a badge beside its title wherever the row is.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | no | The single select that is the row\'s state \u2014 or `milestones` instead |\n| `milestones` | list of (alias \\| [Milestone](#milestone)) (at least 2) | no | Dates in the order the work reaches them, instead of a stored select: the stage is the last one filled, ticking one stamps today, and clearing one clears every later one |\n| `closed` | list of alias (at least one) | no | Options (or milestones) that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `history` | alias | no | A child entity every status change appends one row to (its link to this entity, the new status, the moment and who) \u2014 written by the app\'s own writes, never a table automation; a row the model seeds opens it at its status, the day the rows land, unless the model states its rows; with `field` only |\n| `stages` | map of alias \u2192 [Stage](#stage) | no | Option alias \u2192 who owns that stage and how long it should take: the owner alone presses the acts offered there, refused on the server for anyone else. The status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it; with `field` only |\n\n#### Milestone\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A date field: the stage is reached on the day it holds |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | yes | The stage applies only while each named select holds one of these options, and each named stored yes/no is this value; otherwise the row skips it |\n\n#### Stage\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `owner` | text \\| [Stage role](#stage-role) | yes | Who owns the stage: a member field of the row, `link.field` read through a one-row link, or `{ role }` \u2014 a group |\n| `within` | integer | no | Whole days the stage should take from the moment the row entered it |\n\n#### Stage role\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `role` | alias | yes | A role of the model\'s `roles`: every member of the group it binds to owns the stage |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, `closed` naming options of it \u2014 or its `milestones`. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.history-derived` | A `history` the model does not declare is derived and keeps one entity\'s moves, labelled by that entity ("L\u1ECBch s\u1EED <entity label>", or "<entity label> history"): no declared table holds that label, and the entity has no other field under the link it adds. |\n| `records.history-scope` | A status history reads by its record\'s `read_scope`, answered through its one-row link to the record within the links a row rule reaches \u2014 or it states its own. |\n| `records.milestones` | Milestones are dates a person ticks, each named once; `closed` names some of them, and a deadline (`due`) is never one. |\n| `records.milestone-add` | An add asks the first milestone at most \u2014 each after it is ticked in order. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link, or a declared role, on an option that does not end the work; a role\'s stage needs the status `history` with who moved the row. A status with stages moves only by acts that `set` one of its options \u2014 no save writes it, and no act asks it, sets it otherwise or writes it from a workflow \u2014 and the moment its row entered its stage is kept in `<status>_since`, derived beside it, which nothing else writes. |\n| `records.history-note` | *Noted, never refused:* A record, never a task, whose stored status an act of its app moves, with no `history`: when a row entered each status and who moved it is kept nowhere. |\n| `records.detour-note` | *Noted, never refused:* A stage the work only steps aside into \u2014 not where a row starts, entered from one step alone that also moves the work on without it, and left by its own moves only back to that step (a pause, a repair) \u2014 is a detour: its option and the section staged at it stand before that step\'s, else the work reads it as its next step, and the act moving the work into it leads that section \u2014 never a correction waiting in a \u22EF. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them. A `history` entity gets one row per move \u2014 its link to this\n entity, the new status (a select holding the same option aliases, or text), the\n moment and who \u2014 appended by the app\'s own writes that move the status, never by a\n table automation. A `history` the model does not declare is derived, and needs no\n `records` entry of its own.\n- **Milestones** are the alternative to a stored select: dates in the order the work\n reaches them, the stage being the last one filled (never stored). A milestone with a\n `when` applies only while its select holds those options and its stored yes/no that\n value; otherwise the row skips it.\n The record draws them as one block where ticking stamps today and clearing one clears\n every later one; every save and act re-checks that a date comes after each earlier one\n that applies. `closed` names the milestones that end the work. A register\'s add may ask\n the first milestone, never a later one; an act may stamp one, never clear it.\n\n## Write rules\n\n`write_rules` is what a WRITE meets, keyed by entity alias; each entity\'s is held\nby its table. Every generated write of an\napp (`create_<entity>`, `update_<entity>`, each act) re-checks these on the\nserver; the screen only mirrors them. An `options_where` holds beyond the apps:\nevery save of the link \u2014 the grid, a record\'s form, an import, a workflow, the\nAPI \u2014 is refused where it names a row the narrowing does not admit, and every\npicker of the link offers only the rows it admits.\n\n```jsonc\n"write_rules": {\n // A customer is RECOGNISED by their address. An add that names one \u2014 from the\n // customers register or from a picker\'s "new" \u2014 reuses the row it matches and\n // opens one only where nothing does, so the book never grows a second Acme.\n "customer": { "natural_key": ["email"] },\n "order_line": {\n "fields": {\n // A line of nothing is not a line. Refused on create and on update.\n "quantity": { "min": 1, "max": 9999 },\n // Shipped inside its order\'s window: a bound read off the row a link names\n // is held from both sides \u2014 moving the order\'s dates never strands a line.\n "ships_on": { "min": "order.placed_on", "max": "order.due_on" },\n // Nothing is sold off an empty shelf. Every picker of the link reads only\n // the rows that answer this, and every save refuses the same rows again.\n "product": {\n "options_where": {\n "node_type": "group", "logic": "and",\n "children": [{ "node_type": "condition", "type": "number",\n "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n },\n // One booking per room at a time, while it is held: a create or a save whose\n // span overlaps another held booking of the same room is refused.\n "booking": {\n "fields": { "ends_on": { "min": "starts_on" } },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n}\n```\n\n<!-- generated:start write-rules -->\n\n#### Entity write rules\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `natural_key` | list of alias (at least one) | no | The field aliases a row of this entity is RECOGNISED by. A write that names a row of this entity by these values reuses the row it finds, minting one only where nothing matches. |\n| `fields` | map of alias \u2192 [Field write rule](#field-write-rule) | no | Field alias \u2192 what that field\'s value is bounded by or picked among |\n| `no_overlap` | [No overlap](#no-overlap) | no | No two rows hold overlapping spans \u2014 a create or update that would is refused |\n\n#### Field write rule\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `min` | number \\| text | no | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | no | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n| `options_where` | [filter](#views) | no | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET entity\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | no | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both entities to the same entity. It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `suggest` | text | no | A text field whose control offers, as the reader types, the distinct values a text field of a catalog holds \u2014 `<entity alias>.<field alias>` (a damage position\'s code among the codes on file); any text is still written |\n\n#### No overlap\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | alias | yes | The stored date (or datetime) a row\'s span starts on |\n| `to` | alias | yes | The stored date (or datetime) a row\'s span ends on \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of alias (at least one) | no | Fields two rows share to compete for a span (the same employee, the same room); absent, every row |\n| `while` | map of alias \u2192 list of alias (at least one) | no | Only rows at these options of these selects hold their span (running, not closed); absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the entity\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number or a date \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names `<entity>.<field>`, a stored text field of a declared entity; the app reads that entity, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links this entity and the link\'s target both hold to one entity. |\n| `write.options-where` | `options_where` narrows a link by an `and` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap` | `no_overlap` spans two date fields; `by` names values rows share \u2014 a link, a person, one option, a text or a number; `while` names single selects by their options. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the entity\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `min` or `max` naming a field is read off the row as the save would leave it,\n and one naming `<link>.<field>` off the row the link names \u2014 the link\'s side\n re-checks its own rows when that bound moves.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both entities hold to one\n entity; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n moving what the two compare, on either row, is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the contract carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (\xA7 `text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## Apps\n\nAn app is ONE working register over one entity and the record each row opens, with the\nlogs that stand beside it (`logs`) \u2014 or a dashboard of readings. The author states COMPOSITION \u2014 which fields go where; the runtime owns\nhow each thing looks, one treatment per concept. Nothing is drawn that the app does not\nname, and each fact appears once on a record. What the vocabulary has no word for is an\nact\'s own `workflow`, or a workflow the app declares beside its acts (`workflows`).\n\n```jsonc\n"apps": [{\n "alias": "gate", "name": "Gate in and out", "entity": "visit",\n "register": { "columns": ["service"], "filters": ["customer", "service"] },\n "record": {\n "sections": [\n { "title": "In", "fields": ["customer", "service"], "blocks": [{ "rows": "fee", "columns": ["amount"] }] },\n { "title": "Out", "at": ["in_yard"], "fields": ["release", "seal"], "blocks": [{ "files": ["photos"] }], "acts": ["gate_out"] }\n ]\n },\n "acts": [{ "alias": "gate_out", "label": "Gate out", "when": { "stage": ["in_yard"] },\n "requires": ["release", "seal"], "set": { "stage": "gone", "left_on": "now" }, "confirm": true }],\n "checks": [{ "field": "unpaid", "blocks": ["gate_out"] }]\n}]\n```\n\nThe keys below are the app\'s own. Each part it composes is a page of its own: `model/logs`, `model/workflows`, `model/queries`, `model/register`,\n`model/layouts`, `model/tabs`, `model/export`, `model/readings`, `model/averages-and-bands`, `model/dashboards`, `model/record-page`,\n`model/blocks`, `model/composed-page`, `model/publish-desk`, `model/timeline-and-agenda`, `model/statements`, `model/reading-blocks`, `model/list-block`, `model/tasks`, `model/acts`,\n`model/papers-and-recordings`, `model/checks`.\n\n<!-- generated:start apps -->\n\n#### App\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The app\'s name within the model \u2014 what `--from model.json#<alias>` picks |\n| `name` | text | yes | The job, in the words of the people who do it |\n| `description` | text | no | What the job is for, in a sentence |\n| `icon` | text | no | A lucide icon name the launcher tile draws |\n| `theme` | [Theme](#theme) | no | The launcher tile\'s colour |\n| `labels` | map of alias \u2192 text | no | A field alias of the app\'s entity (a book\'s field lined up by alias takes it too) \u2192 the words this app\'s screens show for it. The column keeps its own name; each label is non-empty, has no `{` or `}`, and differs from every other field\'s shown label |\n| `entity` | alias | yes | The entity whose rows this job works \u2014 the register\'s rows |\n| `books` | list of [Book](#book) (at least one) | no | Other entities the register reads as one list with `entity`\'s rows, each opened, edited and acted on in its own table: the same app over each, its fields lined up with `entity`\'s. Only a table, cards or a plan |\n| `scope` | alias | no | A required one-row link of the entity: the app works inside one row of the linked entity at a time (a project, a branch), picked from a list of them, and every row it reads, counts and adds is that row\'s |\n| `reads` | `"shared"` | no | Every member reads every row, whatever the entity\'s read scope |\n| `writes` | `"children"` \\| `false` | no | `children`: the reader adds and edits the record\'s child rows but not the record\'s own fields. `false`: the reader adds, edits and deletes nothing in the app \u2014 no add, no save, no Delete. Either way the app\'s acts still move a record |\n| `row` | [Row display](#row-display) | no | How this job reads the entity\'s rows where it reads them otherwise than `records` (a cashier\'s figure is what is owed): the subtitle, figure and image stated replace the entity\'s wherever this app draws its rows \u2014 the register, a card, the record\'s header, a calendar, lane or roster entry. The title stays the entity\'s |\n| `register` | [Register](#register) | no | The rows: which columns and filters, the order, how a row is added |\n| `record` | [Record page](#record-page) | no | What a row opens: the door, its sections, and the Activity its head opens \u2014 its saves, and its comments where stated |\n| `acts` | list of [Act](#act) | no | What the reader does to a record \u2014 each a press with its conditions and its write |\n| `checks` | list of [Check](#check) | no | Formulas that warn while they stand, or refuse the acts and saves they name |\n| `logs` | list of [Log](#log) (1\u20133) | no | The lists that stand beside the app\'s register, at most 3: each over another entity, read as a log of what was brought into the register\'s rows or done to them (the files imported, the runs of a batch), with the page a row of it opens. Each is one more entry among the app\'s lists, picked on the line under the title beside the register\'s own rows and counting its rows at an open option of its stored status, and opens as a register of its own inside this app \u2014 its reads, acts and workflows the app\'s. Only the organization\'s own members are shown a log and may read or act on it: a visitor through a public link, and a member of another organization, is not. `reads: "shared"` lifts no row rule of an entity only a log reads. Each list keeps its own records\' activity (`record.activity`). No other app\'s link and no dashboard list opens a row in a log. Never over an entity whose status states owned `stages`; never in an app that states `scope` |\n| `workflows` | map of alias \u2192 [Workflow](#workflow) | no | Workflows of the app no act runs, by alias \u2014 called through the app (`run_app_workflow`, its API) by an agent or a service: each states what it takes and hands back, and its body is set on the app (`set_app_workflow`) and kept by every apply. The screen draws nothing for one |\n| `queries` | map of alias \u2192 [Query](#query) | no | Reads of the app no screen draws, by alias \u2014 called through the app (`run_app_query`, its API) by an agent or a service: each states the rows it reads, what narrows them and what a call may state. The screen draws nothing for one |\n| `declines` | map of text \u2192 text | no | Decided rules this app stays outside of, each with why in a line: by id, and `records.picture:<entity>` and `model.template-act:<template>` with what they fire on. Read by the apply\'s check alone, never by the app |\n\n#### Theme\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `color` | [colour](#select) | yes | The tile\'s colour |\n\n#### Row display\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `subtitle` | list of alias (1\u20132) | no | Up to two fields read under the title in this app, in place of the entity\'s |\n| `figure` | alias \\| `false` | no | The one number a row stands for in this app, in place of the entity\'s; a `limits` bound on it reads as its meter; false, the app draws none |\n| `due` | list of alias (at least one) \\| `false` | no | Dates that are deadlines in this app, in place of the entity\'s; false, the app counts none down |\n| `image` | alias \\| `false` | no | A files field that pictures a row in this app, in place of the entity\'s; false, the app draws none |\n| `status` | `false` | no | false: the rows\' stage is not this app\'s to show \u2014 no badge on a row or in its head, no status chips or counts \u2014 where the entity states one |\n\n#### Book\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `entity` | alias | yes | Another entity whose rows the register reads beside its own \u2014 the same job over another table (a legacy ledger, a second branch\'s book) |\n| `fields` | map of alias \u2192 alias | no | A field of the app\'s entity \u2192 the field of this entity holding the same fact, where their aliases differ; a field the app reads lines up by its own alias otherwise, and one this entity lacks is blank on its rows and drops from what they open \u2014 an act, check or add needing it is not offered on them. Options line up by alias |\n\n<!-- generated:end apps -->\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.alias-unique` | An app\'s alias is unique among the model\'s apps, and an act\'s among its app\'s acts. |\n| `app.icon` | An app\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.theme` | An app states its launcher tile colour (`theme.color`); an app without one is drawn on a grey tile that tells it from no other. |\n| `app.labels` | An app\'s `labels` each name a field of the app\'s entity, say it in words that are not empty and hold no `{` or `}`, and differ from every other field\'s shown label. |\n| `app.records-entry` | Every entity an app lists, opens or picks \u2014 its own, a block\'s, a linked row\'s, a document\'s \u2014 has a `records` entry. |\n| `app.reads-shared` | `reads: "shared"` stands only where a table the app\'s register or its record reads states a `read_scope` \u2014 a table only a log reads keeps its rule. |\n| `app.writes-children` | An app that writes only the record\'s children (`writes: "children"`) adds no row of its own entity. |\n| `app.writes-none` | An app that writes nothing (`writes: false`) adds no row, so neither its register nor a block states a `create` list, and no block stands its lines `under` a document a person makes. |\n| `app.scope` | `scope` is a required one-row link of the app\'s entity, the same on every row the app lists \u2014 never a column, filter, search field, group, `where`, `opens`, section field or add question. |\n| `app.when` | A `when` holds single selects to options and yes/nos to `true` or `false`, stored or a formula of one (a formula with `options` is a select) \u2014 a milestone\'s `when` only a stored select or yes/no, read before any formula over it is computed. |\n| `app.asked-written` | What an add, an act or `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a section\'s field, an add\'s question or an act\'s ask: those rows are the record\'s own, read as a `rows` block. |\n| `app.create-asks` | An add asks fields of a table people write \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | An add (`create`) asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.books` | A register app\'s `books` each name another entity once \u2014 never the app\'s own \u2014 whose fields line up with the app\'s by alias, else by `fields` (a field the app reads, or one a report prints \u2192 one of the book\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each book holds the title, the status, the folder (`scope`), what `where` keeps and every check locking the rows; the register is a table, cards or a plan, whose `at`, `across` and `up` line up like any field. Two books holding a field of their own under one alias hold it as one kind of value. A report\'s `books` each name the app\'s entity or one of its books, once, and one of them holds each field its `where` and `per` narrow by. `register.book` reads a register that has books. |\n| `app.book-option-kin` | *Noted, never refused:* A book\'s option labelled as one of the app\'s, under another alias, reads apart from it: the register lists both and counts each on its own. |\n| `app.book-lacks` | *Noted, never refused:* A book lacking a field the app\'s record, an act or an add reads: what reads it drops from the book\'s rows \u2014 an act, a block, a section, the add. A field only a report prints, held by a book as another kind of value, prints blank on its rows. |\n| `app.rates-in-passing` | *Noted, never refused:* An app with no act, log or tabs of its own whose rows another app\'s lines copy a number off (`default_from` through a link) \u2014 the rates a quote is priced from \u2014 is worked only while that record is written: a block, a section or an act of that app, never an app of its own. |\n| `app.row` | An app\'s `row` states only what differs from `records`: a line that is not the title, a number for its figure, dates for its deadlines, a files picture no act makes documents into, or `false` for a figure, deadlines or picture the entity states and the app draws none of. |\n| `app.files-shown` | Every files field is drawn by some app over its entity \u2014 a section\'s `fields`, a `files` block, a column, the `image`, or where an act making its papers into it (`into`) stands, a section naming the act: the made paper reads under the act, one per template \u2014 or by an app reading its rows as one of its `books`, there by the book\'s own field. A files field no app should draw is left out of the model: the apply takes it off its table where no row holds a file in it and nothing reads it. |\n| `app.tasks` | *Noted, never refused:* A task entity an app lists whose rows no write of the app moves to a closed option (its ring stands disabled), or that an act ticks done and none moves back. |\n| `app.declines` | `declines` names decided rules that fire on the app, each with why the app stays as it is: by id, and `records.picture:<entity>` and `model.template-act:<template>`, said once per entity and per template, with what they fire on. |\n\n<!-- generated:end rules-app -->\n\n`writes: "children"` is a desk that adds and edits a record\'s child rows and never\nthe record itself; `writes: false` is a desk that reads \u2014 it adds, edits and deletes\nno row, its logs\' included, and only its acts write. `reads: "shared"` lifts every read scope the app\'s tables state \u2014\nrefused where none of them states one.\n\n`scope` names a required one-row link of the entity: the app works inside ONE row of\nthe linked entity at a time \u2014 a project, a branch, a season. With no folder remembered\nit opens on the list of them, each with how many of the app\'s rows it holds; inside,\nevery read, count and reading narrows to that one, an add files its row under it,\nand the record states its folder in the header. A scope narrows\nthe view; who may read what stays the entity\'s `read_scope`. The folder link is never a\ncolumn, a filter, a search field, a fact or an add\'s question.\n\nAn app whose job reads its rows otherwise than the entity\'s `records` restates them in\nits own `row` \u2014 the cashier\'s figure is what is still owed, its line the service and the\nday. The subtitle, figure and image it states replace the entity\'s wherever that app\ndraws a row of it; every other app reads `records`, and the title is the entity\'s.\n\n### Declines\n\nA rule the check marks *Refused until adopted or declined* is a treatment the apply requires unless the app\ndeclines it. The apply refuses an app missing one and hands it a patch stating it: merge the patch, or state in the app\'s `declines`\nwhy the app stays as it is, under the key the finding names \u2014 the rule\'s id, or `records.picture:<entity>` and\n`model.template-act:<template>` with what they fire on. A decline naming a rule that is not decided, or one no\nrows of the model could fire, is refused. Only the apply\'s check reads `declines`; the app never does. Which\ntreatment each rule stands for: the `design` reference.\n\n```jsonc\n"declines": { "register.span": "The yard plans by the day each hire is due back, never by its run of days" }\n```\n\n## Logs\n\n`logs` are the lists that stand beside the app\'s register: each over another entity, read as a log\nof what was brought into the register\'s rows or done to them \u2014 a supplier\'s price lists imported\ninto a catalogue of parts, the runs of a nightly batch \u2014 with the page a row of it opens. Here a\nline names its part by an optional one-row link, so a held line\'s part is picked where the line\nstands, and its old price is read against its new one.\n\n```jsonc\n"apps": [{\n "alias": "catalogue", "name": "Catalogue", "entity": "part",\n "register": { "columns": ["price"], "search": ["name", "code"] },\n "logs": [{\n "alias": "price_lists", "name": "Price lists", "entity": "price_list",\n "register": { "columns": ["read", "changed", "held"], "create": false, "remove": false },\n "record": { "door": "page", "sections": [\n { "title": "Held", "blocks": [{ "rows": "list_line", "where": { "outcome": ["held"] }, "columns": ["part", "why"],\n "compare": { "before": "old_price", "after": "new_price" }, "edits": ["part", "new_price"], "create": false }] },\n { "title": "Written", "blocks": [{ "rows": "list_line", "where": { "outcome": ["changed", "applied"] },\n "columns": ["part"], "compare": { "before": "old_price", "after": "new_price" }, "create": false }] }\n ] },\n "acts": [{ "alias": "apply_line", "label": "Apply", "of": "list_line", "when": { "outcome": ["held"] },\n "requires": ["part", "new_price"], "set": { "outcome": "applied" } }]\n }]\n}]\n```\n\nEach log is one more entry among the app\'s lists, picked on the line under the title (folding into one picker where its line cannot seat it), after one entry for the working register\'s own\nrows under the entity\'s label \u2014 counting the log\'s rows at an open option of its stored status; a log\nwhose entity states no status with `closed` options says no number, and a row holding no\nstatus is not counted. Picking the entry opens the log as a register of its own inside the\napp: its own columns, filters, search, order, add and pages, each row opening its own\nrecord with its sections, blocks and acts. Its reads, acts and workflows are the app\'s \u2014\none launcher tile, one roster.\n\n**Who reads a log.** The organization\'s own members, alone. A visitor through the app\'s\npublic link, and a member of another organization, is shown no entry for it, no address\nof it and no way into its rows, and its reads and acts are refused them. `reads: "shared"`\nis the app\'s statement of what its register and its record read: an entity only a log\nreads keeps its `read_scope`. Each list keeps its own records\' activity (`record.activity`)\n\u2014 a register stating `activity: false` shows none though a log keeps its own. A row of a\nlog opens from its own app: no other app\'s link, and no dashboard `list`, opens one there.\nThe designer\'s notes and decisions judge the app\'s register, never a log.\n\n**A log, or another app.** Decide it from the job. A list is a log of this register where\nits rows are what happened TO the register\'s rows \u2014 a file brought in, a batch run, a sync \u2014\nand are read by the same people in passing, to see what changed and to settle what could\nnot be placed. A list people work every day as a desk of their own \u2014 its own queue, its own\ndeadlines, its own people \u2014 is another app\'s register: a second working register is always\nanother app. The limits keep the difference:\n\n- at most three logs to an app, and none beside `scope`: a log reads every row of its entity;\n- a log is one list \u2014 a table or cards, no `tabs`, no `book` column, no `compose` \u2014 and\n states only its `alias`, `name`, `entity`, `register`, `record`, `acts` and `checks`;\n- its entity is never the app\'s own, one of its `books`\' or another log\'s, and never one\n whose status states owned `stages`: the rows waiting on a member are read off registers;\n- an act\'s alias is its own among the app\'s acts and its logs\';\n- no record of the app lists the rows of an entity another of its lists is over: a link to\n one of them opens it on its own list.\n\nA log\'s own rows are usually a claim of what the system did: state `writes: false` on the\nfields a workflow fills, `"create": false` and `"remove": false` on its register, and let\nits lines \u2014 which people do settle \u2014 be written in place (`edits`) and by their acts. An\napp stating `writes: false` writes none of its logs\' rows either: there, only acts write.\n\n<!-- generated:start apps-logs -->\n\n#### Log\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The log\'s name within the app \u2014 its place in the app\'s address, and unique among the app\'s logs |\n| `name` | text | yes | What the people who read the log call it, as its entry among the app\'s lists reads |\n| `entity` | alias | yes | The entity whose rows the log lists \u2014 never the app\'s own, one of its `books`\' or another log\'s |\n| `register` | [Register](#register) | no | The log\'s rows: which columns and filters, the order, how a row is added \u2014 a table or cards, with no `tabs` |\n| `record` | [Record page](#record-page) | no | What a row of the log opens: the door, its sections, and the Activity its head opens |\n| `acts` | list of [Act](#act) | no | What the reader does to a row of the log or to a child row its record lists \u2014 each alias unique among the app\'s acts and its logs\' |\n| `checks` | list of [Check](#check) | no | Formulas of the log\'s rows that warn while they stand, or refuse the acts and saves they name |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.logs` | A register app\'s `logs` \u2014 at most 3 \u2014 each list another entity under an alias of its own: never the app\'s own entity, one of its `books`\' or another log\'s. A log is one list \u2014 a table or cards, with no `tabs`, no `book` column and no composed record \u2014 over an entity whose status states no owned `stages`, and stands in an app that states no `scope`. An act\'s alias is its own among the app\'s acts and its logs\'. No record of the app or of a log lists the rows of an entity another of the app\'s lists is over: a link to one opens it on its own list. A list people work as a desk of its own is another app. |\n\n<!-- generated:end apps-logs -->\n\n## Workflows\n\nA job no press of the screen starts \u2014 an agent or a service handing the app a file, or a list of\nrows to reconcile a table against \u2014 is a workflow the app declares in `workflows`, by alias. The\nmodel states what it takes and what it hands back; a table is named by its entity and a select by\n`<entity>.<field>`, bound to this workspace\'s own at apply. The screen draws nothing for one: it is\ncalled through the app, by `run_app_workflow` or the app\'s API. On an app shared by a public link it\nruns only for someone who holds the app \u2014 a member it is shared with, or a key that reaches it \u2014 and a\nvisitor\'s call is refused as an alias the app does not have.\n\n```jsonc\n"workflows": {\n "reconcile_fees": {\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": {\n "service": { "type": "select", "field": "fee.service" },\n "amount": { "type": "number" }\n } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n }\n}\n```\n\nIts body is set on the app, never stated in the model: `set_app_workflow` with the app, the alias\nand the `source`, leaving `inputs` and `outputs` out \u2014 the body is checked against what the model\ndeclares. Every apply keeps that body and holds what it takes, what it hands back and its\ndescription to the model. To change what a workflow takes or hands back, change the model first:\nthe apply keeps the body where it still meets the change, and where it does not the workflow\nstands on no body again until `set_app_workflow` sets one that does.\nWith no body it refuses every call, and each apply says so. A workflow the model stops declaring is\narchived with its alias, as one bound on the app by hand that the model never declared is.\n\n<!-- generated:start apps-workflows -->\n\n#### Workflow\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `description` | text | yes | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | no | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | no | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n\n#### Workflow value\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"` | yes | What the value is |\n| `description` | text | no | What the value is for, read by whoever calls the workflow |\n| `required` | `false` | no | false: the value may be left out; absent, it is always there |\n| `multi` | `true` | no | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | no | The entity a `record_link` names a row of |\n| `field` | text | no | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of alias (at least one) | no | The values a `select` takes, where no field holds them |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | no | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | no | What each item of an `array` is |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.workflow-value` | A value a declared workflow (`workflows`) takes or hands back states what its type needs and nothing another type does: a `record_link` its `entity`, a `select` its `options` or the `field` holding them \u2014 never both \u2014 an `object` its `fields`, an `array` its `items`; `multi` stands on a `record_link`, `select`, `member` or `file`; an output is never a `member` or a `file`; and a value nests at most 8 deep. |\n| `app.generated-name` | A name the app generates is taken by nothing its model states. No declared workflow and no act\'s `workflow` is `record_activity` or `record_activity_undo`, unless the record states `activity: false`. No declared query, no reading\'s `alias` \u2014 a log\'s as it is read, `<entity>_<alias>` \u2014 and no tab\'s read (`<entity>_list_<tab>`) is the name of a read the app generates, of a declared query or of a reading. |\n\n<!-- generated:end apps-workflows -->\n\n## Queries\n\nAn app generates a query for everything its screen reads (`lotics docs agent_surface` lists them). A question\nthe screen never asks \u2014 one a caller asks the app through `run_app_query` or its API \u2014 is declared in\n`queries`, by alias, in the model\'s own aliases: the entity whose rows it reads, the fields each row\nreturns or the figure they add up to, and what narrows them.\n\n```jsonc\n"queries": {\n "fees_unbilled": {\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n },\n "fees_by_service": {\n "description": "What was charged per service: how many fees and their amount.",\n "rows": "fee",\n "reading": { "value": "amount", "by": "service" }\n }\n}\n```\n\nAn entry of `where` holds what a reading\'s `where` holds \u2014 a select\'s options, a yes/no\'s value, `"me"` on a\nmember field \u2014 or a value the call states: `{ "param": "<name>" }`, an object, which none of those is. A\nrequired param is always stated; one stating `required: false` may be left out, and the condition reading it\nthen narrows nothing. A query reads under its entity\'s read scope, as every read of the app does, and its\nown entity as its list reads it: kept by the register\'s `where`, and inside the row `scope` names \u2014 a param\nthe app adds to the query, `<linked entity>_id`. A `reading` returns one row for all the rows it reads, or\none per value of `by` or per day of `over`. The screen draws nothing for a query, and an apply compiles it\nwith the rest of the app: no body is set. An apply writes the queries the model compiles and no other:\na query set on the app outside the model (`set_app_queries`, on the CLI or in chat) is removed by the next apply, whose plan and\nanswer note it; declared under its alias in `queries`, it is the model\'s.\n\nA query reads one table: on an app that states `books`, whose list reads several, it names a book\'s own\nentity, never the app\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number\n\u2014 and never a number read in each row\'s own unit or currency, where one figure is a different amount on\neach row, nor a date holding a span.\n\nEvery reading of the app \u2014 a dashboard\'s, a register\'s band\'s, a record\'s block \u2014 is a query too, returning\nits groups. It is called by its place, `dashboard_reading_<n>`, `register_reading_<n>` or\n`block_reading_<n>`, counted from 0, so a reading moved is called by another name. One that states `alias`\nis called by it wherever it stands. A log\'s reading is called by the log\'s entity before either name:\n`<entity>_register_reading_<n>`, or `<entity>_<alias>`. A register tab\'s `totals` read is called by `<entity>_totals_<tab>` with the period\'s two days, `from` and `to`, both required. A register\'s reading placed in time (`over`) takes `from` and `to`,\neach left out at will; one above a register with tabs reads its `tab`\'s rows, or every tab\'s where it\nstates none:\n\n```jsonc\n{ "metric": "visit", "value": "fees", "where": { "paid": false }, "label": "Unpaid", "alias": "fees_unpaid" }\n```\n\n<!-- generated:start apps-queries -->\n\n#### Query\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `description` | text | yes | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 [Workflow value](#workflow-value) | no | What a call states, by name, each read by an entry of `where` \u2014 a `number`, `boolean`, `date`, `select`, `record_link`, `member`, holding one. `required: false`: the call may leave it out, and the condition reading it narrows nothing |\n| `rows` | alias | yes | The entity whose rows it reads, under that entity\'s read scope unless the app reads `shared`. The app\'s own entity is read as its list reads it: kept by the register\'s `where`, and inside the row the app\'s `scope` names, which the call states |\n| `fields` | list of alias (at least one) | no | The fields each row returns, by alias. A query states `fields` or `reading`, one of the two |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"` \\| [Query param](#query-param) \\| [Query range](#query-range)) | no | Only the rows meeting every entry, by field: a select holding one of these options, a yes/no this value, a member field holding the reader (`"me"`) \u2014 or what the call states: `{ "param": "<name>" }` on a select, a yes/no, a one-row link, a member or a number, and `{ "from": { "param" }, "to": { "param" } }` on a date or a number, either end alone |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order the rows return in; absent, the order the entity\'s list reads in. Only with `fields` |\n| `limit` | integer | no | The most rows returned. Only with `fields` |\n| `reading` | [Query reading](#query-reading) | no | The rows counted or summed instead of returned: one row for all of them, or one per value of `by` or per day of `over`, each carrying its `by` field or `__day`, `__count`, and `__sum` where `value` is stated |\n\n#### Query reading\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged: summed over the rows holding one, beside how many hold one. Never with `by` or `over` |\n| `by` | alias | no | The single select, one-row link, member or yes/no each row is counted under \u2014 one row returned per value |\n| `over` | alias | no | A date: one row returned per day of it. Never with `by` |\n\n#### Query param\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `param` | text | yes | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | [Query param](#query-param) | no | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | no | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n#### A reading\'s name\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | no | On any reading \u2014 a dashboard\'s, a register\'s band\'s, a record\'s block: the name its query is called by (`run_app_query`), its own among the app\'s readings and queries; absent, its place names it \u2014 `dashboard_reading_<n>`, `register_reading_<n>`, `block_reading_<n>`, counted from 0 \u2014 so a reading moved is called by another name |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.query` | A declared query (`queries`) reads one entity\'s rows as `fields` or as a `reading`, one of the two \u2014 never the app\'s own entity where the app states `books`, whose list reads several tables; `sort` and `limit` stand with `fields`; a `reading` splits by `by` or by the day of `over`, never both, and averages only with neither; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.surface-described` | *Noted, never refused:* A value a declared workflow takes, and a param a declared query takes, that states no `description`: the one line a caller reads to fill it. |\n| `reading.alias` | A reading\'s `alias` is its own among the app\'s readings and declared queries, a log\'s read by its entity before it (`<entity>_<alias>`); the work against its plan above a register states none \u2014 it reads the register\'s own rows. |\n\n<!-- generated:end apps-queries -->\n\n## Register\n\n```jsonc\n"register": { "columns": ["service", "release"], "filters": ["customer", "service"], "create": ["container_no", "customer"] }\n```\n\nEach of `filters` is also an optional param of the register\'s list query, `<entity>_list`, typed as its\nfield: `customer_is` and `service_is` here, a date as `<field>_from` and `<field>_to`, a number as\n`<field>_min` and `<field>_max`. A call stating none of them reads every row the list reads. A filter on\na looked-up link or member, on a number read in each row\'s own unit or currency, on a date holding a span,\nand every filter of an app that states `books` is no param: a call narrows by those with `filters`.\n\n<!-- generated:start apps-register -->\n\n#### Register\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `columns` | list of alias | no | Fields read as columns after the row\'s title \u2014 on a calendar\'s entry or a lane\'s block, its facts after its title; never what the row draws itself (its subtitle, image, status, figure, or the bound its figure\'s meter reads against), which the runtime places. At most 5 besides the row\'s name, status, deadlines and figure: a table draws every column and folds the last stated onto the name\'s line as it narrows, so more is refused |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | no | The fields the reader narrows the rows by every day, in that order \u2014 each earns its place by that daily use, so none to 3 is normal and 3 is a cap, never a quota (a select, a member, a link, a date, a yes/no, a number as a range, or its `tiers` where the business narrows by those bands daily) \u2014 each on a desk\'s line; a phone\'s one Filters sheet holds them. Never the status (its chips); each a field the rows show \u2014 a column, or a part of the row \u2014 or a formula whose every field of its row it reads they show. A threshold the business names ("large orders") is a formula yes/no here; a column\'s header sorts by a day or an amount |\n| `book` | `true` | no | With `books`: a column naming the table each row is of, and a filter by it |\n| `search` | list of alias (at least one) | no | The fields the search box matches (a link by its row\'s title); a pasted list searches each line and names the lines no row matched. Absent, every word of the row |\n| `group` | alias | no | The field the rows open grouped by, the reader\'s grouping starting there \u2014 a period\'s rows read under each period, one per person; absent, ungrouped |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order rows open in: one key, or a list of keys most significant first, each breaking the ties of the ones before it (a select orders by its options\' order); absent, the first deadline soonest first, else the newest first |\n| `layout` | `"table"` \\| `"cards"` \\| `"calendar"` \\| `"roster"` \\| `"lanes"` \\| `"gantt"` \\| `"plan"` | no | `cards` for rows read by their picture; `calendar` for rows read by their day \u2014 a month, a week, a day or a list, an entry at its hour where its date holds one and over its span where its line holds a second date; `roster` for what each row did on each day of a week or a month (who worked which shift, which vehicle ran), or with `expect` which of a set each row holds; `lanes` for rows booked on a resource over time (an appointment in its chair, a hire on its machine); `gantt` for rows each planned over a run of days, one bar a row on one axis of time (a shipment from its sailing to its arrival, a hire from its start to its return, a task of a project) \u2014 its dates in `gantt`, its lanes the register\'s `group`; `plan` for things that stand at a place (items at their places) \u2014 drawn on a plan of the places, a bay\'s rows and tiers in its card, and in 3D \u2014 the place each stands at in `plan`; absent, a table |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the rows whose select holds one of these options and whose yes/no (stored, or a formula) is this value \u2014 read so on the server and never offered as a chip: the rows this app works of an entity other apps read whole (the purchases, of orders both ways). A row added here holds a select\'s one option and a stored yes/no\'s value |\n| `opens` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | The view the register opens on: each entry a narrowing on a field the rows show (or a formula of fields they show) that stands as a chip the reader may take away (the rows still owed), `"me"` a member field holding the reader (the rows mine). One on the status replaces the chips\' opening on the open work \u2014 `"me"` on a status whose `stages` have owners opens on the rows waiting on the reader |\n| `remove` | `false` | no | The app edits its records and offers no Delete on them (a row\'s \u22EF, its record\'s \u22EF) \u2014 a desk correcting a date of records another app makes and closes; absent, a record the app writes is deleted where it stands |\n| `create` | list of alias (at least one) \\| `false` | no | The fields asked when a row is added; absent, the title, the subtitle and figure no default fills, the natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `readings` | list of ([Metric](#metric) \\| [Breakdown](#breakdown) \\| [Trend](#trend) \\| [Pivot](#pivot) \\| [Progress](#progress)) (at least one) | no | Readings of the register\'s own entity above its rows, over the rows in view \u2014 the search, the status and the filters narrow them, but a picture\'s own field, read as the register opens on it. A press on a breakdown\'s part, a pivot\'s cell or a figure with `where` narrows the rows by its field, as a filter does |\n| `attention` | `false` | no | false: a table\'s or cards\' rows keep the register\'s own order (a first-come queue), and no column names whose step each row stands at; absent, those needing attention open first \u2014 those at a step the reader owns, then overdue, then due within 3 days, then those whose line states a warning \u2014 each part in that order, until the reader picks another |\n\n#### Tiered filter\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one) | yes | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Sort key\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | The field rows are ordered by |\n| `desc` | `true` | no | Latest or largest first; absent, soonest or smallest first |\n\n<!-- generated:end apps-register -->\n\n<!-- generated:start rules-register -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.column-drawn` | A column never names what the row draws itself \u2014 its title, subtitle, image, status, figure, or the bound its figure\'s meter reads against \u2014 and names a field once. |\n| `register.columns-budget` | A register\'s stated columns, each at the width of its kind, fit the room a desk leaves beside its name and the row\'s own status, deadline and figure. |\n| `register.filter` | A filter names a select, a member, a link, a date, a yes/no or a number of the register\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status (its chips), nor one `where` fixes. |\n| `register.filter-split` | *Noted, never refused:* A filter on a field a breakdown or pivot in the band splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `register.filter-unshown` | A filter, a narrowing the register `opens` on, and a press in its band (a breakdown\'s part, a pivot\'s cell, a figure\'s `where`) name a field its rows show \u2014 a column; the row\'s title, the line under it, its picture, status or figure, a meter\'s bound, or the unit or currency a drawn figure is read in; a deadline; a warning its line says; the group or lane it stands under \u2014 or a formula, drawn where every field of its own row it reads is (through other formulas too; one reading no field is drawn nowhere). A narrowing to the reader (`"me"`) needs none. |\n| `register.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `register.search` | `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `register.sort` | Each `sort` key names a field of the register\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `register.tab-totals` | A tab\'s `totals` name a child linked to the register\'s entity by a one-row link (`via` where it has several), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column\'s `value` is a number of the child, its `where` holds over the child\'s selects and yes/nos, and a value read in each row\'s own unit or currency stands only where that select of the child looks up, through `via`, a single select of the register\'s entity. Only a table register stating no `books` has them, and no tab states `totals` beside `in` or `open`. |\n| `register.group` | `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 never the status (its chips); only a table groups, and a gantt into its lanes; grouping by the title needs a subtitle to lead each row. |\n| `register.readings-own` | A register\'s `readings` read its own entity; another entity\'s stand on a dashboard. |\n| `register.readings-bands` | A register reading that bands a number by `tiers` has that field with the same tiers among the register\'s `filters`: a press on a band narrows the rows by that filter. |\n| `register.readings-restate` | A register\'s metric never sums the row\'s figure or counts the rows without a `where`: the summary line totals the figure and the status chips count the rows. |\n| `register.where-opens` | `where` and `opens` hold the register\'s own selects and yes/nos, and `opens` a member field holding the reader (`"me"`) \u2014 or, on a status whose `stages` have owners, the rows waiting on the reader; a field `where` fixes is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. |\n| `register.band-pivot` | *Noted, never refused:* A pivot in a register\'s band: its grid reads on a dashboard, and the band leads with a `metric`. |\n| `register.headline` | *Refused until adopted or declined:* A register over rows that move (a status, a deadline) or carry money, laid out as a table, cards or a gantt, states `readings` \u2014 the patch splits the rows by a field they show and reads them over a date. |\n| `register.span` | *Refused until adopted or declined:* Rows that each span a run of days or hours \u2014 two dates on their line, a `frees`, or a `no_overlap` booking them on what its `by` links to \u2014 are drawn in time by some register over them (a calendar, lanes, a gantt or a roster) \u2014 the patch adds an app over them laid out as lanes on what each one books, else as a gantt. |\n| `register.remove` | A register\'s `remove: false` hides the Delete its records would offer, so it stands only where the app writes its records. |\n| `register.attention` | `attention: false` keeps a table\'s or cards\' rows in the register\'s own order \u2014 a first-come queue; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n\n<!-- generated:end rules-register -->\n\nThe status is always the chips, with\ncounts, opening on the rows not closed (every row on a calendar or a lanes board, whose\nwindow of time narrows them) \u2014 never one of `filters`. `filters` are the ones a reader\nnarrows by every day \u2014 none to three, never a quota \u2014 in order of use, each a field the\nrows show (a column, a part of the row) or a formula yes/no, drawn where every field of\nits own row it reads is drawn, at that width \u2014 each on the line\nwith the search and the chips, the grouping one\nchip at its end; a member filter offers "mine". A date filters by a range of days \u2014 of\nminutes on a `datetime` field, its end not held, so back-to-back shifts read each row\nonce \u2014 and can keep the rows holding no date too (in the yard at a moment: in before it,\nout after it or not yet). A number filters by a range typed in its\nunit or currency \u2014 a figure read in each row\'s own, in the one picked beside it \u2014 with a\nslider over a percent or a figure against a constant `limits`; `{ "field", "tiers" }`\noffers the bands its breakpoints cut in place of a range (`[1000, 5000]` on a weight in\nkg: under 1.000 kg, 1.000\u20135.000 kg, 5.000 kg and over), refused on a figure read in each\nrow\'s own unit. A threshold with a name is a formula yes/no, never a range. A\ncolumn the row already draws is refused. `sort` is one key or a list of keys, most\nsignificant first, each breaking the ties of the ones before it \u2014 a shipping line in its\nselect\'s option order, then the arrival day soonest first:\n`[{ "field": "shipping_line" }, { "field": "arrived_on" }]`; a header\'s press leads them.\nAbsent `sort`, rows open soonest deadline first where the row has a `due`, else newest first. `search` names the fields\nthe search box matches \u2014 a link by its row\'s title \u2014 and a pasted list searches each\nline, naming the lines no row matched; absent, it matches every word of the row.\n\n`where` keeps the rows the app works, read so on the server and never a chip: a\npurchase desk over orders of both directions states `"where": { "direction":\n["purchase"] }`, and a row added there is written holding the one option (a select kept\nat several is asked among them). `opens` is the view the register opens on, each entry a\nchip the reader may take away: a cashier opens on `"opens": { "owes": true }`. Both take\na select\'s options or a yes/no\'s value, stored or a formula; `opens` on the status is\nthe chips\' opening choice. `opens` also takes `"me"` on a member field \u2014 `"opens": {\n"assignee": "me" }` opens on the rows assigned to whoever reads, the server reading the\nreader, never the page; `where` refuses it, since it fixes the rows for every reader\n(who may read a row at all is the entity\'s `read_scope`).\n\nHow the rows are laid out is \xA7 Layouts, tabs over a period \xA7 Tabs, the report \xA7 Export, and the band above\nthe rows \xA7 Readings.\n\n## Layouts\n\n`layout` is how the register draws its rows \u2014 one of the pages below; absent, a table. Each reads what the\nrows already state (their `records` line, status and dates), and the keys a layout adds stand on its page.\nWhich one a job needs: the `design` reference.\n\n### Table\n\nAbsent `layout`, each row is one line: the entity\'s `records` entry \u2014 its picture or mark, title and the line under it\n\u2014 then the status, the `columns`, and the figure at the right; the title, the status and a column of days or\namounts sort the rows by their header. A table groups its rows by `group` (a gantt draws it as its lanes); a\ntable or cards reads `tabs` and `books`.\n\n### Cards\n\n`layout: "cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the app\'s\n`row.image`: its title and the line under it, its status and what needs the reader (a deadline, a warning),\nthen its figure and the register\'s `columns` at its foot. Cards are for rows found by their picture (a\nproduct, a vehicle, a damage photo); rows with no picture read better as a table.\n\n### Calendar\n\n`layout: "calendar"` places each row on its day \u2014 a month, a week, a day or a list (a\nphone reads the list or a day): at its hour where the date holds one, over its span\nwhere the row\'s line holds a second date after it, its line\'s other words and the\nregister\'s `columns` after its title. The calendar reads the window in view, and its\ncount and the status chips count that window, opening on every row.\n\n### Lanes\n\n`layout: "lanes"` with `lanes` naming a one-link draws each row of the linked entity as\na lane (a chair, a machine, a room), empty ones too, and each register row as a block\nfrom the first date on its line to the second: over the hours of one day where the first\nholds its hour, else over the days of one day, a week or a month. A block reads the row\'s\nname and the first of its `columns`; a free stretch between blocks adds a row there, its\nlane and its start set, and its end where the next block bounds it. A phone lists each\nlane\'s blocks and free stretches in clock order. Rows naming no lane stand first, in a lane\nof their own; where the app writes the link, each block moves to another lane from its menu.\nInside a folder (`scope`), the lanes are the ones whose own one-link names that folder \u2014 a\nbranch\'s rooms, never every branch\'s. A span\'s end holds its day unless `records` names it\nthe day the row `frees`.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each\nblock\'s number and reads it against the lane row\'s own, at most two. A lane holds its\nblocks while they stand, so it reads the most they add up to at one time in the window \u2014\na day\'s rows together \u2014 named, past its bound, by how much and on which day or at which\nhour. The two are in one unit, or two of one dimension (kg against t); a block then reads\nwhat it adds, and the move menu reads each lane as it would stand with the block on it.\nA bound a single row must keep (no parcel heavier than its van) is a `write_rules` `max`\nthrough the link, which refuses the move.\n\n<!-- generated:start apps-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `lanes` | alias | no | With `layout: "lanes"`: a one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty. A row is a block from the first date on its line to the second \u2014 within one day by the hour where the first holds one, else by the day over one day, a week or a month; a free stretch between blocks adds a row there, its lane, its start and the end the stretch reaches filled |\n| `loads` | map of alias \u2192 alias | no | With `lanes`: what a lane carries against what it holds, at most 2 \u2014 a number of this entity each block adds (a weight) to a number of the lane\'s row it is held within (a payload), in one unit or two of one dimension. Each lane reads the most its blocks add up to at one time in the window \u2014 a day\'s rows together \u2014 and names by how much and when a lane runs over |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.lanes` | `layout: "lanes"` and `lanes` go together: `lanes` is a one-row link to an entity with a `records` entry, the rows name a date on their line, a block\'s two ends are read alike (two days or two moments), and `loads` needs `lanes`. |\n| `register.loads` | `loads` names one to 2 numbers a block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension. |\n\n<!-- generated:end apps-lanes -->\n\n### Gantt\n\n`layout: "gantt"` with `gantt` draws each register row as one bar on one axis of time:\n`{ "start": "etd", "end": "eta", "milestones": ["cut_off"], "planned": { "end": "booked_eta" },\n"progress": "done", "after": "waits_on" }`. `end` defaults to the entity\'s first `due`, and an\nentity with neither is refused; `start` and `end` are two dates of the row, both days or both\nmoments, and each planned date is read as `start` is. `progress` is a percent (0\u2013100) \u2014 absent, a\nrow whose record lists its tasks fills to how many are done;\n`after` is a link to rows of the same entity, one or several, each ending before the row\nstarts. The bars stand in the lanes of the register\'s `group`. Where the app writes the\nrow and a person writes a bar\'s date, the bar is dragged through the row\'s save, which then\nwrites those two dates though no section places them; a computed date, one an act sets, or\nan app with `writes: "children"` drags nothing.\n\n<!-- generated:start apps-gantt -->\n\n#### Gantt keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `gantt` | [Gantt bar](#gantt-bar) | no | With `layout: "gantt"`: the dates and facts each row\'s bar is drawn from |\n\n#### Gantt bar\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | yes | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | no | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | no | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | no | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | no | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | no | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | no | The date the row was planned to start at |\n| `end` | alias | no | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.gantt` | `layout: "gantt"` and `gantt` go together: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each milestone another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end apps-gantt -->\n\n### Plan\n\n`layout: "plan"` draws things that stand at a place \u2014 pallets in a\nwarehouse \u2014 on a plan of the places. The places are the rows of an entity whose `records`\nstates a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet of the\nplan); `plan` names the one-link of the register\'s rows to a place and, for an item in a bay,\nthe row (`across`) and the tier (`up`) it stands in, counted from 1. A bay is drawn as its rows\nand tiers, an area with a count, a landmark as a labelled frame; the reader sees a plan, one\nbay enlarged, and the same plan in 3D. The register may read other tables as `books`: one plan\nof every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking\nit out (those above it where the place is `stacked`, and those in the rows between it and the side\n`reach_from` says the bay is taken from) \u2014 counted over every present row whatever the reader narrows by, so the list,\nits export and an agent\'s read all carry it; `<entity>_plan_load` counts the rows each place holds.\nA write that sets the place, row or tier is refused on the server unless it clears all three,\nor places the item at a free cell of a bay \u2014 resting on a present item where the place is\n`stacked`, a boolean of the place: racks, shelves, platforms and building floors state none and\nhold an item at any tier \u2014 or at an area. A plan opens on every row its `where` keeps, with no\nstatus chip narrowing it. On a desk a press opens a row\'s record in the panel beside the plan, whatever the record\'s `door`; a phone opens a sheet.\n\n```jsonc\n"records": { "bay": { "title": "code", "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } } }\n"register": { "layout": "plan", "plan": { "at": "bay", "across": "row", "up": "tier" }, "filters": ["line"] }\n```\n\n<!-- generated:start apps-plan -->\n\n#### Plan keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `plan` | [Plan](#plan) | no | With `layout: "plan"`: the place each row stands at, and in a bay its row and tier |\n\n#### Plan\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `at` | alias | yes | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias | yes | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias | yes | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | no | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | no | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; in books, the select is matched by option alias, and a book lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | no | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; in books, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A single select of this entity |\n| `option` | alias | yes | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A single select of this entity |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box) | yes | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `across` | number | yes | The box\'s width across the bay\'s rows |\n| `along` | number | yes | The box\'s depth along them |\n| `up` | number | yes | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `kind` | alias | yes | A single select, options aliased exactly `bay`, `area`, `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | no | A single select: the plan sheet it is on |\n| `x` | alias | yes | A number field: left edge, in cells |\n| `y` | alias | yes | A number field: top edge, in cells |\n| `width` | alias | no | A number field: an area\'s frame width, in cells |\n| `depth` | alias | no | A number field: an area\'s frame depth, in cells |\n| `across` | alias | yes | A number field: a bay\'s rows |\n| `up` | alias | yes | A number field: a bay\'s most tiers |\n| `reach_from` | alias | no | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | no | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | no | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `across` | alias | yes | A number field: the width of one cell across the rows |\n| `along` | alias | yes | A number field: the depth of one cell along the place |\n| `up` | alias | yes | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.plan` | `layout: "plan"` and `plan` go together: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan has no `tabs`, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `register.plan-mark` | A plan\'s `mark` names a single select of the row and an option of it by alias: a row holding that option says its label on its box and is hatched in the option\'s colour, which the legend names by its label. A book that holds the select must hold it as a single select with that option; a book lacking it never marks its rows (`app.book-lacks`). |\n| `register.plan-size` | A plan\'s `size` names a single select of the row and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box, any other at its place\'s cell. A book that holds the select must hold it as a single select; a book lacking it draws its rows at their places\' cells (`app.book-lacks`). |\n| `register.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end apps-plan -->\n\n### Roster\n\n`layout: "roster"` draws the register\'s rows down the side and the days of a week or a\nmonth across; `roster` names the entity whose rows fill the days \u2014 each stands on one\nregister row by its single link to it, and on the first date of its line (a shift on a\nperson\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s status, else the first single select on its line (a\nshift\'s kind), several rows their count; a week\'s cells say their words and one more\nfact of the line, a month\'s keep their marks. A day holding none stays empty: nothing\nwas due, which is never an absence. A filled cell opens its row; an empty one adds a row\nthere, the register row and the day set, asking what any add of it asks \u2014 unless no\napp writes those rows (`writes: false`). With `expect` (a single select of those\nrows) the columns are its options in place of days \u2014 a checklist of papers \u2014 and `of`\n(this entity\'s multi-select) names the ones each row expects: a gap among them reads as\none and adds its row, the others stand blank, and each row reads what it holds of them,\n`2/3`. Over days, a roster reads the `cadence` its entity\'s `records` states for its\nrows (a site\'s diary page, Monday to Saturday from breaking ground to handover): a past\nday owed with none is marked missing in the danger tone and counted, today\'s is still\ndue and offered to add, each row reads the days it holds of those owed, and the days\nthe cadence lists none on are quiet. A roster states no `columns` and needs no\n`readings`: its legend counts each state in view.\n\n```jsonc\n"register": { "layout": "roster", "roster": "run", "filters": ["operator"] }\n"register": { "layout": "roster", "roster": "diary_page" }\n```\n\n<!-- generated:start apps-roster -->\n\n#### Roster keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `roster` | alias | no | With `layout: "roster"`: the entity whose rows fill the days \u2014 one single link to this entity, and a date on its row line (`records` title or subtitle). A cell reads its row\'s status, else the first single select on its line, several rows a mark each, the cell read by the one latest in that select\'s options; a row whose line holds a second date after the first fills every day to it; a day with none stays empty, never an absence \u2014 unless this entity\'s `records` `cadence` owes one of them there |\n| `expect` | alias | no | With `roster`: a single select of the roster\'s rows whose options are the columns in place of days \u2014 each cell the row holding that option, read by its status, an empty one added there (a checklist of papers per case); the roster then has no period |\n| `of` | alias | no | With `expect`: this entity\'s own multi-select holding the options each row expects \u2014 its other columns stand blank on that row, never added. Its options are among `expect`\'s |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.roster` | `layout: "roster"` and `roster` go together: the roster\'s entity has one single link to this one and a date on its line, a roster draws no `columns`, `expect` needs `roster` and `of` needs `expect`. |\n| `register.roster-expect` | A roster\'s `expect` is a single select of its rows, and `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n\n<!-- generated:end apps-roster -->\n\n## Tabs\n\nA register reporting a period \u2014 what stands at its end beside what came and went during it (the stock, the\nhires out, the tickets open) \u2014 reads its rows as `tabs` over one `period` the reader picks above them: an\n`open` tab holds the rows open at the period\'s end, an `in` tab the rows dated within it, each with its count\nand each a sheet of the report. A `totals` tab lists every row and draws, in place of the register\'s columns, what a child\'s rows came to in the period: each column adds the child\'s rows `before` the period\'s first day, `in` the period, or `through` its last day, so `before` plus `in` of one value is its `through` (a storeroom\'s items beside what their ledger lines held at the start, took in, gave out and held at the end). Never date chips set by hand, and never a tab per status, which the chips split.\n\n```jsonc\n"register": { "period": "month", "tabs": [\n { "tab": "in_yard", "label": "In the yard", "open": { "from": "arrived_on", "to": "left_on" } },\n { "tab": "arrived", "label": "Arrived", "in": "arrived_on" },\n { "tab": "left", "label": "Left", "in": "left_on" }\n] }\n```\n\nA storeroom\'s items, each with its ledger lines\' quantity before, during and through the period:\n\n```jsonc\n"register": { "period": "month", "tabs": [\n { "tab": "items", "label": "Items", "totals": { "rows": "ledger_line", "on": "moved_on", "columns": [\n { "alias": "opening", "label": "Opening", "value": "quantity", "window": "before" },\n { "alias": "received", "label": "Received", "value": "quantity", "where": { "kind": ["receipt"] }, "window": "in" },\n { "alias": "issued", "label": "Issued", "value": "quantity", "where": { "kind": ["issue"] }, "window": "in" },\n { "alias": "closing", "label": "Closing", "value": "quantity", "window": "through" }\n ] } },\n { "tab": "all", "label": "All items" }\n] }\n```\n\n<!-- generated:start apps-tabs -->\n\n#### Tabs keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tabs` | list of [Register tab](#register-tab) (2\u20135) | no | The lists the register reads its rows as, each a tab with its count over one period the reader picks above them \u2014 the stock at its end beside the arrivals and departures during it, a report\'s sheets; each keeps the register\'s filters and search. Absent, one list. Not with a calendar, roster or lanes, which read their own window |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | no | With `tabs`: the period they open on \u2014 `today`, `week`, `month`, `quarter` or `year` so far, or `{ days }`, the last that many days through now (a night shift running past midnight reads two); absent, this month so far |\n\n#### Register tab\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tab` | alias | yes | The tab\'s name: its address, and the key its rows stand under in a report |\n| `label` | text | yes | What the tab holds, in the reader\'s words |\n| `in` | alias | no | A date (stored, or a formula): the tab holds the rows dated within the register\'s period, from its start through its last day, or up to its last minute \u2014 the arrivals of a period |\n| `open` | [Tab open](#tab-open) | no | The tab holds the rows open at the period\'s end: begun before it, and not ended by then \u2014 what is in stock, out on hire or still owed at that moment |\n| `totals` | [Tab totals](#tab-totals) | no | The tab lists every row the register lists; in place of the register\'s columns, each column draws one figure added over the child\'s rows that belong to the row, windowed by the period |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`"me"`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order this tab\'s rows read in, as the register\'s `sort`; absent, the register\'s |\n\n#### Tab open\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `from` | alias | yes | The date a row begins on (stored, or a formula) |\n| `to` | alias | yes | The date a row ends on (stored, or a formula), empty while it is open |\n\n#### Tab totals\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | An entity of this model whose rows each belong to one row of the register\'s entity: the rows the columns add |\n| `via` | alias | no | The child\'s one-row link to the register\'s entity, where it has more than one; absent, its only one |\n| `on` | alias | yes | A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days |\n| `columns` | list of [Totals column](#totals-column) (1\u20136) | yes | The figures drawn in place of the register\'s columns after each row\'s name, each under its own alias and label |\n\n#### Totals column\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The column\'s name: its address in the totals read |\n| `label` | text | yes | What the column holds, in the reader\'s words |\n| `value` | alias | no | A number of the child (stored, a formula or a rollup) summed over the rows; absent, the rows are counted. A figure read in each row\'s own unit or currency stands only where the child\'s select is a lookup, through `via`, of a single select of the register\'s entity |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the child\'s rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed |\n| `window` | `"before"` \\| `"in"` \\| `"through"` | yes | Which of the child\'s rows, by `on`, the column adds: `before` those dated before the period\'s first day, `in` those from its first day through its last, `through` those on or before its last day |\n\n#### Period days\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `days` | integer | yes | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.tabs` | A register\'s `tabs` each name a tab of their own, never a key a report already holds; a tab states one of `in` and `open` (dates of its rows, `open`\'s two different) or `totals` (a child\'s rows windowed by the period); its `where` and `sort` hold as the register\'s do, and never narrow by the status, which its chips split. Only a table or cards reads tabs, and a band reading\'s `tab` names one of them. |\n\n<!-- generated:end apps-tabs -->\n\n## Export\n\n`export` saves the register as its report \u2014 the title, a line per chip, the search and\nthe moment it was exported, the readings, and every row in view, at most 20,000 of them.\n`export: true` saves it as a workbook, the readings on a sheet before the rows. A list\nstates the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the\nmoment it was made), `dates` (each date filter\'s `from` and `to` by field, a day or a\nmoment as the filter bounds the rows) and the rows under the entity\'s alias (an html one\nmade a PDF, an `excel` one a workbook; absent, the workbook). A report\'s `filename` names\nits file in the template grammar over the same keys but the rows \u2014\n`"Stock {{dates.arrived.to | format:\\"dd.MM.yyyy\\"}}"`; absent, the template\'s name, or\nthe label. A report of some rows (`where`), or of one value the reader picks (`per`: one\nline\'s file), is made of the register as those chips would narrow it; the screen keeps the chips and rows it shows.\n\n<!-- generated:start apps-export -->\n\n#### Export keys\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `export` | `true` \\| list of [Register report](#register-report) (at least one) | no | The rows in view saved as the register\'s report \u2014 its title, a line per thing narrowing the rows, the readings and every row: `true`, one workbook of the register\'s columns; a list, the reports a reader picks from one export menu |\n\n#### Register report\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `label` | text | yes | The report\'s name, in the reader\'s words \u2014 its entry in the export menu and its file\'s title |\n| `description` | text | no | What the report holds, under its name in the menu |\n| `template` | alias | no | A template filled with the report \u2014 `title`, `lines`, `readings`, `at` (when it was made), `dates` (each date filter\'s `from` and `to`, by field), `period` (the tabs\' `from` and `to`), `per` (the value picked), every row in view (at most 20,000) under the entity\'s alias, and each tab\'s under its name: an html one made a PDF, an excel one a workbook; absent, the workbook of the register\'s columns, a sheet per tab |\n| `filename` | text | no | The file\'s name, in the template grammar over one value each \u2014 `title`, `at`, `dates.<field>.from` or `.to` of a date filter, `period.from` or `.to` with tabs, `per` with a `per`, `lines \\| lookup:<n>` \u2014 `Stock {{per}} {{period.to \\| format:"dd.MM.yyyy"}}`; absent, the template\'s name, or the report\'s title |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | The rows the report is of, set on the register as the chips they are before its file is made \u2014 the screen shows what the file holds |\n| `per` | alias | no | A select, a member or a one-link the reader picks one value of from the menu \u2014 the rows narrowed to it, as its chip, and one file of that value |\n| `books` | list of alias (at least one) | no | The rows of these books only \u2014 each the app\'s `entity` or one of its `books`; absent, every book\'s |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `register.export-report` | A register\'s reports each have their own label; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `register.export-template` | A template an export fills reads at its root only `title`, `lines`, `readings`, `at`, `dates` and its rows under the register entity\'s alias \u2014 an entity named none of those \u2014 and is the document of no act. |\n\n<!-- generated:end apps-export -->\n\n## Readings\n\nA reading is one number, or one picture of numbers, over rows. Where it stands decides\nwhich rows: a dashboard reads every row, a register\'s `readings` the rows in view, a\nrecord\'s reading block the child rows under the record. The picture is the runtime\'s,\nchosen from what the reading means \u2014 no key picks a chart.\n\n```jsonc\n{ "metric": "visit", "value": "fees", "where": { "paid": false }, "over": "arrived_on", "label": "Unpaid" }\n{ "metric": "payment", "value": "days_to_pay", "average": true, "over": "paid_on", "better": "down", "label": "Average days to pay" }\n{ "metric": "payment", "value": "late_share", "average": true, "label": "Share paid late" }\n{ "breakdown": "visit", "by": "line" }\n{ "trend": "visit", "over": "arrived_on", "value": "fees" }\n{ "pivot": "visit", "rows": "size", "columns": "line" }\n{ "breakdown": "invoice", "by": { "field": "days_late", "tiers": [1, 31, 61] }, "value": "owed" }\n{ "pivot": "invoice", "rows": "supplier", "columns": { "field": "days_late", "tiers": [1, 31, 61] }, "value": "owed" }\n{ "list": "visit", "where": { "stage": ["in_yard"] }, "columns": ["line"], "app": "gate", "label": "In the yard" }\n{ "list": "task", "where": { "assignee": "me" }, "label": "My tasks" }\n{ "progress": "work_item", "planned": { "start": "plan_start", "end": "plan_end" }, "done": "complete",\n "finished": "accepted_on", "measured": { "rows": "logged_qty", "on": "day", "share": "share_of_item" },\n "weight": "value", "label": "Progress against plan" }\n```\n\nA reading\'s `alias` names the query it is read by (`model/queries`).\n\nA reading\'s `where` keeps rows by a select\'s options, a yes/no\'s value, or `"me"` on a\nmember field \u2014 the rows that name whoever reads, read so on the server.\n\nA metric averaging its `value` (`average: true`) and a split by a number\'s `tiers` are\n`model/averages-and-bands`.\n\n`progress` reads one parent\'s work against its plan \u2014 a register\'s band over a folder, or a record\'s\nblock \u2014 never a dashboard\'s every row: the share of the work planned and the share done, cumulative day by\nday, today\'s two at its foot. Each row is a part of the work, its plan spread evenly over its planned days\nand weighing its `weight` (its value) or, absent, its planned days. Its share done today is `done`, a\npercent the server computes; on an earlier day, its `done` from its `finished` day on, before it what its\n`measured` rows add up to by then \u2014 each row\'s own share of it, a percent the server computes.\n\n<!-- generated:start apps-readings -->\n\n#### Metric\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `metric` | alias | yes | The entity whose rows are counted, or summed, into one number |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged, not summed: its sum over the rows holding one, divided by how many hold one \u2014 a row holding none is no part of it. Under a period each period reads its own average, and its change compares two averages; where no row holds one it reads no figure, never 0, and no change. A share is an average too: a number formula that is 100 on the rows that count and 0 on the others, in percent notation, reads as the share of rows that count |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `target` | number | no | The number it is read against, where no `limits` bounds its value (a bounded value is read against the sum of its bound) |\n| `better` | `"up"` \\| `"down"` | no | Which way its change over the recent periods `over` reads is good; absent, a sum\'s rise and a count kept by `where` falling |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n\n#### Breakdown\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `breakdown` | alias | yes | The entity whose rows are split into parts |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) each row is counted under \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the `by` field\'s label |\n\n#### Trend\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `trend` | alias | yes | The entity whose rows are counted, or summed, per period |\n| `over` | alias | yes | The date each row falls on \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link |\n| `ahead` | `true` | no | Counts forward: the current period first, then the ones after it, over the rows dated today or later (arrivals by their ETA); absent, the periods up to today |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the value\'s label, else the entity\'s |\n\n#### Pivot\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `pivot` | alias | yes | The entity whose rows are counted, or summed, in a grid |\n| `rows` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) down the side \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `columns` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) across the top \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the two fields\' labels |\n\n#### Progress\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `progress` | alias | yes | The entity whose rows are the parts of the work, read as the share of it planned and the share done, day by day |\n| `planned` | [Progress planned](#progress-planned) | yes | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | yes | A number of the row the server computes: its share done today, in percent (0\u2013100) |\n| `finished` | alias | no | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `measured` | [Progress measured](#progress-measured) | no | Before a row is finished, its share done on a day is what these add up to by then, never past its `done`; absent, a row stands at nothing until it is finished, and at its `done` today |\n| `weight` | alias | no | A number of the row: what it weighs in the whole \u2014 its value, its share of the contract; a row holding none weighs nothing. Absent, each row weighs its planned days |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n\n#### Progress planned\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `start` | alias | yes | A date of the row: the first day of its planned work |\n| `end` | alias | yes | A date of the row: the last day of its planned work |\n\n#### Progress measured\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | The entity whose rows record the work as it is done, each through its one-row link to a row of the reading |\n| `on` | alias | yes | A date of those rows (their own, or a lookup): the day each records its work |\n| `share` | alias | yes | A number of those rows the server computes: the share of its row each adds, in percent |\n\n#### List\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `list` | alias | yes | The entity whose rows are listed, each in its `records` anatomy |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `columns` | list of alias | no | Fields read after each row\'s title |\n| `app` | alias | no | An app of this model over the same entity that works its rows: a dashboard row opens there, a record\'s list row has "Open in" to it |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n\n<!-- generated:end apps-readings -->\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A reading sums a number, never a percent \u2014 percents do not add up; a metric\'s `average` reads one. |\n| `reading.average` | `average` averages a metric\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by`, `rows` and `columns` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a pivot crosses two different fields. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s `where` keeps rows by a select\'s options, a yes/no\'s `true` or `false`, or a member field holding the reader (`"me"`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.list-app` | A list\'s `app` is a register app of this model over the list\'s own entity. |\n| `reading.progress` | The work against its plan reads dates of its rows for `planned` and `finished`, a number for `done` and `weight`, and rows `measured` through a one-row link to them, by a date of theirs and a number of theirs. |\n\n<!-- generated:end rules-reading -->\n\nA reading counts its rows, or sums the number `value` names \u2014 never a percent. `by`,\n`rows` and `columns` split the rows by one value each: a single select, a one-row link,\none member, or a yes/no \u2014 stored or a formula, its parts read as its label and the\nothers. `over` is a date, the row\'s own (stored or a formula) or its parent\'s through a\nlookup over a one-link: a trend\'s periods, a metric\'s recent periods beside its number,\nand what a dashboard\'s period windows. `ahead: true` reads a trend forward from the\ncurrent period over the rows still to come. `where` keeps rows whose select holds one\nof the options, or whose yes/no is the value, every entry ANDed \u2014 a band leads with the\njob\'s exception as a formula\'s yes/no (what is late, what is short; drawn by the fields it reads), never a stage the\nstatus chips already count. A metric summing a value `limits` bounds reads against the\nsum of its bound (`10 / 14`); `target` reads one against a number nothing bounds. A\nmetric\'s change is green where it moves the good way: a sum\'s rise, a count kept by\n`where` falling; `better` states the other way where that reads wrong \u2014 money going out\n(`"better": "down"`). A register reads only its own entity; a `list` stands on a\ndashboard, or in a record\'s `blocks` (\xA7 List block).\n\n`readings` read the register\'s own rows above them: the rows in view, so the search,\nthe status and the filters narrow each one, but a picture\'s own field, which it reads as\nthe register opens on it. A table, cards or a gantt over rows that move or carry money states\nthem (`register.headline`); elsewhere they stand where a picture answers something the rows\ncannot. They stand under the title in one compact\nband: lead with the job\'s headline number (a `metric`), then at most the mix (a\n`breakdown`) and the movement (a `trend`) \u2014 a `pivot` stands under the band as a whole table, every line and its totals, and a\n`breakdown` by a number\'s `tiers` of three breakpoints or more under it too, every band a bar. A picture\nstands only where it splits the rows in view into two parts or more, one of them\nholding two rows or more; a split whose rows\nall fall in one part, and a lone figure with no picture beside it, are said on the\nsummary line instead, so a band stands only holding a picture or two figures. The summary line already totals the\nfigure over the rows in view and the status chips count them, so a `metric` summing the\nfigure, or counting the rows of an entity with a status, is refused unless its `where`\nnarrows it.\n\n## Averages and bands\n\nWhat a [reading](#readings) averages, and how it splits its rows by a number.\n\nA metric\'s `value` is summed; with `average: true` it is averaged \u2014 its sum over the rows the reading\nkeeps, divided by how many of them hold a value, so a row holding none is no part of it. It reads in the\nvalue field\'s own notation, and a figure each row reads in its own unit averages per unit as it sums per\nunit. Under a dashboard\'s period it is the average over the period so far, its shape each recent period\'s\nown average, and its change this period\'s average against the one before\'s \u2014 never a sum of averages.\nWhere no row holds a value there is nothing to average: it reads a dash, never 0, with no change against\nthe period before, and a period holding no row is no point of its shape. A\nplain `target` is the number it is read against; a value `limits` bounds is refused, since its bound is a\nsum.\n\nA share is an average too, so it takes no key of its own: a number formula that is `100` on the rows\nthat count and `0` on the others (`if({paid_on} > {due_on}, 100, 0)`), in percent notation, averaged, is\nthe share of rows that count \u2014 "share paid late". A percent is averaged, never summed. Only a `metric`\naverages: a `breakdown`, a `trend` and a `pivot` count their rows or sum `value`.\n\nA breakdown\'s `by` and a pivot\'s `rows` and `columns` each take, in place of a field, a number by its\n`tiers` \u2014 `{ "field", "tiers" }`, the shape a register\'s [tiered filter](#tiered-filter) takes \u2014 and\nsplit the rows by the bands those breakpoints cut: under the first, from each up to the next, from the\nlast up, a figure on a breakpoint in the band above it. `[1, 31, 61]` over days late reads not due,\n1\u201330, 31\u201360 and over 60 \u2014 the aged report, parties down the side and the bands across. Every band is\ndrawn in the bands\' own order, one holding no row at zero, never ranked by size; each is worded in the\nfield\'s own notation, as the filter\'s chip words it, and rows holding no number stand apart. A band of a\nfigure whose definition makes every value whole \u2014 a rollup that counts, a formula that is\n`differenceInCalendarDays(later, earlier)` \u2014 cut at whole breakpoints reads to the last one it holds, so\nno figure stands in two bands\' words; every other figure, a stored number of days or of a counted noun\ntoo, reads between its breakpoints, since it may hold 14.5. The number is stored, a formula or a rollup, or a lookup of one through\none-row links, read in one unit on every row. On a register a band is a door: a press\nnarrows the rows to it through the filter of the same field and tiers, which the register\'s `filters`\nstate too \u2014 the rows holding no number are no band, so no door; on a dashboard and in a record\'s block\nit opens nothing. A register\'s band seats four bars:\na split by one or two breakpoints stands in it, and one by three or more stands whole under it, as a\npivot does, so every band keeps its bar and its name.\n\n## Dashboards\n\nA dashboard is `{ "alias", "name", "dashboard": [readings] }` with no entity, register\nor record: each reading reads every row of its entity, and one period the reader picks\nat the title \u2014 this month, last month, this or last quarter or year, or any days \u2014 windows\neach reading placed in time: one still running so far, one that closed whole, its change\nread against the period before it. A reading placed in no time reads the rows as they\nstand now, and its head says so. `period` is the one it opens on; absent, the month. A\ntrend holding few periods so far is led in by the ones just before it, so no period opens\non one bar.\n`tabs` (2 to 5, each `{ "tab", "label" }`) split a long dashboard into sheets: every\nreading then states the `tab` it stands under, a strip under the title picks one (the first\nopen), and only its readings are drawn. A reading is called by the same name with or without\ntabs. A `list` reading lists rows, each opening in its `app`. The readings answer the one\nquestion the dashboard\'s owner asks, in the order they ask it \u2014 rows to act on lead where\nthe answer is rows; no order of kinds is the rule.\n\n```jsonc\n// The depot owner\'s morning question: which boxes are past their free days, whose are they, is it growing?\n{ "alias": "overview", "name": "Depot overview", "dashboard": [\n { "list": "visit", "where": { "overdue": true }, "columns": ["line"], "app": "gate", "label": "Past free days" },\n { "breakdown": "visit", "by": "line", "where": { "overdue": true }, "label": "Past free days by line" },\n { "trend": "visit", "over": "arrived_on", "where": { "overdue": true }, "label": "Past free days, by arrival" }\n] }\n```\n\n<!-- generated:start apps-dashboard -->\n\n#### Dashboard app\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The app\'s name within the model \u2014 what `--from model.json#<alias>` picks |\n| `name` | text | yes | The job, in the words of the people who do it |\n| `description` | text | no | What the job is for, in a sentence |\n| `icon` | text | no | A lucide icon name the launcher tile draws |\n| `theme` | [Theme](#theme) | no | The launcher tile\'s colour |\n| `reads` | `"shared"` | no | Every member reads every row, whatever the entity\'s read scope |\n| `dashboard` | list of ([Metric](#metric) \\| [Breakdown](#breakdown) \\| [Trend](#trend) \\| [Pivot](#pivot) \\| [List](#list)) (at least one) | yes | The readings, in order \u2014 each over every row of its entity, windowed by the one period the reader picks |\n| `tabs` | list of [Dashboard tab](#dashboard-tab) (2\u20135) | no | The sheets the readings stand on, a strip under the title, the first open: each reading of `dashboard` then states the `tab` it stands under, and only the open tab\'s readings are drawn and read. Absent, every reading stands in one grid |\n| `period` | `"month"` \\| `"quarter"` \\| `"year"` \\| [Dashboard period days](#dashboard-period-days) | no | The period the dashboard opens on, before the reader picks another \u2014 `month`, `quarter` or `year` so far, or `{ days: 30 }`, the last 30 days through today; absent, this month so far. Needs a reading placed in time by `over` |\n| `workflows` | map of alias \u2192 [Workflow](#workflow) | no | Workflows of the app no act runs, by alias \u2014 called through the app (`run_app_workflow`, its API) by an agent or a service: each states what it takes and hands back, and its body is set on the app (`set_app_workflow`) and kept by every apply. The screen draws nothing for one |\n| `queries` | map of alias \u2192 [Query](#query) | no | Reads of the app no screen draws, by alias \u2014 called through the app (`run_app_query`, its API) by an agent or a service: each states the rows it reads, what narrows them and what a call may state. The screen draws nothing for one |\n\n#### Dashboard tab\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `tab` | alias | yes | The tab\'s name: its address (`?tab=`), and what each reading\'s `tab` names |\n| `label` | text | yes | What the tab holds, in the reader\'s words |\n\n#### Dashboard period days\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `days` | `30` | yes | The last 30 days through today \u2014 the one span of days a dashboard opens on |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.period` | A dashboard\'s `period` is the one it opens on, and its period stands only over a reading placed in time by `over`. |\n| `reading.tabs` | A dashboard\'s `tabs` each name a tab of their own, and every reading of its `dashboard` states the `tab` it stands under: a tab no reading names, a reading naming a tab not declared, or one naming none is refused; without `tabs`, no reading states a `tab`. |\n\n<!-- generated:end apps-dashboard -->\n\n## Record page\n\n```jsonc\n"record": {\n "door": "page",\n "sections": [\n { "title": "Details", "fields": ["size", "line", "built_on"] },\n { "title": "Gate in", "at": ["arriving", "in_yard"], "fields": ["arrived_on", "truck"],\n "blocks": [{ "rows": "fee", "where": { "leg": ["in"] }, "expect": "kind", "columns": ["amount", "paid_by"] }],\n "acts": ["gate_in_paper"] },\n { "title": "Sell to a buyer", "description": "Moves the container to the buyer\'s stock once it has left.", "acts": ["sell"] }\n ]\n}\n```\n\n<!-- generated:start apps-record -->\n\n#### Record page\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `door` | `"page"` \\| `"drawer"` \\| `"beside"` | no | A page for work read at length; a drawer for rows worked one after another from the register; `beside` for rows worked one after another while the list stays in view \u2014 the register\'s list and the open record side by side, over a table register alone. Each stacks its sections, and from three sections on navigates them \u2014 a page by a rail, a drawer by a strip pinned over its scroll; absent, a page where a section has `at` or is a `page`, the record has more than three sections or one stands beside the rest (`side`), else a drawer |\n| `sections` | list of [Section](#section) (at least one) | no | The record in the order its work reaches it \u2014 each section its fields, then its blocks, then its acts. Absent, one section of every field a person writes that no other place shows |\n| `comments` | `true` | no | People comment on the record: its comments \u2014 who wrote what and when, with a composer \u2014 stand in its Activity, opened from its head; stated only where the job\'s people discuss a record or the owner asks for one. Absent, no one comments |\n| `history` | `true` | no | Draws nothing of its own: the record\'s Activity shows every move of the status as a change, when and who \u2014 refused beside `activity: false`, which shows the moves nowhere; noted beside Activity, and refused there in a later release. The entity\'s `status.history` is written either way |\n| `activity` | `false` | no | false: the app\'s records show no activity \u2014 the door in each record\'s head and the panel of its saves and comments beside it; where `comments` is stated, the door opens the comments alone. Absent, every record shows it |\n| `compose` | [piece](#composed-page) | no | The record\'s page stated as a tree of finished pieces instead of `sections`, on a page door \u2014 for a page that is its own arrangement of what the app already states: each node names a piece of the catalog (`use`) and binds by name to a field of the entity, an act of the app or a child entity; it holds no condition and no computed value |\n\n#### Section\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `title` | text | yes | What the section is, in the reader\'s words \u2014 its heading, and its name on the record\'s rail or tab |\n| `description` | text | no | One sentence under the title: what the section is for, or what its act does |\n| `at` | list of alias (at least one) | no | Options of the record\'s status (or its milestones) during which this section is the work now \u2014 a step of the path the record moves through: its rail item reads now while the status holds one and this app has work there, done once the record\'s history says it went through one \u2014 or it is a step of the path before where that history opens (with none, where the record stands) that no act moves the work past \u2014 and it stands before the section that is the work now, and waiting otherwise; a section every option of which ends the work, past the path\'s end or entered by its own act, is an exit: no item and nothing drawn until the record stands in it, then set apart after the steps and never one; A page opened from the register opens at it. It never locks what the section holds: its fields are written as the write rules and checks allow at any stage. An act it names is offered during these alone: its `when` holds the status to them, or on milestones it stamps the step after one of them \u2014 a detour and an exit are sections of their own, a detour stated before the step it returns to |\n| `fields` | list of alias (at least one) | no | The record\'s own fields in this section, in the order they are read \u2014 never one the header draws: the row\'s title, subtitle, image, status or figure |\n| `blocks` | list of [block](#blocks) (at least one) | no | What the section holds besides its own fields, under them, in order |\n| `acts` | list of alias (at least one) | no | Acts of this app drawn under the section\'s fields, their asks as more of them and what each lacks said above its button; the header draws no act, so every act of the record itself is named by one section \u2014 an act of a child (`of`) stands on the child\'s row and is never named here. Where a status move stands is `record.move-home`\'s \u2014 an exit\'s, in the header\'s \u22EF. A correction \u2014 `danger` and not one of its step\'s outcomes (no other status move offered at the same moment) \u2014 waits in the section heading\'s \u22EF, and one no section names in the header\'s \u22EF; every other act is named by a section |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n| `side` | `true` | no | The section the rest are worked from, drawn in a pane beside them rather than in their scroll \u2014 the photos looked at, the pool picked from, the paper typed off; at most one on a record, which opens on a page door. It holds what any section holds |\n| `page` | `true` | no | A page of its own, off the record\'s scroll: its own heading and a way back, reached from the record\'s rail after the scroll\'s sections, or from a link at its place where the record has no rail \u2014 for what makes the record worse stacked in it: a long list of related rows, a workspace of its own. Only on a page door, never a step (`at`). Holding only one `text` block over a markdown field, it reads as a document: a 680px column, saved as it is written \u2014 whether it is saved said at its foot |\n\n<!-- generated:end apps-record -->\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A field, a block and an act each stand once on a record: the header draws the title, subtitle, image, status (or milestones), figure and folder, and a field\'s one other place is a section\'s `fields`, a files, text or statement block \u2014 save the image, which one files block may draw again, whole, the figure, which a statement draws as what it comes to, and rows one list prices and another compares (`compare`); two places whose `when`s never hold together (a select at options the other\'s lacks) each draw it, and a plain rows block (no `expect`, `only`, `of`, `under`, `pick`, `post`, `checklist` or `compare`) likewise. |\n| `record.foot-total` | A rows block\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also one of a section\'s `fields`. |\n| `record.fact-restates` | A section\'s field never looks up what its link already reads where it stands: the linked row\'s title beside the link, the figure or bound its meter reads on the header\'s line. |\n| `record.section-holds` | A section holds fields, blocks or acts. |\n| `record.sections` | *Refused until adopted or declined:* A register laid out as a table, cards or a gantt states its record\'s `sections` \u2014 the patch holds the fields people write, a files block per paper, a block per child and the record\'s acts. |\n| `record.header-budget` | *Refused until adopted or declined:* A record\'s head says what the row is and where it stands \u2014 its title, line, picture and status \u2014 and at most two more facts, one of them a deadline at most; the rest stands in a section, unless the app declines with why its job reads more at a glance. |\n| `record.children` | *Refused until adopted or declined:* An entity some app records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a block on its record, a roster of them, lanes of them by that link, or an app over them working in one of its rows at a time (`scope`) \u2014 the patch lists each under the record. |\n| `record.at` | `at` names options of the record\'s stored status, or its milestones; a record with no status has no steps. |\n| `record.at-once` | A stage is the work of one section: two sections naming one option of the status, or one milestone, in `at` hold some field to values apart in their `when` \u2014 a `when` holding the status keeps its section off the options it leaves out. |\n| `record.section-page` | A section is a `page` only on a page door \u2014 never a drawer\'s or one beside the list \u2014 and never a step (`at`), its title naming an address no other page shares (a letter or a digit at least), and never every section. |\n| `record.side` | At most one section stands beside the rest (`side`), on a page door, and never also a page of its own. |\n| `record.beside` | A `door: "beside"` record opens beside a table register \u2014 never a board, cards or a calendar, which draw no list to stand beside. |\n| `record.history` | `record.history` names a status history the entity records (`status.history`), on a record whose Activity is on \u2014 its Activity shows each move, so beside `activity: false` the key draws nothing; no block reads that history. |\n| `record.history-activity` | *Noted, never refused:* `record.history: true` beside a record whose Activity is on: Activity shows every status move as a change already, so the key adds nothing \u2014 a later release refuses it. |\n| `record.section-acts` | A section\'s `acts` name acts of the record itself: an act of a child (`of`) stands on the child\'s row, and one over the register\'s rows (`on`) on the register. |\n| `record.act-in-section` | Every act of the record stands in the `acts` of the section whose work it is; only a correction no section owns \u2014 `danger`, and no other status move offered at the same moment \u2014 or an act an agent runs for the person (a `workflow` or an `intake` moving no status), left off every section, waits in the header\'s \u22EF. |\n| `record.move-home` | A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step it passes anyway; one offered at several steps, or moving back into a detour, stands in the section `at` the status it enters. |\n| `record.act-staged` | An act at a staged section\'s foot is offered only during that section\'s steps: its `when` holds the status to options the section names \u2014 on milestones, it stamps the step after one of them. |\n| `record.act-hidden` | An act is never offered only while its section\'s `when` hides the section. |\n| `record.field-edit` | An act that only writes one field of its record, not the status, from the one input it asks is that field\'s edit: the field rests in the section\'s `fields` as a control. |\n\n<!-- generated:end rules-record -->\n\nThe record is its `sections`, stacked in the order the work reaches them. A section is\nits fields, the acts under them, then its blocks \u2014 the acts at its foot instead where one\nreads what a block holds or none of its fields \u2014 and holds at least one of them. From\nthree sections on, the record is navigated by their titles: a page by a rail that jumps\nto each (a strip of the same names on a phone), a drawer by the same strip pinned over its scroll;\nwith fewer, the sections just stack. `description` is one sentence under the title.\n`at` names the status options (or the milestones) during which the section is the work\nnow \u2014 only on a record that truly moves through those stages: the rail marks it done,\nnow or waiting (an item of no `at` is its title alone), and the section stands even holding\nnothing yet \u2014 it never hides a field, locks it or gates an act, and a record opens at its\nhead. `page: true` makes a section a page of its own under the\nrecord\'s, off its scroll, with a way back \u2014 rarely, for a long related list or a workspace\nof its own that would make the record worse stacked; never on a drawer or a step. The\nheader draws no act: every act on the record is named by the section whose work it is, and one no section names is refused, naming its likely\nsection \u2014 only a correction no section owns waits in the header\'s \u22EF beside Delete. An act\nmoving the status and offered at ONE step (its `when`) stands at that step\'s foot when it\nmoves the work forward \u2014 to the next step, or to an exit later in the status\'s options\n(Reject beside Approve) \u2014 or back to a step the work passes anyway. One offered at SEVERAL\nsteps, or moving back into a detour, is named by the section it enters: a detour draws it and its\ngaps alone while it waits. A detour \u2014 a stage the work only steps aside into from one step and\nleaves only back to it (a pause, a repair) \u2014 stands before that step, its option and its section\nalike; listed after, the work reads it as its next step, and the check notes it with the move\nlisting it before. A `danger` act is a correction \u2014 waiting in the \u22EF of what it acts\non: its section\'s heading, its row, the header\'s where no section names it \u2014 unless it moves\nthe status while another status move is offered at the same moment; then it is one of that\nstep\'s outcomes, a button. Cancel offered at Held and at Confirmed, beside Confirm, is an\noutcome into an exit: state `{ "title": "Cancelled", "at": ["cancelled"], "fields": ["reason"],\n"acts": ["cancel"] }`. An exit stands only once the record is in it, its reason there and its\nrail item apart from the path; until then Cancel waits in the header\'s \u22EF. Every record\nopens its activity from its head \u2014 each save field by field, each move among them, and each\ncomment, with one composer \u2014 unless `activity: false`. `comments: true` lets people comment\n\u2014 opt-in: state it only where the job\'s people discuss a record; with `activity: false` the\ndoor opens the comments alone, and with neither no door stands. An edit in the activity \u2014 never\nthe record\'s making or an undo \u2014 carries Undo for a member who may write the\nrecord, in an app that saves it (none with `writes: false`): each field goes back where the\nrecord still holds what the edit wrote, the rest named with why. Unless `activity: false`, its\norganization\'s members get generated workflows: `record_activity` (`record_id`, `after?`) hands\nback `entries` \u2014 each with `undoable` and `undone` \u2014 and `next?`; in such an app,\n`record_activity_undo` (`record_id`, `entry_id`) hands back `reverted` and `kept`. No other\nworkflow takes either alias. `history: true` draws nothing of its own \u2014 each move is already\nin the activity: noted, refused beside\n`activity: false` (the moves would show nowhere), and refused everywhere in a later release.\n\nA field, a block and an act is each placed ONCE on a record \u2014 the header, one section;\na second place is refused. The header draws the entity\'s `records` title, subtitle,\nimage, status (or milestones) and figure, so none of them is named again in a section\'s\n`fields` or the register\'s `columns` \u2014 save the image, which one `files` block may draw\nagain, whole at reading size (an incident\'s photo, a scan), the header keeping its mark.\nA table, cards or a gantt states its record\'s `sections` (`record.sections`); absent them \u2014 a register laid\nout in time, or one declining the rule \u2014 one section holds every field a person writes that the header does\nnot show. An editable field rests as its control and saves as it changes; everything\nelse is plain text. A section or a block with `when` is shown only while each named\nselect of the record holds one of its options. The one layout serves every entity: a\ncustomer or a product is sections without `at`.\n\n## Blocks\n\n```jsonc\n"blocks": [\n { "rows": "fee", "columns": ["kind", "amount"] },\n { "rows": "fee", "where": { "leg": ["out"] }, "columns": ["kind", "amount"], "under": "invoice" },\n { "rows": "cost", "via": "bill", "create": false, "remove": false, "pick": true },\n { "files": ["photos", "papers"] },\n { "text": "remarks", "when": { "stage": ["held"] } },\n { "statement": [{ "field": "subtotal" }, { "field": "vat", "op": "plus" }, { "field": "total", "op": "equals" }] }\n]\n```\n\n<!-- generated:start apps-blocks -->\n\n#### Rows block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | A child entity whose rows belong to this record |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `columns` | list of alias | no | The child\'s fields read as columns after its title \u2014 never what its row draws (subtitle, image, status, figure, or the bound its figure\'s meter reads against), though an `expect` block\'s figure is a column, filled in place. |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, its picture, the subtitle and figure no default fills, the block\'s columns, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the child rows whose single select holds one of these options, or whose yes/no (stored, or a formula) is this value \u2014 every entry ANDed, read so on the server; a row added here holds the selects\' (one leg\'s fees, of a record holding both legs\'). Each select is one the child requires, so no row stands in no block |\n| `expect` | alias | no | The child\'s title when the record holds one row per value of it \u2014 a single select (one per option, in order) or a one-row link to a catalog (one per row the link may point at): a value not yet filled reads as its own empty line, and no value holds two rows. The block\'s `columns` name at least one field a person fills in place, unless it states `post`, whose lines are ticked |\n| `of` | alias | no | With `expect` on a select: the record\'s own multi-select holding the options this record expects a line for \u2014 the options it holds, in order, rather than every option. Its options are among the title\'s |\n| `only` | list of alias (at least one) | no | With `expect` on a select: the options this block holds a line for, so each paper kind stands in its own section, one place per kind. Never with `of` |\n| `under` | alias | no | The child\'s one-link to a document that covers its rows (an invoice over its fee lines), whose many-link points back and which links to this record: each document stands as a heading over the lines it covers; a filled line no document covers says so on its own row with a make for one document over it, and two or more waiting take a combined make in the block\'s heading. Never also a rows block of the document |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter)) (at most 3) | no | The child\'s fields the reader narrows the block\'s rows by, as a register\'s `filters` \u2014 none to 3, each a field its rows show (a column, or a part of the row) or a formula of fields they show, its status among them where the business narrows by it \u2014 never on a task list, whose status chips narrow it |\n| `search` | list of alias (at least one) | no | The child\'s fields the block\'s search box matches (a link by its row\'s title), a pasted list line by line; absent, the block has no search box |\n| `group` | alias | no | The child\'s field the block\'s rows open grouped by, as a register\'s `group` \u2014 the reader\'s grouping starting there; absent, ungrouped |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | no | The order the block\'s rows open in, as a register\'s `sort` \u2014 within each group where the block groups them; absent, the child\'s first deadline soonest first, else the newest first |\n| `edits` | list of alias (1\u20132) | no | The child\'s fields each line holds as its control, written where the line stands (a quote line\'s sell price, the customer a line is matched to) \u2014 a number, a date, words, one option or a one-row link the row\'s save writes, each a column or the figure, at most 2; a link\'s control is its picker, offering the rows the field\'s own rules admit; every other value reads, and the row opens to write it |\n| `remove` | `false` | no | This list offers no Delete on its rows (its open row and \u22EF); they are deleted where another list of them or their own record offers it \u2014 e.g. lines that are a selection of rows kept elsewhere |\n| `pick` | `true` | no | The block also picks rows of the child that no record holds through `via` yet \u2014 those naming what this record names in each link `via`\'s `same` compares, and holding the block\'s `where` \u2014 and links them here; a row picked leaves the block from its \u22EF, unlinked and kept. `via` is an optional one-row link a person writes, and the record holds the many-link paired with it |\n| `checklist` | [Checklist](#checklist) | no | The child\'s rows, which are tasks, read as a checklist of checks: each one\'s mark \u2014 passed at a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column its note, on its own line), and on a line under its title its photo and its clause; never grouped nor written in place |\n| `compare` | [Compare](#compare) | no | This list reads each row\'s before against its after. Two files fields (a repair\'s damage and its repair, a check failed and redone): once the before holds a photo, the two stand side by side at one size, each row read in full as a card \u2014 on a checklist, whose `photo` is the before, the after beside it on its line \u2014 and an after not taken yet is the camera\'s tile adding it while the row\'s work is open; a list of the same rows without it stays a table. Two value fields of one type \u2014 text, a number, a date or a single select (a price before a sheet and after it): the list stays a table and the pair is one column under the after\'s label \u2014 the before struck, an arrow, the after \u2014 an empty before read as added and an empty after as removed; the after is its control where `edits` names it, and neither is also a column. Never with `expect` |\n| `post` | [Post](#post) | no | This list is a publish desk: with `expect` on a one-row link to a catalog of destinations, every destination the link admits is a line a person ticks \u2014 a tick makes its row from its key alone, an untick deletes it until its status is `closed` \u2014 and the line chosen reads beside the list as the post that destination\'s feed will show, with its words to copy, the block\'s `columns` as its facts and the row\'s acts. Never with `under`, `pick`, `checklist`, `compare` or a `create` list |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Checklist\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `photo` | alias | no | The child\'s files field holding the photo each row is checked by |\n| `clause` | alias | no | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | no | Options of the child\'s status a row stands failed at \u2014 none of them `closed` |\n\n#### Compare\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `before` | alias | yes | A field of the block\'s rows holding what stood before: a files field (the photo of the place before the work \u2014 the damage surveyed, the check failed), or a value \u2014 text, a number, a date or a single select (the price a row held before a sheet changed it) |\n| `after` | alias | yes | Another field of the block\'s rows, of the same type as `before`, holding what stands after: the photo of the same place once the work is done, or the value the row holds now |\n\n#### Files block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `files` | list of alias (at least one) | yes | Files fields of this record, read as pictures and documents |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Text block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `text` | alias | yes | A long text field read as prose |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n<!-- generated:end apps-blocks -->\n\n<!-- generated:start rules-block -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.child-link` | A block reads a child linked to the record; `via` names the link where the child links more than once. |\n| `block.column-drawn` | A child block\'s column never names what the child\'s row draws (title, subtitle, image, status, figure, or the bound its figure\'s meter reads against) nor its link back, and names a field once; an `expect` block\'s figure is its filled-in-place column. |\n| `block.columns-budget` | A child block\'s stated columns, each at the width of its kind, fit the room a desk leaves beside its name and the row\'s own status, deadline and figure. |\n| `block.title-back` | Where a child\'s title is its link back to the record a block lists it under, its first other subtitle names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `block.where` | A rows block\'s `where` names single selects the child requires, by options they hold \u2014 one held at a single option is never also a column \u2014 and the child\'s yes/nos by value. A yes/no is never held: a block adds rows only at a stored one\'s start, and never picks, expects or stands lines under documents. |\n| `block.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `block.under-once` | Documents drawn over their lines (`under`) are never listed again as a block of their own. |\n| `block.edits` | A rows block\'s `edits` name at most two of the child\'s columns or its figure that the row\'s own save writes \u2014 a number, a date, a few words, one option or a one-row link, never the block\'s `via` nor a link it must name alike (`write_rules`\' `same`) \u2014 never on an `expect` block. |\n| `block.remove` | A rows block\'s `remove: false` hides the Delete its rows would offer, so it stands only where the app writes those rows. |\n| `block.compare` | A rows block\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select). Never with `expect`. Over files on a `checklist`, `before` is the check\'s `photo`. Over values: neither side is a column or something the row draws already (title, line, figure, status, deadline), two numbers share a notation, no column is long text, never on a `checklist`. |\n| `block.checklist` | A rows block\'s `checklist` reads a task entity\'s rows as checks \u2014 never expected, under documents, grouped, edited in place or picked together by an act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`. |\n| `block.pick` | A rows block\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no act writes, no other rule compares rows by and no `under` block stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor in an app writing only the record\'s children or nothing. |\n| `block.narrow` | A rows block\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back to the record or a select its `where` holds at one option, nor on an `expect` block; an `under` block is grouped by its documents. |\n| `block.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the block; the block\'s `columns` name at least one field a person fills in place \u2014 unless it states `post`, whose lines are ticked \u2014 and its `create` takes the file where the child is pictured by one. |\n| `block.expect-fills` | An expected line is made from its key and its first filled column \u2014 a `post` block\'s from its key alone, by its tick \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `block.expect-of` | A block\'s `of` or `only` needs `expect` on a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one block per option; an act\'s `paper` is drawn in one. |\n| `block.field-kind` | A files block names files fields of the record, and a text block a text field. |\n| `block.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `block.under-note` | *Noted, never refused:* Rows holding a paper that cover another block\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `block.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no act files a call into or `fills`: the lines still missing read as what a record needs. |\n\n<!-- generated:end rules-block -->\n\nAn add in a block fills the link to this record, never asking it, and a rows block opens each row in a drawer.\nUnder `under` the uncovered lines come first; a document made over\none line starts its figure at the line\'s amount, the heading\'s make covering those ticked in its dialog. `pick` (a\nsupplier bill picking the job\'s cost lines) offers none until the record names each link `via`\'s `same` compares,\nlinks at most 200 ticked, and saves the record: a check locking it refuses, and one refusing a row\'s edits refuses\nthat row. Where the child is pictured by a file a person brings (its `records` `image`), an `expect` line not yet\nfilled is a placeholder naming the paper whose upload makes the row; a catalog link\'s values are the rows its\n`options_where` admits, and the add offers only values not yet held. A field starting from the catalog row\n(`default_from`) shows that value as its hint, taken with one press. A block narrowed by a select\'s `where` expects\nits lines once per value among them (one leg\'s fees beside the other\'s), its foot totalled by the record\'s sum\nnarrowed alike. An `agenda` and a `timeline` are set out under \xA7 Timeline and agenda, a `statement` under\n\xA7 Statements.\n\nA rows block whose `create` asks only numbers, single selects, texts with `suggest` and one-row links (one link at\nleast; no `expect`, `under`, `pick`, checklist or `post`) is also added to by one typed line, its words searching\nthe link\'s rows by title and `records` subtitle \u2014 state there the code people type \u2014 and what it does not ask\ncoming off the row picked (`default_from`).\n\n## Composed page\n\nA record whose page is its own arrangement of what the app already states \u2014 a piece of writing under its title, a\nbrief beside its figures \u2014 states `compose` instead of `sections`: a tree of finished pieces, each named by `use`.\n\n```jsonc\n"record": { "door": "page", "compose": {\n "use": "Column", "children": [\n { "use": "Bar", "children": [\n { "use": "Status" },\n { "use": "Field", "field": "audience" },\n { "use": "Act", "act": "send_for_review" },\n { "use": "Copy", "field": "body", "as": "plain" } ] },\n { "use": "Title" },\n { "use": "Document", "field": "body" },\n { "use": "Group", "title": "Reviews", "children": [\n { "use": "Rows", "child": "review", "create": false },\n { "use": "Act", "act": "ask_reviewer" } ] } ] } }\n```\n\nA node binds by name: a `field` is a field of the record\'s entity, an `act` an act of the app, a `child` an entity\nlinking to the record. What a name binds is read and written exactly as a section naming it would be \u2014 a `Field` and\na `Document` are saved through the record\'s own save, an `Act` runs its workflow, a `Rows` reads the child\'s rows \u2014\nso a tree adds no write of its own. It holds no condition and no computed value: a piece that does not apply on a\nrow (a field its entity\'s `applies` leaves out, an act its `when` does not offer, rows with nothing in them and no\nadd) draws nothing, by the rule that leaves it out of a section, and anything that must depend on the row is an act\'s\n`when` or a field\'s formula, never the tree.\n\nThe first `Act` the page itself draws is its primary and every other one secondary; a `danger` act reads so wherever it\nstands. A `Copy` and a `Document` naming one field copy what is on screen \u2014 the words typed and not yet saved among\nthem. The record\'s chrome stays the runtime\'s: the way back, its Activity and its \u22EF with Delete share the row over\nthe tree, and the head draws no title and no status of its own \u2014 the tree\'s `Title` and `Status` do.\n\n<!-- generated:start apps-compose -->\n\n#### Column piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Column"` | yes | The page\'s reading column, 680px: its pieces stacked in order from one left edge |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces stacked in it, in the order they are read |\n\n#### Bar piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Bar"` | yes | One row of small things on one control height, in two zones: what the record is \u2014 a status, a field\'s control \u2014 from its left edge, what is done to it \u2014 an act, a copy \u2014 ending on its right edge, taking a row of their own under it where the row runs out of room |\n| `children` | list of [piece](#composed-page) (at least one) | yes | Its pieces, each zone\'s in order; a `Field` directly in it is its control alone on one line, named by its label where it holds nothing; an `Act` that destroys or corrects is not drawn here \u2014 it stands in the record\'s \u22EF |\n\n#### Group piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Group"` | yes | A titled stack, headed once by `title` |\n| `title` | text | yes | Its heading, in the reader\'s words; holding one `Rows`, it carries their count and their add, and the group\'s `Act`s end its line |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces under the heading, in order |\n\n#### Panel piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Panel"` | yes | What a reader does not need while writing: nothing in the page, one entry of the record\'s \u22EF named by `title` that opens its pieces in a panel beside the page \u2014 a sheet on a phone; directly in the root `Column` alone |\n| `title` | text | yes | Its entry in the \u22EF and the panel\'s name, in the reader\'s words; an `Act` directly in it ends that name\'s row |\n| `children` | list of [piece](#composed-page) (at least one) | yes | The pieces in the panel, in order: `Rows`, `Field`, `Act`, `Group`, `Document` \u2014 never `Title`, `Status`, `Bar`, `Copy` or another `Panel` |\n\n#### Title piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Title"` | yes | The record\'s title (`records.<entity>.title`) as the page\'s heading, written in place where a person writes it; one a page |\n\n#### Status piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Status"` | yes | The record\'s status (`records.<entity>.status`) as a record\'s head draws it: moved by hand, by its acts\' moves, or read |\n\n#### Field piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Field"` | yes | A field of the record under its label, as a section\'s `fields` draws it |\n| `field` | alias | yes | The field drawn \u2014 never the title or the status, which `Title` and `Status` draw; once a page |\n\n#### Document piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Document"` | yes | A markdown text field written in place with no box, saved as it is written \u2014 whether it is saved said at its foot |\n| `field` | alias | yes | A text field with `format: "markdown"`; once a page |\n\n#### Act piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Act"` | yes | An act of the app on the record as its button: its `when`, what it lacks, its asks and its confirmation as everywhere; the first `Act` the page itself draws is its primary |\n| `act` | alias | yes | An act of this app on the record \u2014 never one `of` a child\'s rows, which stands on its row; once a page |\n\n#### Rows piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Rows"` | yes | A child entity\'s rows under the record, as a rows block lists them, each row\'s own acts on it |\n| `child` | alias | yes | A child entity linking to the record; once a page |\n| `create` | `false` | no | false, rows are not added here \u2014 an act of the page makes them |\n\n#### Copy piece\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `use` | `"Copy"` | yes | A button copying a field\'s words as the page holds them now \u2014 what is typed in its `Document` and not yet saved among them |\n| `field` | alias | yes | The text field copied |\n| `as` | `"plain"` \\| `"raw"` | yes | `plain`, its markdown marks gone; `raw`, as stored |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.compose` | A record\'s `compose` is stated instead of `sections`, on a page door, by an app of one book whose records have no steps (`status.milestones`, `status.stages`) and no picture (`image`) \u2014 a composed page draws neither. Each name is a field of the entity, an act of the app on the record or a child entity linked to it; one `Title`, and each field, act and child drawn once \u2014 a field by `Field` or `Document`, never the title or the status, which `Title` and `Status` draw. The first `Act` the page itself draws is its next step and every other one secondary; an `Act` is a button alone, never one making a set of papers. A `Bar` is one row on one control height, in two zones \u2014 its `Status` and `Field`s from its left edge, its `Act`s and `Copy`s ending on its right edge \u2014 and holds no `Rows` and no `Document`; a `Field` directly in it is its control alone on one line, named by its label where it holds nothing; an `Act` in it that destroys or corrects what is done (`danger`, or a move back) is not drawn there \u2014 it stands in the record\'s \u22EF. A `Panel` draws nothing in the page: it is one entry of the record\'s \u22EF, named by its `title`, opening its pieces in a panel beside the page; it stands directly in the root `Column`, holds `Rows`, `Field`, `Act`, `Group` and `Document` \u2014 never `Title`, `Status`, `Bar`, `Copy` or another `Panel` \u2014 and an `Act` directly in it ends the panel\'s name, secondary. A `Group` is headed once, by its `title`: holding one `Rows`, that heading carries the rows\' count and their add in place of the rows\' own, and the `Act`s the group holds end its line. A `Copy` takes a text field\'s words as the page holds them now, a `Document`\'s words not yet saved among them; a field a `Copy` alone names is read, never written. |\n\n<!-- generated:end apps-compose -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s\nportals \u2014 are a rows block that `expect`s the child\'s one-row link to the catalog of those places and states `post`:\n\n```jsonc\n{ "rows": "posting", "expect": "board", "columns": ["posted_link", "refusal"],\n "post": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page",\n "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per\nlanguage, say), each its editor between the list and the preview, saved as any field of the record is and drawn\nnowhere else on it. The preview is `text` read over what is on screen: where `text` is a formula of the child, the\ndesk computes that same formula over what is typed \u2014 a body before it is saved, the line\'s own column \u2014 so the post\nmoves as it is written, and a place not ticked previews the words its row would hold. For that the formula reads only\nwhat a screen holds whole: stored values of its row, the record through lookups over the link back to it, the place\nthrough lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup through another link or the\nclock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture (its `records` `image`), else\nthe mark of the network it is on where `networks` names one, else none. `group`, another single select of the place,\nstands the lines under its options in their order: a kind holding a ticked line is open, one holding none folded to\nits heading and its count \u2014 the first open where nothing is ticked \u2014 and a place of no kind comes last. A tick makes\nthe line\'s row from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick\ndeletes it until the row\'s status is `closed`: what went out is not taken back. It asks first only where a person\nwrote on the row \u2014 its status moved off its first option, or one of the block\'s `columns` a person writes filled. One line is worked beside the list \u2014 the one\npressed, else the first ticked \u2014 and read as the post that place\'s feed shows: `text` is the child\'s words for that\nplace, `media` and `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a\nfeed. A place on an option not named reads its words on a plain card. Under the bodies stand the block\'s `columns` a\nperson writes of the line\'s row (words for that place alone); under the post, the press copying its words beside\nthe acts `of` the child \u2014 never a second primary: the section\'s own act is that \u2014 then what the row\'s line and the\nblock\'s `columns` hold that nobody writes there (the link it went out at, why it was refused), each drawn only once\nit holds a value. A value an act or a workflow fills is stated as that act\'s, so the desk never offers it as an\nempty box. Where the block\'s box seats three columns they are the list, what is written and\nthe post; narrower, what is written stands over the post; narrower still the list stands alone and a line opens in\nplace. Sending is an\nordinary act of the record, named in the section\'s `acts`.\n\n<!-- generated:start apps-post -->\n\n#### Post\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `bodies` | list of alias (1\u20133) | no | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias | yes | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias | yes | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | no | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias | yes | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | no | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"` | yes | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.post` | A rows block\'s `post` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, `checklist`, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end apps-post -->\n\n## Timeline and agenda\n\nTwo blocks read a child\'s rows by their day: a `timeline` logs what happened, newest first; an `agenda` plans\nwhat is to come on a time axis.\n\n```jsonc\n"blocks": [\n { "timeline": "note" },\n { "agenda": "booking", "columns": ["guide"], "start": "arrival" }\n]\n```\n\n<!-- generated:start apps-timeline-agenda -->\n\n#### Timeline block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `timeline` | alias | yes | A child entity read as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands as a rows block\'s row (entries planned ahead are an `agenda`) \u2014 never the record\'s status history: its Activity shows each move |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, the subtitle and figure no default fills, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Agenda block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `agenda` | alias | yes | A child entity read as planned entries on a time axis: by day, soonest first, each entry with its picture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or subtitle); within a day entries follow a datetime there, else the first single select after the date \u2014 its options in the day\'s order |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `title` | text | no | The block\'s heading; absent, the child entity\'s or the field\'s own label |\n| `columns` | list of alias | no | The child\'s facts read on an entry\'s line after its title \u2014 never what its line already draws (subtitle, image, status, figure) |\n| `create` | list of alias (at least one) \\| `false` | no | The child\'s fields asked when a row is added here; absent, its title, its picture, the subtitle and figure no default fills, the block\'s columns, its natural key and every required field \u2014 each a person writes; false, rows are not added here |\n| `start` | alias | no | The record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2); absent, the weekday and the date alone |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.timeline` | A timeline\'s child holds a date to place its entries by. |\n| `block.agenda` | An agenda\'s child names a date on its row line (`records` title or subtitle); `start` is a date of the record. |\n| `block.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a `timeline` draws them as a log, newest first. |\n| `block.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: an `agenda` draws them by day. |\n\n<!-- generated:end apps-timeline-agenda -->\n\nAn entry with no day yet is a plan, listed first and dated in place; a timeline\'s moment is its child\'s first date,\nand who its member field.\n\n## Statements\n\nA `statement` block draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s\ntotal, a payslip\'s net \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first\nstating no `op`, the last an `equals`. Every figure is a field the server computes or a person writes; the screen adds\nnothing up. A line\'s `parts` lists the rows its figure carries, each read from its own row, and that figure is what\nthey add up to \u2014 a formula, rollup or lookup, or the server\'s copy when the record is made (`default_from`), which\nnothing writes after. A claim\'s "certified before" is the contract\'s certified total copied when the claim is made\n(`made_at`, a moment the record `starts` at `today`), over the claims certified (`certified_at`, an act\'s `now`)\nbefore that moment, each at the figure its certifying act froze (`certified_value`, set to\n`{ "formula": "{claim_value}" }`, which the contract\'s total sums) \u2014 so they always add up to it, as a signed\ncertificate does, after a percent is edited or the contract varied.\n\n```jsonc\n{ "statement": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus",\n "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] },\n "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] } }\n```\n\n<!-- generated:start apps-statement -->\n\n#### Statement block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `statement` | list of [Statement line](#statement-line) (at least 3) | yes | A figure built from figures of the record, read as a statement: each line its operator, its label and its figure, the figures on one right edge, in the order stated \u2014 the last an `equals`, what it all comes to, drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line\'s figure is a control where the app writes it |\n| `title` | text | no | The block\'s heading; absent, the label of what the statement comes to |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Statement line\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | no | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | no | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | no | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `rows` | alias | yes | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias | yes | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | no | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | no | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Only the rows whose single select holds one of these options, or whose yes/no (stored, or a formula) is this value \u2014 read so on the server |\n| `columns` | list of alias (1\u20132) | yes | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias | yes | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end apps-statement -->\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A statement\'s lines are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `equals` \u2014 each `equals` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no add asks and no save or act writes, or a stored number stating `writes: false` \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an act fills, the server copies or the model states no person keys (`writes: false`), never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Reading blocks\n\nA `metric`, `breakdown`, `trend`, `pivot` or `progress` block on a record is a reading (\xA7 Readings) of a child\nentity\'s rows under it, read only \u2014 `via` names the link where the child has more than one.\n\nA `figures` block reads the record\'s own numbers instead, each a tile under its field\'s label: two to eight\nnumbers of the record no person keys \u2014 a formula, a rollup, a lookup through links to one row, or a stored number\nstating `writes: false` (what a workflow or an integration writes). A number a person keys is a field of the\nsection, where it is written. A tile holding nothing reads as not measured, never 0 \u2014 a sum or a count of\nnothing yet reads 0; a stored 0 reads 0.\n\nMetric blocks and a `figures` block standing one straight after another in a section draw as one strip: four\ntiles to a line on a desk, two on a phone.\n\nA `funnel` block reads the same rows as steps people drop out of between: each of its `steps` a number column\nof the child, summed over the rows under the record, drawn in order with the share each keeps of the one before.\nFunnel blocks standing one straight after another in a section draw on one grid \u2014 one name column, one bar origin\nand one value column \u2014 each under its own `label`, its bars over its own first step.\n\n```jsonc\n"blocks": [\n { "metric": "fee", "value": "amount", "label": "Fees" },\n { "breakdown": "fee", "by": "kind" },\n { "trend": "fee", "over": "charged_on", "value": "amount" },\n { "pivot": "fee", "rows": "kind", "columns": "method" },\n { "progress": "task", "planned": { "start": "plan_start", "end": "plan_end" }, "done": "complete", "label": "Progress" },\n { "funnel": "channel_week", "steps": ["impressions", "clicks", "bookings"], "label": "Reach to booking" },\n { "figures": ["sessions", "bookings", "calls", "ad_spend"] }\n]\n```\n\n<!-- generated:start apps-reading-blocks -->\n\n#### Metric block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `metric` | alias | yes | The entity whose rows are counted, or summed, into one number |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `average` | `true` | no | The `value` is averaged, not summed: its sum over the rows holding one, divided by how many hold one \u2014 a row holding none is no part of it. Under a period each period reads its own average, and its change compares two averages; where no row holds one it reads no figure, never 0, and no change. A share is an average too: a number formula that is 100 on the rows that count and 0 on the others, in percent notation, reads as the share of rows that count |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `target` | number | no | The number it is read against, where no `limits` bounds its value (a bounded value is read against the sum of its bound) |\n| `better` | `"up"` \\| `"down"` | no | Which way its change over the recent periods `over` reads is good; absent, a sum\'s rise and a count kept by `where` falling |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Breakdown block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `breakdown` | alias | yes | The entity whose rows are split into parts |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) each row is counted under \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the `by` field\'s label |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Trend block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `trend` | alias | yes | The entity whose rows are counted, or summed, per period |\n| `over` | alias | yes | The date each row falls on \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link |\n| `ahead` | `true` | no | Counts forward: the current period first, then the ones after it, over the rows dated today or later (arrivals by their ETA); absent, the periods up to today |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the value\'s label, else the entity\'s |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Pivot block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `pivot` | alias | yes | The entity whose rows are counted, or summed, in a grid |\n| `rows` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) down the side \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `columns` | alias \\| [Tiered filter](#tiered-filter) | yes | The single select, one link, member or yes/no (stored, a formula, or a lookup of one through one-row links) across the top \u2014 or `{ "field", "tiers" }`, a number in the bands its tiers cut (days late: not due, 1\u201330, 31\u201360, over 60), every band drawn in its own order and a row holding no number apart |\n| `value` | alias | no | A number field summed over the rows; absent, the rows are counted |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `over` | alias | no | The date that places a row in time \u2014 its own (stored, or a formula), or its parent\'s through a lookup over a one-link: a dashboard\'s period windows the rows by it (a reading without one reads the rows as they stand now), and a metric reads its recent periods beside the number |\n| `label` | text | no | What the reading is, in the reader\'s words; absent, the two fields\' labels |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Progress block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `progress` | alias | yes | The entity whose rows are the parts of the work, read as the share of it planned and the share done, day by day |\n| `planned` | [Progress planned](#progress-planned) | yes | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | yes | A number of the row the server computes: its share done today, in percent (0\u2013100) |\n| `finished` | alias | no | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `measured` | [Progress measured](#progress-measured) | no | Before a row is finished, its share done on a day is what these add up to by then, never past its `done`; absent, a row stands at nothing until it is finished, and at its `done` today |\n| `weight` | alias | no | A number of the row: what it weighs in the whole \u2014 its value, its share of the contract; a row holding none weighs nothing. Absent, each row weighs its planned days |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Funnel block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `funnel` | alias | yes | A child entity whose rows each count the same steps, a column a step (a week\'s channels, each with its impressions, clicks and bookings): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. A step no row holds a number in reads as not measured, never as zero |\n| `steps` | list of alias (2\u20138) | yes | The child\'s numbers summed, in order, first step to last \u2014 2 to 8, each stored, a formula or a rollup, all in one notation, never a percent |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `via` | alias | no | The child\'s link to this record, where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Figures block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `figures` | list of alias (2\u20138) | yes | Numbers of this record no person keys, in order, each a tile under its field\'s label \u2014 2 to 8: a formula, a rollup, a lookup, or a stored number stating `writes: false`. A tile holding nothing reads as not measured, never 0 \u2014 a sum or a count of nothing yet reads 0 |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.funnel` | A funnel\'s `steps` are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `block.figures` | A `figures` block\'s tiles are 2 to 8 numbers of the record no person keys \u2014 a formula, a rollup, a lookup through links to one row, or a stored number stating `writes: false` \u2014 each placed once on the record. |\n\n<!-- generated:end apps-reading-blocks -->\n\n## List block\n\nA `list` block puts rows of an entity beside the record, read only \u2014 nothing in it is added, edited or removed, and\nno workflow is made for the list itself (a `rows` block lists and edits a child\'s rows). An act `of` its entity\n(`acts[].of`) stands in each row\'s \u22EF and works that one row; a field it `requires` is one it `asks`. It reads the rows linked to the\nrecord through the list entity\'s one link to it (`via` where it has several). With `same`, a one-row link of the\nrecord\'s entity, it reads the rows sharing that link\'s row with the record, the record left out \u2014 a credit\nnote\'s other notes of its party; the list entity holds one link to that row\'s entity (`via` where it has several).\nA record whose `same` link is empty lists nothing and says so. `where`, `columns`, `label` and `app` read as\non a dashboard\'s list; the heading counts every row, and every row is drawn. A row opens as a record: the\nlist\'s entity is the app\'s own, a book\'s or a log\'s, opening its record here, or `app` names the register app that\nworks it, which opens it (`block.list-opens`).\n`same` stands in a record\'s `blocks` only.\n\n```jsonc\n"blocks": [\n { "list": "visit", "label": "Service visits", "columns": ["engineer"], "app": "visits" },\n { "list": "order", "same": "customer", "label": "Customer\'s other open orders", "where": { "stage": ["draft", "confirmed"] } }\n]\n```\n\n<!-- generated:start apps-list-block -->\n\n#### List block\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `list` | alias | yes | The entity whose rows are listed, each in its `records` anatomy |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `"me"`) | no | Only the rows whose select holds one of these options, whose yes/no (stored or formula) is this value, or whose member field holds the reader (`"me"`) \u2014 each its own or through one-row links; entries ANDed |\n| `columns` | list of alias | no | Fields read after each row\'s title |\n| `app` | alias | no | An app of this model over the same entity that works its rows: a dashboard row opens there, a record\'s list row has "Open in" to it |\n| `same` | alias | no | In a record\'s `blocks` only, read-only: a one-row link of the record \u2014 the rows sharing its row with this record, the record left out, by the list entity\'s one link to that row\'s entity (`via` where several). Absent, the rows linked to this record |\n| `fields` | list of alias (at least one) | no | In a record\'s `blocks` only, read-only: fields of the listed entity a row shows, in this order, when it is opened in place under itself \u2014 one row open at a time. Absent, a row opens in the record\'s drawer |\n| `label` | text | yes | What the reading is, in the reader\'s words |\n| `tab` | alias | no | The register tab it reads, else the open one; or its dashboard tab |\n| `via` | alias | no | The list entity\'s link to this record \u2014 with `same`, to the entity that link points at \u2014 where it has more than one |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | Shown only while each named select of the record holds one of these options, and each named yes/no (stored, or a formula) is this value |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `block.list` | A `list` block, read-only, lists the rows of an entity that link to the record by its one link to it (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row with the record \u2014 the record left out \u2014 by the list entity\'s one link to that row\'s entity (`via` where it has several). `same` and `fields` stand in a record\'s `blocks`, never on a dashboard. `fields` \u2014 at least one, each a field of the listed entity named once, never its title nor one of the `columns` \u2014 are what a row shows, read-only, when it is opened in place. |\n| `block.list-opens` | A `list` block\'s row opens in the record\'s drawer as a record: its entity is one a list of the app draws \u2014 the app\'s own, a book\'s, or a log\'s (`logs`) \u2014 or the list\'s `app` names the register app that works it. |\n\n<!-- generated:end apps-list-block -->\n\n## Tasks\n\nAn entity whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is\nwork someone finishes. Every table of its rows draws it alike \u2014 a rows block of the record it\nbelongs to, its own register, the rows filed under one of its rows (its steps) \u2014 each row led by a\nring. Ticking the ring moves the row to a closed option by the one write the app already has for\nthat move \u2014 the act of that entity setting a closed option (its first preferred), offered on an\nopen row and asking nothing, else its own save where people write the status \u2014 stamping what\nthat act stamps and appending the status history. Unticking runs the act moving a closed row\nback (its `when` holding a closed option), else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled, never hidden, and the check notes it. The status is moved\nin place on the row by the same moves; every other field is edited where the row opens. A\nfiles column reads on a task\'s line as how many files it holds. An act `of` the child with\n`on: "rows"` completes several at once: the list\'s heading offers to select rows, and the act\nruns on those picked. A block with `expect` or `under` draws its own lines, never rings. A record listing rows of a\ntask entity filed under it by a link holding one row says how much of that work is done \u2014 those rows at a closed\noption of all, every one the reader may read, every such block\'s rows counted as one \u2014 wherever its row is drawn: a\nmeter on its head, a column of its register\'s rows, a card\'s foot, a calendar entry, a gantt\'s or a lane\'s bar; a\ngantt of task rows grouped by the row they are filed under says that row\'s on each group\'s head. No rollup is stated\nfor it.\n\n```json\n{\n "entities": [\n {\n "alias": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": [\n { "alias": "name", "label": "Name", "type": "text", "required": true },\n { "alias": "lead", "label": "Lead", "type": "select_member" }\n ]\n },\n {\n "alias": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": [\n { "alias": "title", "label": "Title", "type": "text", "required": true },\n {\n "alias": "project",\n "label": "Project",\n "type": "select_record_link",\n "target_entity": "project",\n "cardinality": "one",\n "required": true\n },\n { "alias": "assignee", "label": "Assignee", "type": "select_member" },\n {\n "alias": "status",\n "label": "Status",\n "type": "select",\n "required": true,\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ],\n "default": ["todo"]\n },\n { "alias": "due", "label": "Due", "type": "date", "format": "date" },\n { "alias": "done_on", "label": "Done on", "type": "date", "format": "date" }\n ]\n }\n ],\n "records": {\n "project": { "title": "name" },\n "task": {\n "title": "title",\n "subtitle": ["assignee"],\n "status": { "field": "status", "closed": ["done"] },\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" }\n }\n },\n "apps": [\n {\n "alias": "projects",\n "name": "Projects",\n "theme": { "color": "blue" },\n "entity": "project",\n "record": {\n "sections": [{ "title": "Work", "fields": ["lead"], "blocks": [{ "rows": "task", "columns": ["due"] }] }]\n },\n "acts": [\n { "alias": "complete", "label": "Complete", "of": "task", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } },\n { "alias": "reopen", "label": "Reopen", "of": "task", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } },\n { "alias": "complete_all", "label": "Complete", "of": "task", "on": "rows", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } }\n ]\n },\n {\n "alias": "my_tasks",\n "name": "My tasks",\n "theme": { "color": "teal" },\n "entity": "task",\n "register": {\n "opens": { "assignee": "me" },\n "readings": [{ "metric": "task", "where": { "status": ["todo"] }, "label": "Open" }]\n },\n "record": {\n "door": "drawer",\n "sections": [{ "title": "Task", "fields": ["project", "due"], "acts": ["finish", "undo"] }]\n },\n "acts": [\n { "alias": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": "now" } },\n { "alias": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n}\n```\n\n## Acts\n\n```jsonc\n"acts": [{\n "alias": "gate_out", "label": "Gate out",\n "when": { "stage": ["in_yard"] }, "requires": ["release", "seal"],\n "asks": ["seal", { "input": "note", "label": "Note", "type": "long_text" }],\n "set": { "stage": "gone", "left_on": "now", "left_by": "me", "remark": "input:note" },\n "confirm": true\n}]\n```\n\n<!-- generated:start apps-acts -->\n\n#### Act\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `alias` | alias | yes | The act\'s name within its app \u2014 its workflow is `act_<alias>` |\n| `label` | text | yes | The verb, as the reader says it |\n| `on` | `"record"` \\| `"rows"` \\| `"view"` | no | `rows` runs on the rows ticked in the register \u2014 with `of`, on the child rows ticked together in a rows block of the record; `view` on every row the register shows (offered while the view is narrowed to its `when`; it states no `requires`); absent, on one record (its page and its row\'s menu) |\n| `of` | alias | no | A rows or list block\'s child entity the act works on: offered on each child row \u2014 or, `on: "rows"`, on the rows ticked together in a rows block \u2014 its conditions and its write that row\'s |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | The act works only while each named select holds one of these options, and each named yes/no (stored, or a formula) is this value |\n| `requires` | list of alias (at least one) | no | Fields that must be filled first, each drawn where the act stands (its section\'s fields, a block\'s, or the act\'s asks \u2014 never the header alone); a blocked act names each one missing |\n| `recommends` | list of alias (at least one) | no | Fields the act runs without and reads when filled: while one is empty, the act says what it will leave blank |\n| `asks` | list of (alias \\| [Asked input](#asked-input)) (at least one) | no | What the reader states when pressing it \u2014 fields of the record (written by the act) or inputs |\n| `set` | map of alias \u2192 (text \\| number \\| boolean \\| `null` \\| [Set formula](#set-formula)) | no | What the act writes: an option alias, a value, `"now"`, `"me"` or `"input:<name>"` \u2014 each the act\'s outcome, read-only elsewhere; or `{ "formula": \u2026 }`, computed over each acted row as it stands when the act runs and written then (a sell price at cost and markup): a starting value, which a person may change after and the act never recomputes |\n| `workflow` | alias | no | An authored workflow (src/workflows/<alias>.ts) the act runs after its checks, for what `set` cannot say |\n| `writes` | list of alias (at least one) | no | With `workflow`, fields of the acted row its body writes (an id kept from a service\'s answer) \u2014 the act\'s, as what `set` states is |\n| `template` | alias | no | A document template the act makes a file from \u2014 an html one made a PDF, an excel one a workbook; over several rows, one file of them all, the rows listed under the entity\'s alias |\n| `templates` | list of [Act template](#act-template) (at least 2) | no | Several papers the act makes into `into` (a case\'s forms), instead of one `template`: listed where the act stands \u2014 each made one as its file, each not yet made as a placeholder \u2014 the reader ticks which to make, one press making those, each replacing its own last paper |\n| `into` | alias | no | The record\'s files field the made document is kept in \u2014 remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | no | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | no | A child the record lists in a rows block whose rows are its papers: the press takes papers, an agent reads them, and each is filed as a row of this child \u2014 its kind the child\'s title, its file in the child\'s files field |\n| `record` | [Recording](#recording) | no | The press records a call, visit or meeting through the host \u2014 Stop ends it \u2014 and files it as a new row of a child the record lists: its audio, its screen where captured, its transcript |\n| `sign` | [Signature](#signature) | no | The press opens a pad the signer signs on, beside what the act asks, and the act keeps the signature as a picture with who signed, when and the witness \u2014 read on the record as one signature, and handed to the paper the act makes |\n| `fills` | list of text (at least one) | no | With `intake`, what the papers read may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child whose rows the papers add \u2014 shown before and after, saved where it differs; a single link is filled with a row the app reads. With `record`, fields of the new row an agent fills from the transcript, saved as they come |\n| `review` | `true` | no | With `workflow`: the workflow only proposes \u2014 its body reads and returns a changeset of the act\'s table in `data.review` \u2014 and the platform writes the rows of it the reader ticks in the act\'s dialog (`approved`). Over every row in view it is handed no rows |\n| `confirm` | `true` | no | The press asks first; the question lists every active warning |\n| `danger` | `true` | no | The act destroys or cannot be undone |\n\n#### Asked input\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `input` | alias | yes | A value the act asks for that is not a field of the record |\n| `label` | text | yes | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"` | yes | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | no | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | no | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | no | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | no | The act is refused without it |\n| `default` | alias | no | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `formula` | text | yes | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n<!-- generated:end apps-acts -->\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Refused until adopted or declined:* Rows a stored status stages towards `closed` options are moved by an act of some app over them, or by its authored `workflow` \u2014 the patch moves each open option to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an act `set`s \u2014 an option, a value, `now`, `me`, an input \u2014 or its workflow `writes` is the act\'s outcome: read-only everywhere else and never asked by an add (`create`); a required one takes a `default`. A field an act computes by a `formula` is a starting value, which a person may change after. |\n| `act.writes` | `writes` stands beside `workflow` and names stored fields of the acted row, each once, that no `set` of the act and no other act over the rows states. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status or a milestone; a bound a write rule holds the field to is checked on the computed value as the act runs. |\n| `act.of` | An act\'s `of` names a child the record lists in a rows or list block; it works on the one row pressed \u2014 or, `on: "rows"`, on the rows ticked together where the record lists it as tasks \u2014 never on the rows in view. |\n| `act.writes-line-key` | An act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.view` | An act over every row in view (`on: "view"`) writes (`set`), makes a document or runs a workflow, and states no `requires`. |\n| `act.requires-drawn` | Every field an act `requires` is drawn where the act stands \u2014 its section\'s fields, a block\'s, its asks, or an unstaged section\'s where its own is unstaged \u2014 never the header alone. |\n| `act.requires-written` | A field an act requires that only an act writes is written by an act offered together with it, or asked by the act itself. |\n| `act.recommends` | A field an act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `"now"` on a date, `"me"` on a member, `"input:<name>"` of an input the act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.set-milestone` | An act stamps a milestone, never clears one \u2014 unticking clears it and every later one. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.history-copy` | What a status move asks is copied onto the history\'s field of the same name, which holds the same kind of value. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field\'s, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. A `file` input is read by the act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an act over the record, the ticked rows or every row in view, in an app over one entity \u2014 never beside `books`, `set`, `template`, `templates`, `intake`, `record`, `sign`, `confirm` or `of`, and it asks inputs only, none named `approved`. Its workflow is that act\'s alone, run by no other act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n\n<!-- generated:end rules-act -->\n\nAn act whose `when` does not hold is not offered \u2014 each select named holding one of its\noptions, each yes/no named (stored, or a formula: a period that has ended) its `true` or\n`false`; every one that holds stands at the\nfoot of the section naming it in `acts` \u2014 a correction in that section heading\'s \u22EF, one\nof a child row on its row (a correction in the row\'s \u22EF). An act\'s `requires` are fields\nits section draws \u2014 its `fields`, a block\'s, the act\'s `asks`, or those of another section\nwith no `at` where its own has none; one shown only in the header or a staged section\nelsewhere is refused. One whose `requires` are\nempty is offered disabled, naming each; one whose `recommends` are empty names what\nit will leave blank and still presses; one a standing check blocks is offered\ndisabled in the check\'s words. The generated `act_<alias>` workflow re-checks all three on the\nserver, writes `set` and what was asked, and appends the status history where the\nact moves the status. A field an act asks is read-only everywhere else. A `select` input\noffers its own options and is written into a select holding the same option aliases; a `link` input picks one row of its `entity`\nand a `member` input one person, each written into a field of its kind. A field an act\nboth `requires` and `asks` never disables the press \u2014 the act asks it, required.\n\nA `file` input is one uploaded file, handed to the act\'s authored `workflow` as its file id (a sheet is read\nfrom it by `excel_get_rows` in a workflow); nothing else reads it, so `set` never writes it into a field, and it starts empty.\n\n`review: true`, beside an authored `workflow`, makes the workflow one that only proposes, and the platform the one\nthat writes. Its body calls only steps that read, and proposes the same for the same inputs and rows \u2014 one that writes,\nany agent, an app agent or a wait is refused where it is saved, applied and run \u2014 and returns in `data.review` a\nchangeset of the act\'s table: `{ "version": 1, "table_id", "creates": [{ "key", "data" }], "updates": [{ "record_id",\n"data" }] }`, `data` holding only the fields that change, by field key, as `update_records` takes them \u2014 no computed\nfield, no file \u2014 each row with an optional `note` and `ticked`, and `unplaced: [{ "title", "note"? }]` for what matched\nnothing. A create\'s `key` is the body\'s own text naming the same line on every run, unique among the creates; so a\nrepeated confirm adds no second row, the body also writes it into a `unique` field. A record is updated once; at most\n2000 rows. Anything else is refused with what is wrong, and nothing is written.\n\nA call without `approved` answers the proposal, a `sha` on each row, and writes nothing, whoever makes it. A call with\n`approved: { "updates": [{ "record_id", "sha" }], "creates": [{ "key", "sha" }] }` \u2014 the `sha` copied from the proposal \u2014\nruns the body again, and the platform writes the named rows of THAT call\'s proposal, with its values,\nnever the caller\'s, each only where it proposes what was read \u2014 an update only of a record the act ran on \u2014 through\nthe ordinary record writes, as steps of the run, every row checked first and all written in one transaction or none:\neach record\'s Activity shows it and, in a workflow, `undo_record_changes` with the run\'s id puts it back. A row no\nlonger proposed, proposed otherwise (`changed`), changing nothing, gone, locked or holding a unique value another row\nholds is left and named; the status each written row moved to, or a made row holds, is recorded in its history by the\nsame run. What is proposed stays the body\'s: match against what the rows hold now, so a row written is proposed no\nmore.\n\nThe dialog asks what the act asks, lists the proposal to tick as one table \u2014 what matched nothing first, then a column\nfor each field any row changes, its value now against proposed, a linked row or a member by name \u2014 and confirms the\nrows left ticked; a row changed since it was read is listed again. Over every row in view the act\nis handed no rows: its body reads the rows it may change, whatever the view, bound by no count of rows; it states no\n`when`, over an entity no row rule keeps to some readers. `review` is refused beside `books`, `set`, `template`,\n`templates`, `intake`, `record`, `sign`, `confirm`, `of`, an ask of a field, and an input named `approved`. A body:\n`lotics docs workflows`.\n\n`on: "view"` runs on every row the register shows \u2014 its search, status and filters \u2014\neach row checked before any is written. `of` names a rows block\'s child entity: the\nact is offered on each child row (its menu and its drawer), its `when`, `requires`,\n`set` and checks are the child\'s, it runs on that row, and a check of the record that\nlocks the child rows locks it too. With `on: "rows"` it runs on the child rows ticked\ntogether in the record\'s task list (\xA7 Tasks) \u2014 every row checked before any is written;\nit is refused where the record lists no tasks of that child.\n\nWhat an act makes, reads, records or has signed is set out under \xA7 Papers and recordings.\n\n## Papers and recordings\n\nBeside what it writes, an act makes papers from templates (`template`, `templates`), reads papers brought into the\nrecord (`intake`), records a call or a visit (`record`) and takes a signature on the device (`sign`).\n\n<!-- generated:start apps-papers -->\n\n#### Act template\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `template` | alias | yes | A document template the act makes a paper of, kept in `into` \u2014 an html one made a PDF, an excel one a workbook |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | no | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `into` | alias | yes | A child the record lists in a timeline or rows block, linking back to it by a single link: each recording is filed as a new row of it |\n| `audio` | alias | yes | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias | yes | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | no | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | no | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | no | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `into` | alias | yes | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias | yes | Who signed: a text field the signer types their name into (someone with no seat in the workspace \u2014 a driver, the owner\'s supervisor), or a member field set to the person pressing, who signs as themselves |\n| `at` | alias | yes | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | no | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.into` | `into` is a files field of the one record the act is pressed on, beside its `template` or `templates`. |\n| `act.files-written` | An act\'s `writes` never names a files field of the record: a file an act makes is a paper \u2014 the record states its papers (an `expect` block over a child pictured by its files field) and the act names its slot with `paper`. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template`, `asks`, `of` or an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a rows block that expects its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the act runs on one record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them. |\n| `act.record` | `record` names a child the record draws in a timeline or a rows block with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a rows block with no `expect`, `under` or `where`, filled in the fields that block adds \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a milestone, a field an act writes or a link `same` narrows; a link\'s row is one the app reads of its entity. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. |\n| `act.sign` | `sign` runs on one record, never a child\'s row: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the act does not also ask, set or `writes`, and no other act signs into `into`. |\n\n<!-- generated:end apps-papers -->\n\n`template` makes a document from the row as the act left it and\nkeeps it in `into`; over several rows it makes one document of them all, the rows\nlisted under the entity\'s alias, and hands it back. `templates` instead names a set of\npapers kept in `into`, listed where the act stands \u2014 each made one as its file, each\nnot made yet as a placeholder \u2014 those whose `when` holds ticked to start; the press\nmakes the ticked ones (sent in `templates`), each replacing the file its template made\nbefore (the file whose `document_template_id` is that template \u2014 never a file a person\nput there), and the set downloads as one archive (`archive_<alias>`).\n\n`intake` reads papers: the press takes files, an agent (`act_<alias>` among the app\'s\nagents) reads them, and each is filed as the record\'s line of its kind in the named\nchild \u2014 that child\'s title \u2014 or a new line, its file in the child\'s one files field.\nWhat they state of each field `fills` names is shown beside what the row holds; the save\nwrites only what differs \u2014 the record\'s fields, `<link>.<field>` on the row a required\none-row link names, a child\'s rows (one found by the child\'s `natural_key` changed, else\nadded) \u2014 each refused as its own save is, and nothing written while one refuses. A single\nlink among them is filled with a row the agent finds through the app\'s read of the rows\nit may name \u2014 narrowed as its picker is \u2014 and an id naming no row of its entity is refused\nbefore the run ends; a link `same` narrows is not filled.\n\n```jsonc\n{ "alias": "read_papers", "label": "Read papers", "intake": "customer_paper", "fills": ["phone", "contact.email", "branch"] }\n```\n\n`sign` takes a signature on the device in front of the signer: the press opens a pad in a\nsheet with what the act asks \u2014 the signer\'s name, where `by` is a text field they type it\ninto \u2014 and the act keeps the picture in `into` in place of any before it, `at` stamped with\nthe server\'s time and the person pressing in `witness` (a member `by` is the person\npressing, signing as themselves). The record reads `into` as one signature \u2014 the stroke,\nwho signed, as what, when and before whom \u2014 and the act\'s paper is handed the picture under\n`into`\'s name, an html template printing it by its url (`{{#each signature}}<img src="{{url}}">{{/each}}`).\n\n```jsonc\n{ "alias": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir",\n "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Checks\n\n```jsonc\n"checks": [{ "field": "release_warning" }, { "field": "unpaid", "blocks": ["gate_out"] }, { "field": "locked", "blocks": ["edit"] }]\n```\n\n<!-- generated:start apps-checks -->\n\n#### Check\n\n| Key | Type | Required | Meaning |\n|---|---|---|---|\n| `field` | alias | yes | A yes/no or text formula of the record (or of the child `of` names): true or non-empty means the check stands; its label is its short name on a row\'s line, and a text formula\'s words are the sentence the record and a tooltip say |\n| `of` | alias | no | A rows block\'s child entity this check is a formula of: standing on a child row, it refuses what it blocks of that row |\n| `blocks` | `"all"` \\| list of (alias \\| `"edit"` \\| `"delete"`) (at least one) | no | Acts, "edit" (the saves and the Delete), "delete" (the Delete alone) or "all" that the standing check refuses; absent, it only warns |\n| `resolve` | alias | no | An act of this app, on the rows the check stands on, that clears it: the check\'s line links to the act where it stands, and the act keeps its own conditions |\n\n<!-- generated:end apps-checks -->\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A check\'s `field` is a yes/no or text formula of the record, or of the child `of` names. |\n| `check.of` | A check\'s `of` names a child the record lists in a rows block. |\n| `check.not-placed` | A check\'s field is never also placed on the record \u2014 the line under the header says it. |\n| `check.blocks` | A check of the record blocks its acts, `"edit"`, `"delete"` or `"all"`; a check of a child blocks that row\'s saves, its Delete, the acts `of` that child, or all \u2014 never the record\'s acts. |\n| `check.resolve` | `resolve` names an act of this app on the rows the check stands on, pressed on one row, not refused by the check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\nA check is a yes/no or text formula of the record: it stands while true or\nnon-empty, and a text formula\'s words are what the reader sees. Without `blocks`\nit warns; with them it refuses the acts named, `"edit"` the record\'s own saves (and\nits Delete), `"delete"` its Delete alone, or `"all"` \u2014 on the server, in every write it\nnames. A check `of` a rows block\'s child stands on each child row: it refuses that\nrow\'s saves (`edit`), its Delete (`delete`), the acts `of` that child it names, or\n`all` of them \u2014 never the record\'s acts. A warning reading the figure of a meter that\n`gates` marks against its bound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s\nline says it in the check\'s tone (the most severe of several, and how many more), while\nits words whole are the row\'s tooltip and stand under the record\'s header. So label it\nas the reader names the problem, in a few words, and let a text formula say the\nsentence. The compiler records the fields a formula reads: a row drawing each of them\nas a control says nothing of the check on its line (the empty control says it), and a\ncheck with no `resolve` links to the first of them the record draws.\n\n## What a run remembers\n\nThe WORKSPACE remembers what each entity, field, select option, role and\ntemplate alias became here, plus which record each first row landed on and the\nfile each document path was uploaded as. The model file itself holds no live id\n\u2014 it is the portable half, and the same file applies to a demo workspace and to\na customer\'s \u2014 so the join lives where the things it names live, and one model\napplied to two workspaces holds two bindings that know nothing of each other.\n\nIt is the workspace\'s and not the file\'s because a model file is never\ncommitted: memory kept beside it is one author\'s disk, absent for a teammate, on\na second machine or after a delete \u2014 and every one of those goes quietly back to\nbinding by label, which is what grows the second table.\n\nEvery later apply binds through it: it takes the remembered id first and falls\nback to a label only for an alias nothing has bound \u2014 a field you have just\nadded, or a workspace nothing has applied this model to. That is what makes a\nrelabel on EITHER side a rename rather than one thing the workspace lacks and\none the model lacks: `apply` binds the thing it has always meant, gives a field\nor a select\'s option the label the file states, and reports the move of a table,\na template or a role \u2014 which side is right there is yours to decide, not a reason\nto refuse the run.\n\nA bound target the workspace no longer holds IS a refusal, by name: re-binding\nto whatever carries that label today is how the model comes to point at\nsomebody else\'s table. On the CLI, `lotics run restore_table` puts a deleted table back.\n\n`lotics model pull` writes a workspace that already works as a model file \u2014 the\nstarting point for another business\'s model, never a source of truth: it carries\none business\'s words and stops describing that workspace the moment either\nchanges.\n\n## A complete model\n\n```json\n{\n "entities": [\n {\n "alias": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": [\n { "alias": "name", "label": "Name", "type": "text", "required": true },\n { "alias": "logo", "label": "Logo", "type": "files" },\n {\n "alias": "tier",\n "label": "Tier",\n "type": "select",\n "options": [\n { "alias": "standard", "label": "Standard", "color": "slate" },\n { "alias": "gold", "label": "Gold", "color": "amber" }\n ],\n "default": ["standard"]\n },\n {\n "alias": "orders",\n "label": "Orders",\n "type": "select_record_link",\n "target_entity": "order",\n "cardinality": "many",\n "sync_both_ways": true,\n "paired_field_alias": "customer"\n },\n {\n "alias": "total_ordered",\n "label": "Total ordered",\n "type": "rollup",\n "source_field_alias": "orders",\n "aggregate_option": { "operation": "sum", "field_key": "amount" }\n }\n ],\n "views": [\n {\n "alias": "gold",\n "label": "Gold customers",\n "filters": {\n "node_type": "condition",\n "type": "select",\n "field_key": "tier",\n "operator": "has_any_of",\n "value": ["gold"]\n },\n "sort": [{ "field_key": "name", "order": "asc" }]\n }\n ]\n },\n {\n "alias": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": [\n { "alias": "code", "label": "Order no.", "type": "text", "unique": true },\n { "alias": "placed_on", "label": "Placed on", "type": "date", "format": "date" },\n {\n "alias": "amount",\n "label": "Amount",\n "type": "number",\n "notation": { "style": "currency", "currency": "VND" }\n },\n {\n "alias": "total",\n "label": "Total with VAT",\n "type": "formula",\n "formula": { "expression": "{amount} * 1.1", "notation": { "style": "currency", "currency": "VND" } }\n },\n {\n "alias": "customer",\n "label": "Customer",\n "type": "select_record_link",\n "target_entity": "customer",\n "cardinality": "one",\n "sync_both_ways": true,\n "paired_field_alias": "orders"\n },\n { "alias": "note", "label": "Note", "type": "text" }\n ]\n }\n ],\n "roles": [{ "alias": "sales", "label": "Sales" }],\n "records": {\n "customer": { "title": "name", "image": "logo", "party": "organization", "figure": "total_ordered" },\n "order": { "title": "customer", "subtitle": ["code", "placed_on"], "figure": "amount", "starts": { "placed_on": "today" } }\n },\n "apps": [\n {\n "alias": "customers",\n "name": "Customers",\n "theme": { "color": "blue" },\n "entity": "customer",\n "register": {\n "columns": ["tier"],\n "readings": [{ "breakdown": "customer", "by": "tier", "value": "total_ordered" }]\n },\n "record": {\n "sections": [\n { "title": "Account", "fields": ["tier"] },\n { "title": "Orders", "blocks": [{ "rows": "order", "columns": ["total"], "create": ["code", "amount"] }] }\n ]\n }\n },\n {\n "alias": "orders",\n "name": "Orders",\n "theme": { "color": "violet" },\n "entity": "order",\n "register": {\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "readings": [{ "trend": "order", "over": "placed_on", "value": "amount" }]\n },\n "record": { "door": "drawer", "sections": [{ "title": "Order", "fields": ["note"] }] }\n }\n ],\n "rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } },\n { "ref": "bluebird", "fields": { "name": "Bluebird Foods", "tier": "standard" } }\n ],\n "order": [\n {\n "ref": "so_1001",\n "fields": {\n "code": "SO-1001",\n "placed_on": "@month-start+2",\n "amount": 4200000,\n "customer": "customer:acme"\n }\n },\n {\n "ref": "so_1002",\n "fields": {\n "code": "SO-1002",\n "placed_on": "@today-3",\n "amount": 1150000,\n "customer": "customer:bluebird"\n }\n }\n ]\n }\n}\n```\n\nEach app of this file, as its reader will see it:\n\n```\nApp customers \u2014 "Customers" over Customers (customer)\n Register \u2014 table (default), newest first (default)\n row [Logo] \xB7 Name \xB7 figure Total ordered\n columns Tier\n filters \u2014\n readings "Tier" \u2014 Total ordered summed per Tier, over the rows in view (default)\n add Name (default)\n Record \u2014 a drawer (default)\n header image Logo \xB7 title Name \xB7 figure Total ordered\n checks \u2014\n header \u22EF Delete\n sections 1. "Account"\n fields Tier\n 2. "Orders"\n block Orders (default) \u2014 rows of Orders through Customer; columns Total with VAT; add asks Order no., Amount\n thread \u2014\n history \u2014\n acts \u2014\n Reads Customers, Orders\n\nApp orders \u2014 "Orders" over Orders (order)\n Register \u2014 table (default), newest first (default)\n row Customer \xB7 under it Order no., Placed on \xB7 figure Amount\n columns \u2014\n filters Customer\n readings "Amount" \u2014 Amount summed per period by Placed on, over the rows in view (default)\n add Order no., Customer, Placed on \u2014 starting Placed on at today\n Record \u2014 a drawer\n header title Customer \xB7 subtitle Order no., Placed on \xB7 figure Amount\n checks \u2014\n header \u22EF Delete\n sections 1. "Order"\n fields Note\n thread \u2014\n history \u2014\n acts \u2014\n Reads Orders, Customers\n\n```\n\nEach `(default)` is a value the model left to the system: the door a record opens\nthrough \u2014 a drawer, since neither record has a stage or more than three sections \u2014 the\norder rows open in, and what an add asks. The order\'s one section holds every field a\nperson writes that the header does not already show. The customer\'s orders\nare a block in its "Orders" section, never its own `Orders` link as a field as well:\none fact, one place. An order is titled by its customer and read by its number under\nit; the block names what its add asks, since a subtitle or a figure is never asked by\ndefault. `Total ordered` is a rollup, so it is read and never asked; the\norders app\'s record opens in a drawer, because its rows are worked one after another.\n';
|
|
46665
46877
|
|
|
46666
46878
|
// docs/examples.md
|
|
46667
46879
|
var examples_default = '# Worked examples\n\nEach section is one treatment, cut from a complete model of an invented business: the job, the keys to\nread, where the treatment is wrong, and the excerpt \u2014 an app the check passes with no finding, as stated;\nthe `records` of every entity it draws; those entities\' fields it names, by what each holds and how it is\ndrawn; and the templates it makes. Left out: labels, descriptions, `required`, `unique`, `default`, a link\'s\npairing, how a computed field computes, and template contents. Choosing among them: the `design` reference.\nEvery key: the `model` reference, at the pages each section names under **Keys**.\n\n## Calendar\n\n**The job.** Book visits on the days they happen, and see a week\'s work at a glance.\n\n**Read.** `register.layout: "calendar"`; each visit stands over its span because its `records` line holds two dates (`scheduled_for`, `ends_at`).\n\n**Keys.** `model/calendar`\n\n**Not when.** Rows booked on a resource that two may not share at once \u2014 that is `lanes`. Rows with a date nobody plans by (an invoice\'s date) stay a table.\n\n```json\n{\n "entities": [\n {\n "alias": "service_visit",\n "fields": [\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "scheduled_for", "type": "date", "format": "datetime"},\n {"alias": "ends_at", "type": "date", "format": "datetime"},\n {"alias": "engineer", "type": "select_record_link", "target_entity": "engineer", "cardinality": "one"},\n {\n "alias": "job",\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n {"alias": "booked_on", "type": "date"},\n {"alias": "parts_ready_on", "type": "date"},\n {"alias": "arrived_on", "type": "date"},\n {"alias": "hours", "type": "number", "notation": {"style": "unit", "unit": "h"}},\n {"alias": "report", "type": "text", "format": "markdown"},\n {"alias": "completed_on", "type": "date"}\n ]\n }\n ],\n "records": {\n "service_visit": {\n "title": "customer",\n "subtitle": ["scheduled_for", "ends_at"],\n "status": {\n "milestones": ["booked_on", {"field": "parts_ready_on", "when": {"job": ["repair"]}}, "arrived_on", "completed_on"],\n "closed": ["completed_on"]\n },\n "figure": "hours",\n "due": ["scheduled_for"]\n }\n },\n "apps": [\n {\n "alias": "visits",\n "name": "Service visits",\n "icon": "calendar",\n "theme": {"color": "emerald"},\n "entity": "service_visit",\n "register": {\n "columns": ["engineer", "job"],\n "filters": ["customer"],\n "sort": {"field": "scheduled_for"},\n "layout": "calendar",\n "create": ["customer", "job", "scheduled_for", "ends_at", "engineer"],\n "readings": [\n {"metric": "service_visit", "where": {"job": ["repair"]}, "label": "Repairs"},\n {"breakdown": "service_visit", "by": "engineer", "value": "hours"}\n ]\n },\n "record": {\n "sections": [\n {"title": "Visit", "at": ["booked_on", "parts_ready_on"], "fields": ["job"], "acts": ["reschedule"]},\n {"title": "Report", "at": ["arrived_on"], "fields": ["engineer", "report"], "acts": ["complete"]}\n ]\n },\n "acts": [\n {\n "alias": "complete",\n "label": "Complete visit",\n "requires": ["engineer"],\n "asks": ["hours", {"input": "summary", "label": "What was done", "type": "long_text", "required": true}],\n "set": {"report": "input:summary", "completed_on": "now"}\n },\n {"alias": "reschedule", "label": "Reschedule", "asks": ["scheduled_for", "ends_at"]}\n ]\n }\n ]\n}\n```\n\n## Lanes\n\n**The job.** Put each service visit on an engineer\'s day by the hour, and see at once who is free between visits.\n\n**Read.** `register.layout: "lanes"` with `lanes` naming the one-row link to the resource (the engineer); every engineer stands as a lane, empty or not.\n\n**Keys.** `model/lanes`\n\n**Not when.** The resource is not a row of the model (a free-text room name), or rows never compete for one \u2014 a `calendar` reads them by day.\n\n```json\n{\n "entities": [\n {\n "alias": "service_visit",\n "fields": [\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "scheduled_for", "type": "date", "format": "datetime"},\n {"alias": "ends_at", "type": "date", "format": "datetime"},\n {"alias": "engineer", "type": "select_record_link", "target_entity": "engineer", "cardinality": "one"},\n {\n "alias": "job",\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n {"alias": "booked_on", "type": "date"},\n {"alias": "parts_ready_on", "type": "date"},\n {"alias": "arrived_on", "type": "date"},\n {"alias": "hours", "type": "number", "notation": {"style": "unit", "unit": "h"}},\n {"alias": "completed_on", "type": "date"}\n ]\n },\n {\n "alias": "engineer",\n "fields": [\n {"alias": "name", "type": "text"},\n {"alias": "base", "type": "select_record_link", "target_entity": "warehouse", "cardinality": "one"}\n ]\n }\n ],\n "records": {\n "service_visit": {\n "title": "customer",\n "subtitle": ["scheduled_for", "ends_at"],\n "status": {\n "milestones": ["booked_on", {"field": "parts_ready_on", "when": {"job": ["repair"]}}, "arrived_on", "completed_on"],\n "closed": ["completed_on"]\n },\n "figure": "hours",\n "due": ["scheduled_for"]\n },\n "engineer": {"title": "name", "subtitle": ["base"], "party": "person"}\n },\n "apps": [\n {\n "alias": "dispatch",\n "name": "Dispatch",\n "icon": "wrench",\n "theme": {"color": "sky"},\n "entity": "service_visit",\n "register": {\n "columns": ["job"],\n "search": ["customer"],\n "layout": "lanes",\n "lanes": "engineer",\n "create": ["customer", "job"]\n },\n "record": {"door": "drawer", "sections": [{"title": "Booking", "fields": ["engineer", "job"]}]}\n }\n ]\n}\n```\n\n## Gantt\n\n**The job.** Read every hire as a bar from the day the machine goes out to the day it is due back, against today.\n\n**Read.** `register.layout: "gantt"` and `register.gantt.start`; with no end stated, the bar ends at the entity\'s first `due`.\n\n**Keys.** `model/gantt`\n\n**Not when.** Rows that last a day or less (a visit, a shift) \u2014 `calendar` or `lanes`; a plan with no dates set yet.\n\n```json\n{\n "entities": [\n {\n "alias": "phieu_thue",\n "fields": [\n {\n "alias": "khach_hang",\n "type": "select_record_link",\n "target_entity": "khach_hang",\n "cardinality": "one"\n },\n {"alias": "so_phieu", "type": "text"},\n {\n "alias": "trang_thai",\n "type": "select",\n "options": [\n {"alias": "moi", "color": "slate"},\n {"alias": "dang_thue", "color": "blue"},\n {"alias": "da_tra", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n {"alias": "phu_trach", "type": "select_member"},\n {"alias": "ngay_giao", "type": "date"},\n {"alias": "han_tra", "type": "date"},\n {"alias": "ngay_tra", "type": "date"},\n {\n "alias": "tinh_trang_tra",\n "type": "select",\n "options": [\n {"alias": "tot", "color": "green"},\n {"alias": "tray_xuoc", "color": "amber"},\n {"alias": "hu_hong", "color": "red"}\n ]\n },\n {"alias": "so_ngay", "type": "formula"},\n {"alias": "tong_tien", "type": "rollup"}\n ]\n }\n ],\n "records": {\n "phieu_thue": {\n "title": "khach_hang",\n "subtitle": ["so_phieu"],\n "status": {"field": "trang_thai", "closed": ["da_tra", "huy"], "history": "lich_su_phieu"},\n "figure": "tong_tien",\n "due": ["han_tra"]\n }\n },\n "apps": [\n {\n "alias": "tien_do_thue",\n "name": "Ti\u1EBFn \u0111\u1ED9 cho thu\xEA",\n "icon": "calendar-range",\n "theme": {"color": "teal"},\n "entity": "phieu_thue",\n "register": {\n "columns": ["phu_trach"],\n "filters": ["phu_trach", "khach_hang"],\n "layout": "gantt",\n "gantt": {"start": "ngay_giao"},\n "remove": false,\n "create": false,\n "readings": [\n {"metric": "phieu_thue", "where": {"trang_thai": ["dang_thue"]}, "label": "Phi\u1EBFu \u0111ang cho thu\xEA"},\n {\n "metric": "phieu_thue",\n "value": "tong_tien",\n "where": {"trang_thai": ["dang_thue"]},\n "label": "Ti\u1EC1n thu\xEA \u0111ang ch\u1EA1y"\n }\n ]\n },\n "record": {\n "sections": [\n {"title": "Phi\u1EBFu thu\xEA", "fields": ["ngay_giao", "han_tra"]},\n {"title": "\u0110ang thu\xEA", "at": ["dang_thue"], "fields": ["so_ngay", "ngay_tra"], "acts": ["nhan_tra"]}\n ]\n },\n "acts": [\n {\n "alias": "nhan_tra",\n "label": "Nh\u1EADn m\xE1y tr\u1EA3",\n "when": {"trang_thai": ["dang_thue"]},\n "asks": ["tinh_trang_tra"],\n "set": {"trang_thai": "da_tra", "ngay_tra": "now"},\n "confirm": true\n }\n ]\n }\n ]\n}\n```\n\n## Roster\n\n**The job.** See who works which shift on each day of the week or the month.\n\n**Read.** `register.layout: "roster"` over the people; `register.roster` names the child whose rows fill the days \u2014 one link back and a date on its line.\n\n**Keys.** `model/roster`\n\n**Not when.** Rows that are themselves the bookings (a stay over several days) \u2014 a `calendar` or `lanes` draws them; a roster\'s row is what the days are filled for.\n\n```json\n{\n "entities": [\n {\n "alias": "nha_si",\n "fields": [\n {"alias": "ho_ten", "type": "text"},\n {\n "alias": "chuyen_mon",\n "type": "select",\n "options": [\n {"alias": "tong_quat", "color": "blue"},\n {"alias": "chinh_nha", "color": "purple"},\n {"alias": "nha_chu", "color": "green"},\n {"alias": "phuc_hinh", "color": "orange"}\n ]\n },\n {"alias": "dien_thoai", "type": "text"}\n ]\n },\n {\n "alias": "lich_truc",\n "fields": [\n {"alias": "nha_si", "type": "select_record_link", "target_entity": "nha_si", "cardinality": "one"},\n {\n "alias": "ca",\n "type": "select",\n "options": [\n {"alias": "sang", "color": "blue"},\n {"alias": "chieu", "color": "purple"},\n {"alias": "ca_ngay", "color": "green"},\n {"alias": "nghi", "color": "gray"}\n ]\n },\n {"alias": "ngay", "type": "date"},\n {"alias": "ghe", "type": "select_record_link", "target_entity": "ghe", "cardinality": "one"}\n ]\n }\n ],\n "records": {\n "nha_si": {"title": "ho_ten", "subtitle": ["chuyen_mon"], "party": "person"},\n "lich_truc": {"title": "ca", "subtitle": ["ngay", "ghe"]}\n },\n "apps": [\n {\n "alias": "lich_truc",\n "name": "L\u1ECBch tr\u1EF1c",\n "icon": "users",\n "theme": {"color": "indigo"},\n "entity": "nha_si",\n "register": {\n "filters": ["chuyen_mon"],\n "layout": "roster",\n "roster": "lich_truc",\n "create": ["ho_ten", "chuyen_mon", "dien_thoai"]\n }\n }\n ]\n}\n```\n\n## Cards\n\n**The job.** Find an item by its picture, and count what the shelf holds.\n\n**Read.** `register.layout: "cards"` over rows whose `records.image` is a photo; `scope` keeps the app inside one warehouse at a time.\n\n**Keys.** `model/cards`, `model/records`, `model/apps`\n\n**Not when.** Rows with no picture \u2014 cards of words are a table drawn worse.\n\n```json\n{\n "entities": [\n {\n "alias": "stock_item",\n "fields": [\n {"alias": "name", "type": "text"},\n {\n "alias": "warehouse",\n "type": "select_record_link",\n "target_entity": "warehouse",\n "cardinality": "one"\n },\n {"alias": "photo", "type": "files"},\n {"alias": "sku", "type": "text"},\n {\n "alias": "category",\n "type": "select",\n "options": [\n {"alias": "pumps", "color": "blue"},\n {"alias": "valves", "color": "teal"},\n {"alias": "seals", "color": "amber"},\n {"alias": "motors", "color": "violet"}\n ]\n },\n {"alias": "on_hand", "type": "number"},\n {"alias": "minimum", "type": "number"},\n {"alias": "price", "type": "number", "notation": {"style": "currency", "currency": "USD"}},\n {"alias": "supplier_page", "type": "text", "format": "link"},\n {"alias": "last_counted", "type": "date"},\n {"alias": "counted_by", "type": "select_member"},\n {"alias": "count_note", "type": "text"}\n ]\n },\n {\n "alias": "order_line",\n "fields": [\n {"alias": "item", "type": "select_record_link", "target_entity": "stock_item", "cardinality": "one"},\n {"alias": "order", "type": "select_record_link", "target_entity": "order", "cardinality": "one"},\n {"alias": "quantity", "type": "number"},\n {"alias": "shipped", "type": "number"},\n {"alias": "picked", "type": "number"},\n {"alias": "unit_price", "type": "number", "notation": {"style": "currency", "currency": "USD"}},\n {"alias": "amount", "type": "formula"},\n {"alias": "category", "type": "lookup"}\n ]\n }\n ],\n "records": {\n "stock_item": {\n "title": "name",\n "subtitle": ["sku", "category"],\n "image": "photo",\n "figure": "on_hand",\n "limits": {"on_hand": 400},\n "gates": {"on_hand": "minimum"}\n },\n "order_line": {\n "title": "item",\n "subtitle": ["order", "unit_price"],\n "figure": "amount",\n "limits": {"shipped": "quantity", "picked": "quantity"}\n }\n },\n "apps": [\n {\n "alias": "stock",\n "name": "Stock",\n "icon": "boxes",\n "theme": {"color": "teal"},\n "entity": "stock_item",\n "scope": "warehouse",\n "register": {\n "columns": ["price"],\n "filters": ["on_hand"],\n "search": ["name", "sku"],\n "layout": "cards",\n "create": false,\n "export": true,\n "readings": [{"breakdown": "stock_item", "by": "category", "value": "on_hand"}]\n },\n "record": {\n "sections": [\n {"title": "Item", "fields": ["price", "minimum", "supplier_page"]},\n {"title": "Last count", "fields": ["last_counted", "counted_by", "count_note"], "acts": ["count"]},\n {"title": "On order", "blocks": [{"rows": "order_line", "columns": ["quantity"]}]}\n ]\n },\n "acts": [\n {\n "alias": "count",\n "label": "Count stock",\n "asks": [\n {"input": "counted", "label": "Units on the shelf", "type": "number", "required": true},\n {"input": "remark", "label": "Remark", "type": "long_text"}\n ],\n "set": {\n "on_hand": "input:counted",\n "last_counted": "now",\n "counted_by": "me",\n "count_note": "input:remark"\n }\n }\n ]\n }\n ]\n}\n```\n\n## Party\n\n**The job.** Keep each customer account \u2014 who they are, what they ordered, what was said to them.\n\n**Read.** `records.customer.party: "organization"` and its `image` (the logo); a `timeline` of touches, a `trend` of its orders, and its papers `expect`ed by kind.\n\n**Keys.** `model/records`, `model/timeline-and-agenda`, `model/blocks`, `model/reading-blocks`\n\n**Not when.** A list of customers is not a job by itself: the customer is a link on the desk whose rows name it, unless the job is the account itself.\n\n```json\n{\n "entities": [\n {\n "alias": "customer",\n "fields": [\n {"alias": "name", "type": "text"},\n {"alias": "logo", "type": "files"},\n {"alias": "code", "type": "text"},\n {\n "alias": "tier",\n "type": "select",\n "options": [\n {"alias": "key", "color": "violet"},\n {"alias": "standard", "color": "sky"},\n {"alias": "lapsed", "color": "gray"}\n ]\n },\n {"alias": "phone", "type": "text"},\n {"alias": "website", "type": "text", "format": "link"},\n {"alias": "account_manager", "type": "select_member"},\n {"alias": "credit_limit", "type": "number", "notation": {"style": "currency", "currency": "USD"}},\n {"alias": "outstanding", "type": "rollup"},\n {"alias": "over_limit", "type": "formula"},\n {\n "alias": "papers_needed",\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ],\n "multi": true\n },\n {"alias": "notes", "type": "text", "format": "markdown"}\n ]\n },\n {\n "alias": "order",\n "fields": [\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "reference", "type": "text"},\n {\n "alias": "stage",\n "type": "select",\n "options": [\n {"alias": "draft", "color": "slate"},\n {"alias": "confirmed", "color": "blue"},\n {"alias": "picking", "color": "amber"},\n {"alias": "shipped", "color": "indigo"},\n {"alias": "delivered", "color": "green"},\n {"alias": "cancelled", "color": "rose"}\n ]\n },\n {"alias": "placed", "type": "date"},\n {"alias": "due_date", "type": "date"},\n {"alias": "total", "type": "rollup"},\n {"alias": "balance", "type": "formula"},\n {"alias": "units_ordered", "type": "rollup"},\n {"alias": "units_shipped", "type": "rollup"},\n {"alias": "units_picked", "type": "rollup"},\n {"alias": "notes", "type": "text", "format": "markdown"},\n {"alias": "paid_in_full", "type": "formula"}\n ]\n },\n {\n "alias": "customer_paper",\n "fields": [\n {\n "alias": "kind",\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ]\n },\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "received_on", "type": "date"},\n {"alias": "file", "type": "files"}\n ]\n },\n {\n "alias": "touch",\n "fields": [\n {"alias": "said", "type": "text"},\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "by", "type": "select_member"}\n ]\n },\n {\n "alias": "service_visit",\n "fields": [\n {"alias": "customer", "type": "select_record_link", "target_entity": "customer", "cardinality": "one"},\n {"alias": "scheduled_for", "type": "date", "format": "datetime"},\n {"alias": "ends_at", "type": "date", "format": "datetime"},\n {"alias": "engineer", "type": "select_record_link", "target_entity": "engineer", "cardinality": "one"},\n {\n "alias": "job",\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n {"alias": "booked_on", "type": "date"},\n {"alias": "parts_ready_on", "type": "date"},\n {"alias": "arrived_on", "type": "date"},\n {"alias": "hours", "type": "number", "notation": {"style": "unit", "unit": "h"}},\n {"alias": "report", "type": "text", "format": "markdown"},\n {"alias": "completed_on", "type": "date"}\n ]\n }\n ],\n "records": {\n "customer": {\n "title": "name",\n "subtitle": ["tier"],\n "image": "logo",\n "party": "organization",\n "figure": "outstanding",\n "limits": {"outstanding": "credit_limit"}\n },\n "order": {\n "title": "reference",\n "subtitle": ["customer", "placed"],\n "status": {"field": "stage", "closed": ["delivered", "cancelled"], "history": "order_stage"},\n "figure": "total",\n "limits": {"units_shipped": "units_ordered", "units_picked": "units_ordered"},\n "due": ["due_date"]\n },\n "customer_paper": {"title": "kind", "image": "file"},\n "touch": {"title": "said"},\n "service_visit": {\n "title": "customer",\n "subtitle": ["scheduled_for", "ends_at"],\n "status": {\n "milestones": ["booked_on", {"field": "parts_ready_on", "when": {"job": ["repair"]}}, "arrived_on", "completed_on"],\n "closed": ["completed_on"]\n },\n "figure": "hours",\n "due": ["scheduled_for"]\n }\n },\n "apps": [\n {\n "alias": "customers",\n "name": "Customers",\n "icon": "users",\n "theme": {"color": "violet"},\n "entity": "customer",\n "reads": "shared",\n "register": {\n "columns": ["phone", "account_manager"],\n "filters": ["account_manager"],\n "sort": {"field": "name"},\n "opens": {"tier": ["key", "standard"]},\n "create": ["name", "code", "credit_limit"],\n "readings": [\n {"breakdown": "customer", "by": "tier", "value": "outstanding"},\n {"breakdown": "customer", "by": "account_manager", "value": "outstanding"}\n ]\n },\n "record": {\n "door": "drawer",\n "sections": [\n {"title": "Contact", "fields": ["phone", "website"]},\n {\n "title": "Account",\n "fields": ["code", "account_manager", "credit_limit"],\n "acts": ["reassign", "lapse", "reinstate"]\n },\n {\n "title": "Orders",\n "blocks": [\n {\n "trend": "order",\n "over": "placed",\n "value": "total",\n "where": {"stage": ["confirmed", "picking", "shipped", "delivered"]},\n "label": "Order value"\n },\n {\n "rows": "order",\n "via": "customer",\n "title": "Open orders",\n "columns": ["due_date"],\n "create": false,\n "where": {"stage": ["draft", "confirmed", "picking", "shipped"]}\n },\n {\n "rows": "order",\n "via": "customer",\n "title": "Shipped, still owed",\n "columns": ["balance"],\n "create": false,\n "where": {"stage": ["shipped", "delivered"], "paid_in_full": false}\n },\n {\n "list": "service_visit",\n "columns": ["engineer", "job"],\n "app": "visits",\n "fields": ["report", "arrived_on", "completed_on"],\n "label": "Service visits"\n }\n ]\n },\n {\n "title": "Account papers",\n "blocks": [\n {\n "rows": "customer_paper",\n "via": "customer",\n "columns": ["received_on"],\n "expect": "kind",\n "of": "papers_needed"\n }\n ]\n },\n {"title": "Contact log", "blocks": [{"timeline": "touch", "via": "customer"}]},\n {"title": "Notes", "blocks": [{"text": "notes"}]}\n ]\n },\n "acts": [\n {\n "alias": "lapse",\n "label": "Mark lapsed",\n "when": {"tier": ["key", "standard"]},\n "set": {"tier": "lapsed"},\n "confirm": true\n },\n {\n "alias": "reinstate",\n "label": "Reinstate",\n "when": {"tier": ["lapsed"]},\n "asks": [\n {\n "input": "back_to",\n "label": "Back to",\n "type": "select",\n "options": [\n {"alias": "key", "label": "Key account", "color": "violet"},\n {"alias": "standard", "label": "Standard", "color": "sky"}\n ],\n "required": true\n }\n ],\n "set": {"tier": "input:back_to"}\n },\n {\n "alias": "reassign",\n "label": "Reassign",\n "asks": [{"input": "to", "label": "Account manager", "type": "member", "required": true}],\n "set": {"account_manager": "input:to"}\n },\n {\n "alias": "clear_visit_hours",\n "label": "Clear hours",\n "of": "service_visit",\n "set": {"hours": null},\n "confirm": true\n }\n ],\n "checks": [{"field": "over_limit"}]\n }\n ]\n}\n```\n\n## Case\n\n**The job.** Gather an applicant\'s papers into one case, make the forms it needs, and file it on time.\n\n**Read.** `expect` blocks for the papers brought (one line per kind, the missing ones empty), an act\'s `templates` for the forms made (ticked and made at once, kept in `into`), and `intake` reading the papers brought.\n\n**Keys.** `model/blocks`, `model/papers-and-recordings`\n\n**Not when.** A record that needs no papers, or one paper made once \u2014 a single `template` act.\n\n```json\n{\n "entities": [\n {\n "alias": "ho_so",\n "fields": [\n {\n "alias": "khach_hang",\n "type": "select_record_link",\n "target_entity": "khach_hang",\n "cardinality": "one"\n },\n {"alias": "du_an", "type": "select_record_link", "target_entity": "du_an", "cardinality": "one"},\n {"alias": "ma_ho_so", "type": "autonumber"},\n {\n "alias": "dich_vu",\n "type": "select",\n "options": [{"alias": "tron_goi", "color": "blue"}, {"alias": "lam_ho_so", "color": "violet"}]\n },\n {\n "alias": "doi_tuong",\n "type": "select",\n "options": [\n {"alias": "thu_nhap_thap", "color": "sky"},\n {"alias": "cong_nhan", "color": "teal"},\n {"alias": "can_bo", "color": "indigo"},\n {"alias": "luc_luong", "color": "green"},\n {"alias": "ho_ngheo", "color": "amber"},\n {"alias": "nguoi_co_cong", "color": "rose"}\n ]\n },\n {\n "alias": "tinh_trang_nha_o",\n "type": "select",\n "options": [{"alias": "chua_co_nha", "color": "gray"}, {"alias": "nha_chat", "color": "orange"}]\n },\n {"alias": "giay_chung_nhan_so", "type": "text"},\n {"alias": "dien_tich_nha", "type": "number"},\n {"alias": "sale", "type": "select_member"},\n {"alias": "xu_ly", "type": "select_member"},\n {"alias": "can_bo_sung", "type": "boolean"},\n {"alias": "phi_dich_vu", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n {\n "alias": "loai_can",\n "type": "select",\n "options": [\n {"alias": "studio", "color": "sky"},\n {"alias": "mot_pn", "color": "blue"},\n {"alias": "hai_pn", "color": "indigo"},\n {"alias": "ba_pn", "color": "violet"}\n ]\n },\n {"alias": "khoi", "type": "select_record_link", "target_entity": "khoi_nha", "cardinality": "one"},\n {"alias": "can_so", "type": "number"},\n {"alias": "tang", "type": "number"},\n {"alias": "hoa_hong_sale", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n {"alias": "ngay_thu_phi", "type": "date"},\n {"alias": "ngay_nhan_giay_to", "type": "date"},\n {"alias": "ngay_lap_ho_so", "type": "date"},\n {"alias": "ngay_nop_cdt", "type": "date"},\n {"alias": "ngay_cdt_duyet", "type": "date"},\n {"alias": "ngay_so_xd_duyet", "type": "date"},\n {"alias": "ngay_boc_tham", "type": "date"},\n {"alias": "ngay_ky_hdmb", "type": "date"},\n {"alias": "ngay_ban_giao", "type": "date"},\n {"alias": "bo_ho_so", "type": "files"},\n {"alias": "hop_dong_mua_ban", "type": "files"},\n {"alias": "giay_to", "type": "select_record_link", "target_entity": "giay_to", "cardinality": "many"},\n {\n "alias": "thanh_vien",\n "type": "select_record_link",\n "target_entity": "thanh_vien",\n "cardinality": "many"\n },\n {\n "alias": "phieu_thu",\n "type": "select_record_link",\n "target_entity": "phieu_thu",\n "cardinality": "many"\n },\n {"alias": "dien_thoai", "type": "lookup"},\n {"alias": "cccd", "type": "lookup"},\n {"alias": "ngay_sinh", "type": "lookup"},\n {"alias": "dia_chi", "type": "lookup"},\n {"alias": "da_thu", "type": "rollup"},\n {"alias": "chua_thu_phi", "type": "formula"},\n {"alias": "con_no_phi", "type": "formula"},\n {"alias": "vuot_thu_nhap", "type": "formula"},\n {"alias": "da_hoan_tat", "type": "formula"}\n ]\n },\n {\n "alias": "thanh_vien",\n "fields": [\n {"alias": "ho_ten", "type": "text"},\n {"alias": "ho_so", "type": "select_record_link", "target_entity": "ho_so", "cardinality": "one"},\n {\n "alias": "quan_he",\n "type": "select",\n "options": [\n {"alias": "nguoi_dung_don", "color": "blue"},\n {"alias": "vo_chong", "color": "violet"},\n {"alias": "con", "color": "teal"},\n {"alias": "bo_me", "color": "amber"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n {"alias": "ngay_sinh", "type": "date"},\n {"alias": "cccd", "type": "text"},\n {"alias": "thu_nhap", "type": "number", "notation": {"style": "currency", "currency": "VND"}}\n ]\n },\n {\n "alias": "giay_to",\n "fields": [\n {\n "alias": "loai",\n "type": "select",\n "options": [\n {"alias": "don_dang_ky", "color": "blue"},\n {"alias": "can_cuoc", "color": "sky"},\n {"alias": "giay_doi_tuong", "color": "violet"},\n {"alias": "xac_nhan_nha_o", "color": "teal"},\n {"alias": "xac_nhan_thu_nhap", "color": "amber"},\n {"alias": "hon_nhan", "color": "indigo"}\n ]\n },\n {"alias": "ho_so", "type": "select_record_link", "target_entity": "ho_so", "cardinality": "one"},\n {"alias": "ngay_nhan", "type": "date"},\n {"alias": "can_sua", "type": "text"},\n {"alias": "tep", "type": "files"},\n {"alias": "phai_sua", "type": "formula"}\n ]\n },\n {\n "alias": "phieu_thu",\n "fields": [\n {\n "alias": "khoan",\n "type": "select",\n "options": [\n {"alias": "dat_coc", "color": "blue"},\n {"alias": "tat_toan", "color": "indigo"},\n {"alias": "phi_ho_so", "color": "violet"}\n ]\n },\n {"alias": "ho_so", "type": "select_record_link", "target_entity": "ho_so", "cardinality": "one"},\n {"alias": "so_tien", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n {\n "alias": "hinh_thuc",\n "type": "select",\n "options": [\n {"alias": "tien_mat", "color": "green", "mark": {"kind": "icon", "name": "banknote"}},\n {"alias": "chuyen_khoan", "color": "blue", "mark": {"kind": "icon", "name": "arrow-right-left"}}\n ]\n },\n {\n "alias": "trang_thai",\n "type": "select",\n "options": [\n {"alias": "cho_thu", "color": "amber"},\n {"alias": "da_thu", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n {"alias": "ngay_thu", "type": "date"},\n {"alias": "nguoi_thu", "type": "select_member"},\n {"alias": "da_chot", "type": "formula"}\n ]\n }\n ],\n "records": {\n "ho_so": {\n "title": "khach_hang",\n "subtitle": ["dich_vu"],\n "status": {\n "milestones": [\n {"field": "ngay_thu_phi", "when": {"dich_vu": ["lam_ho_so"]}},\n "ngay_nhan_giay_to",\n {"field": "ngay_lap_ho_so", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_nop_cdt", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_cdt_duyet", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_so_xd_duyet", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_boc_tham", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_ky_hdmb", "when": {"dich_vu": ["tron_goi"]}},\n {"field": "ngay_ban_giao", "when": {"dich_vu": ["lam_ho_so"]}}\n ],\n "closed": ["ngay_ky_hdmb", "ngay_ban_giao"]\n },\n "figure": "phi_dich_vu"\n },\n "thanh_vien": {"title": "ho_ten", "subtitle": ["quan_he", "cccd"], "party": "person", "figure": "thu_nhap"},\n "giay_to": {"title": "loai", "image": "tep", "starts": {"ngay_nhan": "today"}},\n "phieu_thu": {\n "title": "khoan",\n "subtitle": ["hinh_thuc", "ngay_thu"],\n "status": {"field": "trang_thai", "closed": ["da_thu", "huy"]},\n "figure": "so_tien"\n }\n },\n "templates": [\n {"alias": "don_dang_ky", "type": "html", "label": "\u0110\u01A1n \u0111\u0103ng k\xFD mua nh\xE0 \u1EDF x\xE3 h\u1ED9i"},\n {"alias": "mau_02_chua_co_nha", "type": "html", "label": "M\u1EABu 02 \u2014 X\xE1c nh\u1EADn ch\u01B0a c\xF3 nh\xE0 \u1EDF"},\n {"alias": "mau_03_nha_chat", "type": "html", "label": "M\u1EABu 03 \u2014 X\xE1c nh\u1EADn nh\xE0 \u1EDF d\u01B0\u1EDBi 15 m\xB2/ng\u01B0\u1EDDi"},\n {"alias": "mau_05_thu_nhap", "type": "html", "label": "M\u1EABu 05 \u2014 X\xE1c nh\u1EADn thu nh\u1EADp"},\n {"alias": "danh_sach_nop", "type": "html", "label": "Danh s\xE1ch h\u1ED3 s\u01A1 n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0"}\n ],\n "apps": [\n {\n "alias": "ho_so",\n "name": "H\u1ED3 s\u01A1 nh\xE0 \u1EDF x\xE3 h\u1ED9i",\n "icon": "folder-open",\n "theme": {"color": "blue"},\n "entity": "ho_so",\n "scope": "du_an",\n "register": {\n "columns": ["xu_ly", "can_bo_sung", "doi_tuong"],\n "filters": ["xu_ly", "can_bo_sung"],\n "search": ["khach_hang", "ma_ho_so", "dien_thoai"],\n "create": ["khach_hang", "dich_vu", "doi_tuong", "tinh_trang_nha_o", "loai_can", "phi_dich_vu", "sale"],\n "export": true,\n "readings": [\n {"metric": "ho_so", "where": {"can_bo_sung": true}, "label": "Ch\u1EDD kh\xE1ch b\u1ED5 sung"},\n {"metric": "ho_so", "value": "da_thu", "over": "ngay_nhan_giay_to", "label": "Ph\xED \u0111\xE3 thu"},\n {"breakdown": "ho_so", "by": "doi_tuong"}\n ]\n },\n "record": {\n "sections": [\n {\n "title": "Ng\u01B0\u1EDDi \u0111\u1EE9ng \u0111\u01A1n",\n "fields": [\n "ma_ho_so",\n "dien_thoai",\n "cccd",\n "ngay_sinh",\n "dia_chi",\n "doi_tuong",\n "tinh_trang_nha_o",\n "sale",\n "xu_ly",\n "can_bo_sung"\n ],\n "blocks": [\n {\n "rows": "thanh_vien",\n "title": "H\u1ED9 gia \u0111\xECnh",\n "columns": ["ngay_sinh"],\n "create": ["ho_ten", "quan_he", "ngay_sinh", "cccd", "thu_nhap"]\n },\n {\n "rows": "giay_to",\n "title": "Gi\u1EA5y t\u1EDD c\xE1 nh\xE2n",\n "columns": ["ngay_nhan"],\n "expect": "loai",\n "only": ["can_cuoc", "hon_nhan"]\n }\n ],\n "acts": ["doc_giay_to", "giao_xu_ly", "chuyen_du_an"]\n },\n {\n "title": "Nh\xE0 hi\u1EC7n c\xF3",\n "fields": ["giay_chung_nhan_so", "dien_tich_nha"],\n "when": {"tinh_trang_nha_o": ["nha_chat"]}\n },\n {\n "title": "Ph\xED d\u1ECBch v\u1EE5",\n "blocks": [\n {\n "rows": "phieu_thu",\n "title": "Phi\u1EBFu thu",\n "columns": ["so_tien"],\n "create": ["khoan", "so_tien", "hinh_thuc"],\n "where": {"khoan": ["dat_coc", "tat_toan"]},\n "expect": "khoan",\n "when": {"dich_vu": ["tron_goi"]}\n },\n {\n "rows": "phieu_thu",\n "title": "Phi\u1EBFu thu",\n "columns": ["so_tien"],\n "create": ["khoan", "so_tien", "hinh_thuc"],\n "where": {"khoan": ["phi_ho_so"]},\n "expect": "khoan",\n "when": {"dich_vu": ["lam_ho_so"]}\n }\n ]\n },\n {\n "title": "Gi\u1EA5y t\u1EDD",\n "at": ["ngay_thu_phi"],\n "blocks": [\n {\n "rows": "giay_to",\n "title": "Gi\u1EA5y t\u1EDD",\n "columns": ["ngay_nhan"],\n "create": ["loai", "ngay_nhan", "can_sua", "tep"],\n "expect": "loai",\n "only": ["don_dang_ky", "giay_doi_tuong", "xac_nhan_nha_o", "xac_nhan_thu_nhap"]\n }\n ]\n },\n {\n "title": "B\u1ED9 h\u1ED3 s\u01A1",\n "at": ["ngay_nhan_giay_to", "ngay_lap_ho_so"],\n "acts": ["tao_giay_to", "nop_cdt"]\n },\n {\n "title": "Ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "at": ["ngay_nop_cdt", "ngay_cdt_duyet", "ngay_so_xd_duyet"],\n "fields": ["loai_can"],\n "when": {"dich_vu": ["tron_goi"]}\n },\n {\n "title": "C\u0103n h\u1ED9",\n "at": ["ngay_boc_tham"],\n "fields": ["khoi", "can_so", "tang", "hoa_hong_sale"],\n "blocks": [{"files": ["hop_dong_mua_ban"]}],\n "when": {"dich_vu": ["tron_goi"]}\n }\n ]\n },\n "acts": [\n {\n "alias": "doc_giay_to",\n "label": "\u0110\u1ECDc gi\u1EA5y t\u1EDD",\n "intake": "giay_to",\n "fills": [\n "doi_tuong",\n "tinh_trang_nha_o",\n "giay_chung_nhan_so",\n "dien_tich_nha",\n "khach_hang.ho_ten",\n "khach_hang.cccd",\n "khach_hang.ngay_sinh",\n "khach_hang.dia_chi",\n "thanh_vien"\n ]\n },\n {\n "alias": "tao_giay_to",\n "label": "T\u1EA1o gi\u1EA5y t\u1EDD",\n "templates": [\n {"template": "don_dang_ky"},\n {"template": "mau_02_chua_co_nha", "when": {"tinh_trang_nha_o": ["chua_co_nha"]}},\n {"template": "mau_03_nha_chat", "when": {"tinh_trang_nha_o": ["nha_chat"]}},\n {"template": "mau_05_thu_nhap", "when": {"doi_tuong": ["thu_nhap_thap"]}}\n ],\n "into": "bo_ho_so"\n },\n {\n "alias": "nop_cdt",\n "label": "N\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "when": {"dich_vu": ["tron_goi"]},\n "requires": ["bo_ho_so", "loai_can"],\n "asks": ["loai_can"],\n "set": {"ngay_nop_cdt": "now"},\n "confirm": true\n },\n {\n "alias": "giao_xu_ly",\n "label": "Giao ng\u01B0\u1EDDi x\u1EED l\xFD",\n "asks": [{"input": "nguoi", "label": "Ng\u01B0\u1EDDi x\u1EED l\xFD", "type": "member", "required": true}],\n "set": {"xu_ly": "input:nguoi"}\n },\n {\n "alias": "chuyen_du_an",\n "label": "Chuy\u1EC3n d\u1EF1 \xE1n",\n "asks": [{"input": "du_an_moi", "label": "Sang d\u1EF1 \xE1n", "type": "link", "entity": "du_an", "required": true}],\n "set": {"du_an": "input:du_an_moi"},\n "confirm": true\n },\n {\n "alias": "in_danh_sach",\n "label": "In danh s\xE1ch n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "on": "view",\n "template": "danh_sach_nop"\n },\n {\n "alias": "xac_nhan_thu",\n "label": "X\xE1c nh\u1EADn \u0111\xE3 thu",\n "of": "phieu_thu",\n "when": {"trang_thai": ["cho_thu"]},\n "asks": ["hinh_thuc"],\n "set": {"trang_thai": "da_thu", "ngay_thu": "now", "nguoi_thu": "me"},\n "confirm": true\n },\n {\n "alias": "huy_phieu",\n "label": "H\u1EE7y phi\u1EBFu",\n "of": "phieu_thu",\n "when": {"trang_thai": ["cho_thu"]},\n "set": {"trang_thai": "huy"},\n "danger": true\n }\n ],\n "checks": [\n {"field": "chua_thu_phi", "blocks": ["nop_cdt"]},\n {"field": "con_no_phi"},\n {"field": "vuot_thu_nhap"},\n {"field": "da_hoan_tat", "blocks": ["delete", "doc_giay_to"]},\n {"field": "da_chot", "of": "phieu_thu", "blocks": ["edit"]},\n {"field": "phai_sua", "of": "giay_to"}\n ]\n }\n ]\n}\n```\n\n## Calls\n\n**The job.** Call a lead from their record, and keep what was said as a touch on its timeline.\n\n**Read.** An act\'s `record` (into the `timeline` child: audio, transcript, when and who) and `fills` (the touch\'s fields an agent fills from the transcript).\n\n**Keys.** `model/papers-and-recordings`, `model/timeline-and-agenda`\n\n**Not when.** Calls made and logged elsewhere \u2014 a `timeline` with its own add keeps the note.\n\n```json\n{\n "entities": [\n {\n "alias": "khach_tiem_nang",\n "fields": [\n {"alias": "ho_ten", "type": "text"},\n {"alias": "ten_cong_ty", "type": "text"},\n {\n "alias": "vai_tro",\n "type": "select",\n "options": [\n {"alias": "chu_doanh_nghiep", "color": "emerald"},\n {"alias": "ke_toan_truong", "color": "blue"},\n {"alias": "quan_ly", "color": "teal"},\n {"alias": "nhan_vien", "color": "sky"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n {\n "alias": "loai_hinh",\n "type": "select",\n "options": [\n {"alias": "thuong_mai", "color": "blue"},\n {"alias": "san_xuat", "color": "amber"},\n {"alias": "dich_vu", "color": "violet"},\n {"alias": "xay_dung", "color": "orange"},\n {"alias": "ho_kinh_doanh", "color": "teal"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n {\n "alias": "quy_mo",\n "type": "select",\n "options": [\n {"alias": "q_1_10", "color": "sky"},\n {"alias": "q_11_50", "color": "blue"},\n {"alias": "q_51_200", "color": "indigo"},\n {"alias": "q_200", "color": "violet"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n {"alias": "so_dien_thoai", "type": "text"},\n {"alias": "zalo", "type": "text"},\n {"alias": "email", "type": "text"},\n {"alias": "trang_ca_nhan", "type": "text", "format": "link"},\n {"alias": "anh", "type": "files"},\n {\n "alias": "trang_thai",\n "type": "select",\n "options": [\n {"alias": "moi", "color": "gray"},\n {"alias": "du_dieu_kien", "color": "blue"},\n {"alias": "da_lien_he", "color": "amber"},\n {"alias": "da_chuyen_doi", "color": "emerald"},\n {"alias": "loai", "color": "red"}\n ]\n },\n {\n "alias": "ly_do_loai",\n "type": "select",\n "options": [\n {"alias": "khong_phu_hop", "color": "orange"},\n {"alias": "qua_nho", "color": "amber"},\n {"alias": "chua_co_ngan_sach", "color": "yellow"},\n {"alias": "sai_nguoi", "color": "blue"},\n {"alias": "yeu_cau_dung", "color": "red"},\n {"alias": "trung", "color": "zinc"}\n ]\n },\n {"alias": "vi_sao_du_dieu_kien", "type": "text"},\n {"alias": "phu_trach", "type": "select_member"},\n {"alias": "nguon", "type": "select_record_link", "target_entity": "kenh", "cardinality": "one"},\n {"alias": "lien_he", "type": "select_record_link", "target_entity": "lien_he", "cardinality": "one"},\n {"alias": "cong_ty", "type": "select_record_link", "target_entity": "cong_ty", "cardinality": "one"},\n {"alias": "ngay_chuyen_doi", "type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n {"alias": "ghi_chu", "type": "text", "format": "markdown"},\n {"alias": "tin_hieu", "type": "select_record_link", "target_entity": "tin_hieu"},\n {"alias": "buoc_tiep", "type": "select_record_link", "target_entity": "buoc_tiep"},\n {"alias": "tuong_tac", "type": "select_record_link", "target_entity": "tuong_tac"},\n {"alias": "do_nong", "type": "formula"},\n {"alias": "han_buoc_tiep", "type": "rollup"},\n {"alias": "khong_lien_he", "type": "formula"}\n ]\n },\n {\n "alias": "tin_hieu",\n "fields": [\n {"alias": "tom_tat", "type": "text"},\n {"alias": "noi_dung", "type": "text", "format": "markdown"},\n {"alias": "anh_chup", "type": "files"},\n {"alias": "lien_ket", "type": "text", "format": "link"},\n {"alias": "kenh", "type": "select_record_link", "target_entity": "kenh", "cardinality": "one"},\n {\n "alias": "loai",\n "type": "select",\n "options": [\n {"alias": "hoi_dich_vu", "color": "emerald"},\n {"alias": "than_phien", "color": "blue"},\n {"alias": "tuyen_ke_toan", "color": "amber"},\n {"alias": "moi_thanh_lap", "color": "violet"},\n {"alias": "gioi_thieu", "color": "teal"},\n {"alias": "danh_ba", "color": "zinc"},\n {"alias": "nhieu", "color": "stone"}\n ]\n },\n {"alias": "ngay_dang", "type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n {"alias": "ngay_xay_ra", "type": "formula"}\n ]\n },\n {\n "alias": "buoc_tiep",\n "fields": [\n {"alias": "vi_sao_luc_nay", "type": "text"},\n {\n "alias": "viec",\n "type": "select",\n "options": [\n {"alias": "binh_luan", "color": "blue", "mark": {"kind": "icon", "name": "message-square"}},\n {"alias": "nhan_facebook", "color": "violet", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "nhan_zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "gui_email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gui_bang_gia", "color": "amber", "mark": {"kind": "icon", "name": "receipt"}}\n ]\n },\n {"alias": "ban_nhap", "type": "text", "format": "markdown"},\n {"alias": "han", "type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n {\n "alias": "tinh_trang",\n "type": "select",\n "options": [\n {"alias": "cho", "color": "blue"},\n {"alias": "xong", "color": "emerald"},\n {"alias": "bo_qua", "color": "zinc"}\n ]\n }\n ]\n },\n {\n "alias": "tuong_tac",\n "fields": [\n {"alias": "tom_tat", "type": "text"},\n {"alias": "thoi_diem", "type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n {\n "alias": "qua",\n "type": "select",\n "options": [\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "facebook", "color": "blue", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gap_truc_tiep", "color": "emerald", "mark": {"kind": "icon", "name": "users"}},\n {"alias": "khac", "color": "zinc", "mark": {"kind": "icon", "name": "ellipsis"}}\n ]\n },\n {\n "alias": "phan_hoi",\n "type": "select",\n "options": [\n {"alias": "dang_cho", "color": "blue"},\n {"alias": "da_tra_loi", "color": "green"},\n {"alias": "quan_tam", "color": "amber"},\n {"alias": "khong_phu_hop", "color": "red"},\n {"alias": "khong_phan_hoi", "color": "zinc"},\n {"alias": "sai_so", "color": "stone"}\n ]\n },\n {"alias": "ghi_am", "type": "files"},\n {"alias": "nguyen_van", "type": "text", "format": "markdown"},\n {"alias": "hen_lai", "type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n {"alias": "nguoi_thuc_hien", "type": "select_member"}\n ]\n }\n ],\n "records": {\n "khach_tiem_nang": {\n "title": "ho_ten",\n "subtitle": ["ten_cong_ty"],\n "image": "anh",\n "party": "person",\n "status": {"field": "trang_thai", "closed": ["da_chuyen_doi", "loai"], "history": "lich_su_trang_thai"},\n "due": ["han_buoc_tiep"]\n },\n "tin_hieu": {"title": "tom_tat", "subtitle": ["kenh", "ngay_xay_ra"], "image": "anh_chup"},\n "buoc_tiep": {\n "title": "vi_sao_luc_nay",\n "subtitle": ["viec"],\n "mark": "viec",\n "status": {"field": "tinh_trang", "closed": ["xong", "bo_qua"]},\n "due": ["han"]\n },\n "tuong_tac": {"title": "tom_tat", "subtitle": ["qua", "phan_hoi"]}\n },\n "apps": [\n {\n "alias": "khach_tiem_nang",\n "name": "Kh\xE1ch ti\u1EC1m n\u0103ng",\n "icon": "radar",\n "theme": {"color": "violet"},\n "entity": "khach_tiem_nang",\n "register": {\n "columns": ["phu_trach", "han_buoc_tiep"],\n "filters": ["phu_trach"],\n "create": ["ho_ten", "trang_ca_nhan", "so_dien_thoai", "ten_cong_ty", "nguon"],\n "readings": [\n {"breakdown": "khach_tiem_nang", "by": "phu_trach"},\n {"trend": "khach_tiem_nang", "over": "ngay_chuyen_doi", "label": "Kh\xE1ch chuy\u1EC3n \u0111\u1ED5i"}\n ]\n },\n "record": {\n "sections": [\n {\n "title": "\u0110\xE1nh gi\xE1",\n "at": ["moi"],\n "fields": ["vai_tro", "loai_hinh", "quy_mo", "vi_sao_du_dieu_kien", "do_nong"],\n "blocks": [\n {\n "rows": "tin_hieu",\n "title": "T\xEDn hi\u1EC7u",\n "columns": ["loai", "noi_dung"],\n "create": ["tom_tat", "anh_chup", "loai", "noi_dung", "kenh", "lien_ket", "ngay_dang"]\n }\n ],\n "acts": ["danh_gia_dat"]\n },\n {\n "title": "Li\xEAn h\u1EC7",\n "at": ["du_dieu_kien"],\n "fields": ["so_dien_thoai", "phu_trach", "trang_ca_nhan", "zalo", "email", "ghi_chu"],\n "blocks": [\n {\n "rows": "buoc_tiep",\n "title": "B\u01B0\u1EDBc ti\u1EBFp theo",\n "columns": ["ban_nhap"],\n "create": ["vi_sao_luc_nay", "viec", "han", "ban_nhap"]\n },\n {\n "timeline": "tuong_tac",\n "title": "T\u01B0\u01A1ng t\xE1c",\n "create": ["tom_tat", "qua", "phan_hoi", "thoi_diem", "hen_lai"]\n }\n ],\n "acts": ["ghi_cuoc_goi", "da_lien_he"]\n },\n {\n "title": "Chuy\u1EC3n \u0111\u1ED5i",\n "at": ["da_lien_he"],\n "fields": ["nguon", "lien_he", "cong_ty"],\n "acts": ["chuyen_doi"]\n },\n {"title": "Lo\u1EA1i", "at": ["loai"], "fields": ["ly_do_loai"], "acts": ["loai"]}\n ]\n },\n "acts": [\n {\n "alias": "danh_gia_dat",\n "label": "\u0110\u1EE7 \u0111i\u1EC1u ki\u1EC7n",\n "when": {"trang_thai": ["moi"]},\n "requires": ["vi_sao_du_dieu_kien"],\n "set": {"trang_thai": "du_dieu_kien"}\n },\n {\n "alias": "ghi_cuoc_goi",\n "label": "Ghi \xE2m cu\u1ED9c g\u1ECDi",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "record": {\n "into": "tuong_tac",\n "audio": "ghi_am",\n "transcript": "nguyen_van",\n "at": "thoi_diem",\n "by": "nguoi_thuc_hien"\n },\n "fills": ["tom_tat", "phan_hoi"]\n },\n {\n "alias": "da_lien_he",\n "label": "\u0110\xE1nh d\u1EA5u \u0111\xE3 li\xEAn h\u1EC7",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "set": {"trang_thai": "da_lien_he"}\n },\n {\n "alias": "chuyen_doi",\n "label": "Chuy\u1EC3n \u0111\u1ED5i",\n "when": {"trang_thai": ["da_lien_he"]},\n "workflow": "chuyen_doi_khach",\n "writes": ["lien_he", "cong_ty"],\n "confirm": true\n },\n {\n "alias": "loai",\n "label": "Lo\u1EA1i",\n "when": {"trang_thai": ["moi", "du_dieu_kien", "da_lien_he"]},\n "asks": ["ly_do_loai"],\n "set": {"trang_thai": "loai"},\n "danger": true\n },\n {\n "alias": "lam_xong",\n "label": "\u0110\xE3 l\xE0m",\n "of": "buoc_tiep",\n "when": {"tinh_trang": ["cho"]},\n "set": {"tinh_trang": "xong"}\n }\n ],\n "checks": [{"field": "khong_lien_he", "resolve": "da_lien_he"}]\n }\n ]\n}\n```\n\n## Approval\n\n**The job.** Raise a payment request, see it through approval, and read what is waiting at the top of the list.\n\n**Read.** `records.de_nghi.status` with its `history` (each move: when and who), sections staged by `at`, and `register.readings` leading with the headline number.\n\n**Keys.** `model/status`, `model/record-page`, `model/readings`\n\n**Not when.** Rows that never move \u2014 a reference list (a price list, a catalog) has no status and no headline number.\n\n```json\n{\n "entities": [\n {\n "alias": "de_nghi",\n "fields": [\n {"alias": "noi_dung", "type": "text"},\n {"alias": "so_de_nghi", "type": "text"},\n {\n "alias": "loai",\n "type": "select",\n "options": [\n {"alias": "thanh_toan_ncc", "color": "violet"},\n {"alias": "nhan_cong", "color": "indigo"},\n {"alias": "chi_phi_cong_truong", "color": "sky"},\n {"alias": "tam_ung", "color": "amber"},\n {"alias": "hoan_ung", "color": "teal"}\n ]\n },\n {"alias": "du_an", "type": "select_record_link", "target_entity": "du_an", "cardinality": "one"},\n {\n "alias": "nha_cung_cap",\n "type": "select_record_link",\n "target_entity": "nha_cung_cap",\n "cardinality": "one"\n },\n {"alias": "so_tien", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n {"alias": "han_thanh_toan", "type": "date"},\n {\n "alias": "trang_thai",\n "type": "select",\n "options": [\n {"alias": "nhap", "color": "slate"},\n {"alias": "cho_duyet", "color": "amber"},\n {"alias": "cho_chu_tich", "color": "violet"},\n {"alias": "da_duyet", "color": "blue"},\n {"alias": "da_chi", "color": "green"},\n {"alias": "tu_choi", "color": "rose"}\n ]\n },\n {"alias": "nguoi_de_nghi", "type": "select_member"},\n {"alias": "chung_tu", "type": "files"},\n {"alias": "nguoi_duyet", "type": "select_member"},\n {"alias": "duyet_luc", "type": "date", "format": "datetime"},\n {"alias": "ly_do_tu_choi", "type": "text"},\n {"alias": "phieu_chi", "type": "files"},\n {"alias": "ngan_sach_du_an", "type": "lookup"},\n {"alias": "da_duyet_du_an", "type": "lookup"},\n {"alias": "vuot_ngan_sach", "type": "formula"},\n {"alias": "sat_ngan_sach", "type": "formula"},\n {"alias": "da_gui", "type": "formula"}\n ]\n }\n ],\n "records": {\n "de_nghi": {\n "title": "noi_dung",\n "subtitle": ["du_an"],\n "status": {\n "field": "trang_thai",\n "closed": ["da_chi", "tu_choi"],\n "history": "lich_su_duyet",\n "stages": {\n "nhap": {"owner": "nguoi_de_nghi"},\n "cho_duyet": {"owner": {"role": "giam_doc"}, "within": 1},\n "cho_chu_tich": {"owner": {"role": "chu_tich"}, "within": 2},\n "da_duyet": {"owner": {"role": "ke_toan"}, "within": 2}\n }\n },\n "figure": "so_tien",\n "limits": {"da_duyet_du_an": "ngan_sach_du_an"},\n "due": ["han_thanh_toan"],\n "starts": {"nguoi_de_nghi": "me"}\n }\n },\n "apps": [\n {\n "alias": "de_nghi_chi",\n "name": "\u0110\u1EC1 ngh\u1ECB thanh to\xE1n",\n "icon": "hand-coins",\n "theme": {"color": "amber"},\n "entity": "de_nghi",\n "register": {\n "columns": ["nguoi_de_nghi"],\n "filters": ["nguoi_de_nghi", "du_an"],\n "group": "du_an",\n "create": ["noi_dung", "loai", "du_an", "nha_cung_cap", "so_tien", "han_thanh_toan", "nguoi_de_nghi"],\n "readings": [\n {\n "metric": "de_nghi",\n "value": "so_tien",\n "where": {"trang_thai": ["da_duyet"]},\n "label": "\u0110\xE3 duy\u1EC7t, ch\u1EDD chi"\n },\n {"trend": "de_nghi", "over": "han_thanh_toan", "value": "so_tien"}\n ]\n },\n "record": {\n "door": "drawer",\n "sections": [\n {\n "title": "\u0110\u1EC1 ngh\u1ECB",\n "at": ["nhap"],\n "fields": ["so_de_nghi", "loai", "nha_cung_cap", "han_thanh_toan", "nguoi_de_nghi"],\n "blocks": [{"files": ["chung_tu"], "title": "Ch\u1EE9ng t\u1EEB k\xE8m"}],\n "acts": ["gui_duyet"]\n },\n {\n "title": "Duy\u1EC7t",\n "at": ["cho_duyet", "cho_chu_tich"],\n "fields": ["nguoi_duyet", "duyet_luc", "ly_do_tu_choi"],\n "acts": ["rut_lai"]\n },\n {"title": "\u0110\xE3 chi", "at": ["da_chi"], "blocks": [{"files": ["phieu_chi"], "title": "Phi\u1EBFu chi"}]}\n ]\n },\n "acts": [\n {\n "alias": "gui_duyet",\n "label": "G\u1EEDi duy\u1EC7t",\n "when": {"trang_thai": ["nhap"]},\n "requires": ["chung_tu", "nguoi_de_nghi"],\n "set": {"trang_thai": "cho_duyet"}\n },\n {\n "alias": "rut_lai",\n "label": "R\xFAt l\u1EA1i",\n "when": {"trang_thai": ["cho_duyet", "cho_chu_tich"]},\n "set": {"trang_thai": "nhap"},\n "confirm": true\n }\n ],\n "checks": [{"field": "da_gui", "blocks": ["edit"]}, {"field": "vuot_ngan_sach"}, {"field": "sat_ngan_sach"}]\n }\n ]\n}\n```\n\n## Dashboard\n\n**The job.** The owner\'s question \u2014 what came in, what went out, where it went, and what is still unmatched \u2014 answered over one period.\n\n**Read.** `dashboard`: `metric`s with `over` (the period windows them), a `trend`, `breakdown`s, and a `list` of rows to act on opening in their app.\n\n**Keys.** `model/dashboards`, `model/readings`\n\n**Not when.** One job\'s headline numbers \u2014 those lead that job\'s register as its `readings`.\n\n```json\n{\n "entities": [\n {\n "alias": "giao_dich",\n "fields": [\n {"alias": "noi_dung", "type": "text"},\n {"alias": "ngay", "type": "date"},\n {\n "alias": "loai",\n "type": "select",\n "options": [{"alias": "thu", "color": "green"}, {"alias": "chi", "color": "rose"}]\n },\n {"alias": "so_tien", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n {"alias": "bien_dong", "type": "formula"},\n {\n "alias": "doi_tuong",\n "type": "select_record_link",\n "target_entity": "doi_tuong",\n "cardinality": "one"\n },\n {\n "alias": "danh_muc",\n "type": "select",\n "options": [\n {"alias": "doanh_thu", "color": "green"},\n {"alias": "hang_hoa", "color": "blue"},\n {"alias": "van_chuyen", "color": "indigo"},\n {"alias": "nhan_su", "color": "violet"},\n {"alias": "van_phong", "color": "sky"},\n {"alias": "thue_phi", "color": "slate"},\n {"alias": "ngan_hang", "color": "teal"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n {"alias": "sao_ke", "type": "select_record_link", "target_entity": "sao_ke", "cardinality": "one"},\n {"alias": "hoa_don", "type": "select_record_link", "target_entity": "hoa_don", "cardinality": "many"},\n {\n "alias": "trang_thai",\n "type": "select",\n "options": [\n {"alias": "chua_khop", "color": "amber"},\n {"alias": "da_khop", "color": "green"},\n {"alias": "khong_can_hd", "color": "slate"}\n ]\n }\n ]\n },\n {\n "alias": "hoa_don",\n "fields": [\n {\n "alias": "doi_tuong",\n "type": "select_record_link",\n "target_entity": "doi_tuong",\n "cardinality": "one"\n },\n {"alias": "so_hoa_don", "type": "text"},\n {"alias": "ngay_hoa_don", "type": "date"},\n {"alias": "so_ngay_qua_han", "type": "formula"},\n {\n "alias": "chieu",\n "type": "select",\n "options": [{"alias": "ban_ra", "color": "green"}, {"alias": "mua_vao", "color": "violet"}]\n },\n {"alias": "tong_cong", "type": "formula"},\n {"alias": "thue_suat", "type": "formula"},\n {"alias": "tep", "type": "files"},\n {\n "alias": "giao_dich",\n "type": "select_record_link",\n "target_entity": "giao_dich",\n "cardinality": "many"\n }\n ]\n }\n ],\n "records": {\n "giao_dich": {\n "title": "noi_dung",\n "subtitle": ["ngay"],\n "status": {"field": "trang_thai", "closed": ["da_khop", "khong_can_hd"], "history": "lich_su_khop"},\n "figure": "bien_dong"\n },\n "hoa_don": {"title": "doi_tuong", "subtitle": ["so_hoa_don", "ngay_hoa_don"], "image": "tep", "figure": "tong_cong"}\n },\n "apps": [\n {\n "alias": "dong_tien",\n "name": "D\xF2ng ti\u1EC1n",\n "icon": "chart-line",\n "theme": {"color": "emerald"},\n "dashboard": [\n {\n "metric": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "over": "ngay",\n "label": "Ti\u1EC1n v\xE0o"\n },\n {\n "metric": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "over": "ngay",\n "better": "down",\n "label": "Ti\u1EC1n ra"\n },\n {"trend": "giao_dich", "over": "ngay", "value": "bien_dong", "label": "D\xF2ng ti\u1EC1n r\xF2ng"},\n {\n "breakdown": "giao_dich",\n "by": "danh_muc",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "over": "ngay",\n "label": "Chi theo danh m\u1EE5c"\n },\n {\n "breakdown": "giao_dich",\n "by": "doi_tuong",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "over": "ngay",\n "label": "Thu theo kh\xE1ch h\xE0ng"\n },\n {\n "pivot": "hoa_don",\n "rows": "doi_tuong",\n "columns": {"field": "so_ngay_qua_han", "tiers": [1, 8, 16, 31]},\n "value": "tong_cong",\n "where": {"chieu": ["ban_ra"]},\n "label": "C\xF4ng n\u1EE3 b\xE1n ra theo tu\u1ED5i n\u1EE3"\n },\n {\n "metric": "hoa_don",\n "value": "so_ngay_qua_han",\n "average": true,\n "where": {"chieu": ["ban_ra"]},\n "label": "S\u1ED1 ng\xE0y qu\xE1 h\u1EA1n b\xECnh qu\xE2n"\n },\n {"metric": "hoa_don", "value": "thue_suat", "average": true, "label": "Thu\u1EBF su\u1EA5t b\xECnh qu\xE2n"},\n {\n "list": "giao_dich",\n "where": {"trang_thai": ["chua_khop"]},\n "columns": ["sao_ke"],\n "app": "doi_chieu",\n "label": "D\xF2ng ch\u01B0a kh\u1EDBp"\n }\n ]\n }\n ]\n}\n```\n';
|
|
46668
46880
|
|
|
46669
46881
|
// docs/agent_surface.md
|
|
46670
|
-
var agent_surface_default = '# An app\'s agent surface\n\nEverything a person reads or does in an app, an agent reads or does through that app\'s **queries** and\n**workflows** \u2014 the same ones its screen runs, under the same permissions and the same rules. Three tools\nreach them, over MCP and as `lotics run <tool>`:\n\n| Tool | Answers |\n|---|---|\n| `get_app_capabilities` | The app\'s queries and workflows by alias: each one\'s description, its params or inputs with their types and legal values, and under a query\'s line its output columns (`returns`) \u2014 beside what each table they name holds, in its owner\'s words |\n| `run_app_query` | The rows, a count or the groups of one query \u2014 or of several in one call |\n| `run_app_workflow` | One write \u2014 or several in order \u2014 or a preview of it that writes nothing |\n\nAn app stated in a model generates this surface from the model; the model declares what the screen never\nasks (\xA7 Declaring more). An app\'s logs (`logs`) are part of it: a log\'s list, its rows by id, its record\'s\nblocks and its acts are queries and workflows of the same app, named by the log\'s entity as the register\'s\nare by its own \u2014 `get_app_capabilities` lists them in the one roster, and nothing of a log is another app\'s. What only a log reads or runs answers the organization\'s own members alone, never a caller through the app\'s public link. A custom-code app\'s surface is the queries and workflows bound on it\n(`lotics docs app_bindings`).\n\n## What every app generates\n\nA name in angle brackets is the model\'s alias for that thing. `get_app_capabilities` lists the ones a given\napp has.\n\n### Queries\n\n<!-- generated:start queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<entity>_list` | Every row of <entity> the reader may see. | `search`?; `<scope entity>_id` where the app states `scope`; `<filter>_is`? per `register.filters` field holding one value \u2014 a select, a one-row link, a member, a yes/no; `<filter>_from`? / `<filter>_to`? per date filter \u2014 none for a date holding a span; `<filter>_min`? / `<filter>_max`? per number filter \u2014 none over `books`, none for a looked-up link or member, none for a number read in each row\'s own unit or currency | every entity the app draws; the filter params on the app\'s own entity alone |\n| `<entity>_list_<tab>` | The <entity> rows of the tab "<tab>". | the list\'s; `from`? / `to`? on a tab dated `in` a period; `to` on a tab of rows `open` on a day | each of `register.tabs`; none over `books`, none for a tab whose period reads a date holding a span |\n| `<entity>_record` | One row of <entity> by its id. | `<entity>_id` | every entity the app draws |\n| `<child>_by_<link>` | The <child> rows under one <entity>, through "<link>". | `<entity>_id` | each block of child rows on the record; one narrowed by `where` or ordered by `sort` adds `_<field>_<option>` and `_sorted_<field>` to its name |\n| `<child>_by_<link>_days` | The <child> rows of the <entity> rows handed in whose "<day>" falls from one day to another. | `<entity>_ids`; `from`; `to` | `register.roster` |\n| `<entity>_<link>_pick` | The <target> rows "<link>" may point at, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a written link a write rule narrows (`options_where`, `same`) |\n| `<child>_by_<link>_picks` | The <child> rows no <entity> holds through "<link>" yet, that one <entity> may pick, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a block that picks existing rows into the record |\n| `register_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | the list\'s; `from`? / `to`? where the reading states `over`, or its `tab` is dated `in` a period; `to` where its `tab` is of rows `open` on a day | each of `register.readings` by its place among them, counted from 0 \u2014 but the work against its plan (`progress`), which reads the list\'s own rows; none over `books`. A reading stating `alias` is called by it |\n| `dashboard_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | `from`? / `to`? where the reading states `over` | each of a dashboard\'s readings, counted from 0; a reading stating `alias` is called by it |\n| `block_reading_<n>` | <label>: how many <child> rows there are. Each row carries `__count`. | `<entity>_id`; `same_<field>` where it is a list stating `same` | each reading, list or funnel block of the record, by its place among the record\'s blocks, counted from 0; a reading stating `alias` is called by it |\n| `<entity>_register_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | the list\'s; `from`? / `to`? where the reading states `over` | each of a log\'s `register.readings` by its place among them, counted from 0, named by the log\'s entity; a reading stating `alias` is called `<entity>_<alias>` |\n| `<entity>_block_reading_<n>` | <label>: how many <child> rows there are. Each row carries `__count`. | `<entity>_id`; `same_<field>` where it is a list stating `same` | each reading, list or funnel block of the record a row of a book or of a log opens, by its place among that record\'s blocks, counted from 0, named by the book\'s or the log\'s entity |\n| `<reading>_bound` | <label> / <bound>: the sum of "<bound>" over the <entity> rows. Each row carries `__count`, `__sum`. | its reading\'s | a metric whose value `records.limits` bounds: the bound\'s sum, beside the reading\'s own |\n| `<entity>_export_rows` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | a `register.export` that fills a template |\n| `<entity>_export_rows_of_<book>` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | a report of some of an app\'s `books`: their rows alone, each book named in turn |\n| `<entity>_moves` | Each move in <history> of the <entity> rows handed in: the status it went to, when and by whom, earliest first. | `<entity>_ids` | an entity whose status keeps a history (`records.status.history`) |\n| `<entity>_plan_load` | How many <entity> rows each <place> holds, over every table the register reads \u2014 the rows with no <place> counted apart. | | a `plan` register: its places\' counts of present rows |\n\n<!-- generated:end queries -->\n\nA reading\'s query returns groups, never the rows it read: one row for all of them, or one per value it\nsplits by, or per day. Each row carries the alias of each field it splits by, `__day` where it splits by\nday, `__count`, and `__sum` where it sums a number; its description states which. An average is `__sum`\nover `__count`, both over the rows holding a value.\n\nA reading that states no `alias` is called by its place, so moving it in the model changes the name it is\ncalled by. A place that generates no query keeps its number, so the names may skip one. A reading an agent\nor a published API calls states its `alias` (`lotics docs model/readings`). A log\'s reading is called by the\nlog\'s entity before either name: `<entity>_register_reading_<n>`, or `<entity>_<alias>`.\n\nA register reading\'s query reads the rows it names, whatever a screen has open: the rows of its `tab` where\nit states one, every tab\'s where it states none \u2014 its description says which. One placed in time (`over`)\nreads every day unless the call states `from` or `to`.\n\n### Queries the screen runs for itself\n\nThey run like any other, and `get_app_capabilities` leaves them out: each feeds one control, and takes ids\nthe screen already holds.\n\n<!-- generated:start screen-queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<child>_<link>_target` | One <entity> row by its id, where a <child> row\'s "<link>" may point at it. | `<entity>_id` | a picking block whose link a write rule narrows |\n| `<entity>_<field>_values` | Each "<field>" the <entity> rows hold, once, most held first, narrowed by what the reader typed. | `search`? | a text field a write rule offers values to (`suggest`) |\n| `<entity>_pictures` | The picture and name of each <entity> row among the ids handed in. | `<entity>_ids` | a link to several pictured rows |\n| `<entity>_count_by_<scope>` | How many <entity> rows each <scope entity> holds. | | an app stating `scope` |\n| `<task>_progress_by_<link>` | How many <task> rows each <entity> row handed in holds, at each status. | `<entity>_ids` | rows whose task rows are counted done |\n| `<rows>_measured_by_<link>` | The share of each <entity> row handed in its <rows> rows add, day by day. | `<entity>_ids` | a `progress` reading stating `measured` |\n| `<lane>_lanes` | The <lane> rows of one <scope entity>, each a lane of the board. | `<scope entity>_id` | a lanes board inside an app stating `scope` |\n| `<entity>_same_<link>` | The <entity> rows naming one "<link>". | `same`; `before` where its line reads rows before a moment | a statement line that carries rows (`parts`) |\n\n<!-- generated:end screen-queries -->\n\n### Workflows\n\n<!-- generated:start workflows -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `create_<entity>` | Opens one row of <entity>. | every field the add asks, and the link it files the row under | an entity the app adds rows of |\n| `update_<entity>` | Changes one row of <entity>; every input but the row is optional, and one left out is left as it is. | `record_id`, and each field a person edits \u2014 a files field or a link to several rows as `<field>_added` / `<field>_removed` | an entity the app edits |\n| `remove_<entity>` | Removes one row of <entity>. | `record_id` | an entity the app removes rows of |\n| `act_<act>` | <label> \u2014 on one row of <entity>, refused where its conditions do not hold. | `record_id` \u2014 `record_ids` on an act over several rows \u2014 and what the act asks | each of `acts` that names no workflow of its own |\n| `archive_<act>` | Hands back every file of <label> on one row of <entity> as one archive. | `record_id` | an act making a set of papers (`templates`) |\n| `record_activity` | Lists one record\'s activity, newest first: each save with its fields before and after and who made it, and whether the caller may put it back. `next` is the `after` of the next page. | `record_id`; `after`? | every register app, unless `record.activity` is `false` |\n| `record_activity_undo` | Puts back one change entry of a record\'s activity, as the caller\'s own save, each field where the record still holds what the entry wrote. The fields kept are handed back with why. | `record_id`; `entry_id` | every register app, unless `record.activity` is `false`, where the app edits that entity |\n| `<workflow>_<book>` | The workflow of that name as one of the app\'s `books`, or a log of it, runs it, where its own table or page makes it differ. | that workflow\'s | an app stating `books` or `logs` |\n\n<!-- generated:end workflows -->\n\nA workflow the model declares (`workflows`) and an act that names its own are called by the alias the model\ngives them.\n\n## Calling a query\n\n```\nlotics run get_app_capabilities \'{"app_id":"app_\u2026"}\'\nlotics run run_app_query \'{"app_id":"app_\u2026","alias":"hire_list","params":{"status_is":"opt_\u2026","due_back_to":"2031-03-14"}}\'\n```\n\n| Argument | Does |\n|---|---|\n| `params` | The query\'s declared params. A required one is always sent; an optional one left out narrows nothing. A select takes an option\'s value, a link a record id, a member a member id, a date `yyyy-mm-dd` |\n| `filters` | Narrows the result further, by the query\'s output columns (`lotics docs filters`) |\n| `fields` | The output columns to return, in place of all of them; each row then holds them and the id of the record it is |\n| `sort` | An order in place of the query\'s own: `[{ "field_key": "<column>", "order": "asc" }]`, `asc` or `desc`, each `field_key` an output column\'s name |\n| `count` | `true`: `total`, the number of rows, in place of the rows; with `count_by`, `counts` per value of one column, keyed by an option\'s label, a member\'s name or a linked row\'s display; with `count_where` \u2014 a map of name \u2192 filter, never beside `count_by` \u2014 `counts` per name. Never with `fields`, `sort`, `limit` or `cursor` |\n| `aggregate` | Groups of the result in place of its rows, one row per group: `by` (up to 3 columns), or `day` (a date column, answered as `__day`), and `sum` (a number column, answered as `__sum`), each group with its `__count`. Sent with `params` and `filters` alone |\n| `limit`, `cursor` | A page \u2014 200 rows at most, 50 where no `limit` is stated \u2014 and the `next_cursor` of the page before it; `truncated` says more rows matched than `rows` holds |\n| `runs` | Several reads in one call, 20 at most, each with its own `alias` and arguments, answered in order under `runs`. Never beside an `alias` of the call\'s own |\n\nA query that states its own `limit` lists at most that many rows: `truncated` is `true` where more match, and `total` is\nthe rows the filtered query matches without it. A `count`, `count_by`, `count_where` and an `aggregate` are over every row\nthe query matches, never over the rows its `limit` lists.\n\nThe rows of one call, across its reads, total at most 262,144 bytes: a read past that is refused, naming\n`fields` and `limit` as what narrows it. The names `filters`, `fields`, `sort`, `count_by` and `aggregate`\ntake are the ones on the query\'s `returns` line.\n\nA list\'s params are how a person narrows that register: `search`, the row\'s id on an app that works inside\none row (`scope`), and a param for each filter the register states that one value or a range narrows. A\nfilter with no param \u2014 on a looked-up link or member, on a number read in each row\'s own unit or currency,\non a date holding a span, or on a register of several tables (`books`) \u2014 is narrowed by `filters`, where a\nnumber condition names the unit its value is in as `unit_option`, an option of the figure\'s select by label\nor key. Each tab of a register is a query of its own, taking the list\'s params and the period its rows are\nread over.\n\n## Calling a workflow\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"act_check_out","inputs":{"record_id":"rec_\u2026"},"preview":true}\'\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"act_check_out","inputs":{"record_id":"rec_\u2026"}}\'\n```\n\n| Argument | Does |\n|---|---|\n| `inputs` | The workflow\'s declared inputs. An update takes the record and only the fields that change |\n| `preview` | `true`: nothing is written, and the answer is what the run would return, with the calls it would make \u2014 or `status: "not_previewed"` where the workflow cannot be previewed (\xA7 A preview) |\n| `runs` | Several runs in one call, 50 at most, in order, each its own write, answered under `runs`. The first one refused, failed or not previewed ends the call. An input `{"from_run": 0, "path": "data.record_id"}` is an earlier run\'s answer at that path. A run states its own `preview`, or takes the call\'s |\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","runs":[\n {"alias":"create_hire","inputs":{"customer":"rec_\u2026","machine":"rec_\u2026","due_back":"2031-03-14"}},\n {"alias":"act_check_out","inputs":{"record_id":{"from_run":0,"path":"data.record_id"}}}\n]}\'\n```\n\n## A preview\n\nA previewed run makes every read the run would make and none of its writes. Its answer carries `status`,\n`message`, `field_errors` and `data` as the run would return them, and under `preview`:\n\n| Key | Holds |\n|---|---|\n| `available` | `true` |\n| `writes` | The calls the run would make that are not reads, in order. The app\'s owner and an admin, who may read the workflow\'s body, read each call\'s `step_id`, `tool_name` and `input`. Another member reads each step that would write once: its `step_id` and `tool_name`, and where the step states them outright, the `table_id` it names and how many `records` it lists |\n| `unpredicted` | The parts of the answer left out \u2014 `message`, `field_errors`, `data` \u2014 because each reads what a call the preview did not make would answer |\n\nA preview says nothing of a call its target refuses when it is made \u2014 a locked record, a required field, a\npermission \u2014 nor of what a write sets off in turn: a table\'s own workflows, its computed fields.\n\nA workflow is not previewed where its body reads the answer of a call the preview does not make, to branch,\nloop, check or feed another call, where it reads a linked record after such a call, where it runs an agent,\nwhere it waits, where a step cannot be evaluated or sends its call an input the call refuses, and where the\nrun is past what one preview walks \u2014 its steps, the passes of a loop, its reads or the time it takes. The\nanswer is then `status: "not_previewed"` with\n`preview: { "available": false, "reason" }`, and nothing ran \u2014 within `runs`, it ends the call. The same\nanswers a caller outside the app\'s organization.\n\n## A reviewed act\n\nAn act that states `review` runs a workflow that only proposes: call it with the inputs the act asks and it answers,\nwriting nothing, the changeset its body proposes in `data.review` \u2014 `table_id`, `creates` (each with its `key`) and\n`updates` (each with its `record_id`), each row\'s `data` holding only the fields that change, by field key, with an\noptional `note` and `ticked` (`false` where the body leaves it for a person to choose), and `unplaced`, what was read\nand matched nothing; the platform adds a `sha` to every row. Call it again with the same inputs and `approved`,\n`{ "updates": [{ "record_id", "sha" }], "creates": [{ "key", "sha" }] }`, listing the rows to write with the `sha` each\ncarries in the proposal, copied as it came \u2014 never computed \u2014 and the platform writes those rows as that second call\nproposes them, each only where it proposes the values read:\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026"}}\'\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026","approved":{"updates":[{"record_id":"rec_\u2026","sha":"9f2c\u2026"}],"creates":[{"key":"line-4","sha":"41d0\u2026"}]}}}\'\n```\n\nThe answer\'s `data.applied` names the run (`execution_id`), the records `updated`, each `created` record by its key,\nand each approved row `left` with its `reason`: `not_proposed` (the second call no longer proposes it), `not_acted`\n(an update of a record the act was not run on), `changed` (the second call proposes other values than were read \u2014 read\nthe proposal again), `empty` (an update changing no field), `missing`, `locked` or `conflict`. Every approved row is\nchecked before any is written, and all are written in one transaction or none; the status history of each row written\nthat moved is recorded by the same run, so the workflow step `undo_record_changes` with that `execution_id` as its `workflow_execution_id` takes back both. An act over every\nrow in view takes no `record_ids`. A `file` input takes the id of a file uploaded to the workspace.\n\n## A refusal\n\nA workflow re-checks on the server every rule the screen shows: what an act requires, a bound, a duplicate,\nwhose step it is, a row the caller may not see. A run that is refused writes nothing and answers\n`status: "error"` with the sentence a person would read as `message`, and under `field_errors` the sentence\nfor each input it was refused over. A value of the wrong type, a missing required input and an unknown\nalias are refused before the body runs: the call itself fails with the sentence, and `field_errors` where\nan input is at fault \u2014 within `runs`, a run refused for its inputs answers `status: "error"` in its place,\nand the runs before it stand. A refused read fails the same way, naming the param or the column; within\n`runs`, it answers its `error` and the other reads are still answered.\n\n## Declaring more\n\nWhat a person would ask an agent in the app, and no screen draws, is stated in the model beside the app\'s\nacts. Both are checked by `check_model` and compiled by `apply_model` (`lotics docs model/queries`, `lotics docs model/workflows`).\n\n**A query** \u2014 the rows of one entity, or one figure of them, in the model\'s own aliases:\n\n```jsonc\n"queries": {\n "hires_overdue": {\n "description": "A customer\'s hires still out past the day they were due back, longest overdue first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "required": false, "description": "Only this customer\'s hires." },\n "as_of": { "type": "date", "description": "The day a hire is overdue on: due back before it." }\n },\n "rows": "hire",\n "fields": ["customer", "machine", "due_back", "daily_rate"],\n "where": { "status": ["out"], "customer": { "param": "customer" }, "due_back": { "to": { "param": "as_of" } } },\n "sort": { "field": "due_back" }\n }\n}\n```\n\nIt reads under the entity\'s read scope and, on the app\'s own entity, exactly the rows its list reads \u2014\nso never the entity of an app that states `books`, whose list reads several tables. A condition reading an\noptional param narrows nothing when the call leaves it out; no param compares a number read in each row\'s\nown unit or currency, or a date holding a span. `"reading"` in place of `"fields"` returns a count or a sum \u2014\n`{ "value": "daily_rate", "by": "machine" }` \u2014 as a reading does. A declared query, a declared workflow and\na reading\'s `alias` take no name the app generates (`lotics docs model/app.generated-name`).\n\n**A workflow** \u2014 a write no act of the record makes, typed in the model and its body set on the app:\n\n```jsonc\n"workflows": {\n "import_bookings": {\n "description": "Books every hire a booking sheet lists, reusing a hire the sheet already booked.",\n "inputs": {\n "sheet": { "type": "file", "description": "The booking sheet, one hire per row." },\n "booked_by": { "type": "member", "required": false, "description": "Who the hires are booked by; absent, the caller." }\n },\n "outputs": { "added": { "type": "number" }, "reused": { "type": "number" } }\n }\n}\n```\n\n`lotics run set_app_workflow` sets its body (`lotics docs workflows`). A query set on a model\'s app outside\nthe model (`set_app_queries`, on the CLI or in chat) is removed by the next apply, whose plan and answer note it; declared under\nits alias in `queries`, it is the model\'s. A caller sees the description and\neach input\'s `description` and nothing else, so each says what the value is and what leaving it out means;\n`check_model` notes one that says nothing.\n\n**Shape each for a caller that is not looking at a screen.** One job a person hands an agent \u2014 a paper read,\na message answered, a sheet brought in \u2014 is one declared workflow named for the job, never a chain of the\ngenerated per-row workflows. Take a list where the job covers many rows, a record\'s lines among them. A body\nthat writes more than one row makes them in one `save_record` workflow step, all or nothing, and recognises\nwhat exists by the identity the input itself carries, declared unique on its table, so the same input sent\ntwice updates instead of adding. Return the ids under `outputs`, so the next run can read them. Gate what\ncannot be undone behind an approval step.\n\n## Prove an app as an agent\n\nRun on a throwaway record.\n\n1. `get_app_capabilities` \u2014 every job the app\'s `description` names has an alias that does it or reads it.\n2. `run_app_query` the list with no param, then with each param a person would narrow by; `count: true`\n answers how many without the rows.\n3. `run_app_query` `<entity>_record` with one row\'s id, and each `<child>_by_<link>` under it.\n4. `run_app_workflow` an act with `preview: true`, then without.\n5. `run_app_workflow` an act its record is not ready for: the answer is `status: "error"` with the sentence\n the screen would show.\n6. `run_app_workflow` `record_activity` for the record, then `record_activity_undo` with the entry the act\n wrote: each field the act changed reads as it did before step 4, but one written since, which `kept`\n names. A row the act added under the record and a file it made stay.\n7. `run_app_workflow` the app\'s job workflow with the input a person would hand it \u2014 the paper read, the row:\n it completes in one call. Call it again with the same input: nothing is added.\n';
|
|
46882
|
+
var agent_surface_default = '# An app\'s agent surface\n\nEverything a person reads or does in an app, an agent reads or does through that app\'s **queries** and\n**workflows** \u2014 the same ones its screen runs, under the same permissions and the same rules. Three tools\nreach them, over MCP and as `lotics run <tool>`:\n\n| Tool | Answers |\n|---|---|\n| `get_app_capabilities` | The app\'s queries and workflows by alias: each one\'s description, its params or inputs with their types and legal values, and under a query\'s line its output columns (`returns`) \u2014 beside what each table they name holds, in its owner\'s words |\n| `run_app_query` | The rows, a count or the groups of one query \u2014 or of several in one call |\n| `run_app_workflow` | One write \u2014 or several in order \u2014 or a preview of it that writes nothing |\n\nAn app stated in a model generates this surface from the model; the model declares what the screen never\nasks (\xA7 Declaring more). An app\'s logs (`logs`) are part of it: a log\'s list, its rows by id, its record\'s\nblocks and its acts are queries and workflows of the same app, named by the log\'s entity as the register\'s\nare by its own \u2014 `get_app_capabilities` lists them in the one roster, and nothing of a log is another app\'s. What only a log reads or runs answers the organization\'s own members alone, never a caller through the app\'s public link. A custom-code app\'s surface is the queries and workflows bound on it\n(`lotics docs app_bindings`).\n\n## What every app generates\n\nA name in angle brackets is the model\'s alias for that thing. `get_app_capabilities` lists the ones a given\napp has.\n\n### Queries\n\n<!-- generated:start queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<entity>_list` | Every row of <entity> the reader may see. | `search`?; `<scope entity>_id` where the app states `scope`; `<filter>_is`? per `register.filters` field holding one value \u2014 a select, a one-row link, a member, a yes/no; `<filter>_from`? / `<filter>_to`? per date filter \u2014 none for a date holding a span; `<filter>_min`? / `<filter>_max`? per number filter \u2014 none over `books`, none for a looked-up link or member, none for a number read in each row\'s own unit or currency | every entity the app draws; the filter params on the app\'s own entity alone |\n| `<entity>_list_<tab>` | The <entity> rows of the tab "<tab>". | the list\'s; `from`? / `to`? on a tab dated `in` a period; `to` on a tab of rows `open` on a day | each of `register.tabs`; none over `books`, none for a tab whose period reads a date holding a span |\n| `<entity>_totals_<tab>` | The <child> rows added per <entity> row, by "<link>", over the period from `from` to `to`, dated by "<date>": . | `from`; `to` | each of `register.tabs` stating `totals` |\n| `<entity>_record` | One row of <entity> by its id. | `<entity>_id` | every entity the app draws |\n| `<child>_by_<link>` | The <child> rows under one <entity>, through "<link>". | `<entity>_id` | each block of child rows on the record; one narrowed by `where` or ordered by `sort` adds `_<field>_<option>` and `_sorted_<field>` to its name |\n| `<child>_by_<link>_days` | The <child> rows of the <entity> rows handed in whose "<day>" falls from one day to another. | `<entity>_ids`; `from`; `to` | `register.roster` |\n| `<entity>_<link>_pick` | The <target> rows "<link>" may point at, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a written link a write rule narrows (`options_where`, `same`) |\n| `<child>_by_<link>_picks` | The <child> rows no <entity> holds through "<link>" yet, that one <entity> may pick, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a block that picks existing rows into the record |\n| `register_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | the list\'s; `from`? / `to`? where the reading states `over`, or its `tab` is dated `in` a period; `to` where its `tab` is of rows `open` on a day | each of `register.readings` by its place among them, counted from 0 \u2014 but the work against its plan (`progress`), which reads the list\'s own rows; none over `books`. A reading stating `alias` is called by it |\n| `dashboard_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | `from`? / `to`? where the reading states `over` | each of a dashboard\'s readings, counted from 0; a reading stating `alias` is called by it |\n| `block_reading_<n>` | <label>: how many <child> rows there are. Each row carries `__count`. | `<entity>_id`; `same_<field>` where it is a list stating `same` | each reading, list or funnel block of the record, by its place among the record\'s blocks, counted from 0; a reading stating `alias` is called by it |\n| `<entity>_register_reading_<n>` | <label>: how many <entity> rows there are. Each row carries `__count`. | the list\'s; `from`? / `to`? where the reading states `over` | each of a log\'s `register.readings` by its place among them, counted from 0, named by the log\'s entity; a reading stating `alias` is called `<entity>_<alias>` |\n| `<entity>_block_reading_<n>` | <label>: how many <child> rows there are. Each row carries `__count`. | `<entity>_id`; `same_<field>` where it is a list stating `same` | each reading, list or funnel block of the record a row of a book or of a log opens, by its place among that record\'s blocks, counted from 0, named by the book\'s or the log\'s entity |\n| `<reading>_bound` | <label> / <bound>: the sum of "<bound>" over the <entity> rows. Each row carries `__count`, `__sum`. | its reading\'s | a metric whose value `records.limits` bounds: the bound\'s sum, beside the reading\'s own |\n| `<entity>_export_rows` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | a `register.export` that fills a template |\n| `<entity>_export_rows_of_<book>` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | a report of some of an app\'s `books`: their rows alone, each book named in turn |\n| `<entity>_moves` | Each move in <history> of the <entity> rows handed in: the status it went to, when and by whom, earliest first. | `<entity>_ids` | an entity whose status keeps a history (`records.status.history`) |\n| `<entity>_plan_load` | How many <entity> rows each <place> holds, over every table the register reads \u2014 the rows with no <place> counted apart. | | a `plan` register: its places\' counts of present rows |\n\n<!-- generated:end queries -->\n\nA reading\'s query returns groups, never the rows it read: one row for all of them, or one per value it\nsplits by, or per day. Each row carries the alias of each field it splits by, `__day` where it splits by\nday, `__count`, and `__sum` where it sums a number; its description states which. An average is `__sum`\nover `__count`, both over the rows holding a value.\n\nA reading that states no `alias` is called by its place, so moving it in the model changes the name it is\ncalled by. A place that generates no query keeps its number, so the names may skip one. A reading an agent\nor a published API calls states its `alias` (`lotics docs model/readings`). A log\'s reading is called by the\nlog\'s entity before either name: `<entity>_register_reading_<n>`, or `<entity>_<alias>`.\n\nA register reading\'s query reads the rows it names, whatever a screen has open: the rows of its `tab` where\nit states one, every tab\'s where it states none \u2014 its description says which. One placed in time (`over`)\nreads every day unless the call states `from` or `to`.\n\n### Queries the screen runs for itself\n\nThey run like any other, and `get_app_capabilities` leaves them out: each feeds one control, and takes ids\nthe screen already holds.\n\n<!-- generated:start screen-queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<child>_<link>_target` | One <entity> row by its id, where a <child> row\'s "<link>" may point at it. | `<entity>_id` | a picking block whose link a write rule narrows |\n| `<entity>_<field>_values` | Each "<field>" the <entity> rows hold, once, most held first, narrowed by what the reader typed. | `search`? | a text field a write rule offers values to (`suggest`) |\n| `<entity>_pictures` | The picture and name of each <entity> row among the ids handed in. | `<entity>_ids` | a link to several pictured rows |\n| `<entity>_count_by_<scope>` | How many <entity> rows each <scope entity> holds. | | an app stating `scope` |\n| `<task>_progress_by_<link>` | How many <task> rows each <entity> row handed in holds, at each status. | `<entity>_ids` | rows whose task rows are counted done |\n| `<rows>_measured_by_<link>` | The share of each <entity> row handed in its <rows> rows add, day by day. | `<entity>_ids` | a `progress` reading stating `measured` |\n| `<lane>_lanes` | The <lane> rows of one <scope entity>, each a lane of the board. | `<scope entity>_id` | a lanes board inside an app stating `scope` |\n| `<entity>_same_<link>` | The <entity> rows naming one "<link>". | `same`; `before` where its line reads rows before a moment | a statement line that carries rows (`parts`) |\n\n<!-- generated:end screen-queries -->\n\n### Workflows\n\n<!-- generated:start workflows -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `create_<entity>` | Opens one row of <entity>. | every field the add asks, and the link it files the row under | an entity the app adds rows of |\n| `update_<entity>` | Changes one row of <entity>; every input but the row is optional, and one left out is left as it is. | `record_id`, and each field a person edits \u2014 a files field or a link to several rows as `<field>_added` / `<field>_removed` | an entity the app edits |\n| `remove_<entity>` | Removes one row of <entity>. | `record_id` | an entity the app removes rows of |\n| `act_<act>` | <label> \u2014 on one row of <entity>, refused where its conditions do not hold. | `record_id` \u2014 `record_ids` on an act over several rows \u2014 and what the act asks | each of `acts` that names no workflow of its own |\n| `archive_<act>` | Hands back every file of <label> on one row of <entity> as one archive. | `record_id` | an act making a set of papers (`templates`) |\n| `record_activity` | Lists one record\'s activity, newest first: each save with its fields before and after and who made it, and whether the caller may put it back. `next` is the `after` of the next page. | `record_id`; `after`? | every register app, unless `record.activity` is `false` |\n| `record_activity_undo` | Puts back one change entry of a record\'s activity, as the caller\'s own save, each field where the record still holds what the entry wrote. The fields kept are handed back with why. | `record_id`; `entry_id` | every register app, unless `record.activity` is `false`, where the app edits that entity |\n| `<workflow>_<book>` | The workflow of that name as one of the app\'s `books`, or a log of it, runs it, where its own table or page makes it differ. | that workflow\'s | an app stating `books` or `logs` |\n\n<!-- generated:end workflows -->\n\nA workflow the model declares (`workflows`) and an act that names its own are called by the alias the model\ngives them.\n\n## Calling a query\n\n```\nlotics run get_app_capabilities \'{"app_id":"app_\u2026"}\'\nlotics run run_app_query \'{"app_id":"app_\u2026","alias":"hire_list","params":{"status_is":"opt_\u2026","due_back_to":"2031-03-14"}}\'\n```\n\n| Argument | Does |\n|---|---|\n| `params` | The query\'s declared params. A required one is always sent; an optional one left out narrows nothing. A select takes an option\'s value, a link a record id, a member a member id, a date `yyyy-mm-dd` |\n| `filters` | Narrows the result further, by the query\'s output columns (`lotics docs filters`) |\n| `fields` | The output columns to return, in place of all of them; each row then holds them and the id of the record it is |\n| `sort` | An order in place of the query\'s own: `[{ "field_key": "<column>", "order": "asc" }]`, `asc` or `desc`, each `field_key` an output column\'s name |\n| `count` | `true`: `total`, the number of rows, in place of the rows; with `count_by`, `counts` per value of one column, keyed by an option\'s label, a member\'s name or a linked row\'s display; with `count_where` \u2014 a map of name \u2192 filter, never beside `count_by` \u2014 `counts` per name. Never with `fields`, `sort`, `limit` or `cursor` |\n| `aggregate` | Groups of the result in place of its rows, one row per group: `by` (up to 3 columns), or `day` (a date column, answered as `__day`), and `sum` (a number column, answered as `__sum`), each group with its `__count`. Sent with `params` and `filters` alone |\n| `limit`, `cursor` | A page \u2014 200 rows at most, 50 where no `limit` is stated \u2014 and the `next_cursor` of the page before it; `truncated` says more rows matched than `rows` holds |\n| `runs` | Several reads in one call, 20 at most, each with its own `alias` and arguments, answered in order under `runs`. Never beside an `alias` of the call\'s own |\n\nA query that states its own `limit` lists at most that many rows: `truncated` is `true` where more match, and `total` is\nthe rows the filtered query matches without it. A `count`, `count_by`, `count_where` and an `aggregate` are over every row\nthe query matches, never over the rows its `limit` lists.\n\nThe rows of one call, across its reads, total at most 262,144 bytes: a read past that is refused, naming\n`fields` and `limit` as what narrows it. The names `filters`, `fields`, `sort`, `count_by` and `aggregate`\ntake are the ones on the query\'s `returns` line.\n\nA list\'s params are how a person narrows that register: `search`, the row\'s id on an app that works inside\none row (`scope`), and a param for each filter the register states that one value or a range narrows. A\nfilter with no param \u2014 on a looked-up link or member, on a number read in each row\'s own unit or currency,\non a date holding a span, or on a register of several tables (`books`) \u2014 is narrowed by `filters`, where a\nnumber condition names the unit its value is in as `unit_option`, an option of the figure\'s select by label\nor key. Each tab of a register is a query of its own, taking the list\'s params and the period its rows are\nread over.\n\n## Calling a workflow\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"act_check_out","inputs":{"record_id":"rec_\u2026"},"preview":true}\'\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"act_check_out","inputs":{"record_id":"rec_\u2026"}}\'\n```\n\n| Argument | Does |\n|---|---|\n| `inputs` | The workflow\'s declared inputs. An update takes the record and only the fields that change |\n| `preview` | `true`: nothing is written, and the answer is what the run would return, with the calls it would make \u2014 or `status: "not_previewed"` where the workflow cannot be previewed (\xA7 A preview) |\n| `runs` | Several runs in one call, 50 at most, in order, each its own write, answered under `runs`. The first one refused, failed or not previewed ends the call. An input `{"from_run": 0, "path": "data.record_id"}` is an earlier run\'s answer at that path. A run states its own `preview`, or takes the call\'s |\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","runs":[\n {"alias":"create_hire","inputs":{"customer":"rec_\u2026","machine":"rec_\u2026","due_back":"2031-03-14"}},\n {"alias":"act_check_out","inputs":{"record_id":{"from_run":0,"path":"data.record_id"}}}\n]}\'\n```\n\n## A preview\n\nA previewed run makes every read the run would make and none of its writes. Its answer carries `status`,\n`message`, `field_errors` and `data` as the run would return them, and under `preview`:\n\n| Key | Holds |\n|---|---|\n| `available` | `true` |\n| `writes` | The calls the run would make that are not reads, in order. The app\'s owner and an admin, who may read the workflow\'s body, read each call\'s `step_id`, `tool_name` and `input`. Another member reads each step that would write once: its `step_id` and `tool_name`, and where the step states them outright, the `table_id` it names and how many `records` it lists |\n| `unpredicted` | The parts of the answer left out \u2014 `message`, `field_errors`, `data` \u2014 because each reads what a call the preview did not make would answer |\n\nA preview says nothing of a call its target refuses when it is made \u2014 a locked record, a required field, a\npermission \u2014 nor of what a write sets off in turn: a table\'s own workflows, its computed fields.\n\nA workflow is not previewed where its body reads the answer of a call the preview does not make, to branch,\nloop, check or feed another call, where it reads a linked record after such a call, where it runs an agent,\nwhere it waits, where a step cannot be evaluated or sends its call an input the call refuses, and where the\nrun is past what one preview walks \u2014 its steps, the passes of a loop, its reads or the time it takes. The\nanswer is then `status: "not_previewed"` with\n`preview: { "available": false, "reason" }`, and nothing ran \u2014 within `runs`, it ends the call. The same\nanswers a caller outside the app\'s organization.\n\n## A reviewed act\n\nAn act that states `review` runs a workflow that only proposes: call it with the inputs the act asks and it answers,\nwriting nothing, the changeset its body proposes in `data.review` \u2014 `table_id`, `creates` (each with its `key`) and\n`updates` (each with its `record_id`), each row\'s `data` holding only the fields that change, by field key, with an\noptional `note` and `ticked` (`false` where the body leaves it for a person to choose), and `unplaced`, what was read\nand matched nothing; the platform adds a `sha` to every row. Call it again with the same inputs and `approved`,\n`{ "updates": [{ "record_id", "sha" }], "creates": [{ "key", "sha" }] }`, listing the rows to write with the `sha` each\ncarries in the proposal, copied as it came \u2014 never computed \u2014 and the platform writes those rows as that second call\nproposes them, each only where it proposes the values read:\n\n```\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026"}}\'\nlotics run run_app_workflow \'{"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026","approved":{"updates":[{"record_id":"rec_\u2026","sha":"9f2c\u2026"}],"creates":[{"key":"line-4","sha":"41d0\u2026"}]}}}\'\n```\n\nThe answer\'s `data.applied` names the run (`execution_id`), the records `updated`, each `created` record by its key,\nand each approved row `left` with its `reason`: `not_proposed` (the second call no longer proposes it), `not_acted`\n(an update of a record the act was not run on), `changed` (the second call proposes other values than were read \u2014 read\nthe proposal again), `empty` (an update changing no field), `missing`, `locked` or `conflict`. Every approved row is\nchecked before any is written, and all are written in one transaction or none; the status history of each row written\nthat moved is recorded by the same run, so the workflow step `undo_record_changes` with that `execution_id` as its `workflow_execution_id` takes back both. An act over every\nrow in view takes no `record_ids`. A `file` input takes the id of a file uploaded to the workspace.\n\n## A refusal\n\nA workflow re-checks on the server every rule the screen shows: what an act requires, a bound, a duplicate,\nwhose step it is, a row the caller may not see. A run that is refused writes nothing and answers\n`status: "error"` with the sentence a person would read as `message`, and under `field_errors` the sentence\nfor each input it was refused over. A value of the wrong type, a missing required input and an unknown\nalias are refused before the body runs: the call itself fails with the sentence, and `field_errors` where\nan input is at fault \u2014 within `runs`, a run refused for its inputs answers `status: "error"` in its place,\nand the runs before it stand. A refused read fails the same way, naming the param or the column; within\n`runs`, it answers its `error` and the other reads are still answered.\n\n## Declaring more\n\nWhat a person would ask an agent in the app, and no screen draws, is stated in the model beside the app\'s\nacts. Both are checked by `check_model` and compiled by `apply_model` (`lotics docs model/queries`, `lotics docs model/workflows`).\n\n**A query** \u2014 the rows of one entity, or one figure of them, in the model\'s own aliases:\n\n```jsonc\n"queries": {\n "hires_overdue": {\n "description": "A customer\'s hires still out past the day they were due back, longest overdue first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "required": false, "description": "Only this customer\'s hires." },\n "as_of": { "type": "date", "description": "The day a hire is overdue on: due back before it." }\n },\n "rows": "hire",\n "fields": ["customer", "machine", "due_back", "daily_rate"],\n "where": { "status": ["out"], "customer": { "param": "customer" }, "due_back": { "to": { "param": "as_of" } } },\n "sort": { "field": "due_back" }\n }\n}\n```\n\nIt reads under the entity\'s read scope and, on the app\'s own entity, exactly the rows its list reads \u2014\nso never the entity of an app that states `books`, whose list reads several tables. A condition reading an\noptional param narrows nothing when the call leaves it out; no param compares a number read in each row\'s\nown unit or currency, or a date holding a span. `"reading"` in place of `"fields"` returns a count or a sum \u2014\n`{ "value": "daily_rate", "by": "machine" }` \u2014 as a reading does. A declared query, a declared workflow and\na reading\'s `alias` take no name the app generates (`lotics docs model/app.generated-name`).\n\n**A workflow** \u2014 a write no act of the record makes, typed in the model and its body set on the app:\n\n```jsonc\n"workflows": {\n "import_bookings": {\n "description": "Books every hire a booking sheet lists, reusing a hire the sheet already booked.",\n "inputs": {\n "sheet": { "type": "file", "description": "The booking sheet, one hire per row." },\n "booked_by": { "type": "member", "required": false, "description": "Who the hires are booked by; absent, the caller." }\n },\n "outputs": { "added": { "type": "number" }, "reused": { "type": "number" } }\n }\n}\n```\n\n`lotics run set_app_workflow` sets its body (`lotics docs workflows`). A query set on a model\'s app outside\nthe model (`set_app_queries`, on the CLI or in chat) is removed by the next apply, whose plan and answer note it; declared under\nits alias in `queries`, it is the model\'s. A caller sees the description and\neach input\'s `description` and nothing else, so each says what the value is and what leaving it out means;\n`check_model` notes one that says nothing.\n\n**Shape each for a caller that is not looking at a screen.** One job a person hands an agent \u2014 a paper read,\na message answered, a sheet brought in \u2014 is one declared workflow named for the job, never a chain of the\ngenerated per-row workflows. Take a list where the job covers many rows, a record\'s lines among them. A body\nthat writes more than one row makes them in one `save_record` workflow step, all or nothing, and recognises\nwhat exists by the identity the input itself carries, declared unique on its table, so the same input sent\ntwice updates instead of adding. Return the ids under `outputs`, so the next run can read them. Gate what\ncannot be undone behind an approval step.\n\n## Prove an app as an agent\n\nRun on a throwaway record.\n\n1. `get_app_capabilities` \u2014 every job the app\'s `description` names has an alias that does it or reads it.\n2. `run_app_query` the list with no param, then with each param a person would narrow by; `count: true`\n answers how many without the rows.\n3. `run_app_query` `<entity>_record` with one row\'s id, and each `<child>_by_<link>` under it.\n4. `run_app_workflow` an act with `preview: true`, then without.\n5. `run_app_workflow` an act its record is not ready for: the answer is `status: "error"` with the sentence\n the screen would show.\n6. `run_app_workflow` `record_activity` for the record, then `record_activity_undo` with the entry the act\n wrote: each field the act changed reads as it did before step 4, but one written since, which `kept`\n names. A row the act added under the record and a file it made stay.\n7. `run_app_workflow` the app\'s job workflow with the input a person would hand it \u2014 the paper read, the row:\n it completes in one call. Call it again with the same input: nothing is added.\n';
|
|
46671
46883
|
|
|
46672
46884
|
// AGENTS.md
|
|
46673
46885
|
var AGENTS_default = "# @lotics/cli \u2014 agent index\n\nThe model an agent needs before driving this CLI: which surface answers which question, what the\nconventions are, and where the traps are.\n\n| Read | For |\n|---|---|\n| `lotics --help` | The verb inventory (\xA7 COMMANDS) and global flags. The verb LIST is generated and never stale; the prose beside each verb is hand-written, so where it disagrees with `docs/cli_reference.md`, the reference wins. |\n| `lotics tools` \xB7 `lotics tools <name>` | The agent tool registry and one tool's full JSON Schema. |\n| `lotics docs` \xB7 `lotics docs <area>[/<section>]` \xB7 `lotics docs [<area>] --grep <text>` | This CLI's references, carried inside it so each describes the binary answering. Capped at a page: a doc that does not fit hands back its opening and the addresses into it, so the next call is smaller than the last. A page the copy lacks \u2014 one the server added since this binary was built, which a refusal can cite \u2014 is read from the server's `docs` tool with this machine's credential, and so is every `--grep`, over the references the server serves. A custom-code app's SDK reference is `node_modules/@lotics/app-sdk/AGENTS.md` inside the app. |\n| `lotics docs model` \xB7 `lotics docs model/<section>` | How to write a `model.json` \u2014 the file a workspace is built from: its tables, how a row of each is recognised (`records`), and the apps stated over them. Every top-level key, every field type with the config it needs, the row format, the rules, and a worked example; complete example models of several trades are listed at `https://lotics.ai/presets/index.json`. `lotics model apply` checks the file (every problem in one run), applies its tables and mints a version of each app; the WORKSPACE remembers what each alias became, so every later apply binds by id and a relabel on either side is a rename it reports rather than a second table it adds. `lotics model pull` goes the other way \u2014 the workspace's model, rebuilt from what owns each part. |\n| `lotics docs design` \xB7 `lotics docs design/<section>` | Designing an app \u2014 where an app starts: the method, the treatment each kind of row takes with the `model` page stating its keys, the visual bar, and looking at what an apply built. A finding of the apply names its section. |\n| `lotics docs examples` \xB7 `lotics docs examples/<treatment>` | Each treatment worked through in an app of a complete model: the job, the keys to read, where it is the wrong one, and the excerpt. |\n| [docs/building_an_app.md](./docs/building_an_app.md) | The SEQUENCE \u2014 clarify, model, apply or build, prove, look \u2014 for an app stated in a model and for a custom-code app. Read it once before starting an app. Looking is `lotics run screenshot_app '<json>' -o <dir>`, which saves each PNG and its text snapshot there. |\n| [docs/cli_reference.md](./docs/cli_reference.md) | Per-command contracts, flags, exit codes, and gotchas \u2014 the detail `--help` compresses. |\n| [docs/data_model.md](./docs/data_model.md) | Tables, their fields, and how they relate \u2014 one fact per column, one entity per table and the NAME-OVERLAP probe that says when a split has broken, one vocabulary wherever values are copied, a copy boundary that accounts for every source field, provenance as a link, a declared natural key, history as rows, and why derived DEPTH costs more than row count; then every field type, its properties, computed fields, and what `update_fields` takes. Separate from building_an_app because every workspace starts with tables and many never get an app. |\n| [docs/filters.md](./docs/filters.md) | The one filter grammar every filter-taking tool, view and rollup reads \u2014 conditions, groups, and the operators per field type. |\n| [docs/field_values.md](./docs/field_values.md) | The value each field type takes in a write. |\n| [docs/workflows.md](./docs/workflows.md) | Writing a workflow body \u2014 triggers, steps, what an expression reads, the helpers, approvals and agent steps, and table checks. |\n| [docs/app_bindings.md](./docs/app_bindings.md) | The queries, workflows and agents an app binds \u2014 the query tree, typed inputs and outputs, and an agent's declaration. |\n| [docs/document_templates.md](./docs/document_templates.md) | Generating PDF/Excel/Word/email from reusable templates. |\n| [docs/knowledge_docs.md](./docs/knowledge_docs.md) | Authoring the workspace facts an agent can't guess; who can read a doc; catalog-then-stage retrieval. |\n| [docs/migration.md](./docs/migration.md) | What to DO when something an earlier CLI wrote to disk no longer matches what it does \u2014 local app projects are gone, and each verb that read one has a replacement. |\n| [README.md](./README.md) | Install, auth, and worked examples. |\n\n## Two surfaces, and the trap between them\n\n**`lotics tools` is not the CLI's capability list.** There are two disjoint surfaces:\n\n- **Tools** (`lotics tools`, `lotics run <tool>`) \u2014 the *agent tool registry*: what an agent, workflow,\n or automation may call. Workspace data, templates, knowledge, admin.\n- **Commands** (`lotics --help` \xA7 COMMANDS) \u2014 the CLI's *own verbs*: auth and org/workspace scoping,\n file upload and download, and those that touch a local file for an app \u2014 `model apply`,\n `model check`, `model pull`, `app create --custom`, `app pull` and `app deploy`.\n\nSeveral capabilities exist **only** as commands and appear nowhere in `lotics tools` \u2014 downloading a\nfile is the one most often mistaken for missing. Concluding \"the platform can't do X\" from the tool\nlist alone is a mistake; check both.\n\n**`lotics <verb> --help` prints that verb's entries from \xA7 COMMANDS** (`lotics model --help`,\n`lotics file download --help`); `lotics report --help` prints the report frame. To find out whether\nsomething exists, read `lotics --help` \xA7 COMMANDS \u2014 the whole section, not a narrow grep.\n\n## Conventions that hold across every command\n\n- **Scope is resolved per invocation.** `LOTICS_ORG` / `LOTICS_WORKSPACE` (or `LOTICS_API_KEY`) scope a\n single call without changing the active org or a directory pin \u2014 the safe way to touch one tenant\n from a shell serving many. Every command that resolves a workspace echoes its target to **stderr**\n (`lotics \u2192 <org> / <workspace>`); read it back before trusting a write. Resolution precedence is\n in README \xA7 Organizations.\n- **A machine with no key can still sign in, and the sign-in never blocks you.** `lotics auth\n login <email>` prints the page a person opens (also mailed) and the code that page must show,\n records the request, and EXITS. They press Confirm whenever they get to it; the next command that\n NEEDS a credential collects the key before doing its own work, so \"sign in\" costs you one command\n and then re-running what you wanted. Never wrap it in a timeout waiting for a human \u2014 `--wait`\n exists if you really want one blocking command, and killing that one is safe too (the request\n survives and the next command claims it). A command run before Confirm exits 1 naming the page and\n code again; once the 15 minutes are up it says to ask again. `lotics setup` falls into the same\n flow by itself when the email it was given already has an account: it stops having created\n nothing, and the SAME command run again carries on.\n- **A credential is either a SIGN-IN or an API KEY, and `logout` treats them differently.** A profile\n from `auth login` / `auth signup` acts as the person who confirmed it and is theirs \u2014 `lotics auth\n logout` revokes it server-side, and it lapses on its own after 90 idle days (each use pushes that\n out). A profile from `auth api-key` holds a key an ADMIN issued. A key created in Settings carries\n its OWN access \u2014 every app and table, or only the ones chosen on the key, so a listing that comes\n back short is the key's reach, not a bug \u2014 while a key created FOR a person carries that\n person's access and dies with their membership. Either is routinely also on a server and on\n other machines, so logout only forgets it locally and says so; only an admin revokes it. A profile that states no kind (saved before the field existed) is resolved against the SERVER\n and revoked only if the answer is a sign-in; a bare `--api-key` / `LOTICS_API_KEY` names no\n profile to remove at all. Nothing is ever revoked on a guess \u2014 between two, the destructive one is\n wrong. `lotics auth whoami` prints the kind, asking the server when the store cannot say.\n- **A key created in Settings never administers the organization, whatever its access.** The verbs\n `docs/cli_reference.md` marks *admin only* split in two under a key: `workspace doctor`, which only\n reads inside a workspace the key reaches, runs as before, while applying or pulling a model\n (`model apply`, `model pull`, `setup`), managing people, sharing or\n ownership, creating or deleting a workspace, changing workspace settings, setting credit limits,\n reading the access log and publishing an app's API answer `403` and name the remedy: an admin signed in, so\n `lotics auth login <email>` and run it again. A sign-in acts as that person and is refused none of\n them. Do not retry a `403` with the same credential and do not ask for a wider key \u2014 no answer on\n the key's own screen grants this.\n- **A 401 names its remedy \u2014 act on the hint, do not retry.** \"This credential expired / was\n revoked / belongs to a member who is no longer active\" carries the one remedy that ends this\n credential: run `lotics auth login <email>` for a sign-in, or ask the admin who issued it for a\n new key. A credential minted before that was recorded carries BOTH, because nothing on the row\n tells them apart \u2014 so on a box with no browser, take the second. Only an UNRECOGNIZED key gets\n the generic \"Invalid or disabled API key\", and that one is generic on purpose, so re-sending it\n teaches nothing. A `reason` rides on the body for a script to branch on, since the code stays\n `unauthorized` for every 401.\n- **Large payloads bypass `ARG_MAX`** \u2014 `lotics run <tool> @args.json`, or piped stdin behind `-`. A leading `@` is\n unambiguously a file path (JSON args start with `{`).\n- **stdout is the payload, stderr is the narration.** Progress, status lines, and the target echo go to\n stderr; the result goes to stdout, so piping stays clean. `--json` switches stdout from the\n agent-readable summary to the full structured object.\n- **Every tool is invoked one way \u2014 `lotics run <tool>`.** Including the ones that RUN something\n (`run_app_workflow`, `run_app_agent`, `run_app_query`) and every one that changes an app\n (`set_app_queries`, `set_app_workflow`, `set_app_agent`, `update_app`, `rollback_app`). A command\n exists only for work that touches a local file.\n- **Every change to an app mints a version of it, and rolling back is the undo.** An apply, a\n deploy, a single `set_app_*` or `remove_app_binding`: each is a new version, and `rollback_app` makes an\n earlier one current again. It restores the app \u2014 never a table change or a row a workflow wrote,\n so try a write on a throwaway record.\n- **Exit codes are assertable, and they report the WORK rather than the call.** `lotics run` exits\n non-zero when a `run_app_workflow` or `run_app_agent` result's own envelope carries a failed\n `status` (`error`/`failed`/`cancelled`, or `not_previewed`: a preview asked for and not given) \u2014 any other tool's top-level status is data and exits 0 \u2014\n so `lotics run \u2026 && next-step` cannot walk past a refused run; `workspace doctor` exits non-zero on\n findings. An unrecognized status exits 0 \u2014 the list is an allowlist of failure, so a status added\n later never turns a working script red \u2014 and a parked run (`awaiting_input`) is not a failure.\n- **An app that PUBLISHES an API turns every later binding write into a release.** Publishing\n snapshots what the app's queries, workflows and agents promise to callers outside it \u2014 a\n customer's own site or server, which nobody here can redeploy. From then on an additive change\n re-snapshots silently and a breaking one is REFUSED, naming each change; the tool's\n `acknowledge_breaking_api_change` carries it out and snapshots the break as a new contract version.\n- **Exposure is per app, all or nothing** \u2014 a public share or a key reaches every alias an app\n declares, so what outsiders may call is a second app over the same tables\n ([docs/building_an_app.md](./docs/building_an_app.md) \xA7 7).\n- **`--print-created` / `--cleanup` on any call that reports `side_effects`.** The first prints the\n records created plus a paste-ready cleanup plan and what cannot be auto-undone; the second runs\n those deletes (records only \u2014 never files, integrations or notifications). Neither is a rollback.\n- **Text output is the default and is built for reading**; reach for `--json` only when a field is\n needed programmatically.\n- **`lotics report '<json>'` is the channel for what nothing else records.** Reach for it\n when the platform is genuinely missing something (a capability that does not exist \u2014 no\n command ran), when a success was wrong (exited 0, wrong effect), or when an error did\n not name the remedy \u2014 not for your own mistakes, which the logs already show.\n **It is a frame, not a paragraph** \u2014 `{goal, actual, expected?, tried?, wanted?}`, because a log\n reconstructs what you RAN and never what you WANTED, and that gap is the report. `goal` and\n `actual` are required; there is no severity or category to pick. The\n session's commands attach themselves \u2014 do not retype them. Run it bare for the full prompt; a\n long one rides `@file.json` or an explicit `-` for stdin (bare NEVER reads stdin).\n- **`LOTICS_TELEMETRY=1` correlates a whole session** so the authoring loop's rough edges can be\n found and fixed. Off by default; set it in the shell profile, not per command (each invocation is\n its own process). It sends no arguments, no file contents, and no record data \u2014 see README\n \xA7 Diagnostics.\n\n## Where this CLI is not the answer\n\n- **Editing an app in a local directory.** An app stated in a model is changed by applying the\n model again; its bindings through their `set_app_*` tools; a custom-code app's code by deploying\n its directory again. Nothing reads a local copy of a live app back.\n- **OAuth connections.** Attaching a connected account is web-only; the CLI can list them.\n";
|
|
@@ -46679,7 +46891,7 @@ var building_an_app_default = '# Building an app, end to end\n\nThe other refere
|
|
|
46679
46891
|
var cli_reference_default = "# @lotics/cli \u2014 CLI Command Reference\n\nPer-command syntax, flags, contracts, and gotchas for the public `lotics` CLI. Start at [AGENTS.md](../AGENTS.md) for the model this reference assumes; `lotics --help` is the authoritative, always-current verb list.\n\n| Command | What it does |\n|---|---|\n| `lotics` / `lotics --help` | Show full help: capabilities, the verb list (\xA7 COMMANDS), flags, config. `lotics <verb> --help` prints that verb's entries alone (`lotics model --help`, `lotics file download --help`); `lotics report --help` prints the report frame. |\n| `lotics auth signup <email>` | Create account + org + API key, sends magic link email. Registers the new org as a profile; `--local` pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth login <email>` | Sign in an account that already exists, on a machine holding no key. **Two steps, and it does not wait for the person.** The first prints the page to open \u2014 `https://lotics.ai/cli_login/<request_id>`, also mailed \u2014 and the code that page must show, records the request, and exits 0. They sign in there if asked, check the code and press Confirm. **Then the next command that needs a credential collects the key** before it does its own work, so the second step is just re-running whatever was wanted; a command run before Confirm exits 1 naming the page and the code again, and once the 15 minutes are up it says to ask again. The handful that run WITHOUT a credential \u2014 `docs` among them \u2014 claim nothing, so one of those run after Confirm still answers as though signed out. `--wait` keeps one command instead, holding the terminal until Confirm; `--local` pins this directory to that org rather than setting the global default, and implies `--wait` (a pin names THIS directory, so only the terminal that stays in it can write one). `--json` prints `organization_id`, `workspace_id` and `organization_name` when it finishes signed in, and `request_id`, `confirm_url`, `code`, `email`, `expires_at` when it is the first step. The request's secret is never printed and the org's key never leaves the store. |\n| `lotics auth api-key [key]` | `whoami` \u2192 **upsert** the key's org as a profile in the global store (never overwrites). The profile records the instance the key was verified against (`LOTICS_API_URL`, default `https://api.lotics.ai`), and every later command for that org goes there. `--local` additionally pins this directory to it (pointer) instead of setting the global default. |\n| `lotics auth web` | Send a magic link email to access the web app (requires auth) |\n| `lotics auth whoami` | Print active account name, email, org, resolved workspace, the instance the credential belongs to, which **kind** of credential this machine holds (a sign-in from `auth login`, or an API key \u2014 read from the saved profile, and from the server when the profile does not say, which covers `--api-key`/`LOTICS_API_KEY` and a profile saved before the field existed; unknown only when neither can say), and the resolution **source** (flag/env/local/app-manifest/global). `--json` adds `workspace_id`, `api_url`, `credential_kind` + `source`. |\n| `lotics auth logout [<name\\|id>]` | In a pinned dir: delete the local pin. Else: remove the profile (default the active org), `--all` for every one. What happens server-side depends on which KIND of credential it is. A **sign-in** (`auth login` / `auth signup`) is revoked \u2014 logging that terminal out ends its credential rather than leaving a live one behind; a server that cannot be reached, or a credential already dead, never blocks the local forget, and one line names the org and Settings \u2192 Security \u2192 *Keys and terminals*. An **API key** (`auth api-key`) is only forgotten here \u2014 an admin issued it and it is routinely on a server and on other machines, so one terminal signing out must not kill it for everyone; the line says it is still active and names both pages, because Settings \u2192 API keys is admin-only and the credential may well be the holder's own sign-in, which they revoke themselves at Settings \u2192 Security \u2192 *Keys and terminals*. A profile saved before the kind was recorded states nothing, so the SERVER is asked (`auth whoami`) and it is revoked only if the answer is a sign-in: an older server, a credential minted before the column, and a request that fails all leave it alone. |\n| \u2014 | **A refused credential says which of three ways it is dead, and names the remedy that ends its kind.** `This credential expired.` / `was revoked.` / `belongs to a member who is no longer active in this organization.` carries `Run \\`lotics auth login <email>\\` to sign in again.` for a sign-in and `Ask an admin for a new API key (Settings \u2192 API keys).` for an issued key. A credential minted before that was recorded still gets BOTH in one sentence, because nothing on the row tells them apart \u2014 so a headless box is never sent looking for a browser alone. A key the server does not recognize at all gets one flat `Invalid or disabled API key.` \u2014 deliberately, so a guessed key learns nothing, not even that it named a row. The body carries `reason` for a script to branch on, since the code stays `unauthorized` for every 401. |\n| `lotics org` | List saved orgs (profiles) from the global store with the instance each belongs to, marks active for this directory (a local pin wins over the global default). |\n| `LOTICS_ORG=<name\\|id>` | Scope every command in this shell to one saved org. **Resolved once, before any command dispatches**, so a value matching no saved credential refuses every verb with one sentence \u2014 a read, a write, and a local check that needs no credential alike \u2014 and refuses it before the first byte is written. It refuses even when a credential arrives another way, because `--api-key` / `LOTICS_API_KEY` outrank it in the precedence chain and a write must never fall through to whatever THOSE name while the variable says otherwise; when the variable resolves and a key is also given, the key decides and the command says so. The refusal lists the orgs this machine holds, so it is answerable without another command (`lotics org` is refused by the same rule). A name is whatever the credential was SAVED under \u2014 a server-side rename never moves it, and the new name resolves too, so both keep working and `lotics org` prints the pair. |\n| `lotics org use <name\\|id> [--local]` | Switch the active org by org name (case-insensitive, ambiguous \u2192 error) or id. No flag \u2192 global `active_org`; `--local` \u2192 a `.lotics/config.json` pointer in the current dir. |\n| `lotics workspace` | List workspaces in the active org, marks current with `(current)` |\n| `lotics workspace select <id>` | Set the workspace in the **active scope** \u2014 a local pin if the dir has one, else the active org's global profile. Records the workspace's NAME beside its id, which is what the `lotics \u2192 <org> / <workspace>` echo prints; `workspace list`, `workspace create`, `workspace rename` and `org use` record it too, so a target is named rather than identified. Until one command has listed it, the echo prints the id and says the name is not known yet. |\n| `lotics workspace create <name> [--timezone <Area/City>] [--currency <ISO>]` | Create a new workspace (admin only), auto-switches to it. Neither flag is defaulted from THIS machine, unlike signup: an extra workspace is routinely created by an operator for somebody else. Without `--timezone` the new workspace inherits the zone of the org's OLDEST workspace; without `--currency` it takes the org's default. Both ride the create, so the workspace is never briefly denominated in a currency nobody asked for. `--currency` takes an ISO-4217 code (case-insensitive; anything else is refused). |\n| `lotics workspace rename <name>` | Rename the **current** workspace (admin only) \u2014 the endpoint takes its target from the request's workspace, never a path id, so switch with `workspace select <id>` first and read the `lotics \u2192 <org> / <workspace>` echo before trusting it \u2014 both halves are names, and the rename moves the cached one in the same act. Carries the workspace's existing `default_currency` and `timezone` through unchanged: the endpoint takes the whole settings triple, so sending only a name would blank the other two. |\n| `lotics workspace settings [--name <n>] [--currency <ISO>] [--timezone <Area/City>]` | Change the CURRENT workspace's name, default currency or timezone \u2014 `PATCH /v1/workspace`, admin only. Only what you name changes; the endpoint takes the whole triple, so the CLI carries the two you did not. `rename` is this verb with the name alone, which is why it can never forget the other two. Both values are invisible once they are wrong: the currency decides how every money field RENDERS and the zone decides how every date BUCKETS, on a workspace whose whole purpose may be to look like the customer's own. `--json` prints the updated workspace. |\n| `lotics workspace delete <id> --yes` | Delete a workspace by id (admin only). **Soft delete** \u2014 `archived_at` is set, so it drops out of listings, can no longer be selected, and its tables/records go dark, while the data is retained and recoverable. Its **apps are cascade-archived** too \u2014 every app entry point (embedded, public link, standalone subdomain, incl. anonymous public links) stops serving. Refuses the org's **only** active workspace (400) and any workspace outside the caller's org (404). Requires `--yes` to confirm (destructive; the CLI is used non-interactively). |\n| `lotics workspace doctor` | Report workspace-wide dangling schema references via `GET /v1/workspaces/dangling-references` \u2014 every active app/workflow artifact whose prefixed schema id no longer resolves, printed as `<referent.kind> \"<name>\" (<id>) \u2192 <namespace> <id> (missing)`; healthy prints a one-line all-clear. **Exits non-zero (exit 1) on findings** so scripts can gate on it. Resolves the first workspace like every data command (runs before the global workspace resolution). Admin-only. |\n| `lotics tools` | List tools by category with descriptions |\n| `lotics tools <name>` | Full description, input JSON Schema, and the output schema where the tool answers a shape, for one tool; a workflow step says to call it from a workflow body, not `lotics run` |\n| `lotics run <tool> '<json>'` | Execute a tool (text output via toModelOutput). Args may also come from a file (`lotics run <tool> @args.json`) or stdin behind the `-` sentinel (`cat args.json \\| lotics run <tool> -`) \u2014 both bypass the OS `ARG_MAX` limit for large payloads (a knowledge-doc `content`, a bulk update). A leading `@` on the args is unambiguously a file path (JSON args start with `{`). **Stdin is asked for, never guessed.** `lotics run <tool>` with no payload runs the tool with no arguments and returns at once. `lotics report` takes the same sentinel. In PowerShell use `@file`: quotes inside an inline argument are consumed by the shell, and the CLI reports the JSON it received with its quotes gone \u2014 the error names both escapes. |\n| `lotics run <tool> --json '<json>'` | Execute a tool (full JSON output) |\n| `lotics run <tool>` \u2014 **file cells** | A file in a tool's result carries its `fil_\u2026` id and metadata and **no `url`**, on every tool and in both output modes. That is not a broken file \u2014 this surface resolves no URL for a cell. Reach the bytes with `lotics file download <file_id>`, which takes the id straight from the cell; the text output says so whenever a result carries one. |\n| \u2014 | **Every tool is invoked here, including the ones that RUN something** (`run_app_workflow`, `run_app_agent`, `run_app_query`) and every one that changes an app (`set_app_queries`, `set_app_workflow`, `set_app_agent`, `update_app`, `rollback_app`). A command exists only for work that touches a local file: `model apply`, `model check`, `model pull`, `app create --custom`, `app pull`, `app deploy`. |\n| \u2014 | **An app's queries and workflows take more than their params and inputs** (`lotics docs agent_surface`). `run_app_query '{\"app_id\",\"alias\",\"params\"}'` also takes `filters` and `sort` over the query's output columns, `fields` (the columns to return), `count` with `count_by` or `count_where`, `aggregate`, `limit` (200 rows at most; 50 where none is stated) and `cursor`, and `runs` \u2014 up to 20 reads in one call, each `{\"alias\", \u2026}`, a refused one answered with its `error`; one call's rows total at most 262,144 bytes. `run_app_workflow '{\"app_id\",\"alias\",\"inputs\"}'` also takes `preview: true` \u2014 nothing is written; the answer is what the run would return, with the calls it would make under `preview.writes` and the parts of the answer it could not say under `preview.unpredicted`; a workflow no preview is offered of answers `status: \"not_previewed\"` \u2014 and `runs` \u2014 up to 50 runs in order, the first refused, failed or not previewed ending the call, an input `{\"from_run\": <index>, \"path\": \"data.<key>\"}` reading an earlier run's answer. |\n| \u2014 | **The exit code reports the WORK, not just the call \u2014 for the two tools that RUN one.** `run_app_workflow` and `run_app_agent` whose envelope carries a failed `status` (`error`/`failed`/`cancelled`, or `not_previewed` \u2014 a preview asked for and not given) exit non-zero and print `<tool> \u2192 <status>: <message>` to stderr, so `lotics run \u2026 && next-step` cannot walk past a refused run. The rule is an allowlist of FAILURE \u2014 an unrecognized status exits 0, so a status added later never turns a working script red. A parked run (`awaiting_input`) is not a failure: it is waiting for an answer and the work is still live. Only a TOP-LEVEL `status` counts; one inside the data belongs to the data. Any OTHER tool's `status` is data, and exits 0. |\n| `lotics run <tool> '<json>' -o <dir>` | Also save every **signed link** the answer carries \u2014 an object with a `url`, a `filename` and the `expires_at` its signature ends at, at any depth, such as `screenshot_app`'s images. Each is fetched into `<dir>` (created if missing) under its `filename`, taking a free spelling beside a file of that name already there, and a link's `snapshot` text is written beside it as `<name>.txt`. The written paths follow the answer on **stdout**, one per line (on stderr under `--json`, whose stdout stays the one object). A link is signed for an hour; one the store no longer serves exits non-zero. A workspace file states no `expires_at` and is left to `lotics file download`. |\n| `lotics run <tool> --print-created` | Report the records the call created, grouped by table, with a paste-ready `delete_records` per table and the mandatory caveat naming what cannot be auto-undone (external integrations, notifications, possible sub-workflows). Works for any tool that returns a `side_effects` block, not workflows alone. |\n| `lotics run <tool> --cleanup` | Implies `--print-created`, then runs those deletes \u2014 harvested records **only**, never files / external calls / notifications. **Not a rollback**; a rollback is structurally impossible here. A partial cleanup exits non-zero so a script cannot read it as success. |\n| `lotics file upload <file\\|dir...>` (alias `lotics upload`) \xB7 `--stdin` \xB7 `--base64` \xB7 `--url <url>` | Upload files/directories. **The transport is chosen by size and is not a flag**: under 8 MiB the file is POSTed to `/v1/files`, several such files to a request up to half that route's 100 MiB cap; at or above it the CLI takes presigned part URLs and PUTs the bytes straight to object storage, so they never pass through the API. That threshold matches the AWS CLI's own `multipart_threshold`, and the number matters less than there being nothing to choose \u2014 one verb, any size, up to the 2 GiB a workspace may store. A large upload reads one part at a time, so memory stays flat regardless of file size, and a failure part-way abandons the parts already sent rather than leaving them billable and invisible. A directory expands to its immediate files; `--as <name>` renames a single upload. **Three alternative byte sources, for a caller that never had the bytes on disk** \u2014 an attachment decoded in memory, a generated document, a signed download link \u2014 each mutually exclusive with the others and with a path argument: `--stdin` takes raw bytes on stdin, `--base64` takes base64 on stdin (the shape attachments arrive in), `--url <url>` fetches the URL first. `--stdin`/`--base64` REQUIRE `--as`, because stdin carries no filename and the mime type is derived from it; `--url` falls back to `Content-Disposition` then the URL's last path segment. `--base64` decodes STRICTLY \u2014 `Buffer.from(s, \"base64\")` silently skips invalid characters and truncates on bad padding, so a corrupted pipe would otherwise store a short file that only fails when a human opens it. The `--url` fetch happens in the CLI, not the server: the URL comes from the operator running the command, so routing it through the backend would add an SSRF surface to buy what `curl` already does. |\n| `lotics file download <file_id> [<path>]` \xB7 `-o <dir>` | (alias `lotics download`) Download a stored file: `GET /v1/files/{id}/signed_url` \u2192 fetch the presigned URL and write it where you asked. **The two spellings mean two different things, and neither is read by shape: the positional `<path>` is the FILE to write, `-o <dir>` is the DIRECTORY to save into.** That is `cp` and `curl -o`, so nothing here consults an extension. A named file is written as named, its parent created, overwriting what is there \u2014 the point of naming it is that the next command opens that exact path. A directory is created if missing and written into under the stored filename (the response's `Content-Disposition`), taking a free spelling beside a file of that name already there so a repeat download never clobbers the first; with no destination at all, that filename lands in cwd. Give the destination once \u2014 a positional and `-o` together is refused, as is a positional that names an existing directory or ends in a separator (`a directory goes in -o`). The first argument is a **file id**, so a path in that slot is refused rather than sent as an id. The written path goes to **stdout** (under `--json`, `{file_id, path, filename, stored_filename}`) and the narration to stderr, so a download pipes into whatever opens it. `lotics file download record <record_id> <field_key> [-o <dir>]` spreads every file on a record's file field over a DIRECTORY \u2014 there is no single file for N files to be. |\n| `lotics file list [--limit <n>] [--cursor <token>]` | The workspace's files, newest first \u2014 id, upload time, bytes, MIME type, filename on stdout, one per line (`--json` for the object). `GET /v1/files` with no `file_ids`. A file holding the content of a knowledge doc or template you cannot use is left out. **A page, not a dump**: the store only ever grows, so the last line prints the command for the next page and `next_cursor` is null on the last one. The cursor is opaque and keyset \u2014 pass it back as given \u2014 so an upload landing mid-sweep cannot make a walk skip or repeat a row. Every other file verb takes an id, so this is the only answer to \"what is in here\" short of reading Postgres. |\n| `lotics file delete <file_id>` | Archive a stored file, over the `delete_file` tool. Deleting an original deletes every version of it; a file's current version cannot be deleted on its own, and a document template's file, or a version of it, only by a member who manages the template. **Refused while a record cell, a comment, a knowledge doc, a document template, a voice session or a pending change request still references the file or a version it takes along** \u2014 the refusal names the referents, so this is safe to try. The bytes are left in object storage; the row no longer serves them, which is what \"deleted\" means here. There is no `lotics delete`: the verb needs its noun. |\n| `lotics knowledge list [--include-hidden]` | `GET /v1/knowledge_docs` \u2014 a table of id, name, tags, description (`--json` for the docs). **REST, not the `list_knowledge` tool**: the tool answers what the ASSISTANT may browse, and a hidden doc is out of that corpus by definition, so a tool-backed listing could never show one and the person who hid it would have no way back to it. Hidden docs are left out unless `--include-hidden` asks; those rows are marked `(hidden)`. |\n| `lotics knowledge create --name <n> [--description <d>] [--tags <a,b>] (--from <file.md> \\| --content <str>)` | Read the body client-side (a file XOR an inline string \u2014 exactly one required), then call `create_knowledge` with `{ name, description, content, tags? }` (description defaults to `\"\"`). `--tags` files the doc as it is made, which is the only moment a corpus reliably gets labelled. Prints the new id to stdout. Large files ride the POST body fine. |\n| `lotics knowledge get <id> [-o <file.md>]` | `GET /v1/knowledge_docs/{id}` (`getKnowledgeDoc`) \u2192 the doc with its **hydrated `content`** (the one content-read path for a non-sandbox client). `-o` writes the body via `writeFileAtomic`; else the body goes to stdout. `--json` prints the full doc instead. |\n| `lotics knowledge update <id> [--from <file.md> \\| --content <str>] [--name <n>] [--description <d>] [--tags <a,b>]` | Call `update_knowledge` with **only** the provided fields (a body from --from/--content becomes `content`; the tool diffs + CASes the content change internally, so the CLI passes no `expected_content_file_id`). `--tags` REPLACES the doc's label set \u2014 the single-doc form, where the caller is looking at one doc and can state what it should carry. At least one field required; --from and --content are mutually exclusive. |\n| `lotics knowledge tag <id...> [--add <a,b>] [--remove <c,d>]` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, add_tags?, remove_tags? }` \u2014 one transaction over the whole set. A **DIFF applied to each doc's own labels**, never a replacement: the docs named on one command line carry different labels, so one array across them would strip whatever the others were filed under. Removal matches case-insensitively; adding a label a doc already carries writes nothing. Ids may be separate arguments or comma-separated. At least one of --add/--remove required. |\n| `lotics knowledge hide <id...>` / `lotics knowledge unhide <id...>` | `PATCH /v1/knowledge_docs` with `{ knowledge_doc_ids, hidden }`. Hiding takes docs out of every **listing** \u2014 the Library's list, `list_knowledge`, and the corpus `grep_knowledge` searches \u2014 while leaving IAM untouched and keeping them readable **by id** (`read_knowledge` with an id, a code run staging one, an app agent's declared set). So it can never silently break an app that depends on a doc, and unhiding costs nothing. Refuses the no-argument form rather than reading it as \"everything\". |\n| `lotics knowledge rm <id>` | Archive the doc via `delete_knowledge` (`{ knowledge_doc_id }`). The REST execute path does not gate `needsApproval`, so this runs unattended. |\n| `lotics setup <model.json> [--email <addr>] [--json]` | **The whole first run, in one command.** Creates an account when this machine has no credential (the same call `auth signup` makes \u2014 `--name` and `--timezone` apply), then applies the model to its workspace, then prints the one-time sign-in link. **When that email already has an account it hands over to the `lotics auth login` flow** \u2014 it prints the sign-in page to open and the code it must show, and **exits 1 having created nothing**; the person presses Confirm and runs the same command again, which collects the key and carries on into the model. (`--wait` holds the terminal through the Confirm instead, finishing in one command.) The re-run is not refused for naming an `--email` it is now signed in as \u2014 that address IS the account it holds, not a second one. The file is a workspace MODEL, and it is read and checked before an account is created \u2014 the design decisions an apply would refuse it for too (`lotics docs design`), since a new workspace holds no rows to change them \u2014 because a file with a typo in it must not leave an organization behind. Then it is `lotics model apply` run on the new workspace: its tables, rows and apps; the sign-in link lands on its app when it has one, else on the workspace's app list. It exists because the two-command form has a seam where the FIRST command exists only to produce a credential for the second, and a caller pasting a prompt has to get both right. **`--email` is only for creating an account**: with a credential already resolvable it is REFUSED rather than obeyed, because the two can name different organizations and preferring either one silently writes into an org the caller did not name \u2014 the message says how to do each thing on purpose. Without it, `setup` applies the model to the account you already have. A path positional after the file is accepted and IGNORED with a warning \u2014 `setup` writes nothing to disk \u2014 so a prompt that passes one still runs. **`--json` prints one object on stdout and nothing else** \u2014 what `lotics model apply --json` does (`tables`; `apps`, each with `alias`, `app_id`, `version_id`, `origin`, `address` and `findings`; and `findings`) plus `organization_id`, `workspace_id` and `signin_url`, and a `warnings` array carrying everything the prose form would have said out of band, such as a sign-in link that could not be minted. A warning is never merely silenced: when the command fails with an error before it can emit, the ones it had collected go to stderr alongside it. Reachable with no install: `npx -y @lotics/cli setup \u2026`. |\n| `lotics model apply <model.json> [--app <alias> ...] [--json]` | **The model, applied to this workspace, through the `apply_model` tool.** The file is read and checked against the model's own rules with the validator the server runs, every problem in one run, before anything is uploaded. **The apply refuses an app leaving out a treatment its rows call for** (`lotics docs design`) \u2014 judged by the server beside the workspace's rows, before it writes anything \u2014 until the app adopts it or states why not under the `declines` key the refusal names; the refusal carries each refused app's patch adopting its decisions, to merge in the order printed. Where the model's own rules pass, one refusal carries everything decidable before the first write \u2014 those decisions, what compiling each app finds, a field that cannot leave its table and what the caller may not change \u2014 so one pass fixes them. Documents a row attaches by a path beside the file are uploaded first and the rows sent with their `fil_` ids; a path this workspace already recorded keeps its id, so a re-apply uploads nothing twice. **Where the file was pulled (`-o`) or applied in this workspace before, only what it changed since is sent**, as a `patch`: what changed in the workspace since and the file does not touch stays. An item named by its `alias` that the file puts in a new place \u2014 an act among an app's acts, a field between two others \u2014 is sent as a move beside the patch: inside an app it is built into the app, an option of a select takes its new place among that select's options on the table, and a table's fields and views, the roles, the templates and the apps themselves keep the order the workspace holds, said as a note. A list whose items carry no `alias` \u2014 an app's columns, a section's fields, the sections \u2014 is sent whole in its new order. What the file takes out is sent as a removal: it goes where an apply rebuilds it (an app's acts and columns, a write rule), a field leaves its table, and it is refused, naming the tool that deletes it, where an apply never deletes it (a table, a view, an app); an option leaves every app and stays on its table, said in the notes. **A field the file no longer states leaves its table** \u2014 a field an earlier apply stated, or one the pulled file stated \u2014 only where no live row holds a value in it and nothing outside the model's own apps reads it: no formula, rollup or lookup, no figure's unit or currency, no `default_from` copy, no unique set, no query, agent, table check or workflow body of the workspace. A row in the trash does not count, since no write can clear it: its value goes with the field, and the notes say how many rows it went for. Otherwise nothing is applied and the refusal names the field, how many live rows hold a value and what reads it; a workflow body the author wrote on an app the apply rebuilds that still names the field keeps it on the table, said in the apply's findings, and the next apply sends its removal again until nothing names it. A field of the table no model ever stated is left as it is. **A label the file changes is a rename**: a field's and a select option's label, and a table's description, are written onto the table as the file states them, each named in the notes. **A declared workflow whose `inputs` or `outputs` the file changes** keeps the body set on it where the body still meets them; where it does not, the apply lands and the workflow stands on no body again \u2014 every call refused \u2014 until `set_app_workflow` sets one that does, said on the app's line. A file stating a `null` a patch would read as a removal sends the whole model, said on stderr, and so does a reorder sent to a server that takes no move. A patch builds the apps it states or moves an item of, each other app whose build it changes and each app whose live version names a field or option its tables no longer hold, `--app` naming others; one whose every key and move lies inside one app's body leaves the tables as they stand \u2014 its `tables` is empty \u2014 and checks and builds that app alone, beside any other app whose build reads what it changed. The copy each change is read against is kept per workspace and file under `~/.lotics/model_bases`: an apply narrowed by `--app` leaves in it the other apps as they were, so the next apply sends their edits again, and an apply that fails \u2014 refused, or cut off \u2014 leaves none, so the next sends the whole model. Then the tool adopts or creates every table (the table this workspace bound the entity to, else an existing table of the same label, is ADOPTED and given the fields, options and views it lacks; no stored value changes), writes first rows only where every bound table is empty, and mints a new version of each app the model declares, or the patch builds \u2014 `--app` (repeatable, comma-separated) narrows which apps, while the tables are applied whole. Prints one line per app it built \u2014 alias, `app_id`, `created`/`updated` with the version minted or `unchanged`, and the address it is served at \u2014 then the model's notes once, as the server states them. **What it would change, writing nothing, is `lotics model check`.** **A rollback restores an app's earlier version** (`lotics run rollback_app`); table changes and data writes stay. Resolves and ANNOUNCES its workspace first. `--json` prints `{workspace_id, tables, apps, findings}` on stdout, or `{ok: false, findings}` when the file does not check. |\n| `lotics model check <model.json> [--app <alias> ...] [--json]` | **What applying the model would change, through the `check_model` tool, writing nothing.** The file is read and checked as `model apply` checks it, then sent the same way \u2014 whole, or as what it changed since its base \u2014 and nothing is uploaded or kept. It prints what the apply would do to the schema (what it would add, each kind counted \u2014 tables, fields, options, constraints \u2014 what it leaves as the workspace has it, what the two disagree about), which apps it would create or update, what it would refuse an app for \u2014 the decisions among its findings, read beside the workspace's rows, with each refused app's patch \u2014 and what it would refuse of the model beside its apps (a field that cannot leave its table, a template nothing stores), all in the one run, exiting 1 when it would refuse anything; its notes name each field it would take off a table and each label it would rename; workflow bodies are checked only at apply, since they name fields a check has not created. `check_model` only reads, so a key holding read access alone runs this where `model apply` is refused, and so does a private instance whose licence admits reads only: it needs `schema:read`, and `data:read` when the file states an app or is sent as what it changed. Resolves and ANNOUNCES its workspace first. `--json` prints `{workspace_id, tables, apps, findings}` \u2014 each table and app what the apply would do, an app the patches change carrying its body as they leave it as `draft` \u2014 and `designs`, each refused app's patch in merge order, or `{ok: false, findings}` when the file does not check. |\n| `lotics model pull [-o <model.json>]` | **This workspace's model, rebuilt from what owns each part** \u2014 the tables, fields, options, templates and roles the workspace holds, how rows are recognised, and each app's body from its current version \u2014 through the `get_model` tool, as the file `model apply` reads: to stdout, or to the file `-o` names. What the workspace holds that a model cannot state is printed on stderr, never written into the file. Applying what it wrote changes nothing. With `-o`, what it wrote is the copy the next `model apply` of that file reads its changes against. |\n| `lotics app create <name> --custom [path]` | **A custom-code app**: creates the app (`POST /v1/apps`), scaffolds a Vite + React + TypeScript project into `[path]` (default `./<name>`, refused when not empty \u2014 before the app row exists) that depends on `@lotics/app-sdk` alone and draws with plain React, and installs it (`npm install --ignore-scripts`), then writes the declarations of the app's live bindings (`get_app_types`) into `.lotics/`, which the project's `tsconfig.json` includes. `package.json#lotics` names the app and its workspace, which is how `app deploy` in that directory finds both. The app has no version until the first `lotics app deploy`. `--custom` is required: an app the runtime draws from a model is made by `lotics model apply`. The SDK's reference is `node_modules/@lotics/app-sdk/AGENTS.md` inside the project. |\n| `lotics app pull [app_id] [path]` | **A custom-code app's live source, as a project ready to deploy on it.** The target is `[path]`, else this directory when it is the app's project (or no app is named), else `./<name>`. **The app's own project is brought up to date in place** \u2014 but only when it holds no edit since the version `package.json#lotics.current_version_id` names: its source (packed as a deploy packs it) is compared with that version's archive, ignoring `.lotics/` and `package.json#lotics`, and any difference refuses the pull, naming the changed files; a pull never merges, so local work is never lost. Already at the live version is a no-op that says so. **An empty or new directory receives the source whole**; any other directory is refused. Downloads come from `GET /v1/apps/{id}/versions/{version_id}/source`. `package.json#lotics` is then set to exactly the app, its workspace and the pulled version, dropping every other key an older CLI wrote there, so the next `lotics app deploy` builds on the live version; then `.lotics/` is written (`get_app_types`) and dependencies installed (`npm ci` with a lockfile, else `npm install`, both `--ignore-scripts`). A JSON app has no source tree: the server's refusal names `get_model`, and `lotics model pull` is its pull. |\n| `lotics app deploy [-m <message>]` | **Build this directory and upload it as a new version of the live app.** Rewrites `.lotics/` with the declarations of the app's live bindings (`get_app_types`, replacing each file there), then runs the project's `npm run typecheck` (warned about when absent; a type error in the app's own files stops the deploy, one inside an installed package is reported and does not) and `npm run build`, tars the source (without `node_modules`, `dist`, `.git`, `*.tsbuildinfo`) and `dist/`, and posts both to `POST /v1/apps/{id}/versions` on the version `package.json#lotics.current_version_id` names, then stamps the new one there. The version carries the app's queries, workflows, agents and capabilities forward unchanged \u2014 those are written through their tools. A project with no `build` script, or whose `package.json#lotics` still declares `queries`, `workflows`, `agents` or `capabilities`, is refused before anything is built; the refusal names the tool that sets each. **A 409 because another version went live since this directory's last deploy** (a deploy from elsewhere, a rollback) prints the server's sentence and the version that is live, and names `lotics app pull`: run in this directory, it brings an unedited project up to date, and lists the files a project with edits changed, to carry over into a fresh pull. `-m` (or a bare positional) is the version's message, optional. The workspace comes from `package.json#lotics.workspace_id` unless `--workspace` / `LOTICS_WORKSPACE` names another. |\n| `lotics docs` \\| `lotics docs <area>[/<section>]` \\| `lotics docs [<area>[/<section>]] --grep <text>` | **This CLI's own references, carried inside the binary** \u2014 the model reference, this index, and every doc under `docs/` \u2014 so the doc a reader opens describes the binary answering, listed by the job a reader comes to do. Capped at ONE PAGE: a doc that does not fit prints its opening and the addresses of what it holds (`lotics docs <area>/<section>`, each section's size beside it, or a table's row names), and every address prints within a page. **A reference the binary's copy lacks, or a part of one the server serves, is read from the server's `docs` tool** with this machine's credential, after the copy's refusal \u2014 a page the server added since this binary was built, which a server refusal can cite. A name matching more than one reference, or a part missing from a guide to this CLI, is answered by the copy alone. **`--grep` searches the references the server serves** (not this CLI's own guides, which it refuses), with this machine's credential, narrowed to the area or section named: literal text unless `--regex`, with `--case-sensitive`, `--diacritic-insensitive`, `--context-lines <n>` and `--limit <n>` \u2014 the dialect `grep_knowledge` reads \u2014 each hit under the address that opens its page; any of those options without `--grep` is refused. A custom-code app's SDK reference ships inside `@lotics/app-sdk` in the app's `node_modules`. |\n| `lotics upgrade` | Update this CLI in place. Runs the same installer a person would, chosen by how THIS copy arrived: an npm install upgrades through npm, a script install re-runs the script \u2014 the runtime knows which (the executable is compiled, the npm bin runs under node), so nobody has to. It downloads nothing itself; resolving a version, verifying the checksum and replacing a running executable already exist in the installers, and a second copy of that inside the binary would be a second thing to get right. Replacing the binary while it runs is safe \u2014 a rename leaves the running image mapped on unix, and on Windows the installer moves the old aside precisely because the file is in use. Already current is a no-op that says so. Needs no auth. |\n| `lotics docs model` \\| `lotics docs model/<section>[/\u2026]` | **The model reference, from inside the binary** \u2014 it describes this CLI's own model checker, at this CLI's version; `lotics docs` lists it under \"Build an app\", after `design`. Its first page is what a model composes with, the working order (jobs \u2192 entities and fields \u2192 `records` \u2192 one app per job \u2192 `model apply`) and the section addresses; every page of it is whole. Every top-level key of a `model.json`, every field `type` the contract admits with the config each one needs, the option / view / role / inline-template shapes, `records` (how a row of each entity is recognised), `write_rules`, `apps` (each register, record, act and check), the row format (relative dates `@today` / `@month-start` with whole-day offsets; links as `\"<entity-alias>:<ref>\"`), the rules, and one complete worked example; it points at `https://lotics.ai/presets/index.json` for complete example models of several trades. **Offline, no account.** |\n| `lotics report '<json>'` \\| `lotics report @report.json` | File a report with the Lotics team about what got in your way. **Covers the classes telemetry structurally cannot see**: a capability that does not exist (no command ran, so nothing was recorded), a command that exited 0 having done the wrong thing, an error whose message did not name the remedy, and anything that made authoring slower than it should be. **A frame, not a paragraph** \u2014 `{goal, actual, expected?, tried?, wanted?}`, `goal` and `actual` required, unknown keys dropped rather than refused. **No severity or category.** Ingest is inline JSON, `@file`, or `-` for stdin. A bare sentence is refused with the frame printed beside it, so the fix is one step; a bare invocation prints the frame BEFORE asking for a credential, since someone whose key will not resolve is exactly who has something to report. **Not spooled**: unlike telemetry it posts inline, prints whether it landed, and exits non-zero if it did not, echoing the report back so a failed send never loses it. Runs regardless of `LOTICS_TELEMETRY` \u2014 invoking it IS the consent that passive collection needs an opt-in for \u2014 but with telemetry off there are no recorded commands to attach, and it says so rather than implying context it does not have. Requires auth. Never paste records, file contents, or credentials. **Prints the id of each frame filed** \u2014 a filing nobody can cite cannot be answered about. The ids come from the server, so an instance that only logs the frames prints the count alone; the CLI never mints one of its own, which would hand back a token that resolves to nothing. |\n\n";
|
|
46680
46892
|
|
|
46681
46893
|
// docs/data_model.md
|
|
46682
|
-
var data_model_default = '# The data model \u2014 tables, their fields, and how they relate\n\nThe decisions here outlive any one app, and most become expensive the moment a second screen depends\non them. They stand apart from building an app on purpose: **every workspace starts with tables\nand many never get an app**, so schema design is not a chapter of app building.\n\nThe rules below share one signature. **Both sides read correctly on their own**, so nothing reports\nthe problem \u2014 no error, no empty column, no failing query. Each is found by looking for it. Then,\nunder **Fields**, what each field type takes.\n\n## One fact, one column\n\n**Read the table\'s existing fields first, and add nothing that stores a fact the table already\nstores.** A value written as text and the same value held as a `select_record_link` are one fact in\ntwo columns \u2014 a customer\'s city typed into a text box beside a link to the city record, a status\nword beside the select that decides it, a total beside the formula that computes it.\n\nTwo columns for one fact do not stay equal. Some writer sets only one of them, and nothing reports\nthe divergence: both rows still look correct on their own. A reader that then matches on the text\nhalf treats "Acme" and "Acme Ltd" as different records, so an import creates a duplicate every time\nit runs.\n\n- **Prefer the link, the select, or the formula.** Text is a RENDERING of a record; compose it when\n you read, rather than storing it a second time.\n- **Renaming, retyping or re-pointing the existing field beats adding another.** A field\'s key is\n stable, so a rename breaks nothing that addresses it by key.\n- **Superseding a field means DELETING it**, not leaving it beside its replacement with a\n description that says which one is real.\n- **Empty is not the same as redundant.** A field nothing fills may still be the only home for a\n real distinction \u2014 read what it MEANS before removing it.\n\n## One entity, one table \u2014 and the test is measurable\n\nVariation belongs in a column \u2014 a multi-select role, a kind, a stage \u2014 not in a second table. Two\ntables for one kind of thing give the same real-world entity two rows, two ids and two halves of its\nhistory, and each screen shows whichever half it happens to link to.\n\nSplit tables are often right. A supplier book beside a customer book is a normal shape, and merging\non suspicion is a large repoint bought for nothing. So do not argue it in the abstract:\n\n> **List both tables\' names and look for one that appears in both.**\n\nNone means the split is holding. One means it has broken \u2014 the usual cause is a party you begin to\ninvoice as well as buy from \u2014 and the fix is to merge before a second screen depends on the copy.\n\nWorth writing as a test rather than a note, because a note about a condition nobody re-checks goes\nstale in silence.\n\n## One vocabulary wherever values are COPIED between tables\n\nTwo `select` fields for one concept carry DIFFERENT option keys even when their labels match \u2014 keys\nare minted per field. So anything moving a value between them needs a hand-written key map.\n\nThat map is code. Put it in one named module with a test; written inline at the copy it is invisible,\nuntested, and silently wrong the first time somebody renames an option, because a rename leaves the\nkey intact and the map still compiling. Prefer a link to a shared reference table where the set is\nopen or growing; keep a map only for a small closed set.\n\nWhere one side genuinely holds MORE values than the other, that is not drift \u2014 it is the model\ntelling the truth. The wider side must **refuse** what the narrower one cannot express rather than\nquietly picking the nearest value.\n\n## A copy boundary accounts for EVERY source field\n\nEach field on the source gets a column on the destination, a deliberate drop with the reason written\ndown, or a refusal.\n\nA field with nowhere to land is data destroyed at the boundary, and it is invisible afterwards: the\ndestination is not empty and not obviously wrong \u2014 just a number that no longer agrees with where it\ncame from.\n\n## Provenance is a LINK, not a flag and not a copy\n\nA row created BY another row carries a link to it.\n\nThat link is what makes "is this the estimate or the actual", "where did this come from" and "have we\nalready imported this" answerable at all. A boolean records that something was true once; a link\nstays true, survives a rename, and lets the next write UPDATE the original instead of adding a second\nrow beside it.\n\n## Say what makes two rows the SAME row\n\nDeclare the natural key in the table\'s description.\n\nAnything that imports, reconciles or de-duplicates has to decide identity, and with no declared key\nit falls back to comparing displayed text \u2014 which is how one company arrives three times under three\nspellings. Name the key: a reference number, a tax id, a link plus a period. Then match on `rec_\u2026`\nand `opt_\u2026`, never on rendered labels.\n\n## A state\'s HISTORY is rows, not columns\n\nA `changed at` column says only how long a row has been where it is now \u2014 the next move overwrites\nit \u2014 and a date column per state holds until something re-enters a state it already left.\n\nMeasuring time-in-state or conversion needs one ROW per move: a link to the subject, the state left,\nthe state entered, when. Hold those states as the source field\'s own `opt_` keys so the log carries\nno second vocabulary, and write the row in the workflow that makes the move.\n\n## Keep derived chains shallow\n\nFormulas and rollups are computed and STORED when a row is written, and one that reads another\nrecomputes with it. A rollup over a formula over a formula is paid three times on every touch, and\nagain for every row upstream of it.\n\n**Depth costs more than row count.** This is the optimisation lever that actually exists here; row\nscanning is the platform\'s problem, chain depth is yours.\n\n## Changing a money formula on a live table\n\nFormula edits recompute every row, so the only honest proof that one changed nothing it should not is\nthe numbers themselves:\n\n1. Snapshot the affected totals to a file.\n2. Make the change.\n3. Diff. Identical is the pass.\n\nAnd when a formula gains a new field, **test that the value IS the one you want, never that it\ndiffers from it** \u2014 an empty cell reads as `""`, which differs from every option key, so the inverted\nspelling silently zeroes every row written before the field existed.\n\n## Fields\n\nWhat `create_table` (on the CLI or in chat) and `update_table` take in `add_fields`, and `update_table` in `update_fields`.\n\n### Types and formats\n\n`type` is one of `text`, `number`, `date`, `boolean`, `select`, `select_member`,\n`select_record_link`, `files`, `formula`, `rollup`, `lookup`, `autonumber`. `button` is retired: an\nexisting button field keeps running, but none is created, converted to or edited.\n\nA URL, an email, markdown, a checkbox, a datetime, money, a quantity or a percentage is a `format`\nor a `notation` on another type, never a `type`:\n\n| Wanted | Field |\n|---|---|\n| URL or external link | `{ type: "text", format: "link" }` |\n| Email or phone | `{ type: "text" }` |\n| Markdown | `{ type: "text", format: "markdown" }` |\n| Checkbox | `{ type: "boolean" }` |\n| Money | `{ type: "number", notation: { style: "currency", currency: "USD" } }` |\n| Quantity | `{ type: "number", notation: { style: "unit", unit: "kg" } }` |\n| Percentage | `{ type: "number", notation: { style: "unit", unit: "percent" } }` |\n| Datetime | `{ type: "date", format: "datetime" }` |\n| Date range | `{ type: "date", format: "date_range" }` |\n\n### Properties\n\nA type\'s properties sit **directly on the field object** \u2014 there is no `config` wrapper. A property\nmay itself hold an object (`formula`, `aggregate_option`, `filter`, `order_by`); its inner keys stay\ninside it. Each type takes only its own:\n\n- **text** \u2014 `format?` (`"text"` | `"link"` | `"markdown"`), `unique?`, `default_value?` (a string).\n- **number** \u2014 `notation?`, `default_value?` (a number). `notation` is how the figure reads, one\n of three; on `update_fields` a stated one replaces the field\'s whole.\n - `{ style: "decimal" }` \u2014 a plain number, as a field stating none reads.\n - `{ style: "currency", currency: "VND" }` \u2014 money in an ISO 4217 code.\n - `{ style: "unit", unit }` \u2014 a quantity: `"percent"` (10 reads "10%", never multiplied), a\n measured code \u2014 g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day \u2014 or a counted noun such\n as `ki\u1EC7n`. A change between two units of one dimension converts every stored figure; any other\n change relabels.\n - A currency or unit read on each row is `{ per_row: "\u0110VT" }` in its place: a single select on\n the same row, or a lookup of one through a one-link, named by name or key, whose chosen option\n is that row\'s currency or unit \u2014 every option label an ISO 4217 code, or a unit as `unit`\n takes one.\n- **date** \u2014 `format?` (`"date"` | `"datetime"` | `"date_range"` | `"datetime_range"`), `timezone?`,\n `derive_from?`, `default_value?` (a date string). `derive_from: "created_at"` stamps the row\'s\n creation once, `"updated_at"` re-stamps on every update; the field is then read-only, takes no\n `default_value`, and holds only the `date` and `datetime` formats.\n- **boolean** \u2014 `default_value?` (`true` | `false`).\n- **select** \u2014 `options` `[{ name, color?, mark? }]`, `multi?`, `default_value?`. An option stated without a `color` gets one no sibling option holds.\n- **select_member** \u2014 `multi?`, `default_value?` (member ids).\n- **select_record_link** \u2014 `table_id`, `sync_both_ways?`, `cardinality?`, `paired_field_name?`. A\n link shows the row it names by the one field its table names its rows by \u2014 the table\'s\n `title_field_key`, stated when the table is made or changed, or by `records.<entity>.title` in the\n model; a link states no display fields of its own, and a combined name is a formula field named there.\n `sync_both_ways: true` on an existing one-way link makes it two-way \u2014 never add a second link for\n that. `cardinality: "one"` holds a single row, paired or not; a paired partner of a `"one"` side\n lists that side\'s rows as its children. Two paired sides cannot both be `"one"`. `paired_field_name`\n names the back-reference the target gets.\n- **files** \u2014 no properties.\n- **autonumber** \u2014 `template` (`"INV-{YEAR}-{N:4}"`; tokens `{N}`, `{N:W}` zero-padded to W,\n `{YEAR}`, `{YEAR:2}`, `{MONTH}`, `{DAY}`), or `prefix` + `padding` (1\u201320) for `PREFIX-0001`.\n- **any type**, at create \u2014 `confirm_before_update?`: a person confirms each later edit.\n\n`default_value` fills the field on a NEW record that states no value; existing records are never\nbackfilled, and null clears it. A select\'s or a member field\'s default is an ARRAY even when the\nfield holds one (`["Unread"]`, never `"Unread"`) \u2014 option names in `add_fields`, where the keys do\nnot exist yet, and option keys (`opt_\u2026`) in `update_fields`.\n\n`default_from` (text, number, date, boolean, select, select_member, select_record_link) copies a\nvalue onto a NEW record off the row one of its links names: `{ link_field_key, field_key,\noptions? }`, the link of cardinality `"one"` and not itself copied, the source a field of the linked\ntable of this field\'s own type, date format and notation (a link one to the same table) \u2014 a formula,\na rollup, or a lookup through a one-row link (or an ordered one) read as the value it holds; several\nvalues only into a field holding several; never into a date `derive_from` stamps. It is\ncopied when the record is made and never re-read, so a later change to the source leaves the record\nalone (a line\'s price as it was when the line was booked). A value the write states wins, then the\ncopy, then `default_value`. A select source\'s `options` maps its option keys onto this field\'s\n(`update_fields`, once the keys exist); an option left unmapped is not copied. null clears it. Deleting the link a\ncopy reads through, or the field it copies off, is refused even with `force` until the copy is\ncleared; the dependency report lists the copying field as `copy_link` or `copy_source` under\n`requires_manual_action`. Any other schema change that leaves a copy unable to stand \u2014 its source\nretyped, its link made to hold many \u2014 is refused, naming the copy.\n\n### Computed fields\n\nRead-only in records. `formula` is one key holding an object; a rollup\'s and a lookup\'s properties\nare separate keys on the field \u2014 `rollup: {\u2026}` and `lookup: {\u2026}` are refused as unrecognized.\n\nformula: { expression, notation?, link? }\n\n- `{Field Name}` or `{fld_key}` names a field of the same table, stored as its key, so a rename never\n breaks the formula. A reference to no field, or a call to something that is no helper, is refused.\n- A select reads as an ARRAY of option keys: `{Status}[0]` for a single select,\n `includes({Tags}, "opt_\u2026")` for a multi.\n- The operators, the helpers and how an empty cell reads are the `model` reference, section `formula` \u2014 a model\n names fields by alias where a table tool names them by name or key; the language is the same.\n- `notation` is how a number result reads, as a number field\'s; `link: true` says the result is a\n URL, drawn as a link that opens.\n- On `update_fields` a key left out keeps its stored value, and a stated `notation` replaces the\n stored one whole. `get_table` marks a formula that is null when every field it reads is empty.\n\nrollup \u2014 `source_field_key`, `aggregate_option: { field_key?, operation }`, `filter?`\n\n- `source_field_key` is a `select_record_link` of this table; `aggregate_option.field_key` is a\n field of the linked table, required by every operation but `count`, which counts linked records.\n- Operations by the aggregated field\'s type \u2014 none: `count`; any: `empty`, `filled`,\n `percent_empty`, `percent_filled`, `unique`, `percent_unique`; number: `sum`, `avg`, `median`,\n `min`, `max`, `range`; date: `earliest`, `latest`, `date_range`.\n- The cell\'s type comes from the OPERATION: `earliest` and `latest` hold a date, every other\n operation a number (`date_range` counts days). A "most recent linked date" is `latest` \u2014 `min` and\n `max` are numeric and refuse a date. A rollup takes no notation of its own: `sum` over money\n reads in the aggregated field\'s currency, over a weight in its unit, a count as a plain number\n and a `percent_*` in the unit `percent`.\n- Over a figure read in each row\'s own unit or currency (a notation\'s `per_row`), `sum`,\n `avg`, `median`, `min`, `max` and `range` hold only where that select is a lookup, through the\n link paired with `source_field_key`, of a single select on this table \u2014 the total reads in this\n row\'s option of it. A lookup of such a field has no unit.\n- `filter` aggregates only the linked records it matches: a full group over the LINKED table\'s\n fields \u2014 `{ node_type: "group", logic, children: [{ node_type: "condition", type, field_key,\n operator, value }] }`, a select condition using `has_any_of` with an ARRAY value.\n\nlookup \u2014 `source_field_key`, `lookup_field_key`, `order_by?`\n\n- `lookup_field_key` is a field of the linked table. Without `order_by` the cell holds every linked\n record\'s value; with `order_by: { field_key, direction }` (`desc` latest, `asc` earliest) it holds\n the picked field of the single extreme record \u2014 a "latest linked X" that maintains itself.\n Ordered lookups sharing one `order_by` resolve to the SAME record.\n\n### Examples\n\n```\n{ name: "Gi\xE1 b\xE1n", type: "number", notation: { style: "currency", currency: "VND" } }\n{ name: "Tr\u1ECDng l\u01B0\u1EE3ng", type: "number", notation: { style: "unit", unit: "kg" } }\n{ name: "S\u1ED1 l\u01B0\u1EE3ng", type: "number", notation: { style: "unit", unit: { per_row: "\u0110VT" } } }\n{ name: "Chi\u1EBFt kh\u1EA5u", type: "number", notation: { style: "unit", unit: "percent" } }\n{ name: "Tr\u1EA1ng th\xE1i", type: "select", options: [{ name: "M\u1EDBi" }, { name: "Xong" }] }\n{ name: "M\xE3 \u0111\u01A1n", type: "autonumber", template: "SR-{YEAR}-{N:4}" }\n{ name: "Kh\xE1ch h\xE0ng", type: "select_record_link", table_id: "tbl_x", sync_both_ways: true }\n{ name: "Total", type: "formula", formula: { expression: "{Price} * {Qty}", notation: { style: "currency", currency: "VND" } } }\n{ name: "SL \u0111\xE3 giao", type: "rollup", source_field_key: "Giao h\xE0ng", aggregate_option: { operation: "sum", field_key: "S\u1ED1 l\u01B0\u1EE3ng" } }\n{ name: "Customer Name", type: "lookup", source_field_key: "Customer", lookup_field_key: "Name" }\n{ name: "Latest note", type: "lookup", source_field_key: "Calls", lookup_field_key: "Note", order_by: { field_key: "At", direction: "desc" } }\n```\n\n### Changing a field\n\nA field added by `update_table` shows in a view only when `add_to_views` names it, at the view\'s far\nright; on the CLI or in chat, `update_view` with `move_field` places it beside the columns it belongs with.\n\nAn `update_fields` entry is `{ field_key, name?, description?, convert_to?, \u2026 }` with the same flat\nproperties as `add_fields`, plus what only an update does:\n\n- A select\'s options change through `add_options` `[{ name, color?, mark? }]`, `update_options`\n `[{ key, name?, color?, mark? }]`, `remove_option_keys` and `reorder_options` (every existing\n option once, in order; options added in the same call follow). An option is named by its `opt_\u2026`\n key (its name also resolves); a rename keeps every record\'s value. `mark` is the option\'s brand\n (`{ kind: "brand", name: "tiktok" }`) or kit glyph (`{ kind: "icon", name: "wrench" }`), drawn in\n place of its colour dot \u2014 every option of a field has one or none does, so marking sets them all\n in one call and `mark: null` on each clears them. `distinct_option_colors: true` re-colours a\n select so every option holds its own: the first option of each colour keeps it, the rest take\n colours no option holds.\n- A link\'s `sync_both_ways: false` disconnects the pair; a new `table_id` re-points it and clears its\n record data; `cardinality` is `"one"` for the child side of a parent-child pair, `"many"` for peers.\n';
|
|
46894
|
+
var data_model_default = '# The data model \u2014 tables, their fields, and how they relate\n\nThe decisions here outlive any one app, and most become expensive the moment a second screen depends\non them. They stand apart from building an app on purpose: **every workspace starts with tables\nand many never get an app**, so schema design is not a chapter of app building.\n\nThe rules below share one signature. **Both sides read correctly on their own**, so nothing reports\nthe problem \u2014 no error, no empty column, no failing query. Each is found by looking for it. Then,\nunder **Fields**, what each field type takes.\n\n## One fact, one column\n\n**Read the table\'s existing fields first, and add nothing that stores a fact the table already\nstores.** A value written as text and the same value held as a `select_record_link` are one fact in\ntwo columns \u2014 a customer\'s city typed into a text box beside a link to the city record, a status\nword beside the select that decides it, a total beside the formula that computes it.\n\nTwo columns for one fact do not stay equal. Some writer sets only one of them, and nothing reports\nthe divergence: both rows still look correct on their own. A reader that then matches on the text\nhalf treats "Acme" and "Acme Ltd" as different records, so an import creates a duplicate every time\nit runs.\n\n- **Prefer the link, the select, or the formula.** Text is a RENDERING of a record; compose it when\n you read, rather than storing it a second time.\n- **Renaming, retyping or re-pointing the existing field beats adding another.** A field\'s key is\n stable, so a rename breaks nothing that addresses it by key.\n- **Superseding a field means DELETING it**, not leaving it beside its replacement with a\n description that says which one is real.\n- **Empty is not the same as redundant.** A field nothing fills may still be the only home for a\n real distinction \u2014 read what it MEANS before removing it.\n\n## One entity, one table \u2014 and the test is measurable\n\nVariation belongs in a column \u2014 a multi-select role, a kind, a stage \u2014 not in a second table. Two\ntables for one kind of thing give the same real-world entity two rows, two ids and two halves of its\nhistory, and each screen shows whichever half it happens to link to.\n\nSplit tables are often right. A supplier book beside a customer book is a normal shape, and merging\non suspicion is a large repoint bought for nothing. So do not argue it in the abstract:\n\n> **List both tables\' names and look for one that appears in both.**\n\nNone means the split is holding. One means it has broken \u2014 the usual cause is a party you begin to\ninvoice as well as buy from \u2014 and the fix is to merge before a second screen depends on the copy.\n\nWorth writing as a test rather than a note, because a note about a condition nobody re-checks goes\nstale in silence.\n\n## One vocabulary wherever values are COPIED between tables\n\nTwo `select` fields for one concept carry DIFFERENT option keys even when their labels match \u2014 keys\nare minted per field. So anything moving a value between them needs a hand-written key map.\n\nThat map is code. Put it in one named module with a test; written inline at the copy it is invisible,\nuntested, and silently wrong the first time somebody renames an option, because a rename leaves the\nkey intact and the map still compiling. Prefer a link to a shared reference table where the set is\nopen or growing; keep a map only for a small closed set.\n\nWhere one side genuinely holds MORE values than the other, that is not drift \u2014 it is the model\ntelling the truth. The wider side must **refuse** what the narrower one cannot express rather than\nquietly picking the nearest value.\n\n## A copy boundary accounts for EVERY source field\n\nEach field on the source gets a column on the destination, a deliberate drop with the reason written\ndown, or a refusal.\n\nA field with nowhere to land is data destroyed at the boundary, and it is invisible afterwards: the\ndestination is not empty and not obviously wrong \u2014 just a number that no longer agrees with where it\ncame from.\n\n## Provenance is a LINK, not a flag and not a copy\n\nA row created BY another row carries a link to it.\n\nThat link is what makes "is this the estimate or the actual", "where did this come from" and "have we\nalready imported this" answerable at all. A boolean records that something was true once; a link\nstays true, survives a rename, and lets the next write UPDATE the original instead of adding a second\nrow beside it.\n\n## Say what makes two rows the SAME row\n\nDeclare the natural key in the table\'s description.\n\nAnything that imports, reconciles or de-duplicates has to decide identity, and with no declared key\nit falls back to comparing displayed text \u2014 which is how one company arrives three times under three\nspellings. Name the key: a reference number, a tax id, a link plus a period. Then match on `rec_\u2026`\nand `opt_\u2026`, never on rendered labels.\n\n## A state\'s HISTORY is rows, not columns\n\nA `changed at` column says only how long a row has been where it is now \u2014 the next move overwrites\nit \u2014 and a date column per state holds until something re-enters a state it already left.\n\nMeasuring time-in-state or conversion needs one ROW per move: a link to the subject, the state left,\nthe state entered, when. Hold those states as the source field\'s own `opt_` keys so the log carries\nno second vocabulary, and write the row in the workflow that makes the move.\n\n## Keep derived chains shallow\n\nFormulas and rollups are computed and STORED when a row is written, and one that reads another\nrecomputes with it. A rollup over a formula over a formula is paid three times on every touch, and\nagain for every row upstream of it.\n\n**Depth costs more than row count.** This is the optimisation lever that actually exists here; row\nscanning is the platform\'s problem, chain depth is yours.\n\n## Changing a money formula on a live table\n\nFormula edits recompute every row, so the only honest proof that one changed nothing it should not is\nthe numbers themselves:\n\n1. Snapshot the affected totals to a file.\n2. Make the change.\n3. Diff. Identical is the pass.\n\nAnd when a formula gains a new field, **test that the value IS the one you want, never that it\ndiffers from it** \u2014 an empty cell reads as `""`, which differs from every option key, so the inverted\nspelling silently zeroes every row written before the field existed.\n\n## Fields\n\nWhat `create_table` (on the CLI or in chat) and `update_table` take in `add_fields`, and `update_table` in `update_fields`.\n\n### Types and formats\n\n`type` is one of `text`, `number`, `date`, `boolean`, `select`, `select_member`,\n`select_record_link`, `files`, `formula`, `rollup`, `lookup`, `autonumber`. `button` is retired: an\nexisting button field keeps running, but none is created, converted to or edited.\n\nA URL, an email, markdown, a checkbox, a datetime, money, a quantity or a percentage is a `format`\nor a `notation` on another type, never a `type`:\n\n| Wanted | Field |\n|---|---|\n| URL or external link | `{ type: "text", format: "link" }` |\n| Email or phone | `{ type: "text" }` |\n| Markdown | `{ type: "text", format: "markdown" }` |\n| Checkbox | `{ type: "boolean" }` |\n| Money | `{ type: "number", notation: { style: "currency", currency: "USD" } }` |\n| Quantity | `{ type: "number", notation: { style: "unit", unit: "kg" } }` |\n| Percentage | `{ type: "number", notation: { style: "unit", unit: "percent" } }` |\n| Datetime | `{ type: "date", format: "datetime" }` |\n| Date range | `{ type: "date", format: "date_range" }` |\n\n### Properties\n\nA type\'s properties sit **directly on the field object** \u2014 there is no `config` wrapper. A property\nmay itself hold an object (`formula`, `aggregate_option`, `filter`, `order_by`); its inner keys stay\ninside it. Each type takes only its own:\n\n- **text** \u2014 `format?` (`"text"` | `"link"` | `"markdown"`), `unique?`, `default_value?` (a string).\n- **number** \u2014 `notation?`, `default_value?` (a number). `notation` is how the figure reads, one\n of three; on `update_fields` a stated one replaces the field\'s whole.\n - `{ style: "decimal" }` \u2014 a plain number, as a field stating none reads.\n - `{ style: "currency", currency: "VND" }` \u2014 money in an ISO 4217 code.\n - `{ style: "unit", unit }` \u2014 a quantity: `"percent"` (10 reads "10%", never multiplied), a\n measured code \u2014 g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day \u2014 or a counted noun such\n as `ki\u1EC7n`. A change between two units of one dimension converts every stored figure; any other\n change relabels.\n - A currency or unit read on each row is `{ per_row: "\u0110VT" }` in its place: a single select on\n the same row, or a lookup of one through a one-link, named by name or key, whose chosen option\n is that row\'s currency or unit \u2014 every option label an ISO 4217 code, or a unit as `unit`\n takes one.\n- **date** \u2014 `format?` (`"date"` | `"datetime"` | `"date_range"` | `"datetime_range"`), `timezone?`,\n `derive_from?`, `default_value?` (a date string). `derive_from: "created_at"` stamps the row\'s\n creation once, `"updated_at"` re-stamps on every update; the field is then read-only, takes no\n `default_value`, and holds only the `date` and `datetime` formats.\n- **boolean** \u2014 `default_value?` (`true` | `false`).\n- **select** \u2014 `options` `[{ name, color?, mark? }]`, `multi?`, `default_value?`. An option stated without a `color` gets one no sibling option holds.\n- **select_member** \u2014 `multi?`, `default_value?` (member ids).\n- **select_record_link** \u2014 `table_id`, `sync_both_ways?`, `cardinality?`, `paired_field_name?`. A\n link shows the row it names by the one field its table names its rows by \u2014 the table\'s\n `title_field_key`, stated when the table is made or changed, or by `records.<entity>.title` in the\n model; a link states no display fields of its own, and a combined name is a formula field named there.\n `sync_both_ways: true` on an existing one-way link makes it two-way \u2014 never add a second link for\n that. `cardinality: "one"` holds a single row, paired or not; a paired partner of a `"one"` side\n lists that side\'s rows as its children. Two paired sides cannot both be `"one"`. `paired_field_name`\n names the back-reference the target gets.\n- **files** \u2014 no properties.\n- **autonumber** \u2014 `template` (`"INV-{YEAR}-{N:4}"`; tokens `{N}`, `{N:W}` zero-padded to W,\n `{YEAR}`, `{YEAR:2}`, `{MONTH}`, `{DAY}`), or `prefix` + `padding` (1\u201320) for `PREFIX-0001`.\n- **any type**, at create \u2014 `confirm_before_update?`: a person confirms each later edit.\n\n`default_value` fills the field on a NEW record that states no value; existing records are never\nbackfilled, and null clears it. A select\'s or a member field\'s default is an ARRAY even when the\nfield holds one (`["Unread"]`, never `"Unread"`) \u2014 option names in `add_fields`, where the keys do\nnot exist yet, and option keys (`opt_\u2026`) in `update_fields`.\n\n`default_from` (text, number, date, boolean, select, select_member, select_record_link) copies a\nvalue onto a NEW record off the row one of its links names: `{ link_field_key, field_key,\noptions? }`, the link of cardinality `"one"` and not itself copied, the source a field of the linked\ntable of this field\'s own type, date format and notation (a link one to the same table) \u2014 a formula,\na rollup, or a lookup through a one-row link (or an ordered one) read as the value it holds; several\nvalues only into a field holding several; never into a date `derive_from` stamps. It is\ncopied when the record is made and never re-read, so a later change to the source leaves the record\nalone (a line\'s price as it was when the line was booked). A value the write states wins, then the\ncopy, then `default_value`. A select source\'s `options` maps its option keys onto this field\'s\n(`update_fields`, once the keys exist); an option left unmapped is not copied. null clears it. Deleting the link a\ncopy reads through, or the field it copies off, is refused even with `force` until the copy is\ncleared; the dependency report lists the copying field as `copy_link` or `copy_source` under\n`requires_manual_action`. Any other schema change that leaves a copy unable to stand \u2014 its source\nretyped, its link made to hold many \u2014 is refused, naming the copy.\n\n### Computed fields\n\nRead-only in records. `formula` is one key holding an object; a rollup\'s and a lookup\'s properties\nare separate keys on the field \u2014 `rollup: {\u2026}` and `lookup: {\u2026}` are refused as unrecognized.\n\nformula: { expression, notation?, link? }\n\n- `{Field Name}` or `{fld_key}` names a field of the same table, stored as its key, so a rename never\n breaks the formula. A reference to no field, or a call to something that is no helper, is refused.\n- A select reads as an ARRAY of option keys: `{Status}[0]` for a single select,\n `includes({Tags}, "opt_\u2026")` for a multi.\n- The operators, the helpers and how an empty cell reads are the `model` reference, section `formula` \u2014 a model\n names fields by alias where a table tool names them by name or key; the language is the same.\n- `notation` is how a number result reads, as a number field\'s; `link: true` says the result is a\n URL, drawn as a link that opens.\n- On `update_fields` a key left out keeps its stored value, and a stated `notation` replaces the\n stored one whole. `get_table` marks a formula that is null when every field it reads is empty.\n\nrollup \u2014 `source_field_key`, `aggregate_option: { field_key?, operation }`, `filter?`\n\n- `source_field_key` is a `select_record_link` of this table; `aggregate_option.field_key` is a\n field of the linked table, required by every operation but `count`, which counts linked records.\n- Operations by the aggregated field\'s type \u2014 none: `count`; any: `empty`, `filled`,\n `percent_empty`, `percent_filled`, `unique`, `percent_unique`; number: `sum`, `avg`, `median`,\n `min`, `max`, `range`; date: `earliest`, `latest`, `date_range`.\n- The cell\'s type comes from the OPERATION: `earliest` and `latest` hold a date, every other\n operation a number (`date_range` counts days). A "most recent linked date" is `latest` \u2014 `min` and\n `max` are numeric and refuse a date. A rollup takes no notation of its own: `sum` over money\n reads in the aggregated field\'s currency, over a weight in its unit, a count as a plain number\n and a `percent_*` in the unit `percent`.\n- Over a figure read in each row\'s own unit or currency (a notation\'s `per_row`), `sum`,\n `avg`, `median`, `min`, `max` and `range` hold only where that select is a lookup, through the\n link paired with `source_field_key`, of a single select on this table \u2014 the total reads in this\n row\'s option of it. A lookup of such a field stands only where its own table also looks up that select through the same one-link, and reads in that lookup: a line looks up the item\'s unit through its link to the item, then may look up the item\'s stock through the same link.\n- `filter` aggregates only the linked records it matches: a full group over the LINKED table\'s\n fields \u2014 `{ node_type: "group", logic, children: [{ node_type: "condition", type, field_key,\n operator, value }] }`, a select condition using `has_any_of` with an ARRAY value.\n\nlookup \u2014 `source_field_key`, `lookup_field_key`, `order_by?`\n\n- `lookup_field_key` is a field of the linked table. Without `order_by` the cell holds every linked\n record\'s value; with `order_by: { field_key, direction }` (`desc` latest, `asc` earliest) it holds\n the picked field of the single extreme record \u2014 a "latest linked X" that maintains itself.\n Ordered lookups sharing one `order_by` resolve to the SAME record.\n\n### Examples\n\n```\n{ name: "Gi\xE1 b\xE1n", type: "number", notation: { style: "currency", currency: "VND" } }\n{ name: "Tr\u1ECDng l\u01B0\u1EE3ng", type: "number", notation: { style: "unit", unit: "kg" } }\n{ name: "S\u1ED1 l\u01B0\u1EE3ng", type: "number", notation: { style: "unit", unit: { per_row: "\u0110VT" } } }\n{ name: "Chi\u1EBFt kh\u1EA5u", type: "number", notation: { style: "unit", unit: "percent" } }\n{ name: "Tr\u1EA1ng th\xE1i", type: "select", options: [{ name: "M\u1EDBi" }, { name: "Xong" }] }\n{ name: "M\xE3 \u0111\u01A1n", type: "autonumber", template: "SR-{YEAR}-{N:4}" }\n{ name: "Kh\xE1ch h\xE0ng", type: "select_record_link", table_id: "tbl_x", sync_both_ways: true }\n{ name: "Total", type: "formula", formula: { expression: "{Price} * {Qty}", notation: { style: "currency", currency: "VND" } } }\n{ name: "SL \u0111\xE3 giao", type: "rollup", source_field_key: "Giao h\xE0ng", aggregate_option: { operation: "sum", field_key: "S\u1ED1 l\u01B0\u1EE3ng" } }\n{ name: "Customer Name", type: "lookup", source_field_key: "Customer", lookup_field_key: "Name" }\n{ name: "Latest note", type: "lookup", source_field_key: "Calls", lookup_field_key: "Note", order_by: { field_key: "At", direction: "desc" } }\n```\n\n### Changing a field\n\nA field added by `update_table` shows in a view only when `add_to_views` names it, at the view\'s far\nright; on the CLI or in chat, `update_view` with `move_field` places it beside the columns it belongs with.\n\nAn `update_fields` entry is `{ field_key, name?, description?, convert_to?, \u2026 }` with the same flat\nproperties as `add_fields`, plus what only an update does:\n\n- A select\'s options change through `add_options` `[{ name, color?, mark? }]`, `update_options`\n `[{ key, name?, color?, mark? }]`, `remove_option_keys` and `reorder_options` (every existing\n option once, in order; options added in the same call follow). An option is named by its `opt_\u2026`\n key (its name also resolves); a rename keeps every record\'s value. `mark` is the option\'s brand\n (`{ kind: "brand", name: "tiktok" }`) or kit glyph (`{ kind: "icon", name: "wrench" }`), drawn in\n place of its colour dot \u2014 every option of a field has one or none does, so marking sets them all\n in one call and `mark: null` on each clears them. `distinct_option_colors: true` re-colours a\n select so every option holds its own: the first option of each colour keeps it, the rest take\n colours no option holds.\n- A link\'s `sync_both_ways: false` disconnects the pair; a new `table_id` re-points it and clears its\n record data; `cardinality` is `"one"` for the child side of a parent-child pair, `"many"` for peers.\n';
|
|
46683
46895
|
|
|
46684
46896
|
// docs/filters.md
|
|
46685
46897
|
var filters_default = '# Filters \u2014 choosing records by their fields\n\nOne grammar for every tool that takes a filter: `query_records`, `aggregate_records`, `update_records`\nand `delete_records` by filter, a view\'s filter, a rollup\'s filter, and the filters a caller passes\nto an app\'s query.\n\n## The shape\n\nA filter is a single condition, or a group of conditions.\n\n```\n{ "node_type": "condition", "field_key": "Status", "operator": "has_any_of", "value": ["Done"] }\n{ "node_type": "group", "logic": "and" | "or", "children": [ \u2026conditions or groups ] }\n```\n\nGroups nest up to 4 levels. AND(OR(status = A, status = B), age > 40):\n\n```\n{ "node_type": "group", "logic": "and", "children": [\n { "node_type": "group", "logic": "or", "children": [cond1, cond2] },\n cond3\n] }\n```\n\nEvery `field_key` resolves against the table being filtered \u2014 read each table\'s fields (`get_table`)\nand carry no name across tables: sibling tables holding the same concept routinely name it\ndifferently. A field is named by its `fld_\u2026` key or by its name (`"Status"`).\n\n## Text\n\n| Operators | Value |\n|---|---|\n| `equals`, `not_equals`, `contains`, `does_not_contain`, `starts_with`, `ends_with` | a string |\n| `is_any_of`, `is_none_of` | a string array \u2014 exact, case-insensitive |\n| `contains_any_of` | a string array \u2014 the cell contains any of them, case- and accent-insensitive |\n| `is_empty`, `is_not_empty` | none |\n\n```\n{ "node_type": "condition", "field_key": "Title", "operator": "is_any_of", "value": ["hello", "world"] }\n```\n\nA text value is a string, never an array; `is_any_of` matches several. Its array has no length cap \u2014\npass the whole list in one condition rather than splitting it across calls.\n\n## Number\n\n| Operators | Value |\n|---|---|\n| `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_or_equal_to`, `less_than_or_equal_to` | a number |\n| `is_empty`, `is_not_empty` | none |\n\nA number whose `notation` reads its unit or currency on each row (`{ "per_row": <select> }`) is\nread in each row\'s own, so a comparison on it states `unit_option`: the option of that select its\nvalue is in.\nRows holding another option are out; measured units of one dimension convert.\n\n```\n{ "node_type": "condition", "field_key": "Amount", "operator": "greater_than", "value": 100, "unit_option": "USD" }\n```\n\n## Boolean\n\n`equals` with `true` or `false`.\n\n## Select\n\n| Operators | Value |\n|---|---|\n| `has_any_of` (any of them \u2014 "A or B"), `has_none_of`, `has_all_of` (a multi-select only) | an ARRAY of option names, even for one |\n| `is_empty`, `is_not_empty` | none |\n\n```\n{ "node_type": "condition", "field_key": "Status", "operator": "has_any_of", "value": ["Done", "In Progress"] }\n```\n\n## Member\n\n| Operators | Value |\n|---|---|\n| `has_any_of`, `has_none_of`, `has_all_of` | an array of member ids |\n| `is_current_member`, `is_not_current_member`, `is_empty`, `is_not_empty` | none |\n\n## Date\n\n| Operators | Value |\n|---|---|\n| `before`, `after`, `on_or_before`, `on_or_after`, `on`, `starts_before`, `starts_after`, `ends_before`, `ends_after` | a point |\n| `between`, `overlaps`, `contains`, `within` | `{ start: point \\| null, end: point \\| null }` |\n| `time_of_day` | `{ start_time: "HH:mm" \\| null, end_time: "HH:mm" \\| null }` |\n| `duration_equals`, `duration_greater_than`, `duration_less_than` | `{ amount, unit: "minutes" \\| "hours" \\| "days" }` |\n| `is_empty`, `is_not_empty` | none |\n\nA point is one of:\n\n```\n{ "type": "exact", "date": "2025-03-14", "time": "09:00" } time optional\n{ "type": "relative", "offset": -7, "unit": "minutes" | "hours" | "days" | "weeks" | "months" | "years" }\n{ "type": "period", "period": "day" | "week" | "month" | "quarter" | "year", "boundary": "start" | "end", "offset": 0 }\n```\n\n## Link\n\n| Operators | Value |\n|---|---|\n| `has_any_of` (linked to any \u2014 filters by record identity), `has_none_of`, `has_all_of` (a multi-link only) | an array of record ids (`rec_\u2026`) |\n| `contains`, `not_contains`, `starts_with`, `ends_with` \u2014 deprecated: the text a link stores changes with every rename; filter by record, and by a linked record\'s field through a lookup of it | a string, matched against the linked record\'s display text |\n| `is_empty`, `is_not_empty` | none |\n\n```\n{ "node_type": "condition", "field_key": "Customer", "operator": "has_any_of", "value": ["rec_abc123"] }\n```\n\n## Sort\n\nA view\'s sort is a list, applied in order: `[{ "field_key": "Due", "order": "asc" | "desc" }]`.\n';
|