Überblick
Über die Anwender-Hilfe können Kundenadministratoren kontextbezogene Hilfetexte erstellen, die Endanwendern im User-Client angezeigt werden. Diese Hilfetexte liefern Erklärungen zu Feldern, Workflows oder allgemeine Bedienhinweise — direkt dort, wo sie gebraucht werden.
Die Anwender-Hilfe ist an verschiedene Kontextobjekte gebunden. So lässt sich für jedes Formular, jedes Feld oder jedes Ansichtselement ein eigener Hilfetext hinterlegen. Die Hilfetexte werden zentral im Admin-Client verwaltet und können jederzeit aktualisiert werden.
- Kontextbezogen: Jeder Hilfetext ist an ein bestimmtes UDM-Objekt gebunden (Dialog, Dialogelement, Ansichtselement, App etc.)
- Sortierbar: Mehrere Hilfetexte pro Objekt sind möglich und werden über eine Ordnungsnummer priorisiert
- Zentral verwaltbar: Alle Hilfetexte sind über die globale Übersicht oder direkt am jeweiligen Objekt erreichbar
- Sofort wirksam: Änderungen an Hilfetexten sind nach dem Speichern im User-Client sichtbar
Sie möchten einen Hilfetext erstellen, der Endanwendern erklärt, wie die Felder Rechnungsnummer, Fälligkeitsdatum und Bruttobetrag im Rechnungsdialog korrekt auszufüllen sind. Der Hilfetext soll direkt am Rechnungsdialog erscheinen.
Schritt 1: Hilfetexte öffnen
Es gibt zwei Wege, um Hilfetexte zu bearbeiten:
-
Globale Übersicht
Navigieren Sie im Admin-Client zum Bereich „Verwaltung“ und wählen Sie die Kachel „Anwender-Hilfe“. Hier sehen Sie alle im System vorhandenen Hilfetexte in einer tabellarischen Übersicht mit Spalten für Objekt-Art, Objekt-Name, Titel und Ordnungsnummer.
-
Direkt am Objekt
Öffnen Sie das gewünschte Objekt (z. B. einen Dialog oder eine App) und wechseln Sie auf den Reiter „Anwender-Hilfe“. Dort werden nur die Hilfetexte angezeigt, die diesem Objekt zugeordnet sind.
In unserem Beispiel: Öffnen Sie den Dialog „Rechnung“ und wechseln Sie auf den Reiter „Anwender-Hilfe“. Dort sehen Sie alle Hilfetexte, die dem Rechnungsdialog und seinen Dialogelementen zugeordnet sind.
| Kontexttyp | Objekt | Titel | Sortierung |
|---|---|---|---|
| Dialog | Rechnung | Rechnungsfelder ausfüllen | 10 |
| Dialogelement | Rechnung – Rechnungsnummer | Format der Rechnungsnummer | 20 |
| Dialogelement | Rechnung – Fälligkeitsdatum | Zahlungsziel prüfen | 30 |
| App | Faktura | Erste Schritte in der Faktura | 10 |
Schritt 2: Kontext wählen
Jeder Hilfetext ist an ein Kontextobjekt gebunden. Der Kontext bestimmt, wo der Hilfetext im User-Client angezeigt wird. Beim Erstellen eines neuen Hilfetexts legen Sie die Objekt-Art und das konkrete Objekt fest.
Verfügbare Kontexttypen
| Kontexttyp | Beschreibung | Beispiel |
|---|---|---|
| Dialog | Hilfetext für ein gesamtes Formular (UI-Dialog) | „Rechnung“, „Kundenakte“ |
| Dialogelement | Hilfetext für ein einzelnes Feld oder eine Feldgruppe innerhalb eines Dialogs | „Rechnung – Rechnungsnummer“, „Rechnung – Fälligkeitsdatum“ |
| Ansichtselement | Hilfetext für eine Listenansicht, ein Grid, ein Dashboard oder ein anderes Ansichtselement | „Rechnungsübersicht“, „Kunden-Grid“ |
| App | Hilfetext auf Anwendungsebene — allgemeine Hinweise zur gesamten App | „Faktura“, „CRM“ |
| Datenobjekt | Hilfetext für ein Datenobjekt (Entity) — technische Dokumentation | „Rechnungsdaten“, „Kundenstamm“ |
| Datenquelle | Hilfetext für eine Datenquelle — Erklärung der geladenen Daten | „Offene Rechnungen“, „Aktive Kunden“ |
| Subsystem | Hilfetext für ein Subsystem — Überblick über einen Fachbereich | „Buchhaltung“, „Personalwesen“ |
| Job | Hilfetext für einen automatisierten Hintergrund-Job | „Rechnungsversand“, „Datenimport“ |
In unserem Beispiel: Erstellen Sie über den Reiter „Anwender-Hilfe“ am Rechnungsdialog einen neuen Hilfetext. Der Kontexttyp Dialog und das Objekt „Rechnung“ sind bereits vorausgefüllt.
Schritt 3: Hilfetext eingeben
Im Detailformular des Hilfetexts geben Sie die folgenden Informationen ein:
| Feld | Beschreibung |
|---|---|
| Titel Pflicht | Kurzer, aussagekräftiger Titel des Hilfetexts (z. B. „Rechnungsfelder ausfüllen“) |
| Text Pflicht | Der eigentliche Hilfetext. Unterstützt Freitext mit Formatierung. Beschreiben Sie Schritt für Schritt, worauf der Anwender achten soll. |
| Ordnungsnummer Optional | Bestimmt die Reihenfolge bei mehreren Hilfetexten am selben Objekt. Niedrigere Nummern erscheinen zuerst. |
| Icon Optional | Optionales Icon zur visuellen Kennzeichnung des Hilfetexts |
In unserem Beispiel: Geben Sie als Titel „Rechnungsfelder ausfüllen“ ein. Im Textfeld beschreiben Sie die drei Felder:
- Rechnungsnummer: Wird automatisch vergeben, falls ein Nummernkreis konfiguriert ist. Andernfalls manuell eingeben.
- Fälligkeitsdatum: Das Datum, bis zu dem die Rechnung bezahlt werden muss. Muss nach dem Rechnungsdatum liegen.
- Bruttobetrag: Der Gesamtbetrag inkl. Mehrwertsteuer. Wird ggf. automatisch aus den Positionen berechnet.
Diese Hilfe erklärt die drei wichtigsten Felder im Rechnungsdialog:
- Rechnungsnummer — wird automatisch aus dem Nummernkreis vergeben.
- Fälligkeitsdatum — muss nach dem Rechnungsdatum liegen.
- Bruttobetrag — ergibt sich aus den Positionen inkl. MwSt.
Schritt 4: Hilfetext veröffentlichen
-
Speichern
Klicken Sie auf den Button „Speichern“ in der Toolbar. Der Hilfetext wird in der Datenbank gespeichert und ist ab sofort im User-Client verfügbar.
-
Prüfen im User-Client
Öffnen Sie den User-Client und navigieren Sie zum entsprechenden Dialog oder Ansichtselement. Der Hilfetext wird dort über das Hilfe-Symbol angezeigt.
-
Iterieren
Passen Sie den Text bei Bedarf an. Änderungen werden nach dem erneuten Speichern sofort wirksam — ein Neustart des User-Clients ist nicht erforderlich.
Zugriffswege im Admin-Client
Die Anwender-Hilfe ist an verschiedenen Stellen im Admin-Client erreichbar:
| Zugriffsweg | Beschreibung |
|---|---|
| Verwaltung → Anwender-Hilfe | Globale Übersicht aller Hilfetexte im System. Ermöglicht Suche, Filterung und Navigation zum jeweiligen Objekt. |
| Dialog → Reiter „Anwender-Hilfe“ | Zeigt alle Hilfetexte für den Dialog und seine Dialogelemente (Felder). Neuerstellung mit automatischer Kontextzuordnung. |
| Ansichtselement → Reiter „Anwender-Hilfe“ | Hilfetexte für ein bestimmtes Ansichtselement (Grid, Liste, Dashboard etc.). |
| App → Reiter „Anwender-Hilfe“ | Allgemeine Hilfetexte auf Anwendungsebene. |
Häufige Fragen
| Frage | Antwort |
|---|---|
| Wie viele Hilfetexte kann ein Objekt haben? | Es gibt keine feste Obergrenze. Mehrere Hilfetexte pro Objekt werden über die Ordnungsnummer sortiert. |
| Können Endanwender die Hilfetexte bearbeiten? | Nein. Die Pflege der Anwender-Hilfe erfolgt ausschließlich im Admin-Client durch Kundenadministratoren. |
| Was ist der Unterschied zur Admin-Dokumentation? | Die Anwender-Hilfe richtet sich an Endanwender im User-Client. Die Admin-Dokumentation (Admin-Handbuch) richtet sich an Administratoren und ist nur im Admin-Client sichtbar. |
| Kann ich Hilfetexte für einzelne Formularfelder anlegen? | Ja. Verwenden Sie den Kontexttyp „Dialogelement“. Im Dialog-Reiter „Anwender-Hilfe“ werden alle Felder des Dialogs als mögliche Kontextobjekte angeboten. |
| Was passiert, wenn ich ein Objekt lösche, an dem Hilfetexte hängen? | Die Hilfetexte bleiben bestehen, sind aber nicht mehr zugeordnet. Sie können über die globale Übersicht gefunden und bereinigt werden. |
| Werden Hilfetexte versioniert? | Nein. Es wird immer die aktuelle Version gespeichert. Änderungen überschreiben den vorherigen Stand. Nutzen Sie bei Bedarf das Änderungsprotokoll, um Modifikationen nachzuvollziehen. |