Skip to content

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 ​

PropertyTypeMeaning
name requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
type requiredcounter · queue · roll · route · handover · clock · entry
label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
label.id requiredstring
label.enstring
descriptionlabelA label in Bahasa Indonesia (required) and optionally English.
description.id requiredstring
description.enstring
iconstring
roles requiredlist of nameRoles that may open the screen (the owner always may)
at least 1
devicephone · tablet · anyLayout hint, never a lock
needslist of scan · photo · location · signature · printDevice capabilities; the screen still opens without them, with a notice
offlinenone · queue · edge
ifstringCEL over user (and org, tax); false hides the screen
entryobjectA short phone form: fill, save, next (contract 0030 §2)
entry.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
entry.fields requiredlist of name
at least 1, at most 8
entry.setmap of stringfield: 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.submitbooleanSubmit the record after saving it (the model must be submittable)
entry.againbooleanAfter saving, open an empty form again (default true)
counterobjectSell or take payment at a counter: catalogue, cart, tender, receipt (contract 0030 §2)
counter.catalogue requiredobject
counter.catalogue.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.filterstringList filter (field names, CEL) over the catalogue model, with user
counter.catalogue.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.searchlist of name
counter.catalogue.group_bynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.price requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.barcodenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.imagenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.catalogue.availablename or objectWhat 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.limitintegerRows loaded (default 500)
min 1, max 2000
counter.document requiredobject
counter.document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.lines requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.line requiredobject
counter.document.line.item requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.line.qty requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.line.pricenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.line.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.setmap of stringfield: 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.totalnameThe document's total field (a number); the receipt panel shows the server's value
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.changenameThe document's change field (a number); the receipt panel shows the server's value
pattern ^[a-z][a-z0-9_]{0,62}$
counter.document.summarylist of nameNumber 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.paymentsobject
counter.payments.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.payments.method requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.payments.amount requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.payments.refnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.payments.methodslist of string
at least 1
counter.sessionobject
counter.session.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.session.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.session.filterstringList filter for the caller's open session, e.g. cashier == user.email
counter.session.state requiredobject
counter.session.state.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.session.state.open requiredstring
counter.session.state.closedstring
counter.session.openlist of name
counter.session.setmap of stringfield: 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.closeobject
counter.session.close.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.session.close.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.session.close.fields requiredlist of name
counter.session.close.setmap of stringfield: 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.blindbooleanThe cashier counts cash without seeing the expected amount (default true)
counter.holdboolean
counter.customerobject
counter.customer.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.customer.requiredboolean
counter.printnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
counter.submitboolean
queueobjectWork through cards that change state: kitchen tickets, today's jobs (contract 0030 §2)
queue.source requiredobject
queue.source.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
queue.source.filterstringList filter (field names, CEL, with user and today())
queue.source.sortstringList sort, e.g. created_at or -date
queue.source.limitinteger
min 1, max 500
queue.card requiredobject
queue.card.title requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
queue.card.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
queue.card.linesnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
queue.card.linelist of name
queue.card.fieldslist of name
queue.card.age_fromstringA date or datetime field (or created_at, modified_at) the card's age counts from
queue.steps requiredlist of object
at least 1
queue.steps[].when requiredstringCEL over the card's record
queue.steps[].label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
queue.steps[].label.id requiredstring
queue.steps[].label.enstring
queue.steps[].actionstringsubmit, or an action of the model
queue.steps[].setmap of string or number or booleanfield: literal value
queue.columnsobject
queue.columns.by requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
queue.columns.valueslist of string
queue.refreshintegerSeconds between refreshes (default 10)
min 3, max 300
rollobjectOne parent, many rows marked fast or added by scan: class attendance, stock count, receiving (contract 0030 §2)
roll.document requiredobjectThe parent record: picked among find:, opened by ?doc=, or created
roll.document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.document.findstringList filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly
roll.document.createbooleanOffer "Mulai baru": create a parent with set: (default false)
roll.document.setmap of stringfield: 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.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.document.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.document.sortstring
roll.rows requiredobject
roll.rows.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.rows.label requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.rows.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.rows.qtynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.rows.markobjectA select field of the row marked with one tap; rows start at default
roll.rows.mark.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.rows.mark.valueslist of string
roll.rows.mark.defaultstring
roll.add_byscan · search · none
roll.scanobjectAdds 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 requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.scan.matchnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
roll.submitboolean
routeobjectToday's stops: visit, check in, act there (contract 0030 §2)
route.stops requiredobject
route.stops.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.stops.filterstringList filter (field names, CEL, with user and today())
route.stops.sortstring
route.stops.limitinteger
min 1, max 500
route.stops.title requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.stops.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.stops.addressnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.stops.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.visitobjectThe check-in record made at a stop
route.visit.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.visit.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.visit.setmap of stringfield: 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.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.visit.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.visit.submitboolean
route.actions requiredlist of objectOpen another screen for the stop (?stop=) or create a record from it; set: may read stop
at least 1
route.actions[].label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
route.actions[].label.id requiredstring
route.actions[].label.enstring
route.actions[].screennamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.actions[].createnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
route.actions[].setmap of stringfield: 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
handoverobjectHand items over with proof: rental out/in, proof of delivery (contract 0030 §2)
handover.document requiredobjectThe parent record: picked among find:, opened by ?doc=, or created
handover.document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.document.findstringList filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly
handover.document.createbooleanOffer "Mulai baru": create a parent with set: (default false)
handover.document.setmap of stringfield: 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.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.document.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.document.sortstring
handover.rows requiredobject
handover.rows.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.rows.unit requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.rows.conditionnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.rows.qtynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.rows.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.scanobjectA scanned code adds the unit whose match field (default its name) holds it
handover.scan.matchnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.photosobjectfield: an image field of the document (the first photo); every photo is an attachment of the document
handover.photos.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.photos.mininteger
min 0, max 10
handover.signatureobjectfield: a signature field of the document; by: the field naming the signer
handover.signature.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.signature.bynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
handover.printstring
handover.submitboolean
clockobjectClock in and out at a site (contract 0030 §2)
clock.record requiredobject
clock.record.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.record.filterstringList filter (field names, CEL, with user and today())
clock.record.setmap of stringfield: 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 requiredobjectfield: a datetime field set at the press; location: a geo field; photo: an image field
clock.in.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.in.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.in.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.out requiredobjectfield: a datetime field set at the press; location: a geo field; photo: an image field
clock.out.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.out.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.out.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.siteobjectWhere the user clocks: link is the record's link to the site model, location its geo field, radius_m its radius
clock.site.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.site.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.site.filterstringList filter (field names, CEL, with user and today())
clock.site.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.site.location requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.site.radius_m requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.reasonnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
clock.submitbooleanSubmit the record after clock-out (default false)

entry ​

A short phone form: fill, save, next (contract 0030 §2)

PropertyTypeMeaning
model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
fields requiredlist of name
at least 1, at most 8
setmap of stringfield: 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
submitbooleanSubmit the record after saving it (the model must be submittable)
againbooleanAfter saving, open an empty form again (default true)

counter ​

Sell or take payment at a counter: catalogue, cart, tender, receipt (contract 0030 §2)

PropertyTypeMeaning
catalogue requiredobject
catalogue.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.filterstringList filter (field names, CEL) over the catalogue model, with user
catalogue.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.searchlist of name
catalogue.group_bynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.price requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.barcodenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.imagenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
catalogue.availablename or objectWhat 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.limitintegerRows loaded (default 500)
min 1, max 2000
document requiredobject
document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.lines requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.line requiredobject
document.line.item requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.line.qty requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.line.pricenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.line.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.setmap of stringfield: 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.totalnameThe document's total field (a number); the receipt panel shows the server's value
pattern ^[a-z][a-z0-9_]{0,62}$
document.changenameThe document's change field (a number); the receipt panel shows the server's value
pattern ^[a-z][a-z0-9_]{0,62}$
document.summarylist of nameNumber 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
paymentsobject
payments.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
payments.method requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
payments.amount requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
payments.refnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
payments.methodslist of string
at least 1
sessionobject
session.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
session.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
session.filterstringList filter for the caller's open session, e.g. cashier == user.email
session.state requiredobject
session.state.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
session.state.open requiredstring
session.state.closedstring
session.openlist of name
session.setmap of stringfield: 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.closeobject
session.close.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
session.close.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
session.close.fields requiredlist of name
session.close.setmap of stringfield: 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.blindbooleanThe cashier counts cash without seeing the expected amount (default true)
holdboolean
customerobject
customer.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
customer.requiredboolean
printnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
submitboolean

queue ​

Work through cards that change state: kitchen tickets, today's jobs (contract 0030 §2)

PropertyTypeMeaning
source requiredobject
source.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
source.filterstringList filter (field names, CEL, with user and today())
source.sortstringList sort, e.g. created_at or -date
source.limitinteger
min 1, max 500
card requiredobject
card.title requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
card.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
card.linesnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
card.linelist of name
card.fieldslist of name
card.age_fromstringA date or datetime field (or created_at, modified_at) the card's age counts from
steps requiredlist of object
at least 1
steps[].when requiredstringCEL over the card's record
steps[].label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
steps[].label.id requiredstring
steps[].label.enstring
steps[].actionstringsubmit, or an action of the model
steps[].setmap of string or number or booleanfield: literal value
columnsobject
columns.by requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
columns.valueslist of string
refreshintegerSeconds 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)

PropertyTypeMeaning
document requiredobjectThe parent record: picked among find:, opened by ?doc=, or created
document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.findstringList filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly
document.createbooleanOffer "Mulai baru": create a parent with set: (default false)
document.setmap of stringfield: 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.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.sortstring
rows requiredobject
rows.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.label requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.qtynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.markobjectA select field of the row marked with one tap; rows start at default
rows.mark.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.mark.valueslist of string
rows.mark.defaultstring
add_byscan · search · none
scanobjectAdds 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 requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
scan.matchnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
submitboolean

handover ​

Hand items over with proof: rental out/in, proof of delivery (contract 0030 §2)

PropertyTypeMeaning
document requiredobjectThe parent record: picked among find:, opened by ?doc=, or created
document.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.findstringList filter of the parent records offered (e.g. today's open drafts of the user); ?doc=<name> opens one directly
document.createbooleanOffer "Mulai baru": create a parent with set: (default false)
document.setmap of stringfield: 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.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
document.sortstring
rows requiredobject
rows.table requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.unit requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.conditionnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.qtynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
rows.notenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
scanobjectA scanned code adds the unit whose match field (default its name) holds it
scan.matchnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
photosobjectfield: an image field of the document (the first photo); every photo is an attachment of the document
photos.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
photos.mininteger
min 0, max 10
signatureobjectfield: a signature field of the document; by: the field naming the signer
signature.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
signature.bynamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
printstring
submitboolean

clock ​

Clock in and out at a site (contract 0030 §2)

PropertyTypeMeaning
record requiredobject
record.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
record.filterstringList filter (field names, CEL, with user and today())
record.setmap of stringfield: 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 requiredobjectfield: a datetime field set at the press; location: a geo field; photo: an image field
in.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
in.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
in.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
out requiredobjectfield: a datetime field set at the press; location: a geo field; photo: an image field
out.field requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
out.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
out.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
siteobjectWhere the user clocks: link is the record's link to the site model, location its geo field, radius_m its radius
site.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
site.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
site.filterstringList filter (field names, CEL, with user and today())
site.titlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
site.location requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
site.radius_m requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
reasonnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
submitbooleanSubmit the record after clock-out (default false)

route ​

Today's stops: visit, check in, act there (contract 0030 §2)

PropertyTypeMeaning
stops requiredobject
stops.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
stops.filterstringList filter (field names, CEL, with user and today())
stops.sortstring
stops.limitinteger
min 1, max 500
stops.title requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
stops.subtitlenamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
stops.addressnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
stops.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
visitobjectThe check-in record made at a stop
visit.model requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
visit.link requirednamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
visit.setmap of stringfield: 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.locationnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
visit.photonamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
visit.submitboolean
actions requiredlist of objectOpen another screen for the stop (?stop=) or create a record from it; set: may read stop
at least 1
actions[].label requiredlabelA label in Bahasa Indonesia (required) and optionally English.
actions[].label.id requiredstring
actions[].label.enstring
actions[].screennamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
actions[].createnamesnake_case, never renamed once released
pattern ^[a-z][a-z0-9_]{0,62}$
actions[].setmap of stringfield: 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.

Rangka OS is source-available under the Elastic License 2.0 (ELv2). Free to self-host.