Show Menu
THEMEN×

Standardmäßige Prüffehlermeldungen für adaptive Formulare

Adaptive Formulare validieren die Eingaben, die Sie in Feldern bereitstellen, basierend auf einem voreingestellten Validierungskriterium. Die Validierungskriterien beziehen sich auf die zulässigen Eingabewerte für Felder in einem adaptiven Formular. Sie können die Überprüfungskriterien auf Grundlage der Datenquelle festlegen, die Sie mit dem adaptiven Formular verwenden. Wenn Sie beispielsweise RESTful-Webdienste als Datenquelle verwenden, können Sie die Überprüfungskriterien in einer Swagger-Definitionsdatei definieren.
Wenn die Eingabewerte die Überprüfungskriterien erfüllen, werden die Werte an die Datenquelle gesendet. Andernfalls wird im adaptiven Formular eine Fehlermeldung angezeigt.
Ähnlich wie bei diesem Ansatz können adaptive Formulare jetzt in benutzerdefinierte Dienste integriert werden, um Datenvalidierungen durchzuführen. Wenn die eingegebenen Werte die Überprüfungskriterien nicht erfüllen und die vom Server zurückgegebene Prüffehlermeldung im Standardmeldungsformat vorliegt, werden die Fehlermeldungen auf Feldebene im Formular angezeigt.
Wenn die Eingabewerte die Überprüfungskriterien nicht erfüllen und die Fehlermeldung zur Servervalidierung nicht im Standardmeldungsformat vorliegt, stellen die adaptiven Formulare einen Mechanismus bereit, mit dem die Prüffehlermeldungen in ein Standardformat umgewandelt werden können, sodass sie auf Feldebene im Formular angezeigt werden. Sie können die Fehlermeldung mit zwei der folgenden Methoden in das Standardformat transformieren:
  • Hinzufügen eines benutzerspezifischen Fehlerhandlers bei der Übermittlung eines adaptiven Formulars
  • Fügen Sie benutzerdefinierte Handler zum Aufrufen einer Dienstaktion mit dem Regeleditor hinzu
In diesem Artikel werden das Standardformat für die Prüffehlermeldungen und die Anweisungen zur Konvertierung der Fehlermeldungen von einem benutzerdefinierten in das Standardformat beschrieben.

Standard-Fehlermeldungsformat

Die adaptiven Formulare zeigen die Fehler auf Feldebene an, wenn die Fehlermeldungen zur Servervalidierung im folgenden Standardformat vorliegen:
   {
    errorCausedBy : "SERVER_SIDE_VALIDATION/SERVICE_INVOCATION_FAILURE"
    errors : [
        {
             somExpression  : <somexpr>
             errorMessage / errorMessages : <validationMsg> / [<validationMsg>, <validationMsg>]

        }
    ]
    originCode : <target error Code>
    originMessage : <unstructured error message returned by service>
}

wobei:
  • errorCausedBy beschreibt den Fehlergrund
  • errors Erwähnung des SOM-Ausdrucks der Felder, bei denen die Validierungskriterien zusammen mit der Prüffehlermeldung fehlgeschlagen sind
  • originCode enthält den vom externen Dienst zurückgegebenen Fehlercode
  • originMessage enthält die vom externen Dienst zurückgegebenen Rohfehlerdaten

Konfigurieren der Übermittlung adaptiver Formulare zum Hinzufügen benutzerdefinierter Handler

Wenn die Fehlermeldung zur Serverüberprüfung nicht im Standardformat angezeigt wird, können Sie die asynchrone Übermittlung aktivieren und einen benutzerdefinierten Fehlerhandler für die Übermittlung des adaptiven Formulars hinzufügen, um die Nachricht in ein Standardformat zu konvertieren.

Konfigurieren der asynchronen Übermittlung adaptiver Formulare

Bevor Sie einen benutzerdefinierten Handler hinzufügen, müssen Sie das adaptive Formular für die asynchrone Übermittlung konfigurieren. Führen Sie die folgenden Schritte aus:
  1. In adaptive form authoring mode, select the Form Container object and tap to open its properties.
  2. In the Submission properties section, enable Use asynchronous submission .
  3. Wählen Sie Auf Server erneut überprüfen, um die Eingabefeldwerte vor der Übermittlung auf dem Server zu überprüfen.
  4. Wählen Sie die Übermittlungsaktion aus:
    • Wählen Sie " Senden mit Formulardatenmodell "und wählen Sie das entsprechende Datenmodell, wenn Sie RESTful-Webdienst-basiertes Formulardatenmodell als Datenquelle verwenden.
    • Wählen Sie " An REST-Endpunkt übermitteln"und geben Sie die Umleitungs-URL/den Pfad an, wenn Sie RESTful-Webdienste als Datenquelle verwenden.
  5. Tippen Sie auf , um die Eigenschaften zu speichern.

Hinzufügen eines benutzerspezifischen Fehlerhandlers bei der Übermittlung eines adaptiven Formulars

AEM Forms bietet standardmäßig Handler zur Verarbeitung von erfolgreichen und fehlgeschlagenen Formularübermittlungen an. Handler sind clientseitige Funktionen, die anhand der Serverantwort ausgeführt werden. Wenn ein Formular übermittelt wird, werden die Daten zur Validierung an den Server gesendet, der eine Antwort mit Informationen über den Erfolg oder das Fehlschlagen der Übermittlung an den Client zurücksendet. Die Informationen werden als Parameter an den relevanten Handler übergeben, um die Funktion auszuführen.
Führen Sie die folgenden Schritte aus, um beim Senden des adaptiven Formulars einen benutzerdefinierten Fehlerhandler hinzuzufügen:
  1. Open the adaptive form in authoring mode, select any form object, and tap to open the rule editor.
  2. Wählen Sie Formular in der Struktur „Formularobjekte“ und tippen Sie auf Erstellen .
  3. Wählen Sie Fehler bei Übermittlung aus der Dropdownliste Ereignis.
  4. Schreiben Sie eine Regel, um die benutzerdefinierte Fehlerstruktur in die Standardfehlerstruktur zu konvertieren, und tippen Sie auf Fertig , um die Regel zu speichern.
Im Folgenden finden Sie einen Beispielcode zum Konvertieren einer benutzerdefinierten Fehlerstruktur in die standardmäßige Fehlerstruktur:
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);
    }
}

Der var som_map Listet den SOM-Ausdruck der adaptiven Formularfelder auf, die Sie in das Standardformat umwandeln möchten. Sie können den SOM-Ausdruck eines beliebigen Felds in einem adaptiven Formular anzeigen, indem Sie auf das Feld tippen und "SOM-Ausdruck anzeigen&quot;wählen .
Mithilfe dieses benutzerspezifischen Fehlerhandlers konvertiert das adaptive Formular die in aufgeführten Felder in var som_map das Standard-Fehlermeldungsformat. Die Prüffehlermeldungen werden daher auf Feldebene im adaptiven Formular angezeigt.

Hinzufügen eines benutzerdefinierten Handlers mit der Aktion "Dienst aufrufen"

Führen Sie die folgenden Schritte aus, um einen Fehler-Handler hinzuzufügen, um eine benutzerdefinierte Fehlerstruktur mithilfe der Aktion "Aufrufdienst"des Regeleditors in die Standardfehlerstruktur zu konvertieren:
  1. Open the adaptive form in authoring mode, select any form object, and tap to open the rule editor.
  2. Tippen Sie auf Erstellen .
  3. Erstellen Sie eine Bedingung im Abschnitt Wenn der Regel. Beispiel: # geändert wird. Die Option "Auswählen" wird aus der Dropdownliste &quot;Status auswählen"geändert , um diese Bedingung zu erreichen .
  4. In the Then section, select Invoke Service from the Select Action drop-down list.
  5. Wählen Sie einen Post-Dienst und die zugehörigen Datenbindungen im Abschnitt Eingabe aus. Wenn Sie beispielsweise die Felder Name , ID und Status im adaptiven Formular überprüfen möchten, wählen Sie einen Post-Dienst (Tier) aus und wählen Sie im Abschnitt Eingabe den Eintrag "pet.name", "pet.id"und "pet.status"aus.
Aufgrund dieser Regel werden die Werte, die Sie für die Felder Name , ID und Status eingeben, validiert, sobald das in Schritt 2 definierte Feld geändert wird und Sie die Tabulatortaste aus dem Feld im Formular entfernen.
  1. Select Code Editor from the mode selection drop-down list.
  2. Tippen Sie auf Code bearbeiten .
  3. Löschen Sie die folgende Zeile aus dem vorhandenen Code:
    guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);
    
    
  4. Schreiben Sie eine Regel, um die benutzerdefinierte Fehlerstruktur in die Standardfehlerstruktur zu konvertieren, und tippen Sie auf Fertig , um die Regel zu speichern. Fügen Sie beispielsweise am Ende den folgenden Beispielcode hinzu, um eine benutzerdefinierte Fehlerstruktur in die Standardfehlerstruktur zu konvertieren:
    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);
    
    
    Der var som_map Listet den SOM-Ausdruck der adaptiven Formularfelder auf, die Sie in das Standardformat umwandeln möchten. Sie können den SOM-Ausdruck eines Felds in einem adaptiven Formular anzeigen, indem Sie auf das Feld tippen und im Menü " Mehr Optionen "(...) die Option "SOM-Ausdruck anzeigen"auswählen.
    Stellen Sie sicher, dass Sie die folgende Zeile des Beispielcodes in den benutzerdefinierten Fehlerhandler kopieren:
    guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs, null, errorHandler);
    
    
    Die executeOperation-API enthält die null und errorHandler -Parameter, die auf dem neuen benutzerdefinierten Fehlerhandler basieren.
    Mithilfe dieses benutzerspezifischen Fehlerhandlers konvertiert das adaptive Formular die in aufgeführten Felder in var som_map das Standard-Fehlermeldungsformat. Die Prüffehlermeldungen werden daher auf Feldebene im adaptiven Formular angezeigt.