Creare una guida assistita per la tua app basata su modello

Utilizza riquadri della guida personalizzati e attività guidate per offrire alla tua applicazione Unified Interface un'esperienza di guida integrata personalizzata, su misura per la tua organizzazione. Utilizzare riquadri della guida personalizzati per fornire guida e istruzioni specifiche per tabella, modulo e lingua che includono testo formattato, collegamenti a contenuti, immagini e link a video.

Riquadri della guida personalizzati e percorso di apprendimento

La nuova implementazione della guida guidata per i riquadri della guida personalizzati differisce dalla precedente funzionalità di guida guidata dei percorsi di apprendimento. Entrambe le funzionalità ti consentono di creare una Guida personalizzata per la tua applicazione. Tuttavia, i riquadri della guida personalizzati sono ottimizzati per gli scenari più comuni di guida assistita.

I riquadri della guida personalizzati offrono le seguenti funzionalità principali non disponibili nel percorso di apprendimento:

• Testo RTF in formato libero, inclusi elenchi puntati e numerati.
• Indicatori contestuali e fumetti di aiuto visibilmente collegati.
• Altre opzioni per le origini video, incluse le origini private.
• Archiviazione del contenuto della guida in Microsoft Dataverse come parte della tua soluzione.

I riquadri della guida personalizzati non offrono le seguenti funzionalità chiave disponibili nel percorso di apprendimento:

• Suggerimenti della Guida sequenziali.
• Pagine della Guida in base al ruolo.
• Pagine della guida in base al formato del dispositivo, ad esempio gli smartphone.

Prerequisiti

Per utilizzare la funzionalità dei riquadri della Guida personalizzati, nel tuo ambiente deve essere abilitata l'impostazione dell'ambiente per i riquadri della Guida personalizzati.

Abilita i riquadri della guida personalizzati per il tuo ambiente

1. Accedi all'Interfaccia di amministrazione di Power Platform all'indirizzo https://admin.powerplatform.microsoft.com.
2. Selezionare Gestisci nel riquadro sinistro e quindi aprire l'ambiente desiderato.
3. Seleziona Impostazioni dalla barra dei comandi, quindi seleziona Prodotto>Funzionalità.
4. In Funzionalità della guida, imposta Abilita riquadri della guida personalizzati su Attivato.

Privilegi necessari

• Per creare i riquadri della guida, i creatori di app devono disporre dei privilegi globali di creazione, lettura, scrittura, eliminazione, aggiunta e aggiunta a per la tabella Help Page. Per impostazione predefinita, i ruoli di sicurezza amministratore di sistema e addetto alla personalizzazione del sistema dispongono di questo privilegio.
• Per visualizzare i riquadri della Guida in un'app, gli utenti devono disporre del privilegio di lettura nella tabella Pagina della Guida. Per impostazione predefinita, il ruolo di sicurezza Help Page Consumer dispone di questo privilegio. Per impostazione predefinita, il ruolo di sicurezza Utente di base non dispone di alcun privilegio sulla tabella Pagina della Guida.

Ulteriori informazioni Ruoli di sicurezza e privilegi

Guida personalizzata sensibile al contesto

Ogni riquadro della Guida è univoco per questi contesti:

• Tabella
• Modulo
• Pannello di controllo
• Lingua
• Applicazione

Navigazione nel riquadro Guida

Per impostazione predefinita, il riquadro della Guida rimane aperto e continua a mostrare il contenuto della Guida visualizzato al momento della prima apertura, anche quando si passa a un modulo diverso. Ciò consente al contenuto della Guida di rimanere intatto quando si indirizzano gli utenti a diverse parti dell'app.

Per scrivere il contenuto del riquadro della guida

1. Per visualizzare il riquadro della Guida, apri un'app basata su modello e sulla barra dei comandi seleziona Guida.

   

2. Nel riquadro della Guida, seleziona l'ellisse verticale e seleziona Modifica.

   

   Il riquadro della Guida è ora in modalità di modifica e il cursore è disponibile sul titolo del riquadro della Guida.

3. Dal riquadro di modifica, è possibile eseguire le seguenti attività:

   • Inserisci il testo digitando direttamente nell'area del riquadro Guida.
   • Formatta il testo utilizzando le funzionalità di testo formattato e aggiungi elenchi puntati e numerati, sezioni, video, immagini, collegamenti, coach mark e fumetti di aiuto.

4. Seleziona Salva per salvare le modifiche.

Testo in formato libero

Il testo può essere posizionato in qualsiasi punto del riquadro della Guida. Immetti il testo in formato libero prima, dopo o nelle sezioni. Il testo supporta i formati di carattere grassetto, corsivo, sottolineato e barrato. È possibile utilizzare le funzioni Taglia, Copia e Incolla, nonché l'Annulla multilivello.

Elenchi puntati e numerati

La selezione dell'icona dell'elenco puntato o numerato attiva o disattiva la riga corrente in modo che diventi puntata o numerata. Se hai selezionato più righe in un elenco, ogni riga diventa puntata o numerata. Le tabulazioni e i rientri allineano i sottolivelli numerati all'interno dell'elenco.

Sezioni

Una sezione è un riquadro di testo che può essere compresso. È possibile inserire collegamenti o testo in formato libero al suo interno. Utilizza una sezione per raggruppare elementi simili. Una sezione può essere aperta o compressa per impostazione predefinita.

Video e immagini statiche

È possibile inserire video e immagini statiche nel riquadro della Guida. I video e le immagini sono collegamenti al contenuto in Internet. I riquadri della guida personalizzati non memorizzano i file video e immagine nel riquadro della guida. Quando viene aperto il riquadro della guida, i riquadri della guida personalizzati caricano il contenuto dal collegamento per visualizzarlo. È possibile utilizzare un collegamento a un video di Microsoft Stream se vuoi fare riferimento a contenuti aziendali privati.

I riquadri della guida personalizzati supportano le seguenti fonti video:

• Microsoft Stream (versione classica) (utilizzo per contenuto privato)
• YouTube
• Facebook
• Vimeo

Collegamenti

I collegamenti possono essere a siti Web e aperti nella stessa finestra (impostazione predefinita) o aperti in una finestra separata. La possibilità di collegarsi a una pagina della Guida esistente non è ancora abilitata.

Fumetti e indicatori guida

I fumetti e gli indicatori contestuali possono essere utilizzati per evidenziare specifici elementi dell'interfaccia utente. Un fumetto può contenere del testo.

Un'indicazione in sovrimpressione evidenzia semplicemente un elemento con un puntatore di indicazione per attirare l'attenzione dell'utente su quell'elemento dell'interfaccia utente.

L'autore deve definire l'elemento di destinazione tramite la funzionalità di trascinamento nelle proprietà dei fumetti e degli indicatori guida. L'autore può inserire il testo del titolo e della descrizione per i suggerimenti guidati.

Soluzioni e contenuto del riquadro della Guida personalizzata

Tutto il contenuto della guida viene archiviato in un componente di pagina della guida in Dataverse come parte della tua soluzione. Quando si trasferisce la soluzione da un ambiente a un altro, ad esempio dall'ambiente di test a quello di produzione, è possibile definire che le righe della guida vengano esportate in modo che siano incluse nella soluzione. Ciò consente di mantenere sincronizzato il contenuto della Guida con le funzionalità della soluzione mentre questa passa da un ambiente all’altro. Come parte della soluzione, i riquadri della Guida personalizzata supportano tutte le funzionalità standard di gestione del ciclo di vita delle applicazioni (ALM).

Spostamento del contenuto tramite le soluzioni

Per impostazione predefinita, tutte le nuove pagine della Guida vengono visualizzate nella soluzione predefinita. Se desideri spostare i contenuti in un altro ambiente, aggiungi innanzitutto le pagine della Guida esistenti in una soluzione non gestita prima di esportarle. Per aggiungere una pagina della Guida a una soluzione non gestita, attieniti alla seguente procedura:

1. Accedi a Power Apps.
2. Nel riquadro di spostamento sinistro, seleziona Soluzioni. Se l'elemento non si trova nel riquadro del pannello laterale, seleziona …Altro, quindi l'elemento desiderato.
3. Apri la soluzione non gestita che desideri.
4. Seleziona Aggiungi esistente sulla barra dei comandi, quindi seleziona Pagina della Guida.
5. Seleziona le pagine della Guida che vuoi aggiungere e quindi seleziona Aggiungi. Per ulteriori informazioni, vedi Esportare soluzioni

Automazione della documentazione della pagina della Guida

Potresti voler eseguire il backup o archiviare i tuoi contenuti in un sistema di controllo del codice sorgente. Potresti anche voler utilizzare strumenti di automazione della documentazione, come strumenti di traduzione o di verifica, sui contenuti del riquadro della Guida. I dati del riquadro della Guida personalizzata vengono archiviati direttamente in Dataverse e possono quindi essere esportati e importati per questo scopo.

I riquadri della Guida personalizzata supportano il formato XML personalizzato. Questo formato è documentato in seguito. Ulteriori informazioni: Definizione XML della Guida personalizzata

Quando esportata, ogni pagina della Guida viene esportata come file distinto.

Informazioni sulla soluzione gestita della Guida contestuale

I riquadri della guida personalizzati e la funzionalità delle attività guidate sono costituiti dai componenti della soluzione nella soluzione gestita della Guida contestuale. La personalizzazione o la creazione di record utilizzando le tabelle al di fuori dei riquadri della guida personalizzati e della funzionalità delle attività guidate non è supportata.

Nota che alcune app, come Dynamics 365 Remote Assist e Dynamics 365 Service, includono esperienze di prima esecuzione create utilizzando le tabelle incluse nella soluzione gestita della Guida contestuale. Ad esempio, nella creazione di queste esperienze di prima esecuzione vengono utilizzate le tabelle Pagina della Guida (msdyn_helppage) e Presentazione (msdyn_tour). Attualmente, i riquadri della guida personalizzati e la funzionalità delle attività guidate non supportano la creazione di queste esperienze di primo avvio.

Domande frequenti

Questa sezione illustra le domande frequenti sulle pagine della Guida personalizzata.

Le pagine della Guida personalizzata sono le stesse della Guida personalizzabile?

I riquadri della Guida personalizzata e le attività Guidate sono un'opzione nella sezione Imposta l'URL della Guida personalizzata delle impostazioni di sistema. I riquadri della Guida personalizzata e le attività Guidate abilitano un riquadro della Guida personalizzabile che viene visualizzato accanto al modulo dell'utente. Le altre opzioni di queste impostazioni di sistema impostate nella sezione Guida personalizzata comprendono le funzioni di Guida personalizzabile. Ti consentono di sostituire la Guida delle app predefinita e di indirizzare gli utenti della tua organizzazione a un URL diverso per ottenere assistenza. In alternativa, puoi sovrascrivere la guida per una tabella molto personalizzata, in modo da descrivere meglio il tuo flusso di lavoro.

Per ulteriori informazioni sulla Guida personalizzabile, vedi Abilitare e usare la Guida personalizzabile.

Come viene eseguita la migrazione dei dati dal Percorso di apprendimento nelle pagine della Guida personalizzata?

Il percorso di apprendimento prevede due tipi di assistenza: riquadri della guida e fumetti di guida sequenziali. Le posizioni dell'area commenti della Guida sequenziale sono profondamente integrate con l'interfaccia utente del client Web legacy e non sono trasferibili nei nuovi riquadri della Guida personalizzata.

A seconda della quantità di testo presente nella guida guidata, potrebbe essere più semplice copiare direttamente le informazioni dall'interfaccia utente del percorso di apprendimento al nuovo riquadro della guida personalizzata. Tuttavia, è anche possibile esportare il contenuto della Guida del percorso di apprendimento. Il modo più semplice per eseguire questa operazione è esportare il contenuto tramite la funzionalità Percorso di apprendimento>Libreria contenuti>Localizza>Esporta. Seleziona le righe che desideri ed esportale. Viene creato un file XLIFF per ogni riquadro della guida e attività guidata. Quindi, utilizza un editor XLIFF disponibile pubblicamente o un convertitore da XLIFF a HTML per recuperare i contenuti.

Definizione XML della Guida personalizzata

Questa sezione descrive la definizione XML della Guida personalizzata.

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>

Definizione e utilizzo

L'elemento <pphml> indica al browser della guida che si tratta di un documento PPHML.

L'elemento <pphml> rappresenta la radice di un documento PPHML.

L'elemento <pphml> è il contenitore per tutti gli altri elementi PPHML.

Titolo

Presenta un titolo nella pagina della Guida.

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

Definizione e utilizzo

L'elemento <h1> definisce il titolo della pagina della Guida.

<h1> deve corrispondere al primo elemento in <pphml>.

Immagine

Mostra un'immagine in una pagina di aiuto.

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

Definizione e utilizzo

L'elemento <img> incorpora un'immagine nella pagina della guida.

Attributi

• src: specifica l'URL di un'immagine. Questo attributo è obbligatorio.

• title: Specifica un titolo da mostrare insieme all'immagine, in genere come un suggerimento al passaggio del mouse.

• alt: specifica un testo alternativo per un'immagine. Questo testo è utilizzato dagli screen reader.

Video

Presenta un video nella pagina della Guida.

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

Definizione e utilizzo

L'elemento <video> incorpora un video, ad esempio un film di formazione o di esercitazione, nella pagina della guida.

Fonti supportate

• Microsoft Stream
• YouTube
• Facebook
• Vimeo

Attributi

• src: specifica l'URL del video. Questo attributo è obbligatorio.

• allowFullScreen: specifica se l'utente può accedere alla visualizzazione a schermo intero. I possibili valori sono "true" o "false". Questo attributo non è supportato per tutte le origini video.

• autoplay: specifica che il video inizia la riproduzione non appena la pagina della Guida viene caricata. I possibili valori sono "true" o "false". Questo attributo non è supportato per tutte le origini video.

• startTime: specifica, in secondi, da che punto inizia la riproduzione del video.

Paragrafo

Mostra un paragrafo in una pagina della Guida.

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

Definizione e utilizzo

L'elemento <p> definisce il paragrafo.

Il testo in un paragrafo può essere decorato nei modi seguenti:

• Grassetto, con l'elemento <strong>
• Corsivo, con l'elemento <em>
• Barrato, con l'elemento <del>
• Sottolineato, con l'elemento <u>

Queste decorazioni possono essere in combinazione. Ad esempio, crea un frammento di testo che sia in grassetto sia sottolineato.

Elenco puntato

Presenta un elenco puntato nella pagina della Guida.

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

Definizione e utilizzo

L'elemento <ul> definisce un elenco puntato.

Utilizza l'elemento <ul> insieme all'elemento <li> per creare gli elenchi puntati.

Elenco numerato

Presenta un elenco numerato nella pagina della Guida.

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

Definizione e utilizzo

L'elemento <ol> definisce un elenco ordinato (numerato). Utilizza il tag <ol> insieme all'elemento <li> per creare gli elenchi numerati.

Comprimibile

Presenta una sezione comprimibile nella pagina della Guida.

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

Definizione e utilizzo

L'elemento <collapsible> definisce una sezione di contenuto che l'utente può visualizzare o nascondere su richiesta.

Attributi

• collapsed: specifica se la sezione è compressa o aperta inizialmente. I valori possibili sono "true" (compresso) o "false" (espanso).

Collegamento

Presenta un collegamento nella pagina della Guida.

Collegamento a un sito Web che si apre in una nuova finestra del browser:

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

Collegamento a un'altra pagina della Guida:

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

Definizione e utilizzo

Il tag <a> definisce un collegamento che consente all'utente di passare da una pagina della Guida a un sito Web o a un'altra pagina della Guida.

Attributi

• href: specifica l'URL del sito Web o della pagina della guida a cui passare. Questo attributo è obbligatorio.
• target: specifica dove aprire l'URL collegato.
  • Se non è presente o è _self, si presume che il collegamento rimandi a un'altra pagina della Guida e venga aperto nel browser della Guida.
  • Se _blank, il collegamento viene aperto in una nuova finestra del browser.
  • Se _top, il collegamento viene aperto nella finestra del browser corrente.
  • Se il valore è il nome di un iframe, il collegamento viene aperto nell'iframe.

Indicazione in sovrimpressione

Presenta un'indicazione in sovrimpressione nella pagina della Guida.

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

Definizione e utilizzo

Un indicatore contestuale è un elemento interattivo che può essere usato per attirare l'attenzione dell'utente su un punto specifico dell'interfaccia utente dell'applicazione che ospita il browser della guida.

Attributi

• target: selettore CSS che specifica l'elemento HTML sopra il quale verrà visualizzato il coach mark. Questo attributo è obbligatorio.

Fumetto

Presenta un'area commenti nella pagina della Guida.

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

Definizione e utilizzo

Un'area commenti è un elemento interattivo che può essere utilizzato per aiutare l'utente a eseguire un'azione nell'interfaccia utente dell'applicazione che ospita il browser della Guida.

Attributi

• target: selettore CSS che specifica l'elemento HTML in cui verrà visualizzato il collegamento dell'area commenti. Questo attributo è obbligatorio.
• title: specifica il titolo dell'area commenti.
• details: specifica il contenuto da visualizzare nell'area commenti.