API om de service voor formuliergegevensmodellen aan te roepen vanuit adaptieve formulieren
- Onderwerpen:
- Adaptive Forms
Gemaakt voor:
- User
CAUTIONOverzicht
Met AEM Forms kunnen auteurs van formulieren de invulervaring van formulieren verder vereenvoudigen en verbeteren door services aan te roepen die vanuit een adaptief formulierveld zijn geconfigureerd in een formuliergegevensmodel. Als u een gegevensmodelservice wilt aanroepen, kunt u een regel maken in de visuele editor of een JavaScript opgeven met de guidelib.dataIntegrationUtils.executeOperation API in de code-editor van de regeleditor.
Dit document is vooral bedoeld voor het schrijven van een JavaScript met het guidelib.dataIntegrationUtils.executeOperation API om de service aan te roepen.
De API gebruiken
De guidelib.dataIntegrationUtils.executeOperation API roept een service aan vanuit een adaptief formulierveld. De API-syntaxis ziet er als volgt uit:
guidelib.dataIntegrationUtils.executeOperation(operationInfo, inputs, outputs)
De API vereist de volgende parameters.
| Parameter | Beschrijving |
|---|---|
operationInfo | Structuur voor het opgeven van de modelidentificatie, de bewerkingstitel en de naam van de bewerking van het formulier |
inputs | Structuur om formulierobjecten op te geven waarvan de waarden worden ingevoerd voor de servicebewerking |
outputs | Structuur voor het opgeven van formulierobjecten die worden gevuld met de waarden die door de servicebewerking worden geretourneerd |
De structuur van de guidelib.dataIntegrationUtils.executeOperation API specificeert details over de de dienstverrichting. De syntaxis van de structuur is als volgt.
var operationInfo = {
formDataModelId,
operationTitle,
operationName
};
var inputs = {
inputField1,
inputFieldN
};
var outputs = {
outputField1,
outputFieldN
}
De API-structuur geeft de volgende details over de servicebewerking op.
| Parameter | Beschrijving |
|---|---|
forDataModelId | Geef het pad van de gegevensopslagruimte naar het formuliergegevensmodel op, inclusief de naam ervan |
operationName | Geef de naam op van de uit te voeren servicebewerking |
input | Een of meer formulierobjecten toewijzen aan de invoerargumenten voor de servicebewerking |
| Uitvoer | Een of meer formulierobjecten toewijzen aan uitvoerwaarden van de servicebewerking om formuliervelden te vullen |
Voorbeeldscript om een service aan te roepen
In het volgende voorbeeldscript wordt het guidelib.dataIntegrationUtils.executeOperation API om de getAccountById de dienstverrichting die in employeeAccount formuliergegevensmodel.
De getAccountById de bewerking neemt de waarde in de employeeID formulierveld als invoer voor de empId argument en retourneert werknemersnaam, accountnummer en rekeningsaldo voor de corresponderende werknemer. De uitvoerwaarden worden ingevuld in de opgegeven formuliervelden. De waarde in name argument is ingevuld in het dialoogvenster fullName formulierelement en -waarde voor accountNumber argument in account formulierelement.
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);