Online Hilfen
Das interne kontextsensitive Online-Hilfesystem von Lobster Data Platform / Orchestration kann über Online Hilfen erweitert werden.
|
XML Name |
core:OnlineHelp |
|
Klassenname |
de.lobster.scm.onlinehelp.OnlineHelp |
|
Rechte |
Verwaltung/Stammdaten/Online Hilfen |
Das interne kontextsensitive Online-Hilfesystem von Lobster Data Platform / Orchestration kann über Online Hilfen einfach erweitert werden.
Der zusätzliche Hilfe-Inhalt kann wahlweise auf einem der folgenden Wege bereitgestellt werden:
Hochladen einer PDF-Datei, die direkt im Online-Hilfe-Objekt (Feld documentContent) gespeichert wird.
Angeben einer absoluten oder relativen URL, die auf ein Dokument verweist, das der Browser anzeigen kann.
Eine relative URL wird als Unterseite des Pfads interpretiert, über den der Lobster Data Platform / Orchestration-Client aufgerufen wurde. So kann man z. B. auf Dokumente verweisen, die über den Dateimanager in den web-Ordner oder seine Unterverzeichnisse hochgeladen wurden.
In beiden Fällen wird beim Aufrufen der Online Hilfen das hochgeladene oder verknüpfte Dokument in einem neuen Browser-Tab angezeigt, sofern der Browser das anzuzeigende Dateiformat direkt unterstützt. Anderenfalls erscheint abhängig vom verwendeten Browser ein Dialog zum Öffnen und/oder Herunterladen des Inhalts.
Der Benutzer kann in der Regel über das 
-Symbol (rechts oben in der Titelleiste fast jeder View; s. Screenshot) die passende "Kontexthilfe" (s. Handbuch (Hilfe)) anzeigen, sofern die verwendete Rolle dies erlaubt und für den Kontext mindestens eine "passende" Handbuchseite vorliegt.
Der Zugriff auf Online Hilfen funktioniert nach demselben Prinzip. Sofern für einen Kontext Handbuch-Zugriff besteht, erscheinen für denselben Kontext "passende" Online Hilfen als zusätzliche Optionen in einem Kontextmenü, wenn auf das
-Symbol geklickt wird.
Ob eine bestimmte "Online Hilfe" überhaupt angeboten wird und in welchen Views sie erscheint, hängt einerseits von Zuordnungskriterien und anderseits von dem als Funktionsname angegebenen Kontext-Schlüssel ab (Details s. folgender Abschnitt).
►HINWEIS◄ Wenn die Aktuelle Sprache einer Sitzung die Anzeige von spezifischen Online Hilfen bewirken soll, muss dies über Zuordnungskriterien explizit geregelt werden. Für jeden "mehrsprachig" anzubietenden Inhalt müssen dann mehrere Online-Hilfe-Instanzen konfiguriert werden, denen jeweils ein geeignetes "sprachspezifisches" Zuordnungskriterium zugewiesen wird.
Laufzeitbeispiel:
Neben der Standard-Hilfe (Handbuch (Hilfe)) für Firmenfreigaben erscheint, wie im Screenshot zu sehen, ein zusätzliches "Online-Hilfe"-Dokument mit dem Titel "DON'T PANIC!", wenn der Benutzer auf das
-Symbol klickt.
|
|
|
|
Da es sich bei dem als Hilfe-Seite "DON'T PANIC!" angezeigten Dokument um eine PowerPoint-Präsentation handelt, kann der Browser-Tab diese nicht mit Bordmitteln öffnen. Stattdessen bietet der Browser (im Beispiel "Firefox") die Datei zum Download an. Sie kann gespeichert oder z. B. mit der Standard-Anwendung "PowerPoint" (soweit installiert) geöffnet werden. |
Sofern clientseitig eine passende Applikation installiert ist, kann das über eine URL referenzierte Dokument (hier im *.ppsx Format) an diese zum Öffnen übergeben werden. Alternativ wird in der Regel ein Download unterstützt. Abhängig von Browser-Einstellungen wird der Download ggf. auch direkt beim Anklicken ausgeführt. |
|
|
|
Übersicht für "Online Hilfen"
Der Menüpunkt "Verwaltung/Stammdaten/Online Hilfen" öffnet eine kombinierte Ansicht, die im Listenbereich alle Konfigurationen für Online Hilfen auflisten, auf die im aktuellen Anmeldekontext Zugriff besteht. Der vordefinierte Detailbereich zeigt die unten beschriebenen Konfigurationsmöglichkeiten.
►HINWEIS◄ Rollenberechtigungen und Freigaben für Online Hilfen beziehen sich ausschließlich auf die Konfiguration, nicht auf die operative Verfügbarkeit der konfigurierten Inhalte. Letzter hängt nur von den per Konfiguration zugewiesenen Zuordnungskriterien (2) ab, für die im Anmeldekontext mindestens Lesezugriff bestehen muss, damit ein Inhalt erfolgreich zugeordnet werden kann.
Über die Ribbon Buttons Neu, Löschen, Abbrechen, Kopieren, Speichern (1) können Konfigurationen für Online Hilfen erstellt, geändert/gespeichert, kopiert oder gelöscht werden.Über den Ribbon Button Zuordnung/Zuweisen (2) können bestehende Zuordnungskriterien zugewiesen oder bestehende Zuweisungen von Zuordnungskriterien gelöscht werden. Online Hilfen können nur als Optionen erscheinen, wenn mindestens eines der zugewiesenen Zuordnungskriterien lesbar ist und zutrifft.Die Auswahl für den Besitzer (3) ist (ggf. in Verbindung mit Firmenfreigaben) nur entscheidend für den Zugriff auf die Konfiguration der jeweiligen "Online Hilfe".Der Funktionsname (4) muss zu einem der Kontext-Schlüssel einer View passen, damit die betreffende "Online Hilfe" beim Klick auf das
-Symbol zugeordnet wird.
Die für eine View anwendbaren Kontext-Schlüssel erscheinen in einer Hinweisbox, wenn man die Tasten Strg+Alt gedrückt hält, während man auf das
-Symbol klickt.
Laufzeitbeispiel: Strg+Alt+
in der Übersicht für Online Hilfen liefert folgende Kontext-Schlüssel:
Jeder dieser Schlüssel kann als Funktionsname (4) eingetragen werden, um eine "Online Hilfe" für die Übersicht zu definieren. Allerdings treffen manche Schlüssel ggf. auch im Kontext anderer Views:
Die ersten beiden Zeilen stellen nur auf die Klasse der Entität "Sendung" (Shipment) ab. Wird einer dieser Schlüssel als Funktionsname (4) verwendet, dann ist die "Online Hilfe" für zugehörige Erfassungsmasken und Eigene Übersichten.
In der zweiten und dritten Zeile erscheint der konkrete Viewname, der neben dem View-Typ (hier: listSearchWindow) für Eigene Übersichten auch deren Namen einbezieht.
Schlüssel die das Wildcard-Symbol (*) enthalten, greifen ...
für Views unterschiedlicher Typen für eine Klasse ( ...|Shipmment|* ),
für alle Views eines bestimmten Typs für eine Klasse (...|listSearchWindow|*) oder
für alle Views (*) ohne Bezug zu einer Klasse.
Der Schlüssel administration/masterData/onlineHelpOverview bezieht sich auf den Menüknotennamen, der zur Laufzeit nur gilt, wenn die View tatsächlich über die Menüleiste geöffnet wurde.
►HINWEIS◄ Falls eine "Online Hilfe" das Wildcard-Symbol (*) als Funktionsname (6) verwendet, hängt es nur noch von den zugewiesenen Zuordnungskriterien ab, ob und wo der entsprechende Inhalt als Hilfetext angeboten wird. Dadurch wird ggf. der Zugriff auf Kontexthilfe aus dem Handbuch (s. Handbuch (Hilfe)) erschwert, da dann durch die "überall" anwendbare zusätzlichen Online-Hilfe ein zusätzlicher Klick ins eingeblendete Kontextmenü erforderlich ist. Falls ein bestimmter Anwenderkreis ("Endanwender") allerdings sowieso keinen Handbuchzugriff erhält, kann es sinnvoll sein, für diesen z. B. auf der Grundlage einer Rollenregel in einem Zuordnungskriterium ein allgemeines Dokument (z. B. "Nutzungsbedingungen") als "Online Hilfe" global zuzuweisen, die dann in allen Masken per Klick auf
geöffnet werden kann.
Der Dokumentname (5) erscheint im Kontextmenü für die Hilfe, das nur angezeigt wird, falls zur Laufzeit mehrere Hilfe-Inhalte für denselben Kontext greifen.Der Dokumenttyp (6) mit den Optionen "PDF" und "URL" definiert, ob der Inhalt der Online Hilfe als PDF hochgeladen oder durch eine URL verknüpft werden soll.Das Dokument (7) wird über ein Datei-Element (zum Hochladen) für den Dokumenttyp (6) "PDF" oder ein Textfeld für den Dokumenttyp (6) "URL" definiert.►ANMERKUNG◄ In beiden Fällen wir der Wert für Dokument (7) Base64-codiert im Feld documentContent gespeichert. Dies ist zu berücksichtigen, falls Konfigurationen für Online Hilfen automatisch erstellt oder z. B. per Suche ausgewertet werden sollen.