Setting user TSconfig¶

Importing the user TSconfig into a backend user or group¶

1. Open the record of the user or group. Go to Options > TSconfig.

   

2. Enter the following TSconfig to import a configuration file from your sitepackage:

   TsConfig added in the backend record of a backend user or group

   @import 'EXT:my_sitepackage/Configuration/TsConfig/User/my_editor.tsconfig'

   Copied!

This will make all settings in the file available to the user. The file itself can be kept under version control together with your sitepackage.

TSconfig defined at user level overrides TSconfig defined at group level.

If a user is a member of several groups, the TSconfig from each group is loaded. The order in which the groups are added to the user in field General > Grooup is used.

The TSconfig from latter groups overrides the TSconfig from earlier groups if both define the same property.

Setting default user TSconfig¶

User TSconfig is designed to be individual for users or groups of users. However, good defaults can be defined and overridden by group or user-specific TSconfig.

In extensions, this is done using the Core API function, \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addUserTSConfig(). In the ext_localconf.php file of your extension you can call it like this to set a default configuration.

/**
 * Adding the default User TSconfig
 */
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addUserTSConfig('
     @import "EXT:my_sitepackage/Configuration/TsConfig/User/default.tsconfig"
');

There is a global TYPO3_CONF_VARS value called $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultUserTSconfig']. The API function above adds content to that array. However, the array value itself should not be changed or set directly without using the API.

Verify the final configuration¶

The full user TSconfig of the currently logged-in backend user can be viewed using the System > Configuration backend module and choosing the action $GLOBALS['BE_USER']->getTSConfig() (User TSconfig). However this module can only be accessed by admins.

The Configuration module is available with installed lowlevel system extension.

Override and modify values¶

Properties, which are set in the TSconfig field of a group, are valid for all users of that group.

Values set in one group can be overridden and modified in the same or another group. If a user is a member of multiple groups, the TSconfig settings are evaluated in the order in which the groups are included in the user account: When editing the backend user, the selected groups are evaluated from top to bottom.

Example:

• Add in User TSconfig

  EXT:site_package/Configuration/page.tsconfig

  page.RTE.default.showButtons = bold

  Copied!
• You get the value "bold".

• Add later in User TSconfig

  EXT:site_package/Configuration/user.tsconfig

  page.RTE.default.showButtons := addToList(italic)

  Copied!
• You get the value "bold,italic".

Finally, you can override or modify the settings from groups that your user is a member of in the user TSconfig field of that specific user.

Example:

Let's say the user is a member of a usergroup with this configuration:

TCAdefaults.tt_content {
   hidden = 1
   header = Hello!
}

Then we set the following values in the TSconfig field of the specific user.

page.TCAdefaults.tt_content.header = 234
options.clearCache.all = 1

This would override the default value of the header ("234") and add the clear cache option. The default value of the hidden field is not changed and simply inherited directly from the group.

Overriding page TSconfig in user TSconfig¶

All properties from page TSconfig can be overridden in user TSconfig by prepending the property name with page..

When a page TSconfig property is set in user TSconfig that way, regardless of whether it is in the TSconfig field of a group or a user, it overrides the value of the according page TSconfig property.

To illustrate this feature let's say the action Web > Info > Localization Overview has been disabled via Page TSconfig:

mod.web_info.menu.function {
   TYPO3\CMS\Info\Controller\TranslationStatusController = 0
}

If we activate this configuration in the TSconfig of a certain backend user, that user would still be able to select this menu item because the value of his user TSconfig overrides the same value set in the page TSconfig, just prefixed with page.:

page.mod.web_info.menu.function {
   TYPO3\CMS\Info\Controller\TranslationStatusController = 1
}

# Enable the "bold" button in Page TSconfig (!)
RTE.default.showButtons = bold

# Try to additionally add the "italic" button in User TSconfig (!)
page.RTE.default.showButtons := addToList(italic)