Skip to main content

Developer reference

Liberty Next → Document → Developer reference describes the running installation from the inside: its tables, its settings, its API routes, its command lines and the links between the pieces of its configuration, read from the code and the configuration in force. It is for the people who support the install — superusers only — and changes nothing.

The page has five tabs — Data model, Configuration, API, Command line, Impact; it opens on Configuration and then on the last tab used.


At a glance​

Developer referenceData modelConfigurationAPICommand lineImpact142 edited in a screen · 21 file / environment only · 0 not in the UIEvery status ▾All sectionsappauthjobschangesetsainotifyoidcKEYEDITED INDEFAULTREAD BYjobs.enabledAdminister → App → nomaflowtrue2jobs.max_upload_mbAdminister → App → nomaflow2001jobs.files_dirFile / environment only—3jobs.poolAdminister → App → nomaflowdefault2Five tabsmodel, settings, API, CLI, impactSectionswith their gapsStatus filteredited, file only, missingWhere it is editeda click opens the detail

Data model​

The tables of the framework, then the tables each connector declares, grouped by connector, each with its number of columns. A search finds a table, a column or a label.

A table shows its physical table, its key, the queries that read it and what uses it — screens, dashboards, charts, jobs, Explorer models —, its related tables, then its columns: Column, Label (from the dictionary), Type, References, Screens, Description.


Configuration​

Every setting of the install, by section, with its type, its default and its description.

ColumnMeaning
Key, Label, Type, DefaultThe setting.
Edited inThe page that edits it — Administer → App → Sign-in —, or File / environment only with the reason, or Not in the UI.
Read byThe places in the code that use it.

The header counts the settings edited in a screen, those set in the file or the environment only, and those missing from the interface; the status filter keeps one kind. A click on a row opens its detail, with the code that reads it.


API​

Every route of the server, by module: Method, Path, Summary, Module and Access — public, any signed-in user, superuser, a permission or a role, read from the code. A click on a route opens its parameters, its request and its response, and the place of its handler. For the main read routes — connectors, menus, screens, external addresses, the Data Explorer, Nomaflow jobs and runs — the Response section gives the shape of the JSON returned, with an example. The buttons in the header open the interactive API documentation of the server.

The search runs across every module and shows, per group, the number of matches.


Command line​

Every command installed with the server — liberty-admin, liberty-ops, liberty-connectors, liberty-crypto, liberty-license… —, read from its argument parser. On the left, the commands with a search, folded by default, with Expand all / Collapse all.

A command shows what it does, its usage with Copy, the Options of every command, then each sub-command with its arguments: Argument, Value, Default, required, repeatable. Under Docker, ./liberty wraps the installation, the upgrade, the backups and the database: see Operations. The command-line section of the technical report is built from the same reading.


Impact​

Every entity of the configuration with what it uses and what uses it, followed through: what a change to a pool, a query, a screen or a dictionary entry reaches. The links are the ones the Package dependency walk follows.

On the left, the entities by kind — pools, connectors, queries, API endpoints, dictionary entries, lookups, sequences, enums, screens, menu items, charts, dashboards, shared actions, Explorer models, jobs, notification rules, AI blocks —, folded by default, with a search (scope.name). Unused only keeps the entities nothing points at — menu items, jobs, notification rules, pools, Explorer models and dictionary entries, opened or reached otherwise, are never counted as unused —, and Referenced but not defined lists the references to an entity that does not exist.

A picked entity shows:

PartContent
Headeruses N · used by N, and Open in editor, which goes to its builder.
A change here reachesThe entities reached, counted by kind: a query → its screens → the menu items opening them, the charts → their dashboards, the jobs and actions running it.
Used byThe tree of what uses it, level by level (up to 8 levels).
UsesWhat it uses directly.
Everything it needsEvery entity it depends on, followed through.

A click on an entity of the tree re-centres the view on it; Back returns to the previous one. A dictionary entry has no explicit reference: a column reaches its entry by name.