Difference between revisions of "Multi-tenancy"

Jump to: navigation, search
(Tenant administration)
(Just some grammar updates.)
Line 1: Line 1:
 
{{Workplace}}
 
{{Workplace}}
  
Moodle Workplace allows main administrator to create multiple "tenants" and allocate the users to different tenants. Tenants will be using the same site but will not see each other. Each tenant can have their own site name, logo and color scheme.
+
Moodle Workplace allows the main administrator to create multiple "tenants" and allocate users to each of them. Tenant users will all be using the same site but will not see each other. Each tenant can have their own site name, logo and colour scheme.
  
 
{{MediaPlayer | url = https://youtu.be/JbJwSzHSJKk | desc = Moodle Workplace | Training | Multi Tenancy}}
 
{{MediaPlayer | url = https://youtu.be/JbJwSzHSJKk | desc = Moodle Workplace | Training | Multi Tenancy}}
  
 +
When Moodle Workplace is installed, the site is prepared to be multi-tenant. The capability 'moodle/category:viewcourselist' is removed from the roles "Authenticated user" and "Guest". If you don't want to use Multitenancy functionality, you may consider allowing these capabilities.
  
When Moodle Workplace is installed, the site is prepared to be multi-tenant. The capability 'moodle/category:viewcourselist' is removed from roles "Authenticated user" and "Guest". If you don't want to use Multitenancy functionality, you may consider to allow these capabilities.
+
==Managing tenants==
  
==Managing tenants==
+
The main administrator or a user with the capability '[[Capabilities/tool/tenant:manage|tool/tenant:manage]]' is able to create tenants, change their settings, associate tenants with course categories and assign tenant administrators. Three additional roles are automatically created when Moodle Workplace is installed, automatically assigned to the following users:
  
Main admin or a user with capability '[[Capabilities/tool/tenant:manage|tool/tenant:manage]]' is able to create tenants, change their settings, associate tenants with course categories and assign tenant administrators. Three roles are automatically created when Moodle Workplace is installed and they are automatically assigned to:
 
 
* "[[Tenant administrator role|Tenant administrator]]" role is assigned to the tenant administrator in the system context
 
* "[[Tenant administrator role|Tenant administrator]]" role is assigned to the tenant administrator in the system context
 
* "[[Tenant manager role|Tenant manager]]" role is assigned to the tenant administrator in the context of this tenant's course category
 
* "[[Tenant manager role|Tenant manager]]" role is assigned to the tenant administrator in the context of this tenant's course category
* "[[Tenant user role|Tenant user]]" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has one capability 'moodle/category:viewcourselist'
+
* "[[Tenant user role|Tenant user]]" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has the capability 'moodle/category:viewcourselist'
  
These roles and role assignments can not be manually deleted. However main administrator can modify the roles if necessary. For example, "Tenant administrator" role by default contains capability '[[Capabilities/tool/tenant:managetheme|tool/tenant:managetheme]]' that allows the tenant administrator to change the look of their tenant (logo and colors). Main admin may decide that theme customisation should be only done centrally and prohibit this capability in the "Tenant administrator" role. Same can be done for the '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]' capability.
+
These roles and role assignments can not be manually deleted. However the main administrator can modify the roles if necessary. For example, the "Tenant administrator" role by default contains the capability '[[Capabilities/tool/tenant:managetheme|tool/tenant:managetheme]]' that allows the tenant administrator to change the look of their tenant (logo and colours). The main administrator may decide that theme customisation should only be done centrally and prohibit this capability in the "Tenant administrator" role. The same can be done for the '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]' capability.
  
Main admin or a user with capability '[[Capabilities/tool/tenant:allocate|tool/tenant:allocate]]' is able to move users between tenants.
+
The main administrator or a user with the capability '[[Capabilities/tool/tenant:allocate|tool/tenant:allocate]]' is able to move users between tenants.
  
 
==Tenant administration==
 
==Tenant administration==
  
[[Tenant administrator role]] by default has capability '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]'. Unless the capability is removed from the role by the main admin, the tenant administrator can create and edit users inside their tenant.  
+
The [[Tenant administrator role]] by default has the capability '[[Capabilities/tool/tenant:manageusers|tool/tenant:manageusers]]'. Unless this capability is removed from the role by the main administrator, the tenant administrator can create and edit users inside their tenant.  
  
Tenant administrator can assign other roles to its users, for example "Program manager" or "Organisation structure manager" in the system context.
+
The tenant administrator can assign other roles to their users, for example "Program manager" or "Organisation structure manager" in the system context.
  
If the tenant has its own course category, tenant administrator is also a "[[Tenant manager role|Tenant manager]]" in this course category and he is able to assign roles in the context of this course category, for example "Course creator". For easier management there is a single page that lists all the roles that tenant administrator can assign in both system and category context. It can be accessed through '''Workplace launcher -> Users -> Roles'''.
+
If the tenant has its own course category, the  tenant administrator is also a "[[Tenant manager role|Tenant manager]]" in this course category and is able to assign roles in the context of this course category, for example "Course creator". For easier management there is a single page that lists all the roles that the tenant administrator can assign in both system and category context. It can be accessed through '''Workplace launcher -> Users -> Roles'''.
  
 
[[File:workplace_rolesmanagement.png|thumb|600px|center|Managing roles for tenant administrator]]
 
[[File:workplace_rolesmanagement.png|thumb|600px|center|Managing roles for tenant administrator]]
  
Tenant administrator is also able to manage their course category and all courses in it. Access to the course management is done through '''Workplace launcher -> Courses'''.  Hint: check out the "Edit" menu for the course category.
+
The tenant administrator is also able to manage their course category and all courses in it. Access to the course management is done through '''Workplace launcher -> Courses'''.  Hint: check out the "Edit" menu for the course category.
  
 
[[File:workplace_categorymanagement.png|thumb|600px|center|Category management]]
 
[[File:workplace_categorymanagement.png|thumb|600px|center|Category management]]

Revision as of 09:48, 20 September 2019

workplacelogo.png This feature is part of Moodle Workplace, which is available through Moodle Partners.


Moodle Workplace allows the main administrator to create multiple "tenants" and allocate users to each of them. Tenant users will all be using the same site but will not see each other. Each tenant can have their own site name, logo and colour scheme.

Moodle Workplace

When Moodle Workplace is installed, the site is prepared to be multi-tenant. The capability 'moodle/category:viewcourselist' is removed from the roles "Authenticated user" and "Guest". If you don't want to use Multitenancy functionality, you may consider allowing these capabilities.

Managing tenants

The main administrator or a user with the capability 'tool/tenant:manage' is able to create tenants, change their settings, associate tenants with course categories and assign tenant administrators. Three additional roles are automatically created when Moodle Workplace is installed, automatically assigned to the following users:

  • "Tenant administrator" role is assigned to the tenant administrator in the system context
  • "Tenant manager" role is assigned to the tenant administrator in the context of this tenant's course category
  • "Tenant user" role is assigned to any user allocated to the tenant in the context of this tenant's course category. By default this role only has the capability 'moodle/category:viewcourselist'

These roles and role assignments can not be manually deleted. However the main administrator can modify the roles if necessary. For example, the "Tenant administrator" role by default contains the capability 'tool/tenant:managetheme' that allows the tenant administrator to change the look of their tenant (logo and colours). The main administrator may decide that theme customisation should only be done centrally and prohibit this capability in the "Tenant administrator" role. The same can be done for the 'tool/tenant:manageusers' capability.

The main administrator or a user with the capability 'tool/tenant:allocate' is able to move users between tenants.

Tenant administration

The Tenant administrator role by default has the capability 'tool/tenant:manageusers'. Unless this capability is removed from the role by the main administrator, the tenant administrator can create and edit users inside their tenant.

The tenant administrator can assign other roles to their users, for example "Program manager" or "Organisation structure manager" in the system context.

If the tenant has its own course category, the tenant administrator is also a "Tenant manager" in this course category and is able to assign roles in the context of this course category, for example "Course creator". For easier management there is a single page that lists all the roles that the tenant administrator can assign in both system and category context. It can be accessed through Workplace launcher -> Users -> Roles.

Managing roles for tenant administrator

The tenant administrator is also able to manage their course category and all courses in it. Access to the course management is done through Workplace launcher -> Courses. Hint: check out the "Edit" menu for the course category.

Category management

See also