Improving tenants doc page

This commit is contained in:
Thomas Georgios Giannos 2024-05-10 11:49:36 +03:00
parent 6767226b46
commit bfaa8f8a53
1 changed files with 29 additions and 1 deletions

View File

@ -40,3 +40,31 @@ There is a filtering option available for tenants.
In order for the filters to apply, you have to click the `Apply filters` button.
You can also clear any filters already applied, by pressing the `clear all filters` option, located at the top of the popup.
---
## Edit form
There are three options available for a tenant.
- **Name**: The display name for the tenant. This name will appear on the UI.
- **Code**: The identifier for the tenant, used internally by the system.
- **Description**: A short description for the tenant.<br/>*This is optional.*
A tenant, once created can be configured on the [Tenant Configuration](/docs/documentation/administration/tenant-configuration) page.
---
## Multitenancy
There is always one tenant available on the platform and is called `Default`. It is the tenant assigned by default to all the entities (users, descriptions etc.), unless the tenant scope that is being selected is different.
There are two ways a user can change the tenant scope.
- Select a tenant from the top toolbar, on the dropdown appearing next to the notifications icon.
- Select a tenant from the user profile page
:::tip
The options to change the tenant scope are only available when the logged in user belongs to one or more tenants. Otherwise, the user is attached only to the default tenant. Also, system administrators can select from all the available tenants.
:::