Appearance
Tenant
Platform consoleTenantsTenantPermission:
platform adminAlso known as
- tenant detail
- enter tenant
- impersonate
- act as
- suspend tenant
- reactivate
- archive tenant
- enable modules
- reset password
- unlock user
The tenant page is where you look after one organisation: check its details and usage, switch its modules on and off, help its users who are locked out, enter its workspace to support it, and suspend, reactivate or archive it.
The header shows the name, status, sign-in address, creation date and base currency, with Edit details, Enter tenant and More actions (…). A suspended tenant shows This tenant is suspended. with a Reactivate tenant button; an archived one shows This tenant is archived. and is read-only.
Overview tab
Organisation lists the Name, Slug, Sign-in address, Status, Base currency, Language and Created. Usage shows the Modules enabled, Users and the Tenant id (quote it to support).
To change the details:
- Select Edit details.
- Change the Name, Language or Base currency, and select Save changes. You see Changes saved.
Changes apply to every user at the tenant. The base currency cannot change once documents are posted.
Switch modules on or off
- Select the Modules tab. The line at the top says how many modules are on, for example 14 of 14 modules on.
- Switch modules on or off. The dependency rules of Create a tenant apply, and changed rows are marked Turning on or Turning off.
- Select Save modules (or Discard changes). You see Modules updated.
Data in a module you turn off is kept and comes back when you turn it on again. Users lose its pages at their next page load. If the server refuses the set you see The server refused these modules. with the reason.
Help a user who cannot sign in
The Users tab lists the tenant's users with Email, Roles, Status and Last sign-in.
To set a new password:
- Select … on the user's row, then Reset password.
- Type the New password (at least 10 characters) or select Generate.
- Select Reset password. You see Password reset for …. Their other sessions are signed out.
To unlock a user locked after too many failed sign-ins, select …, Unlock, and confirm. You see … can sign in again. Users also unlock themselves after 15 minutes.
Day-to-day user management (new users, roles) belongs to the tenant's own administrator in Users.
Enter the tenant
- Select Enter tenant (only for an Active tenant: Only active tenants can be entered.).
- The tenant's workspace opens on its Home page, with a gold bar at the top: You are inside … as platform admin.
- Work as an account administrator would, for example to check a setting.
- Select Leave in the gold bar to return to the console.
Entering and leaving are recorded in the Platform audit with the tenant's name, and everything you change inside is in the tenant's own audit trail under your name.
Suspend, reactivate or archive
- Select … (More actions) and choose Suspend tenant, Reactivate tenant or Archive tenant.
- Read the consequence in the dialog. To suspend, type the Reason (required; recorded in the platform audit log).
- Confirm. You see … suspended, … reactivated or … archived.
| Action | Available when | What happens |
|---|---|---|
| Suspend tenant | Active | Everyone at the tenant is signed out at once and cannot sign in until you reactivate it. Data is kept. |
| Reactivate tenant | Suspended | Users can sign in again straight away. |
| Archive tenant | Active or suspended | Closes the tenant for good: users are signed out and cannot sign in, and it cannot be entered. Data is retained under the retention policy. Cannot be undone. |
See Tenants for the statuses.
Related
- Tenants
- Create a tenant
- Module catalogue
- Platform audit
- Find your way around: the gold "acting as" bar
- Tenant administration
