Freigeben über

Erstellen Sie einen interaktiven Begleiter für Ihre App Einheitliche Oberfläche

  • Artikel

Verwenden Sie benutzerdefinierte Hilfebereiche und Aufgabenhilfen, um Ihrer Einheitliche Oberfläche Anwendung eine benutzerdefinierte, auf Ihr Unternehmen zugeschnittene Hilfefunktion, im Produkt zu bieten. Verwenden Sie benutzerdefinierte Hilfebereiche, um tabellen-, formular- und sprachspezifische Hilfe und Anleitungen bereitzustellen, die Rich Text, Inhaltslinks, Bilder und Videolinks enthalten.

Wichtig

  • Benutzerdefinierte Hilfebereiche ersetzen die frühere Lernpfad-geführte Hilfefunktion, die mit älteren Webclient-Apps verwendet wurde.
  • Benutzerdefinierte Hilfefenster funktionieren nicht mit Einheitliche Oberfläche-Apps, die auf einem Mobilgerät ausgeführt werden, wie Android und iOS-Tablets und -Smartphones.

Benutzerdefinierte Hilfebereiche und -Lernpfad

Die neue Implementierung des interaktiven Begleiters benutzerdefinierter Hilfebereiche unterscheidet sich von der vorherigen Funktion des interaktiven Lernpfadbegleiters. Beide Funktionen erlauben Ihnen die Erstellung benutzerdefinierter Hilfe für Ihre Anwendung. Allerdings werden benutzerdefinierte Hilfebereiche für die gängigsten Szenarien interaktiver Begleiter optimiert.

Benutzerdefinierte Hilfebereiche bieten die folgenden Hauptfunktionen, die beim Lernpfad nicht verfügbar sind:

  • Frei definierbarer Rich-Text, einschließlich Aufzählungszeichen und Nummerierung.
  • Sichtbar verknüpfte Trainermarkierungen und Hilfesprechblasen.
  • Weitere Optionen für Videoquellen, einschließlich privater Quellen.
  • Speicher des Hilfeinhalts im Microsoft Dataverse als Rahmen Ihrer Lösung.

Benutzerdefinierte Hilfebereiche bieten nicht die folgenden Hauptfunktionen, die beim Lernpfad verfügbar sind:

  • Sequenzielle Hilfesprechblasen.
  • Hilfeseiten pro Rolle.
  • Hilfeseiten für Pro-Gerät-Formfaktor, z. B. Smartphone.

Anforderungen

Um die Funktion für benutzerdefinierte Hilfefenster verwenden zu können, benötigt Ihre Umgebung Folgendes:

Benutzerdefinierte Hilfebereiche für Ihre Umgebung aktivieren.

  1. Öffnen Sie eine modellgesteuerte App, und wählen Sie dann in der Befehlsleiste Einstellungen Einstellungen > Erweiterte Einstellungen aus.

  2. Gehen Sie zu Einstellungen > System > Verwaltung.

  3. Wählen Sie auf der Verwaltungsseite den Eintrag Systemeinstellungen.

  4. Wählen Sie auf der Registerkarte Allgemein unter Benutzerdefinierte Hilfe-URL einrichten Ja für Benutzerdefinierte Hilfebereiche und Aufgabenhilfen aktivieren, und klicken Sie dann auf OK.

    Benutzerdefinierte Hilfebereiche aktivieren

Wichtig

  • Sie können benutzerdefinierte Hilfebereiche oder die benutzerdefinierte Hilfe aktiveren, aber nicht beide gleichzeitig. Bestätigen Sie, dass Benutzerdefinierte Hilfe für anpassbare Tabellen verwenden und Parameter an URL anfügen auf Nein festgelegt wurden.
  • In einigen Umgebungen müssen Sie möglicherweise auch Lernpfad aktivieren auf Ja festlegen.

Erforderliche Berechtigungen

  • Um Hilfebereiche zu erstellen, benötigen App-Ersteller globale Berechtigungen zum Erstellen, Lesen, Schreiben, Löschen und Anfügen in der Tabelle Hilfeseite. Die Sicherheitsrollen Systemadministrator und Systemanpasser verfügen standardmäßig über diese Rechte.
  • Um Hilfebereiche in einer App anzuzeigen, benötigen Benutzer Leseberechtigung für die Hilfeseite-Tabelle. Die Hilfebereichanwender-Sicherheitsrolle besitzt standardmäßig diese Berechtigung. Standardmäßig hat die Basisbenutzer-Sicherheitsrolle keine Berechtigungen für die Hilfeseite-Tabelle.

Weitere Informationen: Sicherheitsrollen und Rechte

Kontextbezogene benutzerdefinierte Hilfe

Jeder Hilfebereich für diese Kontexte ist eindeutig:

  • Anwendung
  • Tabelle
  • Formular
  • Sprache

Hilfebereichnavigation

Standardmäßig bleibt ein Hilfebereich geöffnet und in dem Hilfsinhalt, mit dem Sie ihn zuerst geöffnet haben, auch wenn Sie zu einem anderen Formular navigieren. Auf diese Weise bleibt der Hilfeinhalt erhalten, während Sie die Benutzer zu verschiedenen Teilen der App leiten.

Hilfebereichsinhalt verfassen

  1. Um einen Hilfebereich anzuzeigen öffnen Sie eine modellgesteuerte App und wählen Sie dann Hilfe auf der Befehlsleiste aus.

    Hilfe.

  2. Klicken Sie im Hilfebereich auf die vertikalen Auslassungszeichen und wählen Sie dann Bearbeiten aus.

    Hilfe bearbeiten

    Der Hilfebereich ist jetzt im Bearbeitungsmodus und der Cursor ist auf dem Hilfebereichstitel positioniert.

  3. Aus dem Bearbeitungsbereich können Sie die folgenden Aufgaben ausführen:

    • Geben Sie den Text ein, indem Sie direkt im Hilfebereich schreiben.
    • Formatieren Sie Text mithilfe von Rich-Text-Funktionen und fügen Sie Aufzählungszeichen/nummerierte Listen, Abschnitte, Videos, Bilder, Links, Trainermarkierungen und Sprechblasenhilfe hinzu.

  4. Wählen Sie Speichern aus, um Ihre Änderungen zu speichern.

Freihandtext

Text kann an einer beliebigen Stelle im Hilfebereich platziert werden. Geben Sie Freihandtext vor, in oder nach Abschnitten ein. Text unterstützt die Schriftartformate Fett, Kursiv, Unterstrichen und Durchgestrichen. Ausschneiden, Kopieren und Einfügen können ebenso wie Rückgängig machen über mehrere Schritte verwendet werden.

Aufzählungszeichen und nummerierte Listen

Das Auswählen des Aufzählungszeichens oder Zahlensymbols wechselt auf der aktuellen Schreibzeile, um diese als Aufzählung oder Nummerierung zu formatieren. Wenn Sie in einer Liste mehrere Zeilen ausgewählt haben, wird jede Zeile aufgezählt oder nummeriert. Tabulatoren und Einrückungen von Unternummern werden innerhalb der Liste ausgerichtet.

Abschnitte

Ein Abschnitt ist ein reduzierbares Textfeld. Sie können Links oder Freihandtext darin eingeben. Verwenden Sie einen Abschnitt, um ähnliche Elemente zu gruppieren. Ein Abschnitt kann standardmäßig geöffnet oder reduziert werden.

Video und statische Bilder

Sie können Videos und statische Bilder in Ihren Hilfebereich einfügen. Videos und Bilder sind Links zu Internet-Inhalten. Benutzerdefinierte Hilfebereiche speichern nicht die Video- und Bilddateien in Ihrem Hilfebereich. Wenn der Hilfebereich geöffnet ist bringen benutzerdefinierte Hilfebereiche Inhalte aus dem Link, um sie anzuzeigen. Sie können einen Link mit einem Video Microsoft Stream verwenden, wenn Sie auf korporativen privaten Inhalt verweisen möchten.

Tipp

Vergessen Sie nicht, die Link-URL für das gewünschte Video oder Bild zu kopieren, damit Sie es in Ihren Hilfebereich einfügen können.

Benutzerdefinierte Hilfebereiche unterstützen die folgenden Videoquellen:

  • Microsoft Stream (Klassisch) (für privaten Inhalt verwenden)
  • YouTube
  • Facebook
  • Vimeo

Links können sich auf Websites beziehen und im gleichen Fenster (Standard) oder in einem separaten Fenster öffnen. Die Möglichkeit der Verknüpfung zu einer vorhandenen Hilfeseite ist noch nicht aktiviert.

Sprechblasen und Trainermarkierungen

Sprechblasen und Trainermarkierungen können verwendet werden, um auf bestimmten Benutzeroberflächenelementen zu verweisen. Eine Sprechblase kann Text enthalten.

Sprechblase einfügen

Eine Trainermarkierungen hebt einfach ein Element mit einem Coach-Zeiger hervor, um die Aufmerksamkeit des Benutzers auf das Element der Benutzeroberfläche zu lenken.

Trainermarkierungen einfügen

Der Autor muss das Ziel durch Drag & Drop-Funktion in den Eigenschaften von Ballons und Trainermarkierungen definieren. Der Autor kann den Text für Titel und Beschreibung für Trainermarken eingeben.

Drag & Drop

Hinweis

  • Sprechblasen und Trainermarkierungen funktionieren nicht gut mit benutzerdefinierten Komponenten. Diese Funktion gilt nur für standardmäßige Einheitliche Oberfläche UI-Komponenten.
  • Sequenzielle Hilfe-Sprechblasen und Trainermarkierungen werden noch nicht unterstützt.

Lösungen und benutzerdefinierter Hilfebereichsinhalt

Alle Inhalte der Hilfe werden in einer Hilfeseitenkomponente in Dataverse als Teil Ihrer Lösung gespeichert. Wenn Sie Ihre Lösung von einer Umgebung in eine andere verschieben, z. B. vom Test in die Produktion, können Sie festlegen, dass Ihre Hilfezeilen exportiert werden, damit sie in die Lösung aufgenommen werden. Dies ermöglicht Ihnen, Ihren Hilfeinhalt konsistent mit Funktionen in Ihrer Lösung zu halten, wenn er in verschiedene Umgebungen verschoben wird. Als Bestandteil Ihrer Lösung unterstützen benutzerdefinierte Hilfebereiche alle Funktionen der Standardlösung von ALM.

Inhalt über Lösungen verschieben

Standardmäßig erscheinen alle neuen Hilfeseiten in der Standardlösung. Wenn Sie Ihre Inhalte auf eine andere Umgebung verschieben möchten, fügen Sie zunächst Ihre vorhandenen Hilfeseiten einer nicht verwalteten Lösung hinzu, bevor Sie sie exportieren. um eine Hilfeseite einer nicht verwalteten Lösung hinzufügen, gehen Sie folgendermaßen vor:

  1. Melden Sie sich bei Power Apps an.
  2. Wählen Sie im linken Navigationsbereich die Option Lösungen aus. Wenn sich das Element nicht im linken Seitenbereich befindet, wählen Sie …Mehr und dann das gewünschte Element aus.
  3. Öffnen Sie die gewünschte nicht verwaltete Lösung.
  4. Wählen Sie auf der Befehlsleiste Vorhandenes Element hinzufügen und anschließend Hilfeseite aus.
  5. Wählen Sie die Hilfeseiten, die Sie hinzufügen möchten, und anschließend Hinzufügen aus. Weitere Informationen: Exportieren von Lösungen

Automatisierung der Hilfeseitendokumentation

Sie sollten Ihren Inhalt in einem Quellcodeverwaltungssystem sichern oder speichern. Sie sollten auch möglicherweise Tools zur Dokumentationsautomatisierung wie Übersetzungstools oder Prüffunktionen für Hilfebereichsinhalte verwenden. Benutzerdefinierte Hilfebereichsdaten werden direkt in Dataverse gespeichert und können deshalb exportiert und importiert werden.

Benutzerdefinierte Hilfebereiche unterstützen ein benutzerdefiniertes XML-Format. Dieses Format wird unten dokumentiert. Weitere Informationen: Benutzerdefinierte Hilfe XML-Definition

Beim Exportieren wird jede Hilfeseite als separate Datei exportiert.

Über die verwaltete Lösung der Kontexthilfe

Die benutzerdefinierten Hilfefenster und die Funktion der Aufgabenhilfen besteht aus den Lösungskomponenten in der verwalteten Lösung der Kontexthilfe. Das Anpassen oder Erstellen von Datensätzen mithilfe der Tabellen außerhalb der benutzerdefinierten Hilfebereiche und der Funktion der Aufgabenhilfen wird nicht unterstützt.

Beachten Sie, dass einige Apps, wie z. B. Dynamics 365 Sales und Dynamics 365 Service, Eindrücke aus der ersten Ausführung enthalten, die mithilfe von Tabellen erstellt werden, die in der verwalteten Lösung der Kontexthilfe enthalten sind. Beispielsweise werden sowohl Hilfeseitentabellen (msdyn_helppage) als auch Tourtabellen (msdyn_tour) bei der Erstellung dieses Eindrucks bei der ersten Ausführung verwendet. Derzeit unterstützen die benutzerdefinierten Hilfebereiche und die Funktion der Aufgabenhilfen das Erstellen dieser Eindrücke bei der ersten Ausführung nicht.

Häufig gestellte Fragen

In diesem Abschnitt werden häufig gestellte Fragen zu benutzerdefinierten Hilfeseiten behandelt.

Sind benutzerdefinierte Hilfeseiten identisch mit anpassbarer Hilfe?

Benutzerdefinierte Hilfebereiche und Aufgabenhilfen sind eine Option im Abschnitt Benutzerdefinierte Hilfe-URL festlegen der Systemeinstellungen. Benutzerdefinierte Hilfebereiche und Aufgabenhilfen aktivieren einen anpassbaren Hilfebereich, der rechts neben dem Formular des Benutzers erscheint. Die anderen Optionen in diesen Systemeinstellungen zum Einstellen des benutzerdefinierten Hilfeabschnitts enthalten die anpassbaren Hilfefunktionen. Mit der anpassbaren Hilfe ist es möglich, die standardmäßige Apps-Hilfe zu überschreiben und Benutzer in Ihrer Organisation an eine andere URL für die Hilfe zu verweisen. Alternativ können Sie auch die Hilfe für eine stark angepasste Tabelle überschreiben, damit Sie den Workflow besser beschreiben können.

Weitere Informationen zu anpassbaren Hilfen finden Sie unter Anpassbare Hilfe aktivieren und verwenden.

Wie migriere ich meine Daten vom Lernpfad zu den benutzerdefinierten Hilfeseiten?

Der Lernpfad enthält zwei Arten von Hilfe: Hilfebereiche und sequenzielle Hilfesprechblasen. Die sequenziellen Hilfesprechblasenspeicherorte sind tief in der bestehenden Benutzeroberfläche des Webclient integriert und lassen sich somit nicht zu den neuen benutzerdefinierten Hilfebereichen übertragen.

Je nachdem, wieviel Text Ihr interaktiver Begleiter enthält, können Sie die Informationen möglicherweise am einfachsten direkt von der Lernpfadbenutzeroberfläche zur neuen benutzerdefinierten Hilfebereichsbenutzeroberfläche kopieren. Sie können jedoch Ihre Lernpfadhilfeinhalt auch exportieren. Die einfachste Methode zum Exportieren Ihres Inhalts ist die Verwendung der Funktion Lernpfad > Inhaltsbibliothek > Lokalisieren > Exportieren. Wählen Sie die gewünschten Spalten aus, und exportieren Sie sie dann. Damit wird eine XLIFF-Datei für jeden Hilfebereich und Aufgabenhilfe erstellt. Verwenden Sie dann einen öffentlich verfügbar XLIFF-Editor oder XLIFF zu HTML-Wandler, um Ihren Inhalt abzurufen.

XML-Definition für benutzerdefinierte Hilfe

Dieser Abschnitt beschreibt die benutzerdefinierte Hilfe XML-Definition.

PPHML

<pphml>
    <h1>FAQ</h1>
    <collapsible title="What is PPHML?">
        <p>PPHML is a domain specific language for help content. It is used to create help content that includes elements such as images, videos, balloons, coach marks, etc.</p>
    </collapsible>
    <collapsible title="What does PPHML stand for?">
        <p>PPHML stands for Power Platform Help Markup Language</p>
    </collapsible>
</pphml>

Definition und Verwendung

Das <pphml>-Element sagt dem Hilfebrowser, dass es sich hier um ein PPHML-Dokument handelt.

Das <pphml>-Element stellt den Stamm eines PPHML-Dokuments dar.

Das <pphml>-Element ist der Container für alle anderen PPHML-Elemente.

Titel

Stellt einen Titel in einer Hilfeseite dar.

<h1>This will be displayed at the top of the help page</h1>

Definition und Verwendung

Das <h1>-Element definiert den Titel einer Hilfeseite.

<h1> Das muss das erste interne Element sein <pphml>.

Bild

Stellt ein Bild in einer Hilfeseite dar.

<img src="smiley.gif" alt="Smiley face" title="Smiley face"/>

Definition und Verwendung

Das <img>-Element bettet ein Bild in einer Hilfeseite ein.

Attribute

  • src: Gibt die URL eines Bildes an. Dieses Attribut ist erforderlich.

  • title: Gibt einen Titel an, der zusammen mit dem Bild angezeigt wird, in der Regel als darauf zeigende QuickInfo.

  • alt: Gibt einen Alternativtext für ein Bild an. Dieser Text wird von Screenreadern verwendet.

Video

Stellt ein Video in einer Hilfeseite dar.

<video src="https://www.youtube.com/watch?v=WSWmn7WM3i4" />

Definition und Verwendung

Das <video>-Element bettet ein Video, wie etwa ein Tutorial oder einen Schulungsfilm, in einer Hilfeseite ein.

Unterstützte Quellen
  • Microsoft Stream
  • YouTube
  • Facebook
  • Vimeo

Attribute

  • src: Gibt die URL des Videos an. Dieses Attribut ist erforderlich.

  • allowFullScreen: Gibt an, ob der Benutzer das Video zur Vollbildanzeige wechseln kann. Mögliche Werte lauten "True" oder "False". Dieses Attribut wird nicht für alle Videoquellen unterstützt.

  • autoplay: Gibt an, dass die Wiedergabe des Videos beginnt, sobald die Hilfeseite geladen wird. Mögliche Werte lauten "True" oder "False". Dieses Attribut wird nicht für alle Videoquellen unterstützt.

  • startTime: Spezifiziert, in Sekunden, ab welchem Punkt die Wiedergabe des Videos startet.

Absatz

Stellt einen Abschnitt in einer Hilfeseite dar.

<p>This is some text in a paragraph.</p>

Definition und Verwendung

Das <p>-Element definiert einen Absatz.

Text in einem Absatzes kann folgendermaßen hervorgehoben werden:

  • Fett, mit <strong>-Element
  • Kursiv, mit <em>-Element
  • Durchgestrichen, mit <del>-Element
  • Unterstrichen, mit <u>-Element

Diese Hervorhebungen können kombiniert werden. Beispielsweise können Sie ein Textfragment darstellen, das sowohl fett als auch unterstrichen ist.

Aufzählung

Stellt eine Aufzählung in einer Hilfeseite dar.

<ul>
    <li>Coffee</li>
    <li>Tea</li>
    <li>Milk</li>
</ul>

Definition und Verwendung

Das <ul>-Element definiert eine Aufzählung.

Verwenden Sie das <ul>-Element zusammen mit dem <li>-Element, um Aufzählungen zu erstellen.

Nummerierte Liste

Stellt eine nummerierte Liste in einer Hilfeseite dar.

<ol>
    <li>First step</li>
    <li>Second step</li>
    <li>Third step</li>
</ol>

Definition und Verwendung

Das <ol>-Element definiert eine geordnete (nummerierte) Liste. Verwenden Sie die <ol>-Markierung zusammen mit dem <li>-Element, um nummerierte Listen zu erstellen.

Reduzierbar

Stellt einen reduzierbaren Abschnitt in einer Hilfeseite dar.

<collapsible title="This is a Section">
    <p>This is a paragraph inside a section</p>
    <img src=smiley.gif" title="This is an image inside a section" />
</collapsible>

Definition und Verwendung

Das <collapsible>-Element definiert einen Abschnitt des Inhalts, den der Benutzer bei Bedarf ein- oder ausblenden kann.

Attribute

  • collapsed: Gibt an, ob der Abschnitt zuerst reduziert oder erweitert wird. Mögliche Werte sind "True" (reduziert) oder "False" (erweitert).

Stellt einen Link in einer Hilfeseite dar.

Verknüpfung mit einer Website, die in einem neuen Browserfenster geöffnet wird:

<a href="https://www.microsoft.com" target="_blank">Microsoft Home Page</a>

Verknüpfung mit einer anderen Hilfeseite:

<a href="./LearnMore">Learn More</a>

Definition und Verwendung

Das <a>-Tag definiert einen Link, der dem Benutzer ermöglicht, von einer Hilfeseite zu einer Website oder einer anderen Hilfeseite zu navigieren.

Attribute

  • href: Gibt die URL der Website oder einer Hilfeseite an, zu der navigiert werden soll. Dieses Attribut ist erforderlich.
  • target: Gibt an, wo die verknüpfte URL geöffnet werden soll.
    • Sofern nicht vorhanden oder _self, wird angenommen, dass der Link zu einer anderen Hilfeseite verweist und im Hilfebrowser geöffnet wird.
    • Wenn _blank, wird der Link in einem neuen Browserfenster geöffnet.
    • Wenn _top, wird der Link im aktuellen Browserfenster geöffnet.
    • Wenn der Wert der Name eines iframe ist, wird der Link in dem IFrame geöffnet.

Trainermarkierung

Stellt eine Trainermarkierung in einer Hilfeseite dar.

<coachmark target="#my-html-button">Click to highlight the HTML element with id [my-html-button]</coachmark>

Definition und Verwendung

Eine Trainermarkierung ist ein interaktives Element, das verwendet werden kann, um die Aufmerksamkeit des Benutzers auf einen bestimmten Punkt in der Benutzeroberfläche der Anwendung, die den Hilfebrowser hostet, zu lenken.

Attribute

  • target: CSS Auswahl, die das HTML-Element angibt, über dem die Trainermarkierung angezeigt wird. Dieses Attribut ist erforderlich.

Sprechblase

Stellt eine Sprechblase in einer Hilfeseite dar.

<balloon target="#my-html-button" title="This button submits the form" details="Please click this button to continue and submit the form">Click to show a balloon over the HTML element with id [my-html-button]</balloon>

Definition und Verwendung

Eine Sprechblase ist ein interaktives Element, das verwendet werden kann, um dem Benutzers bei der Ausführung einer Aktion in der Benutzeroberfläche der Anwendung, die den Hilfebrowser hostet, hilft.

Attribute

  • target: CSS-Auswahl, die das HTML-Element angibt, über dem der Sprechblasenlink angezeigt wird. Dieses Attribut ist erforderlich.
  • title: Gibt den Titel der Sprechblase an.
  • details: Gibt den Inhalt an, der in der Sprechblase angezeigt werden soll.

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).