Gestori di errori per il modulo adattivo basato su componenti core

AEM Forms fornisce gestori predefiniti di successo e di errori per l’invio di moduli. Fornisce inoltre funzionalità per personalizzare le funzioni del gestore degli errori. Ad esempio, puoi richiamare un flusso di lavoro personalizzato nel back-end per codici di errore specifici o informare il cliente che il servizio non è disponibile. I gestori sono funzioni lato client che vengono eseguite in base alla risposta del server. Quando un servizio esterno viene richiamato utilizzando le API, i dati vengono trasmessi al server per la convalida, che restituisce una risposta al client con informazioni sull’evento di successo o errore per l’invio. Le informazioni vengono passate come parametri al gestore pertinente per eseguire la funzione. Un gestore degli errori consente di gestire e visualizzare gli errori o i problemi di convalida rilevati.

Il modulo adattivo convalida gli input forniti nei campi in base a criteri di convalida predefiniti e verifica la presenza di vari errori restituiti dall’endpoint REST configurato per richiamare un servizio esterno. È possibile impostare i criteri di convalida in base all’origine dati utilizzata con il modulo adattivo. Ad esempio, se utilizzi i servizi web RESTful come origine dati, puoi definire i criteri di convalida in un file di definizione Swagger.

Se i valori di input soddisfano i criteri di convalida, vengono inviati all’origine dati, altrimenti nel modulo adattivo viene visualizzato un messaggio di errore tramite un gestore degli errori. Simile a questo approccio, Forms adattivo si integra con gestori di errori personalizzati per eseguire le convalide dei dati. Se i valori di input non soddisfano i criteri di convalida, i messaggi di errore vengono visualizzati a livello di campo nel modulo adattivo. Ciò si verifica quando il messaggio di errore di convalida restituito dal server è nel formato di messaggio standard.

Utilizzo dei gestori di errori

I gestori di errori vengono utilizzati per vari scopi. Di seguito sono elencati alcuni degli utilizzi delle funzioni di gestione degli errori:

• Esegui convalida: la gestione degli errori inizia con la convalida degli input dell’utente in base a regole o criteri predefiniti. Quando gli utenti compilano un modulo adattivo, il gestore degli errori convalida l’input per garantire che soddisfi il formato, la lunghezza o qualsiasi altro vincolo richiesto.

• Fornire feedback in tempo reale: quando viene rilevato un errore, il gestore degli errori visualizza un feedback immediato all’utente, ad esempio messaggi di errore in linea sotto i campi del modulo corrispondenti. Questo feedback consente agli utenti di identificare e correggere gli errori senza dover inviare il modulo e attendere una risposta.

• Visualizzare messaggi di errore: quando un invio di un modulo adattivo rileva un errore di convalida, il gestore degli errori visualizza un messaggio di errore appropriato. I messaggi di errore devono essere chiari, concisi ed evidenziati nei campi specifici che richiedono attenzione.

• Evidenzia il campo errato: per attirare l’attenzione dell’utente su campi non corretti specifici, il gestore degli errori evidenzia o distingue visivamente i campi corrispondenti. Viene eseguita modificando il colore di sfondo, aggiungendo un'icona o un bordo o qualsiasi altro segnale visivo che consenta agli utenti di individuare e risolvere rapidamente gli errori.

Formato della risposta di errore/errore

Un modulo adattivo visualizza gli errori a livello di campo se i messaggi di errore di convalida del server sono nel seguente formato standard.
Il codice riportato di seguito illustra la struttura di risposta dei guasti esistente:

   {
    errorCausedBy : "SERVER_SIDE_VALIDATION/SERVICE_INVOCATION_FAILURE"
    errors : [
        {
             errorMessage / errorMessages : <validationMsg> / [<validationMsg>, <validationMsg>]
        }
    ]
    originCode : <target error Code>
    originMessage : <unstructured error message returned by service>
    }

Dove:

• errorCausedBy descrive il motivo dell’errore.
• errors menziona l’espressione dei campi che non hanno soddisfatto i criteri di convalida insieme al messaggio di errore di convalida.
• originCode aggiunto dall’AEM e contiene il codice di stato http restituito dal servizio esterno.
• originMessage aggiunto dall’AEM e contiene i dati non elaborati sull’errore restituiti dal servizio esterno.

Con i miglioramenti delle funzioni e i successivi aggiornamenti delle versioni di AEM Forms, la struttura di risposta dei guasti esistente è stata modificata in un nuovo formato basato su RFC7807, compatibile con le versioni precedenti della struttura di risposta dei guasti esistente:

    {
        "type": "SERVER_SIDE_VALIDATION/FORM_SUBMISSION/SERVICE_INVOCATION/FAILURE/VALIDATION_ERROR", (required)
        "title": "Server side validation failed/Third party service invocation failed", (optional)
        "detail": "", (optional)
        "instance": "", (optional)
        "validationErrors" : [ (required)
            {
                "fieldName":"<qualified fieldname of the field whose data sent is invalid>",
                "dataRef":<JSONPath (or XPath) of the data element which is invalid>
                "details": ["Error Message(s) for the field"] (required)

            }
        ],
        "originCode": <Origin http status code>, (optional - in case of SERVER_SIDE_VALIDATION)
        "originMessage" : "<unstructured error message returned by service>" (optional - in case of SERVER_SIDE_VALIDATION)
    }

Dove:

• type (required) specifica il tipo di errore. Può corrispondere a uno dei seguenti valori:

  • SERVER_SIDE_VALIDATION indica un errore dovuto alla convalida lato server.
  • FORM_SUBMISSION indica un errore durante l’invio del modulo
  • SERVICE_INVOCATION indica un errore durante una chiamata di un servizio di terze parti.
  • FAILURE indica un errore generale.
  • VALIDATION_ERROR indica un errore dovuto a un errore di convalida.

• title (optional) fornisce un titolo o una breve descrizione dell’errore.

• detail (optional) fornisce ulteriori dettagli sull’errore, se necessario.

• instance (optional) rappresenta un'istanza o un identificatore associato all'errore e consente di tenere traccia o identificare l'occorrenza specifica dell'errore.

• validationErrors (required) contiene informazioni sugli errori di convalida. Include i campi seguenti:

  • fieldname cita il nome del campo qualificato dei campi che non soddisfano i criteri di convalida.
  • dataRef rappresenta il percorso JSON o XPath dei campi che non hanno superato la convalida.
  • details contiene il messaggio di errore di convalida con il campo errato.

• originCode (optional) aggiunto dall’AEM e contiene il codice di stato http restituito dal servizio esterno

• originMessage (optional) aggiunto dall’AEM e contiene i dati non elaborati sull’errore restituiti dal servizio esterno.

Formato risposta errore di esempio

Alcune delle opzioni per visualizzare le risposte di errore sono:

Requisiti per aggiungere un gestore degli errori utilizzando il servizio Invoke dell’editor di regole

Prima di aggiungere un gestore di errori utilizzando il servizio Invoke dell’editor di regole:

• Abilitare i componenti core Forms adattivi per il tuo ambiente AEM Cloud Service.

• Scopri come creare funzioni personalizzate.

Aggiungi gestore errori tramite l’Editor regole

Utilizzo di Servizio di richiamo dell’editor di regole , è possibile definire i criteri di convalida in base all'origine dati utilizzata con il modulo adattivo. Se si utilizzano i servizi Web RESTful come origine dati, è possibile definire i criteri di convalida in un file di definizione Swagger. Utilizzando le funzioni di gestore degli errori e l’editor di regole in Adaptive Forms, puoi gestire e personalizzare in modo efficace la gestione degli errori. Definisci le condizioni utilizzando l’Editor regole e configura le azioni da eseguire quando la regola viene attivata. Il modulo adattivo convalida gli input immessi nei campi in base a criteri di convalida predefiniti. Se i valori di input non soddisfano i criteri di convalida, i messaggi di errore vengono visualizzati a livello di campo in un modulo adattivo.

Utilizzando l’editor di regole, puoi:

• Aggiungi funzione gestore errori predefinita
• Aggiungi funzione di gestione degli errori personalizzata

Aggiungi funzione gestore errori predefinita

È supportato un gestore degli errori predefinito per visualizzare i messaggi di errore sui campi se la risposta di errore si trova nello schema standard o in un errore di convalida lato server.
Per informazioni su come utilizzare un gestore degli errori predefinito utilizzando Servizio di richiamo dell’editor di regole , ad esempio un semplice modulo adattivo con due campi, ID animale domestico e Nome animale domestico e utilizza un gestore degli errori predefinito in corrispondenza di ID animale domestico per verificare la presenza di vari errori restituiti dall’endpoint REST configurato per richiamare un servizio esterno, ad esempio, 200 - OK,404 - Not Found, 400 - Bad Request. Per aggiungere un gestore degli errori predefinito tramite l’azione Richiama servizio dell’editor di regole, esegui i passaggi seguenti:

1. Apri un modulo adattivo in modalità di authoring, seleziona un componente modulo e tocca Editor regole per aprire l’editor di regole.
2. Tocca Crea.
3. Creare una condizione in Quando sezione della regola. Ad esempio: Quando[Nome del campo ID animale domestico] è stato modificato. Seleziona viene modificato dal Seleziona stato elenco a discesa.
4. In Then sezione, seleziona Richiama servizio dal Seleziona azione elenco a discesa.
5. Seleziona un Servizio post e le associazioni di dati corrispondenti dalla Input sezione. Ad esempio, per convalidare ID animale domestico, seleziona un Servizio post as GET /pet/{petId} e seleziona ID animale domestico nel Input sezione.
6. Seleziona le associazioni di dati da Output sezione. Seleziona Nome animale domestico nel Output sezione.
7. Seleziona Gestore errori predefinito dal Gestore errori sezione.
8. Clic Fine.

Come risultato di questa regola, i valori immessi per ID animale domestico verifica la convalida per Nome animale domestico utilizzo di un servizio esterno richiamato dall’endpoint REST. Se i criteri di convalida basati sull’origine dati non riescono, i messaggi di errore vengono visualizzati a livello di campo.

Aggiungi funzione di gestione degli errori personalizzata

È possibile aggiungere una funzione di gestione degli errori personalizzata per eseguire alcune delle azioni seguenti:

• gestisce le risposte di errore che utilizzano risposte di errore non standard o standard. È importante notare che queste risposte di errore non standard non sono conformi al schema standard di risposte di errore.
• invia eventi di analytics a qualsiasi piattaforma di analytics. Ad esempio, Adobe Analytics.
• visualizza la finestra di dialogo modale con messaggi di errore.

Oltre alle azioni citate, i gestori degli errori personalizzati possono essere utilizzati per eseguire funzioni personalizzate che soddisfano requisiti utente specifici.

Il gestore degli errori personalizzati è una funzione (libreria client) progettata per rispondere agli errori restituiti da un servizio esterno e fornire una risposta personalizzata agli utenti finali. Qualsiasi libreria client con annotazione @errorHandler è considerata una funzione di gestione degli errori personalizzata. Questa annotazione consente di identificare la funzione di gestione degli errori specificata in .js file.
Per informazioni su come creare e utilizzare un gestore degli errori personalizzato utilizzando Servizio Invoke dell'editor di regole , prendiamo un esempio di modulo adattivo con due campi, ID animale domestico e Nome animale domestico e utilizza un gestore degli errori personalizzato in corrispondenza di ID animale domestico per verificare la presenza di vari errori restituiti dall’endpoint REST configurato per richiamare un servizio esterno, ad esempio, 200 - OK,404 - Not Found, 400 - Bad Request.

Per aggiungere e utilizzare un gestore di errori personalizzato in un modulo adattivo, effettua le seguenti operazioni:

1. Creare un gestore degli errori personalizzato
2. Utilizza l’Editor regole per configurare un gestore degli errori personalizzato

1. Creare un gestore degli errori personalizzato

Per creare una funzione di errore personalizzata, effettuare le seguenti operazioni:

Per creare una funzione di errore personalizzata, effettuare le seguenti operazioni:

1. Clona l’archivio as a Cloud Service di AEM Forms..

2. Creare una cartella in [AEM Forms as a Cloud Service repository folder]/apps/ cartella. Ad esempio, crea una cartella denominata come experience-league

3. Accedi a [AEM Forms as a Cloud Service repository folder]/apps/[AEM Project Folder]/experience-league/ e creare un ClientLibraryFolder as clientlibs.

4. Crea una cartella denominata js.

5. Accedi a [AEM Forms as a Cloud Service repository folder]/apps/[AEM Project Folder]/clientlibs/js cartella.

6. Aggiungi un file JavaScript, ad esempio function.js. Il file contiene il codice per il gestore degli errori personalizzato.
   Aggiungiamo il seguente codice al file JavaScript per visualizzare la risposta e le intestazioni, ricevute dall’endpoint del servizio REST, nella console del browser.

       /**
       Custom Error handler
       * @name customErrorHandler Custom Error Handler Function
       * @errorHandler
       */
       function customErrorHandler(response, headers, globals)
       {
           console.log("Custom Error Handler processing start...");
           console.log("response:"+JSON.stringify(response));
           console.log("headers:"+JSON.stringify(headers));
           alert("CustomErrorHandler - Enter valid PetId.")
           globals.invoke('defaultErrorHandler',response, headers)
           console.log("Custom Error Handler processing end...");
       }
   

   Per chiamare il gestore errori predefinito dal gestore errori personalizzato, viene utilizzata la seguente riga del codice di esempio:
   globals.invoke('defaultErrorHandler',response, headers)

   NOTA

   In .content.xml file, aggiungi categories = [custom-errorhandler-name]. Ad esempio, in questo caso: [custom-errorhandler-name] viene fornito come customfunctionsdemoV2.

7. Salva il function.js file.

8. Accedi a [AEM Forms as a Cloud Service repository folder]/apps/[AEM Project Folder]/clientlibs/js cartella.

9. Aggiungi un file di testo come js.txt. Il file contiene:

       #base=js
       functions.js
   

10. Salva il js.txt file.
    La struttura di cartelle creata è simile alla seguente:

    

    NOTA

    Per ulteriori informazioni su come creare funzioni personalizzate, fai clic su funzioni personalizzate nell’editor di regole.

11. Aggiungi, esegui il commit e invia le modifiche nell’archivio utilizzando i seguenti comandi:

        git add .
        git commit -a -m "Adding error handling files"
        git push
    

12. Eseguire la pipeline.

Una volta eseguita correttamente la pipeline, il gestore degli errori personalizzato diventa disponibile nell’editor di regole del modulo adattivo. Ora vediamo come configurare e utilizzare un gestore di errori personalizzato utilizzando il servizio Invoke dell’editor di regole in AEM Forms.

2. Utilizza l’Editor regole per configurare un gestore degli errori personalizzato

Prima di implementare il gestore degli errori personalizzato in un modulo adattivo, assicurati che il nome della libreria client nel Categoria libreria client allinea con il nome specificato nell'opzione categorie della .content.xml file.

Per utilizzare un gestore degli errori personalizzato utilizzando Servizio di richiamo dell’editor di regole azione:

1. Apri un modulo adattivo in modalità di authoring, seleziona un componente modulo e tocca Editor regole per aprire l’editor di regole.
2. Tocca Crea.
3. Creare una condizione in Quando sezione della regola. Ad esempio, Quando [Nome del campo ID animale domestico] è stato modificato, seleziona è stato modificato dal Seleziona stato elenco a discesa.
4. In Then sezione, seleziona Richiama servizio dal Seleziona azione elenco a discesa.
5. Seleziona un Servizio post e le associazioni di dati corrispondenti dalla Input sezione. Ad esempio, per convalidare ID animale domestico, seleziona un Servizio post as GET /pet/{petId} e seleziona ID animale domestico nel Input sezione.
6. Seleziona le associazioni di dati da Output sezione. Ad esempio, seleziona Nome animale domestico nel Output sezione.
7. Seleziona Gestore errori personalizzato dal Gestore errori sezione.
8. Clic Fine.

s

Come risultato di questa regola, i valori immessi per ID animale domestico verifica la convalida per Nome animale domestico utilizzo di un servizio esterno richiamato dall’endpoint REST. Se i criteri di convalida basati sull’origine dati non riescono, i messaggi di errore vengono visualizzati a livello di campo.

Apri la console del browser e controlla la risposta e l’intestazione, ricevute dall’endpoint del servizio REST, per il messaggio di errore di convalida.

La funzione del gestore degli errori personalizzato è responsabile dell’esecuzione di azioni aggiuntive, ad esempio la visualizzazione di una finestra di dialogo modale o l’invio di un evento di analisi, in base alla risposta all’errore. Una funzione di gestione degli errori personalizzata offre la flessibilità necessaria per adattare la gestione degli errori ai requisiti utente specifici.

Informazioni aggiuntive

• Creare un modulo adattivo basato su Componenti core autonomi
• Creare stili o temi per i moduli
• Creare o aggiungere un modulo adattivo alla pagina AEM Sites

Consulta anche

• Creare un modulo adattivo di AEM
• Aggiungere un modulo adattivo AEM a una pagina AEM Sites
• Applicare i temi a un modulo adattivo AEM
• Aggiungere componenti a un modulo adattivo di AEM
• Utilizzare il CAPTCHA in un modulo adattivo AEM
• Generare la versione PDF (DoR) di un modulo adattivo AEM
• Tradurre un modulo adattivo di AEM
• Abilitare Adobe Analytics per un modulo adattivo per tenere traccia dell’utilizzo dei moduli
• Collegare un modulo adattivo a Microsoft SharePoint
• Collegare un modulo adattivo a Microsoft Power Automate
• Collegare un modulo adattivo a Microsoft OneDrive
• Collegare un modulo adattivo all’archiviazione BLOB di Microsoft Azure
• Collegare un modulo adattivo a Salesforce
• Utilizzare Adobe Sign in un modulo adattivo di AEM
• Aggiungere una nuova lingua per un modulo adattivo
• Inviare dati del modulo adattivo a un database
• Inviare dati del modulo adattivo a un endpoint REST
• Inviare dati del modulo adattivo al flusso di lavoro di AEM
• Utilizzare il portale dei moduli per elencare moduli adattivi di AEM su un sito web di AEM