URL-Parameter

loginToken

Dem Parameter loginToken kann ein Login-Token als Textwert zugewiesen werden, mit dem ein automatisches Gastbenutzer-Login ausgeführt werden soll.

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

HINWEIS◄ Wird der Parameter loginToken gleichzeitig mit dem Parameter locale verwendet, übersteuert der Parameter locale nicht die im per loginToken identifzierten Gastbenutzerkonto zugeordnete Sprache (locale) als Aktuelle Sprache der Sitzung. Allerdings kann die Sprachauswahl per locale auch in dieser Kombination durchaus operative Auswirkungen:

  • Bis zum erfolgreichen Aufbau der Gastbenutzer-Sitzung können Fehlermeldungen auftreten, etwa weil der loginToken unbekannt, abgelaufen, inaktiv oder zu oft verwendet worden ist (s. Gastbenutzer für Details). Falls die maximale gleichzeitiger Logins für den angegebenen loginToken übrschritten würde, scheitert der Sitzungsaufbau ggf. (abhängig vom force-Parameter) ebenfalls mit einer Fehlermeldung. Für die Lokalisierung von Fehlermeldungen ist in diesen Fällen der locale-Parameter relevant.

  • Falls die per loginToken angeforderte Sitzung nicht zustande kommt, erscheint per Standard ein Login-Dialog für dessen Kontext der locale-Parameter ebenfalls den Ausschlag gibt.

  • Kann die per loginToken angeforderte Sitzung erfolgreicht gestartet werden, bestimmt der locale-Parameter die Login-Sprache auch dann wieder, wenn diese durch Abmelden regulär beendet wurde.

force

Der Parameter force wird in Verbindung mit einer Gastbenutzer-Anmeldung über den loginToken-Parameter berücksichtigt, falls durch den Aufbau der angeforderten Sitzung der Grenzwert "Max. gleichzeitige Sitzungen" (maxConcurrentSessions) für das zugehörige Gastbenutzerkonto überschritten würde:

  • Spezifiziert die URL force=false, dann entscheidet im Konfliktfall die Antwort des anmeldenden Gastbenutzers auf eine Benutzerrückfrage, ob eine bestehende Sitzung mit demselben loginToken geschlossen werden soll, um die angeforderte Anmeldung zu ermöglichen. Anderenfalls wird der Anmeldeversuch abgebrochen. Die Anforderung kann durch Aktualisieren des Browsertabs wiederholt werden, z. B. nachdem gezielt eine andere Sitzung abgemeldet wurde.

  • Per Standard, also falls der Parameter auf einen anderen (auch keinen) Wert verweist oder nicht verwendet wird, dann wird im Konfliktfall ohne Rückfrage eine bestehende Sitzung zwangsweise beendet, um die angeforderte Anmeldung zu ermöglichen. Im betroffenen Client erscheint für begrenzte Zeit eine Benachrichtigung für den "abgemeldeten" Gastbenutzer.

open

Mit diesem Parameter kann eine View adressiert werden, die direkt nach dem Login geöffnet werden soll .Wie bei einem interaktiven Zugriff entscheidet das System dabei selbstständig anhand von Zuordnungskriterien, was der Anwender zu sehen bekommt. Es kann also keine bestimmte Maske oder Übersicht zur Anzeige aufgerufen werden und auch die Zugriffsrechte werden abhängig von der verwenden Anmeldung berücksichtigt.

Die folgenden Parameter können in Verbindung mit open verwendet werden, um weitere Details zu definieren.

id
[load]

Wenn per open eine Übersicht oder eine Detailmaske geöffnet wird, kann der Parameter id verwendet werden, um auf ein bestimmtes Objekt abzustellen. Was diese Vorwahl genau bewirkt hängt vom Typ der Ansicht und davon ab, ob außerdem der Parameter load verwendet wird:

  • Ausgehend von einer Übersicht (z. B. einer Sendungsübersicht) und ohne den Parameter load bewirkt der Parameter id grundsätzlich eine Filterung auf die angegebene Objekt-ID. Ist dieses Objekt nicht vorhanden oder innerhalb der Sitzung (Firma/Rolle) nicht im Zugriff, erscheint die Übersicht leer. Mit dem Parameter load wird das angegebene Objekt "angesteuert" um Details anzuzeigen. Enthält die Übersicht eine Detailsicht (z. B. Firmenübersicht), entspricht dies dem Auswählen des Objekts in der Liste. Bei einer reinen "Liste" (z. B. Sendungsübersicht) erscheinen dagegen die Details zum Objekt in einer eigenen Maske (z. B. Sendungsdetails).

  • Ausgehend von einer Detailsicht (z. B. Bestelldetails) bewirkt der Parameter id in Verbindung mit dem Parameter load, dass die Daten des entsprechenden Objekts direkt in der Detailmaske erscheinen, falls das Objekt vorhanden ist und innerhalb der Sitzung Zugriff besteht. In allen anderen Fällen wird die Detailsicht mit einem neuen Datenobjekt geöffnet.

Ohne Angabe einer id ist der Parameter load wirkungslos.

loginview

Legt fest welcher Logintyp im Loginfenster geladen werden soll. Der Parameterwert ist dabei ein Schlüssel zur Identifikation des Typs.
z.B. loginview=guest

Bislang stehen folgende Schlüssel zur Verfügung:

  • user Der Standardbenutzerlogin mit Benutzername, Passwort und ggf. Firma und Rolle

  • guest Der Gastbenutzerlogin mit Logintokenfeld

  • portal Wenn das _data Portal zur Verfügung steht lädt dieser Parameter initial die Maske für den Portallogin

locale

Über den Parameter locale kann die Sprache für den aufgerufenen Lobster Data Platform / Orchestration-Client vorgewählt werden. Als Parameterwert wird dabei ein interner Name (name) für eine konfigurierte Sprache (Dynamische Aufzählung) erwartet, also z. B. locale=en für die Sprache "Englisch".

WICHTIG◄ Der Wert für den Parameter locale übersteuert Einstellungen für die Sprache im Browser ("Bevorzugte Sprachen") bzw. für das Betriebssystem (Anzeigesprache). Lobster Data Platform / Orchestration prüft den Parameterwert nach folgendem Schema:

  • Entspricht der Parameterwert exakt (inkl. Groß-/Kleinschreibung) dem Namen eines Werts in der Dynamischen Aufzählung Sprache, dann wird diese Sprache zugewiesen, sofern sie als Unterstützte Sprache qualifiziert ist.

  • Verwendet der Parameterwert den Aufbau einer länderspezifischen Sprache (<localeCode>_<countryCode>), die nicht in der Dynamischen Aufzählung Sprache unbekannt ist oder zumindest nicht als Unterstützte Sprache gilt, dann wird die im Parameterwert enthaltene "globale Sprache" (<localeCode>) ausgewertet wie im folgenden Schritt beschrieben.

  • Für die Prüfung einer direkt oder indirekt adressierten "globalen Sprache" gilt die folgende Fallunterscheidung:

    • Ist die adressierte "globale Sprache" eine Unterstützte Sprache, dann wird sie zugewiesen.

    • Ist die adressierte "globale Sprache" vorhanden aber keine Unterstützte Sprache, dann wird die Sprache "Englisch" (en) zugewiesen.

    • Ist die adressierte "globale Sprache" komplett unbekannt, wird auf die Standardsprache zurückgegriffen (Details s. Sprache).

HINWEISE

  • Ab Version 4.8 beeinflusst der Parameter locale (genau wie eine interaktive Sprachauswahl im Anmeldedialog) nicht nur den Anmeldedialog und ggf. die dort angestoßene Passwort-Vergessen-Funktion, sondern übersteuert die im Benutzerkonto definierte Sprachauswahl. Die Auswahl im Benutzerkonto wird dadurch aber nicht geändert. Sie greift bei der nächsten Anmeldung ohne locale-Parameter in der URL wieder wie gewohnt.

  • Der Parameter locale wirkt in Bezug auf die Aktuelle Sprache einer Sitzung unabhängig davon, ob die Rolle der Session über die Berechtigung zum "Sprache ändern" (Verwaltung/Konten/Profil/Sprache ändern) verfügt oder nicht.

  • Falls über Parameter loginToken auf ein Gastbenutzer-Konto zugegriffen wird, hat der Parameter locale keine Auswirkung, da für die direkt und ohne Login gestartete Sitzung immer die im Konto festgelegte Sprache verwendet wird.

menu

Legt den Zustand des Menüs fest. z.B. menu=hover

Folgende Modi werden unterstützt, können jedoch, abhängig vom verwendeten Basislayout, teilweise unterschiedlich interpretiert werden:

  • hidden - Versteckt das Menü. Es kann über den Menüknopf oder durch die Such-Tastenkombi "STRG/CMD + SHIFT + F" wieder, in "schwebendem" Zustand, eingeblendet werden

  • hover - Zeigt das Menü in "schwebendem" Zustand an. Ein Klick außerhalb des Menüs versteckt es automatisch

  • normal - Standard

  • full - Zeigt das Menü im Vollbildmodus an, wenn nicht automatisch eine View geöffnet wird (Nur Urban Layout)

  • none - Versteckt das Menü. Es kann nicht wieder eingeblendet werden (Wichtig: Zum aktuellen Stand kann sich der Benutzer auch nicht mehr selbst abmelden)

safeMode

Qualifiziert den Start einer Sitzung im abgesicherten Modus (s. Abgesicherter Modus (safeMode)), falls die Rolle der Session über die betreffende Berechtigung verfügt. Anderenfalls wird der Parameter ignoriert.

►HINWEISE◄

  • Die "Adresse" für den Aufruf einer View mit open kann man meist ermitteln, indem man mit gedrückten STRG- und ALT-Tasten auf das Fragezeichen in der Titelleiste der geöffneten Ansicht klickt. Dann erscheinen Informationen zum Kontext der View in einem Dialogfenster, das in der letzten Zeile die gesuchte Zeichenfolge zeigt. Der Screenshot zeigt die Meldung für eine "Firmenübersicht", in der der ausschlaggebende Abschnitt blau hervorgehoben ist:

    images/download/attachments/137310944/image2018-9-25_11-27-45-version-1-modificationdate-1689947435764-api-v2.png



  • Enthält die "Adresse" einer View Zeichen, die in einer URL unzulässig bzw. "reserviert" sind ( ! * ' ( ) ; : @ & = + $ , / ? % # [ ] ), müssen diese im Parameter URL-encoded also durch zweistellige Hexadezimalcodes mit vorangestelltem %-Zeichen ersetzt werden. In den folgenden Beispielen sind diese Codes blau hervorgehoben, die ersetzten Zeichen rot :

    URL mit Parametern

    Gewünschte Auswirkung

    ./SCM/?open=shipment%2FshipmentOverview

    Einstieg in die Sendungsübersicht shipment/shipmentOverview

    ./SCM/?open=shipment%2FshipmentDetails

    Einstieg in die Sendungsneuanlage shipment/shipmentDetails

    ./SCM/?open=shipment%2FshipmentDetails&id=701&load

    Einstieg in die Sendungsdetails einer Sendung mit ID = 701

    ./SCM/?open=shipment%2FPortal%24Testportal

    Einstieg in ein Portal mit der Seiten-Id shipment/Portal#Testportal

  • Textzeichen in der Adresse müssen unter Beachtung der Groß-/Kleinschreibung korrekt eingegeben werden, also "shipmentOverview" und nicht "ShipmentOverview" oder "documents" und nicht "DOCUMENTS" (usw.)

  • Wenn beim Aufruf von Lobster Data Platform / Orchestration über URL-Parameter bestimmte Objekte in einer Übersicht "abgefragt" werden sollen, sollte eine Externe Suche als Lösungsmöglichkeit in Betracht gezogen werden.

  • Auch die Ereignisse der Kategorie Anmeldung (Ereignisse) bieten über Ereignisbehandlungen weiterführende Möglichkeiten das Verhalten beim "Einstieg" in Lobster Data Platform / Orchestration zu beeinflussen.