Skip to content
ReferenceForDeveloper

Developer glossary ​

The guides for everyone else use plain words; the code uses its own. This table maps one to the other. For the product words (host, vendor, listing, entitlement and the rest), see the main Glossary.

WordMeansIn the code
Organizationa customer of BMA, with its own users, modules, settings and datatenant: table tenants, Tenant::currentId()
Platform organizationthe organization of BMA staff (code platform)Tenant::PLATFORM_CODE, Tenant::currentIsPlatformTenant()
BMA staff / platform usersomeone who runs the platform and can act across organizationsusers.is_platform, or a member of the platform organization
Organization adminan administrator inside one organizationpermission tenant.admin
Groupa set of users that permissions and menus are granted totable user_group, per organization
Permission keyone capability, such as sawscore.viewtable next_permissions; Rbac::requirePermission()
App databaseusers, organizations, permissions, menus, modules, settings, audit logApiDb::pdo()
Inventory databasebusiness data, shared by organizations or private to oneApiDb::inventory()
Tenant scopethe filter that keeps every query inside one organizationInventoryQuery with /*TENANT*/; TenantScope
Front controllerthe one PHP file every API request entersappcenter-next/api/index.php
Entitlement gatethe check that the organization has the module enabled before its routes runModuleRegistry::gate()
Routera PHP function ($method, $path, $body) that answers the paths it ownsapi_v1_route_* in api/routes/, or a module's api.router
Envelopethe JSON shape of every answerApiResponse; see API conventions
ShellBMA's browser app: sign-in, navigation, workspace tabsnext-src/
Workspace tabone open screen in the shell's tab striphost.workspace for modules
Modulea feature that plugs into the API, the shell and the menumodule.json; ModuleRegistry
Core / source / builder moduleships with BMA / signed PHP and JavaScript package / App Builder JSONmanifest kind
Module registrythe list of registered module versions and, per organization, what is installed and enabledtables modules, module_versions, tenant_modules
Variantan organization's own copy of a module, with its own idmodule:fork; manifest extends
Overridean organization's small changes to a module (rename or hide menus and screens)manifest overridable
Hooksa module's code that runs on install, enable, upgrade, disable, uninstallModuleHooks, ModuleHooksBase
Module taska module's scheduled job, run by the cron runner while the module is enabledModuleTaskRunner::task(); CronService::ensureModuleTaskJob()
Sealed secreta value encrypted before it is stored, never sent backCrypto::sealSecret(); settings x-secret
Organization keyeach organization's own data key, which seals its secrets and filesCrypto::tenantKey()
Tenant APIan organization's App Builder data, reached with an API key/tenant-api/v1/…; TenantAppApi
Audit logwho changed what, per organizationAuditLog::record(); table ac_audit_log
Sandboxa throwaway BMA install on SQLite for development and testsbin/dev-sandbox.sh