URL parameters

loginToken

The loginToken parameter can be assigned a login token as a text value with which an automatic Guest users login is executed.

Example: loginToken=646449c3-8778-446d-9928-4ead9da18076

►NOTE◄ If the loginToken parameter is used simultaneously with the locale parameter, the locale parameter does not override the language (locale) assigned in the guest user account identified by loginToken as the Current locale of the session. However, the language selection by locale can have quite operational effects even in this combination:

• Error messages may occur until the guest user session is successfully established, e.g. because the loginToken is unknown, expired, inactive, or has been used too often (see Guest users for details). If the maximum number of concurrent logins for the specified loginToken is exceeded, the session setup may also fail with an error message (depending on the force parameter). The locale parameter is relevant for locating error messages in these cases.
  
  

• If the session requested by loginToken is not established, a login dialog appears by default, for the context of which the locale parameter is also decisive.
  
  

• If the session requested by loginToken can be started successfully, the locale parameter determines the login language again even if it was terminated regularly by logging out.

force

The force parameter is taken into account in conjunction with a Guest users login via the loginToken parameter if the establishment of the requested session would exceed the (maxConcurrentSessions) limit for the associated guest user account:

• If the URL specifies force=false, then in case of conflict the logon guest user's response to a user query decides whether to close an existing session with the same loginToken to allow the requested login. Otherwise, the login attempt is aborted. The request can be repeated by refreshing the browser tab, e.g. after specifically logging out of another session.
  
  

• By default, i.e. if the parameter points to another (even no) value or is not used, then in case of conflict an existing session is forcibly terminated without prompting to allow the requested login. In the affected client, a notification for the 'logged out' guest user appears for a limited time.

open

This parameter is used to call for a specific view to be opened immediately after login. The system handles this request no differently from an interactive approach and will present output depending on Association criteria. The parameter does not address a specific form or overview and data access may be restricted based on permissions and authorizations for the session.

The following parameters may be combined with open to define further details.

id
[load]

When the open parameter addresses an overview or details form, the id parameter may be used to designate a specific object as data context. The effects of this depend on the type of view and the presence of the load parameter in the URL:

• For an overview (e.g. Shipment overview) and without parameter load, the id parameter serves as a filter criterion to identify an object by its id. If that object does not exist or is not visible in the context of the session (company account, role), an empty overview appears. With parameter load included in the URL, details of the specified object will be presented. For a view featuring a details section (e.g. company accounts), the effect is equivalent to selecting an entry in the list. If the overview is a plain list (e.g. Shipment overview), the details will appear in an additional view (e.g. Shipment details).

• For a detail view (e.g. Order details) the id parameter combined with the load parameter, will immediately produce details in a form, provided the object exists and is visible within the session. In all other cases, the detail view is loaded with a new data object.

Without an id, the load parameter is ineffective.

loginview

Defines which login type should be loaded in the login window. The parameter value is a key for identification of the type.
e.g. loginview=guest

So far, the following keys are available:

• user: The default user login with username, password and, if necessary, company and role.

• guest: The guest user login with login token field.

• portal: If the _data portal is available, this parameter initially loads the form for the portal login.

locale

The locale parameter can be used to preselect the Locale for the called Lobster Data Platform / Orchestration client. An internal name (name) for a configured Locale (dynamic enumeration) is expected as a parameter value, e.g. locale=en for the Locale 'English'.

►IMPORTANT◄ The value for the locale parameter overrides settings for the language in the browser ('Preferred languages') or for the operating system (display language). Lobster Data Platform / Orchestration checks the parameter value according to the following scheme:

• If the parameter value corresponds exactly (incl. upper/lower case) to the name of a value in the dynamic enumeration Locale, then this language will be assigned if it qualifies as a Supported locale.
  
  

• If the parameter value uses the structure of a country-specific locale (<localeCode>_<countryCode>) that is not unknown in the dynamic enumeration Locale or at least is not considered a Supported locale, then the 'global locale' (<localeCode>) contained in the parameter value is evaluated as described in the following step.
  
  

• The following case distinction applies to the testing of a directly or indirectly addressed 'global locale':
  

  • If the addressed 'global locale' is a Supported locale, then it will be assigned.

  • If the addressed 'global locale' is present but not a Supported locale, then the language 'English' (en) will be assigned.

  • If the addressed 'global locale' is completely unknown, the Default locale is used (see Locale for details).

►NOTE◄

• From version 4.8 onwards, the locale parameter (as well as an interactiv selection of locale in the ogin dialog) not only affects the login dialog and possibly the 'Forgot password' function triggered there, but also overrides the language selection defined in the user account. However, this does not change the selection in the user account. The next time the user logs in without the locale parameter in the URL, the selection will take effect as usual.

• The locale parameter acts with respect to the Current locale of a session regardless of whether the Role of session has the 'Change locale' permission (Administration/Accounts/Profile/Change locale) or not.

• If a Guest users account is accessed via parameter loginToken, the locale parameter has no effect, since the language specified in the account is always used for the session started directly and without login.

menu

Sets the state of the menu. e.g. menu=hidden

The following modes are supported:

• hidden – hides the menu. It can be displayed again in a 'floating' state via the menu button or the search key combination 'CTRL/CMD + SHIFT + F'.

• hover – displays the menu in a 'floating' state. Clicking outside the menu automatically hides it.

• normal – default.

• full - Opens the menu in full screen mode if no view is opened right away (Urban layout only)

• none – hides the menu. It cannot be shown again (important: In the current state, users can no longer log themselves out).

safeMode

Qualifies the start of a session in Safe mode (see Safe mode (safeMode)), if the respective permission is granted by the Role of session.