User menu

images/download/attachments/201671184/image-2025-5-8_13-6-37-version-1-modificationdate-1746702396769-api-v2.png

Header area:
Profile picture | User of session
Role of session, Company of session
Click to open ↓


Menu entries:

Some menu items are linked to permissions
for the Role of session!

Custom entries
can be added to the menu to trigger Client workflows.
Their availability depends on the evaluation of
Association criteria in the context of the session.

The menu items Reload main menu
and Logout are always available.

images/download/attachments/201671963/image-2025-5-16_8-34-2-version-1-modificationdate-1747377241475-api-v2.png

The User menu section can be found on the right-hand side of the Top bar.

User menu functions

Header: Information on the login context

The header area, which is permanently visible within the Top bar, provides information about the most important aspects of the login context for the current session:

Session feature

Display

Notes

User of session

If a Profile picture is assigned to the User of session (see Change profile picture), this appears on the far left in the header area of the User menu section. Otherwise, the first letter of the string generated to identify the user appears.

The User of session is identified via a concatenation of the relevant text fields (‘Name’/name1, ‘Name 2’/name2 and, if applicable, ‘Name 3’/name3) from the address of the user account, provided these are filled. If none of these fields are filled, the ‘user name’ (username) is used.

There is no profile picture, address or user name available for Guest users.

A logged-in guest user is identified by their ‘login token’ (loginToken), which is typically a randomly generated sequence of characters and numbers. The first character of this string therefore appears instead of the profile picture.

Role of session

The role predefined or selected during login (see Roles) is shown on the left in the lower text line.

If the Localization or Company specific localization provides for a localisation of the role name for the Current locale, this is used. Otherwise, the 'role name’ (roleName) appears directly.

Company of session

The company predefined or selected during login (see Companies/Clients) is identified in the lower text line after a comma as a separator.

The Company of session is identified via a concatenation of the relevant text fields (‘Name’/name1, ‘Name 2’/name2 and, if applicable, ‘Name 3’/name3) in the address of the company account.

If none of the relevant name fields in the address of the Company of session are filled, the second line of text ends with a comma and no reference to the Company of session.

Menu entries in the User menu

The actual User menu is opened by clicking in the header area.

Different types of restrictions may apply to the display of menu items:

  1. Users or Guest users can be considered as User of session. Not all menu entries are relevant for Guest users.

  2. Most menu entries are linked to the existence of a specific permissions for the Role of session.

  3. The Fast switch is only offered for Users who have a choice when logging in.

  4. Customised menu entries (for Client workflows) only appear if assigned Association criteria apply.

The following table refers exclusively to the menu items predefined by the system for which type 1, 2 and 3 restrictions may be relevant.

Menu entry

Description

Restriction?

for Guest users

Settings

Opens a dialogue in which settings can be made for the User of session:

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg Permissions for the Role of session for at least one function in the dialogue::

  • ‘Administration/Accounts/Profile/Change profile picture’

  • ‘Administration/Accounts/Profile/Change password’

  • None for 'Common settings'

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg not relevant

Print service

Enables Print documents to be output on a printer available on the client side.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg Permissions for Role of session: 'Administration/System/Printing service'

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg when authorised

Change locale

Assigns a supported language (see Locale) to the User of session and defines this as the Current locale for the session.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg Permissions for Role of session:
‘Administration/Accounts/Profile/Change locale’

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg when authorised

Switch theme: <Color theme>


or Color themes (menu node)

Apply an alternative Color theme for the current session.
NOTE◄ Alternative Color themes can be selected directly (one alternative) or from a menu node (multiple alternatives).

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg applicable Style template specifies alternative Color themes (s. Styles, Style templates)

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg if alternative themes exist

Reload main menu

Updates the Main menu, where menu entries can be added, removed or appear with a new icon/labelling text.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Always available

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Always available

Integration Notes

Opens the central view for notes (Lobster Data Platform / Integration).

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Always available

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg not relevant

Help

The menu node Help appears, upon permissions for at least one of the contained menu items:

  • Manual (opens an online manual in a new browser tab)

  • About Lobster (information about the Lobster Data Platform (version, installation)

  • Start product tour (highlights key features of user interface)

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg Permissions for the Role of session for at least one menu item:

  • 'Help/Admin manual'

  • 'Help/About'

  • any of the above

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg when authorised

Fast switch / Logout

Opens the dialogue for the Fast switch, which enables the Role of session and/or Company of session to be changed without logging out or logging out of the session.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/help_16.svg User of session has the choice between several Roles and/or Companies/Clients when logging in

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/error.svg not relevant

Logout

Logs out of the current session and displays the login dialogue in the browser window.

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Always available

images/s/-95e2zf/9012/8yg2g7/_/images/icons/emoticons/check.svg Always available