Skip to content

Configuration Reference ​

There is one config file: config/ui5.php. Core owns the base keys, the SDK contributes its own on top, and your host states whichever value it wants to change. Nothing is published, nothing is forked.

Configuration shows the file a host actually writes. This page is the complete key list — what each key is for, what the default is, and who owns it.

How the merge works ​

changed in 2.0The SDK merges its keys **deep** into `ui5`. Your file states only what

differs, down to a single nested key:

  • Maps merge key by key, and your value wins at every leaf. context, intents, the collectors of discovery, the body of the navigation are maps: one entry of yours adds a contributor, an intent or a collector, or replaces the one with the same key.
  • A list is one value. A candidate chain such as branding.config.ci is a list: yours replaces the SDK's whole, so name every candidate you want, in order.
  • [] says nothing. An empty array keeps the SDK's default; it does not empty a list.
  • You cannot remove an entry of the SDK's from a map.

Core's own keys merge as Laravel's mergeConfigFrom() does, one level deep — they are the host's settings (modules, middleware, registry), so you hold them whole in the file you published.

php
// config/ui5.php — your own CI candidate in front of the SDK's placeholder, nothing else restated
'context' => [
    \LaravelUi5\Sdk\Shell\Context\Contracts\ContextServiceInterface::KEY_NAVIGATION => [
        'config' => ['branding' => ['config' => [
            'ci' => [AcmeCiCandidate::class, \LaravelUi5\Sdk\Shell\Navigation\SaaSBrandingCandidate::class],
        ]]],
    ],
],

Core's keys ​

KeyDefaultWhat it does
versionan OpenUI5 version tagThe default OpenUI5 version for every app, unless the app overrides it. Used at runtime and when scaffolding.
meta[]Key/value pairs stamped into the generator block of every generated manifest.json.
routes[]Laravel route names exposed to the manifest as laravel.ui5.routes — e.g. login, logout, home. Resolved through route().
registryUi5Registry::classThe artifact registry. A host on the SDK sets SdkRegistry::class.
context_factoryCoreContextFactory::classBuilds the per-request context. A host on the SDK sets the SDK's factory — that is what upgrades Ui5Context to SdkContext.
middlewaresee belowThe artifact route stack.
odata_middlewaresee belowThe OData route stack.
modules[]The explicit list of your business modules. Only what is listed here is registered.
auth_enabledenv('ENABLE_AUTH_4_UI5', true)The authentication gate. false makes it inert — local development only.
artifact_resolvers[PathBasedArtifactResolver::class]The ordered chain mapping a request path to an artifact.

Three of those are where an SDK host differs from a Core-only host, and all three are in the quickstart: registry, context_factory, and the two middleware arrays. A fourth is easy to miss — artifact_resolvers needs two SDK entries appended, or the shell and export routes resolve nothing:

php
'artifact_resolvers' => [
    \LaravelUi5\Core\Runtime\PathBasedArtifactResolver::class,
    \LaravelUi5\Sdk\Shell\ShellContextArtifactResolver::class,
    \LaravelUi5\Sdk\Export\ExportArtifactResolver::class,
],

The SDK's keys ​

audit ​

php
'audit' => [
    'redact' => ['password', 'password_confirmation', 'current_password', 'token', 'secret', 'api_key'],
    'models' => [],
],

redact lists the keys whose values never enter a log — compared case-insensitively; a list, so yours replaces this one. models lists your models that carry #[Audited], so the write rule knows which tables are audited. Both concern code, so they are configuration. The validation log's switch and the logs' retention periods are values the operator decides, so they are settings.

migrations ​

php
'migrations' => env('UI5_MIGRATIONS', 'app'),

Who runs the schema. 'app', the default: the app loads the migrations of its database packages — laravelui5/sdk-db, and laravelui5/foundation-db where it is installed — and php artisan migrate runs them as usual. 'tms': the app loads none. The schema is run by the TMS of the LaravelUi5 Platform — on a copy of the database, checked and switched over in one release run, never by migrate --force on production. Unless the Platform runs your installation, leave it at 'app'.

i18n ​

php
'i18n' => [
    'customizing' => [
        PartnerRelationshipType::class => RelationshipType::class,
        PartnerRole::class             => PartnerRoleEntry::class,
    ],
    'models' => [
        Artifact::class => ArtifactLocalizedTable::class,
        Ability::class  => AbilityLocalizedTable::class,
        Role::class     => RoleLocalizedTable::class,
    ],
],

The models whose translated columns read in the request's language from sdk_texts. customizing maps a catalog's model to the Customizing entry class that declares its rows; models maps any other model to its LocalizedTableInterface adapter. Both are maps: add your own catalogs' models and the SDK's stay. See Synced Texts.

php
'navigation_service' => DefaultNavigationService::class,

DefaultNavigationService builds the navigation tree from the registry in memory. CachedNavigationService reads the file ui5:nav compiled — bind it in production, and run ui5:nav before the first request or it throws. See caching and performance.

export ​

php
'export' => [
    'max_rows' => 500,
    'writers'  => ['csv' => CsvExportWriter::class],
],

max_rows is the guard the export controller checks before streaming — a wider export is a 422 telling the user to narrow the list. writers maps a format token to its writer; add xlsx here with your own writer, and your spreadsheet library stays in your composer.json. See table export.

context ​

The map that builds context.json. Each key is a ContextServiceInterface::KEY_* constant, each value a contributor — and a contributor fills exactly one key, never merges into another's.

Shipped keys: actor and principal (the same IdentityContextContributor, wired twice with a config flag saying which partner to project), abilities, actions (from discovery.context), navigation, and settings and weave (both appended by the provider itself).

The navigation entry is the one with real structure inside it — a projector, a branding block with CI and home candidates, a body pipeline of contributors, an identity block and a footer. The LeanShell's navigation manager requires context.navigation at init; without it the shell dies with shell_initialization_failed.

discovery ​

Two assembled discovery services — discovery.context and discovery.search, both container singletons. Each declares the result key it lands under, the route it is reachable at, and a map of collectors, each collector paired with an authorizer.

The separation this encodes is load-bearing: a collector finds things, an authorizer constrains the query. Collectors never query security tables. See visibility and CmdK.

shell ​

Two halves.

shell.manifest is the client-side knob block that reaches the LeanShell: the log level (UI5_SHELL_LOG_LEVEL), the intent-dispatcher URL template, the command palette's placeholder and hotkeys, the search manager's minChars, the help manager's default locale, and the close hotkeys for the help viewer and nav options.

The intent dispatcher is a template, /ui5/shell/{slug}/intend.json, not a baked route() URL — config is merged at register() time, before routes exist, so the client fills in {slug} itself.

shell.services is the map of shell contributors, each contributing exactly one root node to the shell manifest. discovery.search carries a limit here.

intents ​

Your intent capabilities, as IntentClass => ['authorizer' => …, 'handler' => …]. The default holds the SDK's own seven (weave.navigate, weave.open, partner.impersonate, navigation.open, ui5-artifact.open, ui5-valuehelp.open, session.logout); an entry of yours adds to them, or swaps the authorizer or handler of one. See intent dispatch.

help ​

php
'help' => ['markdown' => ['table' => [...]]],

Passed verbatim to the CommonMark environment factory. Only the Table extension is configured. Heading permalinks are deliberately not registered — help pages must not carry ¶ anchors before every heading, they pollute the viewer. To change the extension set, rebind MarkdownEnvironmentFactoryInterface rather than reaching for a config key that does not exist.

Environment variables ​

VariableReachesDefault
ENABLE_AUTH_4_UI5ui5.auth_enabledtrue
UI5_SHELL_LOG_LEVELui5.shell.manifest.logLeveldebug
UI5_MIGRATIONSui5.migrationsapp

Set UI5_SHELL_LOG_LEVEL to something quieter than debug in production.

The SDK's settings ​

Some values are not the developer's to decide but the operator's. The SDK declares them as settings of its library, com.laravelui5.sdk: Pragmatiqu IT ships the defaults, and the operator changes them on scope Installation in the Settings app. ui5:sync writes the declarations.

SettingTypeDefault
automation_actore-mail[email protected]
audit.validation_logbooleanfalse
audit.retention.securitydays365
audit.retention.validationdays30
audit.retention.businessdays365
audit.retention.reportdays1095

automation_actor ​

The partner who answers for what nobody started by hand: ui5:sync, ui5:prune, scheduled jobs. It is recorded as the author of their changes in the change log. The setting holds an e-mail, and the partner is found by it — any type, an organisation or department as well as a person. The default is Pragmatiqu IT's support department, which ui5:intake writes before anything else, so even the first sync has its actor. A setting naming no partner stops every automation run until it is corrected.

audit.validation_log ​

Record what was entered when a request fails validation — the field, the rules and the value, redacted by audit.redact. Off by default: the values are personal data.

audit.retention.* ​

Days each log keeps its rows. ui5:prune, which the SDK schedules daily, deletes older ones — run the scheduler. The change log has no retention; it is never pruned.

Two keys that are not config ​

Worth naming, because people look for them:

  • There is no sdk.* namespace. Everything the SDK reads lives under ui5.*. A key the vendor does not read is a key nobody maintains.
  • There is no list of your apps' abilities, roles or settings. Those are declared in code with attributes and land in the database through ui5:sync. Configuration wires services; declarations describe artifacts.