Tenant settings
  • 05 Apr 2022
  • 2 minutes to read

Tenant settings


Article summary

When creating or editing a tenant the following settings are available.

SettingDescription
Notes

Name

The name of the tenant.

Required field. 

Tenant identifier

Tenant identifier must be unique, and include lower case letters (a-z) and numbers (0-9). No capital letters, spaces or special characters. The tenant identifier must start in a letter, e.g. t001.

Required field.

The Tenant identifier will be used as part of the URL for tenant login pages if the Enable pre-login tenant themes setting is enabled. 

Description

You can optionally add a description of the tenant. This may help others to understand how to use the tenant. 

-

Suspended

Tick to suspend the tenant.

When a tenant is suspended the user status for all Tenant members will be changed to Tenant Suspended. Tenant members will not be able to log in to the site while their tenant is suspended.

Tenant category name

If you are using Totara Learn then a new course category will be created to contain all of the courses for your tenant. This field allows you to enter a name for the course category created for the tenant. If left blank then the tenant name will be used. 

This only applies when using Totara Learn. 

As with other course categories in Totara Learn, you can create subcategories to the tenant course category.

Tenant participants audience name

When creating a new tenant an audience will also be created containing all of the tenant users. This field allows you to choose a custom name for the tenant audience. If left blank then the tenant name will be used. 

These audiences are created at the category level, not the system level, and therefore have limited actions available for them. You can find out more in the Tenant audiences section.

Tenant dashboard name

Give a name to the dashboard assigned to this tenant. If left blank then the tenant name will be used. 

The dashboard name is visible to Tenant members. Global Site Administrators can change the tenant dashboard name at any point.

Clone dashboard

You can choose to clone any existing dashboard for use as the tenant dashboard. 

Cannot be edited after creation. 

If you wish to create a new dashboard for the tenant then you will need to create a dashboard as usual, and then choose that one to be cloned when creating your tenant. 

The Totara Academy has a whole course dedicated to using Multitenancy in Totara. Here you can learn more on how to set up and use tenants, see best practice, and give it a go yourself.

Can't find what you're looking for? Contact us at documentation@totara.com. Alternatively, book a call to have a chat about your Totara platform with a dedicated Customer Success Manager.

© Copyright 2024 Totara Learning Solutions. All rights reserved.

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.