API zum Aufrufen von Formulardatenmodelldiensten aus adaptiven Formularen

Überblick

AEM Forms ermöglicht es Formularautoren, das Ausfüllen von Formularen weiter zu vereinfachen und zu verbessern, indem sie Dienste, die in einem Formulardatenmodell konfiguriert sind, aus einem adaptiven Formularfeld heraus aufrufen. Um einen Datenmodelldienst aufzurufen, können Sie entweder eine Regel im Visual Editor erstellen oder mit der API guidelib.dataIntegrationUtils.executeOperation im Code-Editor des Regeleditors ein JavaScript angeben.

In diesem Dokument wird das Schreiben von JavaScript im APIguidelib.dataIntegrationUtils.executeOperation für den Aufruf eines Dienst beschrieben.

Verwenden der API

Die guidelib.dataIntegrationUtils.executeOperation-API ruft einen Dienst aus einem Feld für ein adaptives Formular auf. Für die API gilt die folgende Syntax:

guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs)

Für die API sind die folgenden Parameter erforderlich.

Parameter Beschreibung
operationInfo Struktur zur Angabe von Formulardatenmodellkennung, Operationstitel und Operationsname
inputs Struktur zum Festlegen von Formularobjekten, deren Werte für den Dienstvorgang eingegeben werden
outputs Struktur zur Angabe von Formularobjekten, die mit den vom Dienstvorgang zurückgegebenen Werten gefüllt werden

Die Struktur der API guidelib.dataIntegrationUtils.executeOperation gibt Details zum Dienstvorgang an. Die Struktur weist die folgende Syntax auf.

var operationInfo = {
formDataModelId,
operationTitle,
operationName
};
var inputs = {
inputField1,
inputFieldN
};
var outputs = {
outputField1,
outputFieldN
}

Die API-Struktur gibt die folgenden Informationen zum Webdienst-Vorgang an.

Parameter Beschreibung
forDataModelId Geben Sie den Repository-Pfad zum Formulardatenmodell an, einschließlich Name
operationName Geben Sie den Namen des Dienstvorgangs an, um
input Ordnen Sie ein oder mehrere Formularobjekte den Eingabeargumenten für den Dienstvorgang zu.
Ausgabe Ordnen Sie ein oder mehrere Formularobjekte Ausgabewerte aus dem Dienstvorgang zu, um Formularfelder zu füllen.

Beispielskript zum Erstellen eines Dienstes

Das folgende Beispielskript verwendet die API guidelib.dataIntegrationUtils.executeOperation, um den im Formulardatenmodell employeeAccount konfigurierten Dienstvorgang getAccountById aufzurufen.

Der Vorgang getAccountById nimmt den Wert im Formularfeld employeeID als Eingabe für das empId-Argument und gibt Mitarbeitername, Kontonummer und Kontostand für den entsprechenden Mitarbeiter zurück. Die Ausgabewerte werden in den angegebenen Formularfeldern befüllt. Beispielsweise wird der Wert im Argument name im Formularelement fullName und der Wert für accountNumber im account-Formularelement gefüllt.

var operationInfo = {
"formDataModelId": "/content/dam/formsanddocuments-fdm/employeeAccount",
"operationName": "getAccountDetails"
};
var inputs = {
"empid" : employeeID
};
var outputs = {
"name" : fullName,
"accountNumber" : account,
"balance" : balance
};
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs);

Auf dieser Seite