Octibiz
Demo

Durchsucht Website und Dokumentation gemeinsam. Enter zeigt alle Treffer, Esc schließt.

System & feature switches

System & feature switches screen in Octibiz

Overview

Two tabs, two different things: Settings are values the system reads at runtime. Feature switches are switches that turn functions on and off system-wide.

Plugin modules do not appear here. They are governed through the plugin manager. What lives here are the core's switches.

Core tasks

Maintain settings. Every setting carries a key, a value, a type, a scope and a category. The types are Text, Integer, Yes/No, JSON and Encrypted — the last for credentials that should not sit in clear text.

Choose the right scope. Two scopes are available:

ScopeMeaning
Systemapplies to the whole installation
Brandapplies to one particular brand only

With scope Brand, naming the brand is mandatory — and selectable only on creation. A setting does not move to another brand later; a new one is created instead.

Company name for emails without a brand. The setting system.company_name names the company in emails not assigned to any brand — for example the portal invitation to a customer without a brand ("Your invitation to the … customer portal"). Empty means: the only active brand applies, with several the default brand, otherwise the first active one. The gap "the customer portal" no longer occurs.

Turn feature switches on or off. The second tab switches functions system-wide. It takes effect immediately and for everyone.

Restrict a switch to brands and roles. In a switch's edit dialog, the Visibility section decides who an active switch applies to — for example the AI workspace (ai.workspace) for one role first, or the customer portal (module.portal) for one brand only. For anyone outside, the function is off. The list marks such switches as restricted.

Fields in detail

System settings are key-value pairs. The mask shows the meaning of each setting; this page explains what the fields around it mean.

FieldRequiredValues / formatWhat it does
Value valuenodepending on the typeThe value set. What is permissible follows from the type.
Type typeyesyes/no, number, text, structure, encryptedHow the value is treated. Encrypted is the important case: such values are stored encrypted and never shown again — credentials belong there and nowhere else.
Category categorynotext, max. 100 charactersGrouping in the overview.

Feature switches carry these fields:

FieldRequiredValues / formatWhat it does
Name nameyestext, max. 100 charactersThe switch's identifier, e.g. ai.workspace. Selectable only on creation; module.* names are managed by the system.
Active enablednoyes/noThe main switch — takes effect immediately and for everyone.
Description descriptionnotext, max. 255 charactersWhat the switch is for.
Configuration confignokey-value pairs, empty = noneAdditional values, such as thresholds of a gradual rollout. Visible to administrators only.
Brands visibleBrandIdsnoselection, empty = allThe switch applies only to users with a membership in one of the chosen brands; a cross-brand membership matches every brand.
Roles visibleRoleIdsnoselection, empty = allThe switch applies only to users holding one of the chosen roles. If both lists are set, one membership must satisfy both.

Visibility does not filter data. It only decides whether the function exists for a user. In the customer portal the brand selection applies via the customer's brand, the role selection does not. Automations and background runs only see the main Active switch.

A setting is not a permission. It changes behaviour, not access. Who may change a setting follows from their role; the setting itself protects nothing.

Values with a delivered default can be reset to it. An update does not overwrite a value you have set.

Settings & permissions

  • Permission platform.settings.manage. Without it the page is unreachable.
  • The key is the identity. Parts of the program read settings by it; a typo means the value is

not found — without an error message, because an absent value is a legitimate state.

  • Encrypted values cannot be read back. You can overwrite them but not inspect them.
  • A switch takes effect immediately and for everyone. This page is not a place to experiment

during working hours. To show a function to a part of the team first, restrict it via Visibility.

  • No exception for administrators. Visibility follows brand and role, for you too; this page stays

reachable, and a selection that is too narrow can be taken back at any time.

  • Switched off or hidden ⇒ no menu entry. The AI switches ai.gateway, ai.workspace and

ai.brain take their surfaces with them: menu entry, page and AI buttons disappear, opening the address directly leads to the start page. ai.brain depends on the gateway, ai.workspace on the gateway and the brain — with ai.gateway off, both are off too; with ai.brain off, the assistant is off. The portal assistant follows ai.gateway and its brand selection (the customer's brand).

  • ai.gateway off is an emergency stop. The system then calls no AI model at all — not from

automations, the Company Brain's knowledge embedding or other background runs either. AI helpers on the business pages return their fallback (no suggestion, or the analysis without AI), and an automation's Run AI step fails with "AI is switched off". A brand or role restriction of ai.gateway applies on top for every call made by a signed-in user.

FAQ & troubleshooting

A colleague lacks a function although the switch is active. Check the switch's Visibility: if they belong to none of the chosen brands or roles, the function is off for them.

A module is missing from the feature switches. Plugin modules do not live here but in the plugin manager.

A changed setting has no effect. Check the key and the scope. A setting scoped to Brand applies only there; for the rest, the system value or none continues to apply.

I cannot change a setting's brand. Correct — it is selectable only on creation. Create a new one.

After turning a switch off, remnants remain in the interface. Reload the interface. If it persists, it belongs with your administrator.

settings.system · Available from version 0.5.0