Appearance
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.
| Word | Means | In the code |
|---|---|---|
| Organization | a customer of BMA, with its own users, modules, settings and data | tenant: table tenants, Tenant::currentId() |
| Platform organization | the organization of BMA staff (code platform) | Tenant::PLATFORM_CODE, Tenant::currentIsPlatformTenant() |
| BMA staff / platform user | someone who runs the platform and can act across organizations | users.is_platform, or a member of the platform organization |
| Organization admin | an administrator inside one organization | permission tenant.admin |
| Group | a set of users that permissions and menus are granted to | table user_group, per organization |
| Permission key | one capability, such as sawscore.view | table next_permissions; Rbac::requirePermission() |
| App database | users, organizations, permissions, menus, modules, settings, audit log | ApiDb::pdo() |
| Inventory database | business data, shared by organizations or private to one | ApiDb::inventory() |
| Tenant scope | the filter that keeps every query inside one organization | InventoryQuery with /*TENANT*/; TenantScope |
| Front controller | the one PHP file every API request enters | appcenter-next/api/index.php |
| Entitlement gate | the check that the organization has the module enabled before its routes run | ModuleRegistry::gate() |
| Router | a PHP function ($method, $path, $body) that answers the paths it owns | api_v1_route_* in api/routes/, or a module's api.router |
| Envelope | the JSON shape of every answer | ApiResponse; see API conventions |
| Shell | BMA's browser app: sign-in, navigation, workspace tabs | next-src/ |
| Workspace tab | one open screen in the shell's tab strip | host.workspace for modules |
| Module | a feature that plugs into the API, the shell and the menu | module.json; ModuleRegistry |
| Core / source / builder module | ships with BMA / signed PHP and JavaScript package / App Builder JSON | manifest kind |
| Module registry | the list of registered module versions and, per organization, what is installed and enabled | tables modules, module_versions, tenant_modules |
| Variant | an organization's own copy of a module, with its own id | module:fork; manifest extends |
| Override | an organization's small changes to a module (rename or hide menus and screens) | manifest overridable |
| Hooks | a module's code that runs on install, enable, upgrade, disable, uninstall | ModuleHooks, ModuleHooksBase |
| Module task | a module's scheduled job, run by the cron runner while the module is enabled | ModuleTaskRunner::task(); CronService::ensureModuleTaskJob() |
| Sealed secret | a value encrypted before it is stored, never sent back | Crypto::sealSecret(); settings x-secret |
| Organization key | each organization's own data key, which seals its secrets and files | Crypto::tenantKey() |
| Tenant API | an organization's App Builder data, reached with an API key | /tenant-api/v1/…; TenantAppApi |
| Audit log | who changed what, per organization | AuditLog::record(); table ac_audit_log |
| Sandbox | a throwaway BMA install on SQLite for development and tests | bin/dev-sandbox.sh |