Skip to content

.rk schemas ​

Every kind of .rk file, generated from schema/0.5.

KindLives inWhat it is
app.rkapps/<app>/app.rkWhat 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.rksent 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.rkLayer 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.rkapps/<app>/dashboards/<name>.rkA dashboard file: apps/<app>/dashboards/<name>.rk
features.rk<site>/features.rkLayer 4: plans and the entitlements they grant (apps, capabilities, limits)
flow.rkmodules/<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.rkmodules/<module>/imports/<name>.rkTurns the rows of an uploaded CSV or XLSX file into records of one model (contract 0012).
layout.rk<site>/layouts/<name>.rkLayer 6: the app shell and pages built from UI blocks
letterhead.rk<site>/letterhead.rk or <site>/letterheads/<org>.rkRangka letterhead
model.rkmodules/<module>/models/<model>.rkRangka model
module.rkmodules/<module>/module.rkA reusable business unit (modules/<name>/module.rk): models, rules, flows and roles
overlay.rk<site>/custom/<model>.rkCompany layer (layer 4): fields, rules and view tweaks an organisation adds to an app model, in <site>/custom/<model>.rk
print.rkmodules/<module>/print/<name>.rk or <site>/print/<name>.rkRangka print format
process.rkapps/<app>/processes/<name>.rk, modules/<module>/processes/<name>.rk or <site>/processes/<name>.rkRangka process
role.rkmodules/<module>/roles/<role>.rk or apps/<app>/roles/<role>.rkA role an app defines (apps/<app>/roles/<role>.rk)
screen.rkmodules/<module>/screens/<name>.rkA 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.rkLayer 2: which backend capabilities are on and which driver serves each
template.rktemplates/<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>.rkLayer 6: colours, type and density for an installation or one organisation

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