Messaggi di errore di convalida standard per i moduli adattivi
ATTENZIONE
AEM 6.4 ha raggiunto la fine del supporto esteso e questa documentazione non viene più aggiornata. Per maggiori dettagli, consulta la nostra periodi di assistenza tecnica. Trova le versioni supportate qui.
I moduli adattivi convalidano gli input forniti nei campi in base a criteri di convalida predefiniti. I criteri di convalida si riferiscono ai valori di input accettabili per i campi in un modulo adattivo. È 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 immessi soddisfano i criteri di convalida, questi vengono inviati all’origine dati. In caso contrario, nel modulo adattivo viene visualizzato un messaggio di errore.
Analogamente a questo approccio, i moduli adattivi possono ora integrarsi con i servizi personalizzati per eseguire le convalide dei dati. Se i valori di input non soddisfano i criteri di convalida e il messaggio di errore di convalida restituito dal server è nel formato di messaggio standard, i messaggi di errore vengono visualizzati a livello di campo nel modulo.
Se i valori di input non soddisfano i criteri di convalida e il messaggio di errore di convalida del server non è nel formato di messaggio standard, i moduli adattivi forniscono un meccanismo per trasformare i messaggi di errore di convalida in un formato standard in modo che vengano visualizzati a livello di campo nel modulo. Puoi trasformare il messaggio di errore nel formato standard utilizzando uno dei due metodi seguenti:
Aggiungi un gestore di errori personalizzato per l’invio di moduli adattivi
Aggiungi il gestore personalizzato all'azione Invoke Service utilizzando l'Editor regole
Questo articolo descrive il formato standard dei messaggi di errore convalida e le istruzioni per trasformare i messaggi di errore da un formato personalizzato a quello standard.
Formato del messaggio di errore di convalida standard
Nei moduli adattivi vengono visualizzati gli errori a livello di campo se i messaggi di errore convalida del server sono nel seguente formato standard:
errors menzione dell’espressione SOM dei campi che non hanno soddisfatto i criteri di convalida insieme al messaggio di errore di convalida
originCode contiene il codice di errore restituito dal servizio esterno
originMessage contiene i dati di errore non elaborati restituiti dal servizio esterno
Configurare l’invio di moduli adattivi per aggiungere gestori personalizzati
Se il messaggio di errore convalida server non viene visualizzato nel formato standard, è possibile abilitare l’invio asincrono e aggiungere un gestore di errori personalizzato nell’invio di moduli adattivi per convertire il messaggio in un formato standard.
Configurare l’invio asincrono di moduli adattivi
Prima di aggiungere un gestore personalizzato, devi configurare il modulo adattivo per l’invio asincrono. Esegui i seguenti passaggi:
In modalità di creazione dei moduli adattivi, seleziona l’oggetto Contenitore modulo e tocca per aprire le relative proprietà.
In Invio sezione proprietà, abilita Utilizzare l’invio asincrono.
Seleziona Rivelare sul server per convalidare i valori dei campi di input sul server prima dell’invio.
Selezionare l’azione Invia:
Seleziona Invia utilizzando il modello dati del modulo e selezionare il modello dati appropriato, se si utilizza il servizio web RESTful basato su servizi web modello dati modulo come origine dati.
Seleziona Invia all’endpoint REST e specifica URL/percorso di reindirizzamento, se utilizzi i servizi web RESTful come origine dati.
Tocca per salvare le proprietà.
Aggiungi un gestore di errori personalizzato per l’invio di moduli adattivi
AEM Forms fornisce gestori di errori e di successo preconfigurati per l’invio dei moduli. I gestori sono funzioni lato client che vengono eseguite in base alla risposta del server. Quando un modulo viene inviato, i dati vengono trasmessi al server per la convalida, che restituisce una risposta al client con informazioni sull’evento riuscito o di errore per l’invio. Le informazioni vengono passate come parametri al gestore pertinente per eseguire la funzione .
Esegui i seguenti passaggi per aggiungere un gestore di errori personalizzato all’invio di moduli adattivi:
Apri il modulo adattivo in modalità di creazione, seleziona un oggetto modulo qualsiasi e tocca per aprire l’editor di regole.
Seleziona Modulo nell’albero Oggetti modulo e toccare Crea.
Seleziona Errore nell'invio dall’elenco a discesa Evento .
Scrivere una regola per convertire la struttura di errore personalizzata nella struttura di errore standard e toccare Fine per salvare la regola.
Di seguito è riportato un codice di esempio per convertire una struttura di errore personalizzata nella struttura di errore standard:
var data = $event.data;
var som_map = {
"id": "guide[0].guide1[0].guideRootPanel[0].Pet[0].id_1[0]",
"name": "guide[0].guide1[0].guideRootPanel[0].Pet[0].name_2[0]",
"status": "guide[0].guide1[0].guideRootPanel[0].Pet[0].status[0]"
};
var errorJson = {};
errorJson.errors = [];
if (data) {
if (data.originMessage) {
var errorData;
try {
errorData = JSON.parse(data.originMessage);
} catch (err) {
// not in json format
}
if (errorData) {
Object.keys(errorData).forEach(function(key) {
var som_key = som_map[key];
if (som_key) {
var error = {};
error.somExpression = som_key;
error.errorMessage = errorData[key];
errorJson.errors.push(error);
}
});
}
window.guideBridge.handleServerValidationError(errorJson);
} else {
window.guideBridge.handleServerValidationError(data);
}
}
La var som_map elenca l’espressione SOM dei campi modulo adattivo che si desidera trasformare in formato standard. Per visualizzare l’espressione SOM di qualsiasi campo di un modulo adattivo, tocca il campo e seleziona Visualizza espressione SOM.
Utilizzando questo gestore di errori personalizzato, il modulo adattivo converte i campi elencati in var som_map nel formato standard del messaggio di errore. Di conseguenza, i messaggi di errore di convalida vengono visualizzati a livello di campo nel modulo adattivo.
Aggiungi un gestore personalizzato utilizzando l'azione Invoke Service
Esegui i seguenti passaggi per aggiungere il gestore errori per convertire una struttura di errore personalizzata nella struttura di errore standard utilizzando Editor di regole Richiama azione del servizio:
Apri il modulo adattivo in modalità di creazione, seleziona un oggetto modulo qualsiasi e tocca per aprire l’editor di regole.
Tocca Crea.
Crea una condizione nel Quando della regola. Ad esempio, quando[Nome del campo] viene modificato. Seleziona viene modificato dal Seleziona stato elenco a discesa per ottenere questa condizione.
In Then sezione , seleziona Richiama servizio dal Seleziona azione elenco a discesa.
Seleziona un servizio di pubblicazione e i relativi binding dei dati dal Ingresso sezione . Ad esempio, se desideri convalidare Nome, ID e Stato nei campi del modulo adattivo, seleziona un servizio post (pet) e seleziona pet.name, pet.id e pet.status nel Ingresso sezione .
Come risultato di questa regola, i valori immessi per Nome, ID e Stato i campi vengono convalidati non appena il campo definito nel passaggio 2 viene modificato e si esce dal campo nel modulo.
Seleziona Editor di codice dall’elenco a discesa selezione modalità.
Scrivere una regola per convertire la struttura di errore personalizzata nella struttura di errore standard e toccare Fine per salvare la regola.
Ad esempio, aggiungi il seguente codice di esempio alla fine per convertire una struttura di errore personalizzata nella struttura di errore standard:
var errorHandler = function(jqXHR, data) {
var som_map = {
"id": "guide[0].guide1[0].guideRootPanel[0].Pet[0].id_1[0]",
"name": "guide[0].guide1[0].guideRootPanel[0].Pet[0].name_2[0]",
"status": "guide[0].guide1[0].guideRootPanel[0].Pet[0].status[0]"
};
var errorJson = {};
errorJson.errors = [];
if (data) {
if (data.originMessage) {
var errorData;
try {
errorData = JSON.parse(data.originMessage);
} catch (err) {
// not in json format
}
if (errorData) {
Object.keys(errorData).forEach(function(key) {
var som_key = som_map[key];
if (som_key) {
var error = {};
error.somExpression = som_key;
error.errorMessage = errorData[key];
errorJson.errors.push(error);
}
});
}
window.guideBridge.handleServerValidationError(errorJson);
} else {
window.guideBridge.handleServerValidationError(data);
}
}
};
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, null, errorHandler);
La var som_map elenca l’espressione SOM dei campi modulo adattivo che si desidera trasformare in formato standard. Per visualizzare l’espressione SOM di qualsiasi campo di un modulo adattivo, tocca il campo e seleziona Visualizza espressione SOM da Altre opzioni Menu (…).
Assicurati di copiare la seguente riga del codice di esempio nel gestore di errori personalizzato:
L’API executeOperation include null e errorHandler in base al nuovo gestore di errori personalizzato.
Utilizzando questo gestore di errori personalizzato, il modulo adattivo converte i campi elencati in var som_map nel formato standard del messaggio di errore. Di conseguenza, i messaggi di errore di convalida vengono visualizzati a livello di campo nel modulo adattivo.
per aprire le relative proprietà.
per salvare le proprietà.
per aprire l’editor di regole.
