.rk schemas
Every kind of .rk file, generated from schema/0.5.
| Kind | Lives in | What it is |
|---|---|---|
| app.rk | apps/<app>/app.rk | What a customer installs (apps/<name>/app.rk): the modules it uses, connectors, roles, menu, dashboards, home and onboarding |
| app-overlay.rk | `` | Company layer for an app's menu, in <site>/custom/app.<app>.rk (contract 0049): the company's words for the app's menu groups and sub-menus |
| changeset.rk | sent to /api/v1/changesets (not a file on disk) | A proposed change to metadata: the only way Rangka AI (and the Console) changes a running installation |
| config.rk | <site>/config.rk | Layer 4: defaults for an organisation (company) |
| connector.rk | <connector>/connector.rk (rangka-connectors) | Layer 3: an integration (rangka-connectors/<name>/connector.rk): how to authenticate, the events it triggers and the actions flows can call. |
| dashboard.rk | apps/<app>/dashboards/<name>.rk | A dashboard file: apps/<app>/dashboards/<name>.rk |
| features.rk | <site>/features.rk | Layer 4: plans and the entitlements they grant (apps, capabilities, limits) |
| flow.rk | modules/<module>/flows/<name>.rk (apps may add glue flows) | Durable flow: steps run in order on an event or a schedule, through the queue. |
| import.rk | modules/<module>/imports/<name>.rk | Turns the rows of an uploaded CSV or XLSX file into records of one model (contract 0012). |
| layout.rk | <site>/layouts/<name>.rk | Layer 6: the app shell and pages built from UI blocks |
| letterhead.rk | <site>/letterhead.rk or <site>/letterheads/<org>.rk | Rangka letterhead |
| model.rk | modules/<module>/models/<model>.rk | Rangka model |
| module.rk | modules/<module>/module.rk | A reusable business unit (modules/<name>/module.rk): models, rules, flows and roles |
| overlay.rk | <site>/custom/<model>.rk | Company layer (layer 4): fields, rules and view tweaks an organisation adds to an app model, in <site>/custom/<model>.rk |
| print.rk | modules/<module>/print/<name>.rk or <site>/print/<name>.rk | Rangka print format |
| process.rk | apps/<app>/processes/<name>.rk, modules/<module>/processes/<name>.rk or <site>/processes/<name>.rk | Rangka process |
| role.rk | modules/<module>/roles/<role>.rk or apps/<app>/roles/<role>.rk | A role an app defines (apps/<app>/roles/<role>.rk) |
| screen.rk | modules/<module>/screens/<name>.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 |
| system.rk | <site>/system.rk | Layer 2: which backend capabilities are on and which driver serves each |
| template.rk | templates/<name>/template.rk (0.4, deprecated: now apps/<app>/app.rk) | A starting point for a new installation: the apps to install, connectors, roles, fixtures and onboarding questions. |
| theme.rk | <site>/themes/<name>.rk | Layer 6: colours, type and density for an installation or one organisation |