API pour appeler le service de modèle de données de formulaire à partir de formulaires adaptatifs

Dernière mise à jour : 2023-05-04
  • Créé pour :
  • User
ATTENTION

AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Présentation

AEM Forms permet aux auteurs de formulaires de simplifier et d’améliorer davantage l’expérience de remplissage de formulaire en appelant les services configurés dans un modèle de données de formulaire depuis un champ de formulaire adaptatif. Pour appeler un service de modèle de données, vous pouvez créer une règle dans l’éditeur visuel ou spécifier un script JavaScript en utilisant l’API guidelib.dataIntegrationUtils.executeOperation dans l’éditeur de code de l’éditeur de règles.

Ce document se concentre sur l’écriture d’un script JavaScript en utilisant l’API guidelib.dataIntegrationUtils.executeOperation pour appeler un service.

Utilisation de l’API

L’API guidelib.dataIntegrationUtils.executeOperation appelle un service depuis un champ de formulaire adaptatif. La syntaxe API se présente comme suit :

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

L’API requiert les paramètres suivants.

Paramètre Description
operationInfo Structure permettant de spécifier l’identifiant du modèle de données de formulaire, le titre de l’opération et le nom de l’opération
inputs Structure pour spécifier les objets de formulaire dont les valeurs sont saisies dans l’opération de service
outputs Structure pour spécifier les objets de formulaire qui seront renseignés avec les valeurs renvoyées par l’opération de service

La structure de l’API guidelib.dataIntegrationUtils.executeOperation spécifie les détails sur l’opération de service. La syntaxe de la structure est la suivante.

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

La structure de l’API spécifie les détails suivants sur l’opération de service.

Paramètre Description
forDataModelId Spécifiez le chemin du référentiel vers le modèle de données de formulaire, y compris son nom.
operationName Spécifiez le nom de l’opération de service à exécuter.
input Faire correspondre un ou plusieurs objets de formulaire aux arguments d’entrée pour l’opération de service
Sortie Faire correspondre un ou plusieurs objets de formulaire aux valeurs de sortie de l’opération de service pour remplir les champs de formulaire

Exemple de script pour appeler un service

L’exemple de script suivant utilise l’API guidelib.dataIntegrationUtils.executeOperation pour appeler l’opération de service getAccountById configurée dans le modèle de données de formulaire employeeAccount.

L’opération getAccountById utilise la valeur du champ de formulaire employeeID comme entrée pour l’argument empId et renvoie le nom de l’employé, le numéro de compte et le solde du compte pour l’employé correspondant. Les valeurs de sortie sont renseignées dans les champs de formulaire spécifiés. Par exemple, la valeur de l’argument name est renseignée dans l’élément de formulaire fullName et la valeur de l’argument accountNumber, dans l’élément de formulaire account.

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);

Sur cette page