User Account Menu
Menu or toolbar (depending on the location of the plugin assignment) to display the current user. It contains submenus to trigger various Account actions.
Illustration 1. Example view of the user account menu in the application toolbar (right)
Configuration
The following configuration controls, among other things, the order and availability of Account actions.
Sample configuration
{
"userTextTpl" : "Benutzer: {global.userSession.firstName}", (1)
"userTooltipTpl" : "{global.userSession.firstName} {global.userSession.lastName} ({global.userSession.loginName})", (2)
"languageSelector" : true, (3)
"accountPage" : true, (4)
"logout" : false, (5)
"changePw" : true, (6)
"icon" : true, (7)
"deleteLocalStorage" : true, (8)
"cookieSettings" : true, (9)
"link" : false, (10)
"linkTarget" : "popup,width=320,height=320", (11)
"linkUrl" : "https://example.com/auth/realms/MY_REALM/account", (12)
"linkText" : "Account Management", (13)
"linkIconCls" : "x-fal fa-user-edit", (14)
"buttonLogout" : false, (15)
"avatar" : true, (16)
"updateProfile" : true, (17)
"configureTotp" : false, (18)
"changeOrganisation" : false, (19)
"menuContent" : [
"accountPage",
"updateProfile",
"configureTotp",
"changePw",
"link",
"languageSelector",
"cookieSettings",
"deleteLocalStorage",
"changeOrganisation",
"logout"
], (20)
}| 1 | Textual representation of the button for the menu.
Information in the UserSession can be accessed here via XTemplate syntax.
If the value is left empty, the first and last name of the current user are displayed. Further details on the XTemplate syntax and its application can be found on the page XTemplate syntax |
||
| 2 | Content of the tooltip available on the menu button. Here you can also use XTemplate Syntax can also be used here. | ||
| 3 | If true:
Offers the option of changing the language in the BPC.See also Multiple Language Support. Until BPC 4.2.4 this option was called See also Account action |
||
| 4 | If true:
Navigates to the user information page User information page.
See also Account action |
||
| 5 | If true:
Logs out the user.
See also Account action |
||
| 6 | If true:
Allows you to change your own password.See also Change password. See also Account action |
||
| 7 | If true, an icon is displayed before the text (userTextTpl). |
||
| 8 | If true:
Deletes local data in the browser.See also Resetting the local storage. See also Account action |
||
| 9 | If true:
Displays the personal privacy settings.This can be used to control whether personalization information should be saved in addition to necessary information. See also Account action |
||
| 10 | If true:
Link to an external page (e.g. for account management in the identity provider). for account management in the identity provider).
The link target is defined via linkUrl.
See also Account action |
||
| 11 | Specifies how the link is to be opened.
All valid target values can be entered here, e.g. to open the link in a new tab/window.
If the value contains the term popup, a browser pop-up is generated and all window features can be used, e.g. to influence the position and size of the pop-up. |
||
| 12 | Target of the link. | ||
| 13 | Textual content for the menu element that represents the link. | ||
| 14 | Icon on the menu element for the link. | ||
| 15 | Additional logout button directly next to the account menu. This is only displayed if the account menu is not integrated within another menu (e.g. the global menu). | ||
| 16 | Display of an avatar instead of a button.
The avatar is a round representation of the initials of the logged-in user.
Alternatively, an image can also be displayed.
To make this possible, your Identity provider (OIDC or Keycloak) must set the picture attribute correctly.
To load images, it may be necessary to specify the source servers in the Content Security Policy Header for loading images.
The avatar display does not work within a menu. |
||
| 17 | If true:
Displays a popup in which the user’s own profile is updated in the Keycloak can be edited.
See also Account action |
||
| 18 | If true:
Displays a popup in which the own TOTP configuration in the Keycloak can be edited.
See also Account action |
||
| 19 | If true:
See also Account action |
||
| 20 | This array can be used to control the order of the elements in the menu.
The names of the elements correspond to the attribute names that can be used to (de)activate them.
If you do not want to influence the order, you can also remove this parameter.
|
Keywords:
