Einen interaktiven Begleiter für Ihre modellgesteuerte App erstellen

Verwenden Sie benutzerdefinierte Hilfebereiche und geführte Aufgaben, um Ihrer Unified Interface-App eine benutzerdefinierte Hilfe im Produkt zu bieten, die auf Ihre Organisation zugeschnitten ist. Verwenden Sie benutzerdefinierte Hilfebereiche, um tabellen-, formular- und sprachspezifische Hilfe und Anleitungen bereitzustellen, die Rich Text, Inhaltslinks, Bilder und Videolinks enthalten.

Benutzerdefinierte Hilfebereiche und -Lernpfad

Die neue Implementierung der geführten Hilfe für benutzerdefinierte Hilfebereiche unterscheidet sich von der vorherigen Funktion für geführte Hilfe in Lernpfaden. Beide Funktionen erlauben Ihnen die Erstellung benutzerdefinierter Hilfe für Ihre Anwendung. Allerdings sind benutzerdefinierte Hilfebereiche für die gängigsten Szenarien der geführten Hilfe 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:

• Aufeinanderfolgende Hilfeblasen.
• Hilfeseiten pro Rolle.
• Hilfeseiten für geräteabhängige Formfaktoren, wie Smartphones.

Anforderungen

Um das Feature für benutzerdefinierte Hilfebereiche verwenden zu können, muss in Ihrer Umgebung die Umgebungseinstellung für benutzerdefinierte Hilfebereiche aktiviert sein.

Benutzerdefinierte Hilfebereiche für Ihre Umgebung aktivieren.

1. Melden Sie sich beim Power Platform Admin Center an unter https://admin.powerplatform.microsoft.com.
2. Wählen Sie im linken Bereich "Verwalten" aus, und öffnen Sie dann die gewünschte Umgebung.
3. Wählen Sie Einstellungen in der Befehlsleiste und dann Produkt>Features aus.
4. Setzen Sie unter Hilfefunktionen die Option Benutzerdefinierte Hilfebereiche aktivieren auf Ein.

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. Standardmäßig verfügt die Sicherheitsrolle „Help Page Consumer“ über 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 ist für diese Kontexte einzigartig:

• Tabelle
• Formular
• Übersicht
• Sprache
• Antrag

Navigation im Hilfebereich

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.

Inhalte für den Hilfebereich verfassen

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

   

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

   

   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.

Freitext

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 sowie mehrstufiges Rückgängigmachen können ebenfalls verwendet werden.

Aufzählungszeichen und nummerierte Listen

Wenn Sie auf das Symbol für Aufzählungszeichen oder Nummerierung klicken, wird die aktuelle Zeile in eine Aufzählung bzw. nummerierte Liste umgewandelt. 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 einklappbares Textfeld. Sie können Links oder Freihandtext darin eingeben. Verwenden Sie einen Abschnitt, um ähnliche Elemente zu gruppieren. Ein Abschnitt kann standardmäßig entweder geöffnet oder eingeklappt sein.

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 wird, laden benutzerdefinierte Hilfebereiche die Inhalte über den Link, um sie anzuzeigen. Sie können einen Link mit einem Video Microsoft Stream verwenden, wenn Sie auf korporativen privaten Inhalt verweisen möchten.

Benutzerdefinierte Hilfebereiche unterstützen die folgenden Videoquellen:

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

Links

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. Ein Ballon kann Text enthalten.

Eine Coach-Markierung hebt einfach ein Element mit einem Hinweiszeiger hervor, um die Aufmerksamkeit des Benutzers auf dieses UI-Element zu lenken.

Der Autor muss das Ziel mithilfe der Drag-and-Drop-Funktion in den Eigenschaften von Ballons und Coachmarks definieren. Der Autor kann den Text für Titel und Beschreibung für Trainermarken eingeben.

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 standardmäßigen Funktionen des Anwendungslebenszyklusmanagements (ALM) für Lösungen.

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.

Informationen zur verwalteten Lösung für die kontextbezogene Hilfe

Die Funktion für benutzerdefinierte Hilfebereiche und geführte Aufgaben besteht aus den Lösungskomponenten in der verwalteten Lösung „Kontextbezogene Hilfe“. 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 die Tabellen Hilfe-Seite (msdyn_helppage) als auch Tour (msdyn_tour) bei der Erstellung dieser Erlebnisse bei der Erstausführung verwendet. Derzeit unterstützen die benutzerdefinierten Hilfebereiche und die Funktion für geführte Aufgaben das Erstellen dieser Erstbenutzeroberflächen 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 weiteren Optionen in diesem Bereich der Systemeinstellungen für den benutzerdefinierten Hilfebereich umfassen die anpassbaren Hilfefunktionen. Sie können die Standardhilfe der Apps überschreiben und Benutzer in Ihrer Organisation für Hilfe auf eine andere URL umleiten. 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 hat zwei Hilfetypen: Hilfefenster und aufeinanderfolgende Hilfesprechblasen. Die Positionen der sequenziellen Hilfe-Sprechblasen sind eng in die Benutzeroberfläche des alten Webclients integriert und lassen sich nicht auf die neuen benutzerdefinierten Hilfebereiche übertragen.

Je nachdem, wie viel Text Ihre geführte Hilfe enthält, ist es möglicherweise am einfachsten, die Informationen direkt von der Benutzeroberfläche des Lernpfads in die Benutzeroberfläche des neuen benutzerdefinierten Hilfebereichs zu 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 für jeden Hilfebereich und jede geführte Aufgabe eine XLIFF-Datei 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

Zeigt einen Titel auf einer Hilfeseite an.

<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> Dies muss das erste Element innerhalb von <pphml> sein.

Bild

Zeigt ein Bild auf einer Hilfeseite an.

<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 zusätzlich zum Bild angezeigt wird, in der Regel als Tooltip beim Darüberfahren mit der Maus.

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

Video

Zeigt ein Video auf einer Hilfeseite an.

<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 eine 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.

Der Text innerhalb eines Absatzes kann auf folgende Weise formatiert werden:

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

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

Aufzählung

Zeigt eine Aufzählungsliste auf einer Hilfeseite an.

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

Definition und Verwendung

Das <ul>-Element definiert eine Liste mit Aufzählungszeichen.

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.

Einklappbar

Stellt einen ein-/ausklappbaren Abschnitt auf 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 Benutzende bei Bedarf ein- oder ausblenden kann.

Attribute

• collapsed: Gibt an, ob der Abschnitt anfänglich eingeklappt oder ausgeklappt ist. Mögliche Werte sind “True“ (reduziert) oder „False“ (erweitert).

Link

Zeigt einen Link auf einer Hilfeseite an.

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 diesem iframe geöffnet.

Trainermarkierung

Zeigt eine Coachmarkierung auf einer Hilfeseite an.

<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-Selektor, der das HTML-Element angibt, über dem die Coachmarke angezeigt wird. Dieses Attribut ist erforderlich.

Ballon

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 Hinweisblase ist ein interaktives Element, mit dem der Benutzer in der Benutzeroberfläche der Anwendung, in der der Hilfebrowser gehostet wird, eine Aktion ausführen kann.

Attribute

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