Tutoriel : créer un modèle de données de formulaire dans AEM Forms tutorial-create-form-data-model
Ce tutoriel fait partie de la série Création de votre première communication interactive. Il est recommandé de suivre la série dans l’ordre chronologique pour comprendre, exécuter et accomplir le cas d’utilisation complet du tutoriel.
À propos du tutoriel about-the-tutorial
Le module d’intégration de données AEM Forms vous permet de créer un modèle de données de formulaire à partir de sources de données tierces telles que le profil utilisateur AEM, les services web RESTful, les services web basés sur SOAP, les services OData et les bases de données relationnelles. Vous pouvez configurer des objets et des services de modèle de données dans un modèle de données de formulaire et les associer à un formulaire adaptatif. Les champs de formulaire adaptatif sont liés aux propriétés de l’objet de modèle de données. Les services vous permettent de préremplir le formulaire adaptatif et d’écrire les données de formulaire soumises dans l’objet de modèle de données.
Pour plus d’informations sur l’intégration des données de formulaire et sur le modèle de données du formulaire, voir Intégration de données AEM Forms.
Ce didacticiel vous décrit étape par étape le processus de préparation, création, configuration et association d’un modèle de données de formulaire avec une communication interactive. À la fin de ce didacticiel, vous serez capable de :
Le modèle de données de formulaire se présente comme ceci :
A. Sources de données configurées B. Schémas de source de données C. Services disponibles D. Objets de modèle de données E. Services configurés
Prérequis prerequisites
Avant de commencer, vérifiez que vous disposez des éléments suivants :
- Base de données MySQL avec des exemples de données comme indiqué dans la section Configurer la base de données.
- Lot OSGi pour le pilote JDBC MySQL, comme expliqué dans la section Regrouper le pilote de base de données JDBC.
Étape 1 : Configurer la base de données step-set-up-the-database
Une base de données est essentielle pour créer une communication interactive. Ce didacticiel utilise une base de données pour afficher le modèle de données de formulaire et les fonctionnalités de persistance des communications interactives. Configurez une base de données comprenant les tableaux des clients, des factures et des appels.
L’image suivante présente des exemples de données pour le tableau des clients :
Utilisez l’instruction DDL suivante pour créer le tableau client dans la base de données.
CREATE TABLE `customer` (
`mobilenum` int(11) NOT NULL,
`name` varchar(45) NOT NULL,
`address` varchar(45) NOT NULL,
`alternatemobilenumber` int(11) DEFAULT NULL,
`relationshipnumber` int(11) DEFAULT NULL,
`customerplan` varchar(45) DEFAULT NULL,
PRIMARY KEY (`mobilenum`),
UNIQUE KEY `mobilenum_UNIQUE` (`mobilenum`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8
Utilisez l’instruction DDL suivante pour créer le tableau factures dans la base de données.
CREATE TABLE `bills` (
`billplan` varchar(45) NOT NULL,
`latepayment` decimal(4,2) NOT NULL,
`monthlycharges` decimal(4,2) NOT NULL,
`billdate` date NOT NULL,
`billperiod` varchar(45) NOT NULL,
`prevbal` decimal(4,2) NOT NULL,
`callcharges` decimal(4,2) NOT NULL,
`confcallcharges` decimal(4,2) NOT NULL,
`smscharges` decimal(4,2) NOT NULL,
`internetcharges` decimal(4,2) NOT NULL,
`roamingnational` decimal(4,2) NOT NULL,
`roamingintnl` decimal(4,2) NOT NULL,
`vas` decimal(4,2) NOT NULL,
`discounts` decimal(4,2) NOT NULL,
`tax` decimal(4,2) NOT NULL,
PRIMARY KEY (`billplan`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8
Utilisez l’instruction DDL suivante pour créer le tableau appels dans la base de données.
CREATE TABLE `calls` (
`mobilenum` int(11) DEFAULT NULL,
`calldate` date DEFAULT NULL,
`calltime` varchar(45) DEFAULT NULL,
`callnumber` int(11) DEFAULT NULL,
`callduration` varchar(45) DEFAULT NULL,
`callcharges` decimal(4,2) DEFAULT NULL,
`calltype` varchar(45) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8
Le tableau des appels inclut les informations sur l’appel telles que la date, l’heure, le numéro, la durée de l’appel et les frais d’appel. Le tableau des clients est lié au tableau des appels à l’aide du champ Numéro de mobile (mobilenum). Pour chaque numéro de mobile répertorié dans le tableau des clients, le tableau des appels contient plusieurs enregistrements. Par exemple, vous pouvez récupérer les informations sur l’appel pour le numéro de téléphone mobile 1457892541 en vous reportant au tableau des appels.
Le tableau des factures comprend les informations sur la facturation, telles que la date, la période, les frais mensuels et les frais d’appel. Le tableau des clients est lié au tableau des factures à l’aide du champ Plan de facturation. Un plan est associé à chaque client dans le tableau des clients. Le tableau des factures comprend les informations de tarification pour tous les plans existants. Par exemple, vous pouvez extraire les informations de plan de Sarah à partir du tableau des clients et utiliser ces informations pour extraire les informations de tarification à partir du tableau des factures.
Étape 2 : Configurer la base de données MySQL comme source de données step-configure-mysql-database-as-data-source
Vous pouvez configurer différents types de sources de données pour créer un modèle de données de formulaire. Pour ce tutoriel, vous allez configurer la base de données MySQL qui est configurée et remplie avec des exemples de données. Pour plus d’informations sur les autres sources de données prises en charge et sur leur configuration, reportez-vous à la section Intégration de données d’AEM Forms.
Procédez comme suit pour configurer votre base de données MySQL :
-
Installez le pilote JDBC pour la base de données MySQL en tant que lot OSGi :
-
Connectez-vous à l’instance d’auteur AEM Forms en tant qu’administrateur et accédez aux bundles de la console web d’AEM. L’URL par défaut est https://localhost:4502/system/console/bundles.
-
Sélectionnez Installer/Mettre à jour. Une boîte de dialogue Charger/installer les bundles s’affiche.
-
Sélectionnez Choisir un fichier pour rechercher et sélectionner le bundle OSGi du pilote JDBC MySQL. Sélectionnez Démarrer le bundle et Actualiser les packages, puis sélectionnez Installer ou Mettre à jour. Assurez-vous que le pilote JDBC d’Oracle Corporation pour MySQL est actif. Le pilote est installé.
-
-
Configurez la base de données MySQL comme source de données :
-
Accédez à la console web d’AEM à l’adresse https://localhost:4502/system/console/configMgr.
-
Recherchez la configuration Apache Sling Connection Pooled DataSource. Sélectionnez pour ouvrir la configuration en mode édition.
-
Dans la boîte de dialogue de configuration, indiquez ce qui suit :
-
Nom de la source de données : vous pouvez spécifier un nom. Spécifiez par exemple MySQL.
-
Nom de la propriété de service de source de données : spécifiez le nom de la propriété de service contenant le nom de la source de données. Il est spécifié lors de l’enregistrement de l’instance de source de données en tant que service OSGi. Par exemple, datasource.name.
-
Classe de pilote JDBC : spécifiez le nom de la classe Java du pilote JDBC. Pour la base de données MySQL, spécifiez com.mysql.jdbc.Driver.
-
URI de connexion JDBC : spécifiez l’URL de connexion de la base de données. Pour la base de données MySQL s’exécutant sur le port 3306 et le schéma teleca, l’URL est la suivante :
jdbc:mysql://'server':3306/teleca?autoReconnect=true&useUnicode=true&characterEncoding=utf-8
-
Nom d’utilisateur : nom d’utilisateur de la base de données. Il est nécessaire d’activer le pilote JDBC pour établir une connexion avec la base de données.
-
Mot de passe : mot de passe de la base de données. Il est nécessaire d’activer le pilote JDBC pour établir une connexion avec la base de données.
-
Test lors de l’emprunt : activez l’option Test lors de l’emprunt.
-
Test lors du renvoi : activez l’option Test lors du renvoi.
-
Requête de validation : spécifiez une requête SQL SELECT pour valider les connexions du pool. La requête doit renvoyer au moins une ligne. Par exemple, sélectionnez* à partir du client ou de la cliente.
-
Isolation de transaction : définissez la valeur sur READ_COMMITTED.
-
Conservez les valeurs par défaut des autres propriétés et sélectionnez Enregistrer.
Une configuration similaire à la suivante est créée.
-
Étape 3 : Créer un modèle de données de formulaire step-create-form-data-model
AEM Forms fournit une interface utilisateur intuitive pour créer un modèle de données de formulaire à partir des sources de données configurées. Vous pouvez utiliser plusieurs sources de données dans un modèle de données de formulaire. Pour le cas d’utilisation de ce tutoriel, vous utiliserez MySQL comme source de données.
Procédez comme suit pour créer un modèle de données de formulaire :
-
Dans l’instance de création AEM, accédez à Formulaires > Intégrations de données.
-
Sélectionnez Créer > Modèle de données de formulaire.
-
Dans l’assistant Créer un modèle de données de formulaire, spécifiez un nom pour le modèle de données de formulaire. Par exemple, FDM_Create_First_IC. Sélectionnez Suivant.
-
L’écran Sélectionner la source de données répertorie toutes les sources de données configurées. Sélectionnez la source de données MySQL, puis Créer.
-
Cliquez sur Terminé. Le modèle de données de formulaire FDM_Create_First_IC est créé.
Étape 4 : Configurer un modèle de données de formulaire step-configure-form-data-model
La configuration d’un modèle de données de formulaire inclut :
- l’ajout d’objets et de services de modèle de données
- la création de propriétés enfants calculées pour un objet de modèle de données
- l’ajout d’associations entre les objets de modèle de données
- la modification des propriétés d’objet du modèle de données
- la configuration des services pour les objets de modèle de données
Ajout d’objets et de services de modèle de données add-data-model-objects-and-services
-
Dans l’instance d’auteur AEM, accédez à Formulaires > Intégrations de données. L’URL par défaut est https://localhost:4502/aem/forms.html/content/dam/formsanddocuments-fdm.
-
Le modèle de données de formulaire FDM_Create_First_IC que vous avez créé précédemment est répertorié ici. Sélectionnez-le, puis sélectionnez Modifier.
La source de données sélectionnée MySQL est affichée dans le volet Sources de données.
-
Développez l’arborescence de la source de données MySQL. Sélectionnez les objets et services de modèle de données suivants dans le schéma teleca :
-
Objets de modèle de données:
- factures
- appels
- client ou cliente
-
Services :
- get
- mise à jour
Sélectionnez Ajouter la sélection pour ajouter des objets et des services de modèle de données sélectionnés au modèle de données de formulaire.
Les objets de modèle de données facture, appels et client ou cliente sont affichés dans le volet de droite de l’onglet Modèle. Les services get et update s’affichent dans la section Services.
-
Créer des propriétés enfants calculées pour un objet de modèle de données create-computed-child-properties-for-data-model-object
Une propriété calculée est celle dont la valeur est calculée sur la base d’une règle ou d’une expression. À l’aide d’une règle, vous pouvez définir la valeur d’une propriété calculée sur une chaîne littérale, un nombre, le résultat d’une expression mathématique ou la valeur d’une autre propriété dans le modèle de données de formulaire.
En fonction du cas d’utilisation, créez la propriété enfant calculée usagecharges dans l’objet de modèle de données facture à l’aide de l’expression mathématique suivante :
- Frais d’utilisation = frais d’appel + frais de conférence téléphonique + frais SMS + frais d’internet mobile + itinérance nationale + itinérance internationale + services à valeur ajoutée (toutes ces propriétés existent dans l’objet de modèle de données factures)
Pour plus d’informations sur la propriété calculée enfant usagecharges, consultez la section Planifier la communication interactive.
Exécutez les étapes suivantes pour créer des propriétés enfant calculées pour un objet de modèle de données bills :
-
Cochez la case en haut de l’objet de modèle de données factures pour le sélectionner, puis cliquez sur Créer une propriété enfant.
-
Dans le volet Créer une propriété enfant :
- Saisissez usagecharges comme nom de propriété enfant.
- Activez Calculé.
- Sélectionnez Flottant comme type, puis Terminé pour ajouter la propriété enfant à l’objet de modèle de données factures.
-
Sélectionnez Modifier la règle pour ouvrir l’éditeur de règles.
-
Sélectionnez Créer. Une fenêtre de règles Définir la valeur s’ouvre.
-
Dans la liste déroulante Sélectionner une option, sélectionnez Expression mathématique.
-
Dans l’expression mathématique, sélectionnez callcharges et confcallcharges comme premier et second objets, respectivement. Sélectionnez plus en tant qu’opérateur. Sélectionnez l’expression mathématique puis Étendre l’expression pour ajouter les objets smscharges, internetcharges, roamingnational, roamingintnl et vas à l’expression.
L’image suivante décrit l’expression mathématique dans l’éditeur de règles :
-
Sélectionnez Terminé. La règle est créée dans l’éditeur de règles.
-
Sélectionnez Fermer pour fermer la fenêtre de l’éditeur de règles.
Ajouter des associations entre les objets de modèle de données add-associations-between-data-model-objects
Une fois les objets de modèle de données définis, vous pouvez créer des associations entre eux. L’association peut lier un objet à un ou plusieurs objets. Par exemple, plusieurs personnes à charge peuvent être associées à un employé ou une employée. Il s’agit d’une association d’un objet à plusieurs objets, désignée par 1:n sur la ligne reliant les objets de modèle de données associés. Toutefois, si une association renvoie un nom d’employé unique pour un ID d’employé donné, elle est appelée association un-à-un.
Lorsque vous ajoutez des objets de modèle de données associés d’une source de données à un modèle de données de formulaire, leurs associations sont conservées et affichées comme étant liées par des lignes fléchées.
En fonction du cas d’utilisation, créez les associations suivantes entre les objets de modèle de données :
Procédez comme suit pour créer des associations entre objets de modèle de données :
-
Cochez la case en haut d’un objet de modèle de données du client ou de la cliente pour le sélectionner et choisissez Ajouter une association. Le volet des propriétés Ajouter une association s’ouvre.
-
Dans le panneau Ajouter une association :
-
Spécifiez un titre pour l’association. Ce champ est facultatif.
-
Sélectionnez Un à plusieurs dans la liste déroulante Type.
-
Sélectionnez appels dans la liste déroulante Objet de modèle.
-
Sélectionnez get dans la liste déroulante Service.
-
Sélectionnez Ajouter pour relier l’objet de modèle de données du client ou de la cliente à l’objet de modèle de données d’appels à l’aide d’une propriété. En fonction du cas d’utilisation, l’objet de modèle de données calls doit être lié à la propriété de numéro de mobile dans l’objet de modèle de données customer. La boîte de dialogue Ajouter un argument s’affiche.
-
-
Dans la boîte de dialogue Ajouter un argument :
-
Sélectionnez mobilenum dans la liste déroulante Nom. La propriété Numéro mobile est une propriété commune disponible dans les objets de modèle de données customer et calls. Par conséquent, elle est utilisée pour créer une association entre les objets de modèle de données customer et calls.
Plusieurs enregistrements d’appels sont disponibles dans le tableau des appels pour chaque numéro de téléphone disponible dans l’objet de modèle customer. -
Spécifiez un titre et une description facultatifs pour l’argument.
-
Sélectionnez client ou cliente dans la liste déroulante Liaison à.
-
Sélectionnez mobilenum dans la liste déroulante Valeur de liaison.
-
Sélectionnez Ajouter.
La propriété mobilenum s’affiche dans la section Arguments.
-
-
Sélectionnez Terminé pour créer une association 1:n entre les objets de modèle de données customers et calls.
Une fois que vous avez créé une association entre les objets de modèle de données customer et calls, créez une association 1:1 entre les objets de modèle de données customer et bills.
-
Cochez la case en haut d’un objet de modèle de données customer pour le sélectionner et sélectionnez Ajouter une association. Le volet des propriétés Ajouter une association s’ouvre.
-
Dans le panneau Ajouter une association :
-
Spécifiez un titre pour l’association. Ce champ est facultatif.
-
Sélectionnez Un objet à un autre dans la liste déroulante Type.
-
Sélectionnez factures dans la liste déroulante Objet de modèle.
-
Sélectionnez get dans la liste déroulante Service. La propriété billplan, qui est la clé principale du tableau des factures, est déjà disponible dans la section Arguments.
Les objets de modèle de données bills et customer sont respectivement liés à l’aide des propriétés billplan (factures) et customerplan (client). Créez une liaison entre ces propriétés pour récupérer les détails du plan pour touts les clientes et clients disponibles dans la base de données MySQL. -
Sélectionnez client ou cliente dans la liste déroulante Liaison à.
-
Sélectionnez customerplan dans la liste déroulante Valeur de liaison.
-
Sélectionnez Terminé pour créer une liaison entre les propriétés billplan et customerplan.
L’image suivante décrit les associations entre les objets de modèle de données et les propriétés utilisées pour créer des associations entre eux :
-
Modifier les propriétés de l’objet de modèle de données edit-data-model-object-properties
Après avoir créé des associations entre l’objet client ou cliente et d’autres objets de modèle de données, modifiez les propriétés du client ou de la cliente pour définir la propriété en fonction de laquelle les données sont extraites de l’objet de modèle de données. En fonction du cas d’utilisation, le numéro de mobile est utilisé comme propriété pour extraire des données de l’objet de modèle de données client ou cliente.
-
Cochez la case en haut de l’objet de modèle de données client pour le sélectionner et sélectionnez Modifier les propriétés. Le panneau Modifier les propriétés s’ouvre.
-
Spécifiez client ou cliente comme objet de modèle de niveau supérieur.
-
Sélectionnez get dans la liste déroulante Service Read.
-
Dans la section Arguments :
-
Sélectionnez Attribut de requête dans la liste déroulante Liaison à.
-
Spécifiez mobilenum comme valeur de liaison.
-
-
Sélectionnez update dans la liste déroulante Service Write.
-
Dans la section Arguments :
-
Pour la propriété mobilenum, sélectionnez customer dans la liste déroulante Liaison à.
-
Sélectionnez mobilenum dans la liste déroulante Valeur de liaison.
-
-
Sélectionnez Terminé pour enregistrer les propriétés.
-
Cochez la case en haut de l’objet de modèle de données appels pour le sélectionner et sélectionnez Modifier les propriétés. Le panneau Modifier les propriétés s’ouvre.
-
Désactiver l’Objet de niveau supérieur pour l’objet de modèle de données calls.
-
Sélectionnez Terminé.
Répétez les étapes 8 à 10 pour configurer les propriétés pour l’objet de modèle de données factures.
Configuration des services configure-services
-
Accédez à l’onglet Services.
-
Sélectionnez le service get, puis Modifier les propriétés. Le panneau Modifier les propriétés s’ouvre.
-
Dans le panneau Modifier les propriétés :
-
Saisissez un titre et une description facultatifs.
-
Sélectionnez client ou cliente dans la liste déroulante Objet de modèle de sortie.
-
Sélectionnez Terminé pour enregistrer les propriétés.
-
-
Sélectionnez le service update, puis Modifier les propriétés. Le panneau Modifier les propriétés s’ouvre.
-
Dans le panneau Modifier les propriétés :
-
Saisissez un titre et une description facultatifs.
-
Sélectionnez client dans la liste déroulante Objet de modèle d’entrée.
-
Sélectionnez Terminé.
-
Sélectionner Enregistrer pour enregistrer le modèle de données de formulaire.
-
Étape 5 : Tester le modèle de données de formulaire et les services step-test-form-data-model-and-services
Vous pouvez tester les objets et services de modèle de données pour vérifier si le modèle de données de formulaire est correctement configuré.
Procédez comme suit pour effectuer le test :
-
Accédez à l’onglet Modèle, sélectionnez l’objet de modèle de données customer et cliquez sur Tester l’objet de modèle.
-
Dans la fenêtre Tester le modèle de données de formulaire, sélectionnez Objet de modèle de lecture dans le menu déroulant Sélectionner le modèle/service.
-
Dans la section Entrée, spécifiez une valeur pour la propriété mobilenum qui existe dans la base de données MySQL configurée et cliquez sur Tester.
Les informations du client associées à la propriété mobilenum spécifiée sont récupérées et affichées dans la section Sortie, comme indiqué ci-dessous. Fermez la boîte de dialogue.
-
Accédez à l’onglet Services.
-
Sélectionnez le service get et cliquez sur Tester le service.
-
Dans la section Entrée, spécifiez une valeur pour la propriété mobilenum qui existe dans la base de données MySQL configurée et sélectionnez Test.
Les informations du client associées à la propriété mobilenum spécifiée sont récupérées et affichées dans la section Sortie, comme indiqué ci-dessous. Fermez la boîte de dialogue.
Modifier et enregistrer des données d’exemple edit-and-save-sample-data
L’éditeur de modèle de données de formulaire vous permet de générer des exemples de données pour toutes les propriétés d’objet de modèle de données, y compris les propriétés calculées, dans un modèle de données de formulaire. Il s’agit d’un ensemble de valeurs aléatoires conformes au type de données configuré pour chaque propriété. Vous pouvez également modifier et enregistrer des données qui sont conservées même si vous régénérez les données d’exemple.
Procédez comme suit pour générer, modifier et enregistrer des données d’exemple :
-
Sur la page de modèle de données de formulaire, cliquez sur Modifier les données dʼexemple. Cela génère et affiche les exemples de données dans la fenêtre Modifier les exemples de données.
-
Dans la fenêtre Modifier les données d’exemple, modifiez les données selon les besoins puis sélectionnez Enregistrer. Fermez la fenêtre.