screen.rk
A work screen a module ships in screens/<name>.rk (contract 0030): one staff job on a phone or tablet, rendered by the web app from one of seven types. It writes only through the record API, so permissions, row scope, rules, flows and approvals apply as for a form.
Lives in modules/<module>/screens/<name>.rk · Schema screen.json (source) · first line: # yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/screen.json
Properties
| Property | Type | Meaning |
|---|---|---|
name required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
type required | counter · queue · roll · route · handover · clock · entry | |
label required | label | A label in Bahasa Indonesia (required) and optionally English. |
label.id required | string | |
label.en | string | |
description | label | A label in Bahasa Indonesia (required) and optionally English. |
description.id required | string | |
description.en | string | |
icon | string | |
roles required | list of name | Roles that may open the screen (the owner always may) at least 1 |
device | phone · tablet · any | Layout hint, never a lock |
needs | list of scan · photo · location · signature · print | Device capabilities; the screen still opens without them, with a notice |
offline | none · queue · edge | |
if | string | CEL over user (and org, tax); false hides the screen |
entry | object | A short phone form: fill, save, next (contract 0030 §2) |
entry.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
entry.fields required | list of name | at least 1, at most 8 |
entry.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
entry.submit | boolean | Submit the record after saving it (the model must be submittable) |
entry.again | boolean | After saving, open an empty form again (default true) |
counter | object | Sell or take payment at a counter: catalogue, cart, tender, receipt (contract 0030 §2) |
counter.catalogue required | object | |
counter.catalogue.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.filter | string | List filter (field names, CEL) over the catalogue model, with user |
counter.catalogue.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.search | list of name | |
counter.catalogue.group_by | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.price required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.barcode | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.image | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.catalogue.available | name or object | What is left to sell: a number field of the catalogue model (contract 0034), or a balance model read for the open session's outlet (contract 0039). The card shows 'Sisa N' at 5 or less and 'Habis' at 0 or less; it never blocks a sale |
counter.catalogue.limit | integer | Rows loaded (default 500) min 1, max 2000 |
counter.document required | object | |
counter.document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.lines required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.line required | object | |
counter.document.line.item required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.line.qty required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.line.price | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.line.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
counter.document.total | name | The document's total field (a number); the receipt panel shows the server's value pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.change | name | The document's change field (a number); the receipt panel shows the server's value pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.document.summary | list of name | Number fields of the document shown under the cart, in this order, as POST /api/v1/compute answers them; the last one is the total line (contract 0034) at most 8 |
counter.payments | object | |
counter.payments.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.payments.method required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.payments.amount required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.payments.ref | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.payments.methods | list of string | at least 1 |
counter.session | object | |
counter.session.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.session.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.session.filter | string | List filter for the caller's open session, e.g. cashier == user.email |
counter.session.state required | object | |
counter.session.state.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.session.state.open required | string | |
counter.session.state.closed | string | |
counter.session.open | list of name | |
counter.session.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
counter.session.close | object | |
counter.session.close.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.session.close.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.session.close.fields required | list of name | |
counter.session.close.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
counter.session.blind | boolean | The cashier counts cash without seeing the expected amount (default true) |
counter.hold | boolean | |
counter.customer | object | |
counter.customer.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.customer.required | boolean | |
counter.print | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
counter.submit | boolean | |
queue | object | Work through cards that change state: kitchen tickets, today's jobs (contract 0030 §2) |
queue.source required | object | |
queue.source.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
queue.source.filter | string | List filter (field names, CEL, with user and today()) |
queue.source.sort | string | List sort, e.g. created_at or -date |
queue.source.limit | integer | min 1, max 500 |
queue.card required | object | |
queue.card.title required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
queue.card.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
queue.card.lines | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
queue.card.line | list of name | |
queue.card.fields | list of name | |
queue.card.age_from | string | A date or datetime field (or created_at, modified_at) the card's age counts from |
queue.steps required | list of object | at least 1 |
queue.steps[].when required | string | CEL over the card's record |
queue.steps[].label required | label | A label in Bahasa Indonesia (required) and optionally English. |
queue.steps[].label.id required | string | |
queue.steps[].label.en | string | |
queue.steps[].action | string | submit, or an action of the model |
queue.steps[].set | map of string or number or boolean | field: literal value |
queue.columns | object | |
queue.columns.by required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
queue.columns.values | list of string | |
queue.refresh | integer | Seconds between refreshes (default 10) min 3, max 300 |
roll | object | One parent, many rows marked fast or added by scan: class attendance, stock count, receiving (contract 0030 §2) |
roll.document required | object | The parent record: picked among find:, opened by ?doc=, or created |
roll.document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.document.find | string | List filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly |
roll.document.create | boolean | Offer "Mulai baru": create a parent with set: (default false) |
roll.document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
roll.document.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.document.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.document.sort | string | |
roll.rows required | object | |
roll.rows.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.rows.label required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.rows.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.rows.qty | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.rows.mark | object | A select field of the row marked with one tap; rows start at default |
roll.rows.mark.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.rows.mark.values | list of string | |
roll.rows.mark.default | string | |
roll.add_by | scan · search · none | |
roll.scan | object | Adds a row by camera, scanner or search: field is the row's link filled, match the field of the linked model that holds the code (default its name) |
roll.scan.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.scan.match | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
roll.submit | boolean | |
route | object | Today's stops: visit, check in, act there (contract 0030 §2) |
route.stops required | object | |
route.stops.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.stops.filter | string | List filter (field names, CEL, with user and today()) |
route.stops.sort | string | |
route.stops.limit | integer | min 1, max 500 |
route.stops.title required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.stops.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.stops.address | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.stops.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.visit | object | The check-in record made at a stop |
route.visit.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.visit.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.visit.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
route.visit.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.visit.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.visit.submit | boolean | |
route.actions required | list of object | Open another screen for the stop (?stop=) or create a record from it; set: may read stop at least 1 |
route.actions[].label required | label | A label in Bahasa Indonesia (required) and optionally English. |
route.actions[].label.id required | string | |
route.actions[].label.en | string | |
route.actions[].screen | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.actions[].create | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
route.actions[].set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
handover | object | Hand items over with proof: rental out/in, proof of delivery (contract 0030 §2) |
handover.document required | object | The parent record: picked among find:, opened by ?doc=, or created |
handover.document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.document.find | string | List filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly |
handover.document.create | boolean | Offer "Mulai baru": create a parent with set: (default false) |
handover.document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
handover.document.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.document.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.document.sort | string | |
handover.rows required | object | |
handover.rows.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.rows.unit required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.rows.condition | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.rows.qty | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.rows.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.scan | object | A scanned code adds the unit whose match field (default its name) holds it |
handover.scan.match | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.photos | object | field: an image field of the document (the first photo); every photo is an attachment of the document |
handover.photos.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.photos.min | integer | min 0, max 10 |
handover.signature | object | field: a signature field of the document; by: the field naming the signer |
handover.signature.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.signature.by | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
handover.print | string | |
handover.submit | boolean | |
clock | object | Clock in and out at a site (contract 0030 §2) |
clock.record required | object | |
clock.record.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.record.filter | string | List filter (field names, CEL, with user and today()) |
clock.record.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
clock.in required | object | field: a datetime field set at the press; location: a geo field; photo: an image field |
clock.in.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.in.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.in.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.out required | object | field: a datetime field set at the press; location: a geo field; photo: an image field |
clock.out.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.out.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.out.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.site | object | Where the user clocks: link is the record's link to the site model, location its geo field, radius_m its radius |
clock.site.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.site.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.site.filter | string | List filter (field names, CEL, with user and today()) |
clock.site.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.site.location required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.site.radius_m required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.reason | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
clock.submit | boolean | Submit the record after clock-out (default false) |
entry
A short phone form: fill, save, next (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
fields required | list of name | at least 1, at most 8 |
set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
submit | boolean | Submit the record after saving it (the model must be submittable) |
again | boolean | After saving, open an empty form again (default true) |
counter
Sell or take payment at a counter: catalogue, cart, tender, receipt (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
catalogue required | object | |
catalogue.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.filter | string | List filter (field names, CEL) over the catalogue model, with user |
catalogue.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.search | list of name | |
catalogue.group_by | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.price required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.barcode | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.image | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
catalogue.available | name or object | What is left to sell: a number field of the catalogue model (contract 0034), or a balance model read for the open session's outlet (contract 0039). The card shows 'Sisa N' at 5 or less and 'Habis' at 0 or less; it never blocks a sale |
catalogue.limit | integer | Rows loaded (default 500) min 1, max 2000 |
document required | object | |
document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.lines required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.line required | object | |
document.line.item required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.line.qty required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.line.price | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.line.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
document.total | name | The document's total field (a number); the receipt panel shows the server's value pattern ^[a-z][a-z0-9_]{0,62}$ |
document.change | name | The document's change field (a number); the receipt panel shows the server's value pattern ^[a-z][a-z0-9_]{0,62}$ |
document.summary | list of name | Number fields of the document shown under the cart, in this order, as POST /api/v1/compute answers them; the last one is the total line (contract 0034) at most 8 |
payments | object | |
payments.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
payments.method required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
payments.amount required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
payments.ref | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
payments.methods | list of string | at least 1 |
session | object | |
session.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
session.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
session.filter | string | List filter for the caller's open session, e.g. cashier == user.email |
session.state required | object | |
session.state.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
session.state.open required | string | |
session.state.closed | string | |
session.open | list of name | |
session.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
session.close | object | |
session.close.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
session.close.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
session.close.fields required | list of name | |
session.close.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
session.blind | boolean | The cashier counts cash without seeing the expected amount (default true) |
hold | boolean | |
customer | object | |
customer.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
customer.required | boolean | |
print | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
submit | boolean |
queue
Work through cards that change state: kitchen tickets, today's jobs (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
source required | object | |
source.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
source.filter | string | List filter (field names, CEL, with user and today()) |
source.sort | string | List sort, e.g. created_at or -date |
source.limit | integer | min 1, max 500 |
card required | object | |
card.title required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
card.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
card.lines | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
card.line | list of name | |
card.fields | list of name | |
card.age_from | string | A date or datetime field (or created_at, modified_at) the card's age counts from |
steps required | list of object | at least 1 |
steps[].when required | string | CEL over the card's record |
steps[].label required | label | A label in Bahasa Indonesia (required) and optionally English. |
steps[].label.id required | string | |
steps[].label.en | string | |
steps[].action | string | submit, or an action of the model |
steps[].set | map of string or number or boolean | field: literal value |
columns | object | |
columns.by required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
columns.values | list of string | |
refresh | integer | Seconds between refreshes (default 10) min 3, max 300 |
roll
One parent, many rows marked fast or added by scan: class attendance, stock count, receiving (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
document required | object | The parent record: picked among find:, opened by ?doc=, or created |
document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.find | string | List filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly |
document.create | boolean | Offer "Mulai baru": create a parent with set: (default false) |
document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
document.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.sort | string | |
rows required | object | |
rows.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.label required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.qty | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.mark | object | A select field of the row marked with one tap; rows start at default |
rows.mark.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.mark.values | list of string | |
rows.mark.default | string | |
add_by | scan · search · none | |
scan | object | Adds a row by camera, scanner or search: field is the row's link filled, match the field of the linked model that holds the code (default its name) |
scan.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
scan.match | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
submit | boolean |
handover
Hand items over with proof: rental out/in, proof of delivery (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
document required | object | The parent record: picked among find:, opened by ?doc=, or created |
document.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.find | string | List filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly |
document.create | boolean | Offer "Mulai baru": create a parent with set: (default false) |
document.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
document.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
document.sort | string | |
rows required | object | |
rows.table required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.unit required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.condition | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.qty | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
rows.note | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
scan | object | A scanned code adds the unit whose match field (default its name) holds it |
scan.match | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
photos | object | field: an image field of the document (the first photo); every photo is an attachment of the document |
photos.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
photos.min | integer | min 0, max 10 |
signature | object | field: a signature field of the document; by: the field naming the signer |
signature.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
signature.by | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
print | string | |
submit | boolean |
clock
Clock in and out at a site (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
record required | object | |
record.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
record.filter | string | List filter (field names, CEL, with user and today()) |
record.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
in required | object | field: a datetime field set at the press; location: a geo field; photo: an image field |
in.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
in.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
in.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
out required | object | field: a datetime field set at the press; location: a geo field; photo: an image field |
out.field required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
out.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
out.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
site | object | Where the user clocks: link is the record's link to the site model, location its geo field, radius_m its radius |
site.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
site.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
site.filter | string | List filter (field names, CEL, with user and today()) |
site.title | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
site.location required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
site.radius_m required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
reason | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
submit | boolean | Submit the record after clock-out (default false) |
route
Today's stops: visit, check in, act there (contract 0030 §2)
| Property | Type | Meaning |
|---|---|---|
stops required | object | |
stops.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
stops.filter | string | List filter (field names, CEL, with user and today()) |
stops.sort | string | |
stops.limit | integer | min 1, max 500 |
stops.title required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
stops.subtitle | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
stops.address | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
stops.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
visit | object | The check-in record made at a stop |
visit.model required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
visit.link required | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
visit.set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
visit.location | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
visit.photo | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
visit.submit | boolean | |
actions required | list of object | Open another screen for the stop (?stop=) or create a record from it; set: may read stop at least 1 |
actions[].label required | label | A label in Bahasa Indonesia (required) and optionally English. |
actions[].label.id required | string | |
actions[].label.en | string | |
actions[].screen | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
actions[].create | name | snake_case, never renamed once released pattern ^[a-z][a-z0-9_]{0,62}$ |
actions[].set | map of string | field: CEL over user, org, tax, today(), now() and the record the screen was opened for (stop, doc), evaluated by the kernel when the screen opens |
Generated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.