On this page

All pages




Introduction

Flavours are a way to define a set of features and settings that will be applied to a Totara site. Flavours can set defaults and enforce settings so that they cannot be changed in the interface anymore.

With the introduction of Totara 13, flavours are used to configure a site to use specific product combinations - for example Learn and Perform or Learn, Perform and Engage.

Flavours exist as a type of plugin and are located in the code in the server/totara/flavour/flavours directory.

If no flavour is set then sites will default to the Learn only flavour.

Activating flavours

For a flavour to take effect it needs to be activated (either via a config flag in the config.php file or via a command line script) and enforced. Enforcing a flavour can be done via a CLI script or in the Features overview by an admin. There can only be one flavour active at a time.

There are two approaches to activating flavours:

The first is to add:

$CFG->forceflavour = 'learn_perform_engage';

to your config.php, and then run the command:

php server/totara/flavour/cli/enforce_current.php

or as an administrator go to the Feature overview page (at /totara/flavour/view.php) and click on the Enforce flavour button.

Alternatively you can use the command line script provided to activate and enforce a flavour in one go:

php server/totara/flavour/cli/activate_flavour.php --activate=learn_perform_engage

Changing flavours

If a customer adjusts their subscription to include a different set of products, you may want to change the flavour on an existing site.

You can change flavours at any time by activating and enforcing the new flavour using the steps above.

Changing to a more fully featured flavour

If you switch from a more limited flavour to one with more features (for example, switching from Learn to Learn and Perform) you will need to manually enable the new features that you want to use. This can be done by navigating to Quick-access menu > Configure features then clicking on the settings link for the product you want to use. Settings that were previously displayed as locked will now be available.

Changing to a more restricted flavour

If you switch from a flavour with more features to one with fewer features (for example, switching from Learn, Perform and Engage to just Learn) some functionality that was previously enabled will now be unavailable.

If you run the command line script to set the new flavour this will happen automatically.

If you modify $CFG→forceflavour in your config.php you will need to manually enforce the flavour. Visit Quick-access menu > Configure Features > Feature overview ({site-url}/totara/flavour/view.php). You will see something like this:

A comparison of features between flavours.

The red rows indicate features that are currently enabled but are not available in this flavour.

Press the Enforce current flavour button and it will change to this:

Feature comparison after selecting Enforce current flavour.

When you view the features that are no longer available you'll get a message indicating that they are locked:

Viewing locked features after changing flavour.

Upgrading a pre-13 site

If you are upgrading a site from Learn 12 or below to version 13, we recommend you set your flavour in your config.php file before you upgrade. This will ensure the new functionality is automatically enabled following the upgrade. See these instructions for more details.