Tenant licences

The basic principle

Every customer tenant needs a valid, hardware-bound licence. Without an effective licence the tenant is blocked completely: API calls are refused with 403, users see a block page after signing in, and background processing skips the tenant. The system and demo tenants are exempt from the licence requirement. System administrators are never blocked — which makes the licence page the way to lift a block at any time.

Which features a tenant may use is stated in the licence itself: redaction (Docuflair Redact), pseudonymisation (Docuflair Mask), Archive, DMS, plus the page quota per year and the maximum number of users. Features that are not licensed are hidden in the interface, and the corresponding API endpoints answer with 403.

Note

Alternatively, the tenant administrator can apply their own tenant’s licence themselves (the self-service page /admin/license, reachable even while the tenant is blocked). Removing a licence remains reserved for system administrators.

Applying a licence, step by step

Open Tenants → ⋮ → Licence (/system/tenants/{code}/edit/license):

1. Copy the hardware ID: the “Hardware ID of this tenant” card shows a unique identifier formed from the tenant ID and the server’s hardware. Copy it with “Copy”. (The expandable detail “Show the underlying components” lists the hardware characteristics included.)
2. Have the licence issued: pass the hardware ID to the licence server or your contact — the licence returned is bound to exactly that ID.
3. Enter the licence string: paste the signed licence string (Base64) into the field and click “Save & verify”. Alternatively: “Upload licence file” (a text file .lic/.txt, max. 64 KB) or — where an activation address is configured — “Retrieve online”.

The status is checked and displayed immediately:

Status badge	Meaning
Valid (green)	The licence is active; the tenant is unlocked.
Expired (yellow)	The licence was valid, but the expiry date has passed.
Wrong hardware ID / wrong tenant (yellow)	The licence is signed correctly but was issued for a different hardware ID. The view shows “Expected:” and “In licence:” for comparison.
Invalid signature (red)	The string has been altered or does not come from the licence server.
Invalid format (tampered/truncated) (red)	The string is damaged — often a copy-and-paste error.
No licence stored (grey)	No licence has been applied yet.

Current licence and page consumption

With a valid licence, the “Current licence” card shows:

• the licensed options (redaction, pseudonymisation, Archive, DMS — each yes/no) plus the page quota per year and the maximum users,
• the licence data (including the expiry date),
• the page consumption: “x of y pages used, z remaining” with a progress bar (yellow from 75%, red from 90%) and the “Recent counts” table (time, document, version, pages).

Warning

If the note “This tenant’s consumption ledger is inconsistent…” appears, consumption data has been changed or deleted outside the application (suspected tampering). Contact support in that case.

Removing a licence: the “Remove licence” button (with the inline confirmation “Really remove?”) deletes the stored string — the tenant falls back into the blocked state. Both operations are recorded (tenant.license.update, tenant.license.clear).