Skip to content

Glossary ​

The vocabulary the SDK uses to describe its world. Where a term is overloaded in the wider Laravel, UI5 or SAP ecosystem, this page records the SDK's specific meaning.

A ​

Ability ​

A semantic permission — the atomic unit of authorization. Belongs to exactly one artifact and carries an AbilityType. Stored in sdk_abilities.

AbilityType ​

The enum that categorises an ability. Five values are in use: Access (structural — may you open this at all), See (UX visibility), Act (a backend-validated operation), Read (an OData entity set) and, since 3.0, Call (another module calling a released service). Integer-backed; the 0 slot is vacant, left by a retired Use type. See permission levels.

Action ​

The only way anything is written. An Ui5Action artifact with a typed handler and a form request, dispatched over ui5/api/…. OData is read-only in LaravelUi5, so there is no other write path. See mutating actions.

Actor ​

The partner authorization is evaluated as. Under impersonation this differs from the principal. Carried on the SdkContext; read it with $context->actor(), never from Auth::user().

Actor slot value ​

A slot value a person carries — Alice works in EUR, Bob in CHF. Stored in sdk_slot_assignments, one value per actor and slot, no history. See actor slot values.

Artifact ​

A registered UI5 entity: application, library, card, report, tile, analytic tile, dashboard, dashboard group, action, resource, dialog, value help, analytics set, analytic card, chart. Identified by a namespace string, catalogued in sdk_artifacts, and the unit an ability belongs to.

B ​

Automation actor ​

The partner who answers for what nobody started by hand — ui5:sync, ui5:prune, scheduled jobs — recorded as the author of their changes. Named by e-mail in the setting automation_actor; by default Pragmatiqu IT's support department. See configuration.

BusinessTransaction ​

The seal an SDK action handler works inside. The dispatcher opens a database transaction, hands the handler the transaction object, and maps commit or rollback to the business outcome. A handler reports through it rather than committing on its own.

C ​

Capability mini-app ​

A standalone app whose presence in a person's world is gated by one Access ability. The SDK's preferred unit of granularity: if not everyone may use it, it is its own app. Route-gating inside an app is explicitly retired. See capability mini-apps.

CmdK ​

The command palette — the global search surface in the LeanShell, opened with Cmd+K. Discovers; does not decide. See global search.

Concept ​

A LUX Weave identity: this is a Partner, declared with #[Concept] on the class that owns the model. Two modules that name the same concept can navigate to each other without either knowing the other exists. See Weave.

ConceptEntry ​

The single canonical front door to a concept — at most one per concept. "To open a Partner, go here." Declared with #[ConceptEntry].

Configuration ​

The tenant's own values — who holds which role, which units are in use, the company's details. Written at runtime by the implementation consultant or an administrator, per tenant. The counterpart of Customizing, which is the vocabulary; they never share a table. Not to be confused with Laravel's config files (config/ui5.php), which are read at boot and belong to the code.

Context ​

See SdkContext. In the UI5 client, Context also means something else: the control that binds an element to a help topic by UUID.

Customizing ​

Controlled vocabularies declared in code and projected into the database by ui5:sync — partner roles, relationship types, address providers. The table is owned entirely by the code: sync deletes any row nobody declared. Distinct from configuration. See reference catalogs.

D ​

Dashboard ​

A composition of tiles and cards, declared as an artifact and rendered from a manifest the client walks. Contributions from other modules arrive through Weave.

Delegation ​

A row in sdk_delegations permitting one partner to impersonate another, for a bounded window.

Discovery ​

Finding artifacts that match a query. The discovery layer finds; the Security domain decides what may be seen; the constraint is applied in the query, never in PHP afterwards. See visibility and CmdK.

E — H ​

Explain ​

The verbose form of ability resolution: every granted ability carries its source — which role or group produced it, from which assignment row, valid over which window. See the Explain CLI.

Exportable ​

A table-shaped dataset an app can hand over as a download — filename, headings, count, rows. Named in the SDK's own terms so no spreadsheet library reaches a signature. See table export.

Group ​

A structural bundle of roles and abilities, granted as one unit. Stored in sdk_groups.

Help topic ​

A documentation page identified by a UUID, authored at doc/<uuid>/<locale>.md inside the owning module, compiled by ui5:help. See the help concept.

I — L ​

Impersonation ​

Acting inside another partner's context while the original principal is preserved for audit. Always lands on the Launchpad, never on a gated app. See impersonation.

Installation ​

What is identical in every environment of one app: the operator's key and the installation's values — country, base currency, time zone, decimal places. A committed class, app/Installation.php, generated by ui5:intake. See installation and tenant.

Intent ​

A structured request the client sends to the server for a decision — open this artifact, navigate there, start impersonating. Authorized server-side, then handled. Seven ship with the SDK. See intent dispatch.

Launchpad ​

The shipped landing app: the module home, the safe landing for impersonation, and the default post-login destination. Auth-only, no #[Access] gate — by design. See the Launchpad.

Launch tile ​

A tile marked #[Launchpad('<capability>')]: the door to its app on the Launchpad, placed on a capability of the closed catalogue. A module has at most one; a module whose app is a Concept's front door has exactly one. See the Launchpad.

LeanShell ​

The SDK's runtime container around a UI5 app: navigation, context, search, intent dispatch, help and global dialogs. See the shell overview.

LoginRecord ​

The SDK's own DTO for a partner's login state, so nothing above the seam names your User model. See login.

LUX Weave ​

The cross-vendor composition layer — #[Concept], #[ConceptEntry], #[Weave] — that lets modules from different authors navigate into and contribute to each other. See Weave.

M — P ​

Manifest ​

An artifact's JSON descriptor. The SDK extracts ability declarations from it; Core injects the OData data source into it. Generated — edit the source project, not the output.

Module ​

A coherent set of artifacts that ship together, listed in ui5.modules. The module carries the version (VERSION), and every address of its artifacts uses it; an artifact has none of its own. Modules are runtime-only: sdk_artifacts stores artifacts by namespace, with no foreign key to a module.

Operation ​

A released service that is one verb — one method on its interface, always guarded by #[Call], running in its caller's unit of work. Declared with AbstractOperation. See Released Services.

Operator ​

The organisation that runs the installation — the company itself, or its agency. One per host, on OperatorAdmin, written by ui5:intake. See installation and tenant.

Partner ​

A business actor — a person, an organisation or a department, all in sdk_partners. The SDK's generalisation over user / customer / contact / account. Authorization is about partners, not user accounts. See partners.

Platform owner ​

Pragmatiqu IT, whose platform every installation runs on: a row the SDK writes into every database, with its support department. Key and name only, no legal data.

Principal ​

The authenticated identity — who signed in. Distinct from the actor, which is whose permissions apply. They differ only under impersonation.

R — S ​

Read gate ​

Whether an actor may read an OData entity set at all: by the set's own #[Read] ability, else by the app's #[Access] (since 2.0). Separate from scoping, which answers which rows. See the read gate.

Read surface ​

The columns and relations of a model another module may read with a SemVer guarantee, named by #[ReadSurface] on the owner's model. Everything else of the model is internal. See Released Services.

Role ​

A named bag of abilities, stored in sdk_roles, linked through sdk_ability_role. Granted to a partner for a window, optionally in a context. Not to be confused with a partner role (customer, supplier), which is business master data in sdk_partner_roles.

Role scope ​

The context_type / context_id pair on a role assignment: this role, but only for that project. The role says who, the scope says which. See role scope.

Scope (settings) ​

The level a setting applies at, most general to most specific: Platform, Installation, Tenant, Site, User. Resolution walks from specific to general and the first answer wins. See scope precedence.

Scoping (entity sets) ​

Restricting which rows an actor sees, applied in the query by a scope applier. Distinct from the read gate. See scoped entity sets.

SdkContext ​

The immutable per-request context: artifact, tenant, actor, principal, locale, timestamp, the ability snapshot and the settings. Every authorization decision evaluates against one explicitly. Bound by the middleware at the request edge.

Service ​

A facade one module releases for others: a declaration (AbstractService, or AbstractOperation for one verb) naming a plain interface and its final handler, listed in the module's ARTIFACTS. Another module declares it with #[Uses] and takes it from the registry, guarded; it is not bound in the container. Distinct from a Laravel service — an extension point the owner binds with bindIf and a replacement with bind. See Released Services.

Setting ​

A scoped configuration value for one artifact, stored as JSON in sdk_settings and type-validated separately from storage. Answers how is this artifact configured, where a slot answers in what context am I working. See reading and writing settings.

Slot ​

A declared need for a contextual value — "I need to know the period" — declared with #[Slot] on a module and resolved per request through the chain Request → Actor → Composition → Setting. Seven scalar types, no arrays, no models. See actor slot values.

Snapshot ​

The compact form of ability resolution: a flat [type => [ability => bool]] map. What the runtime uses; explain is its verbose sibling.

Sync ​

The pipeline that persists declarations into the database — eight workers, fixed order, idempotent, checked first by ui5:ready. See the sync pipeline.

System actor ​

Gone since SDK 2.0. What it stood for is now the platform owner, the operator and the automation actor. See the system actor.

T — Z ​

Tenant ​

The company the installation runs for — in-house the operator itself, for an agency its customer. One tenant is one database: no row-level tenant filtering. Found along the operator's operator_for, which ui5:tenant writes. See installation and tenant.

Tile ​

A dashboard widget artifact. An analytic tile is the single-metric variant — what earlier releases called a KPI, and the name you will still find in old material.

UUID ​

The identity of a help topic. Used because file paths and titles change under refactoring and UUIDs do not. Renaming a topic must never change its UUID.

Value help ​

A picker dialog answering which one? — an SDK-owned artifact type with named scopes, each scope resolving to an entity set gated by its own read gate. See value helps.