Composants d'intégration

Composants d'intégration

La cartouche int_dqe est l'implémentation principale permettant d'intégrer les fonctionnalités DQE dans SFCC. Cet article présente une vue d'ensemble de ses composants.

Services DQE

Ces services interagissent avec les API DQE et fournissent des fonctionnalités de validation et de suggestion pour les e-mails, les numéros de téléphone et les adresses.

Services implémentés

• dqe.http.email.validate
• dqe.http.phone.validate
• dqe.http.address.suggestions.search
• dqe.http.address.suggestions.complete
• dqe.http.address.validate

API DQE utilisées

• Suggestions d'adresse
• Validation d'adresse
• Validation d'e-mail
• Validation de téléphone

Scripts et fonctions utilitaires DQE

Tous les scripts DQE, fichiers utilitaires et la logique associée se trouvent dans cartridges/int_dqe/cartridge/scripts/dqe. Ce dossier contient les fonctionnalités DQE de base pour SFCC : suggestions et validation d'adresse, validation des e-mails et des téléphones, gestion de la configuration DQE et appels aux services DQE.

• cartridges/int_dqe/cartridge/scripts/dqe/dqeAddress.js : contient les méthodes DQE liées aux adresses, utilisées pour obtenir des suggestions d'adresse et valider les adresses.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeAPI.js : fournit des méthodes permettant d'interagir avec l'API DQE. Il agit comme middleware entre les scripts DQE et les services DQE.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeCache.js : fournit des méthodes pour travailler avec le cache personnalisé DQE. Ce cache stocke les résultats de validation des codes de réponse DQE et permet d'éviter des requêtes excessives vers les objets personnalisés de la base de données.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeConstants.js : contient les constantes DQE utilisées dans les autres fichiers d'intégration et d'extension.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeEmailValidator.js : fournit des méthodes permettant de valider les adresses e-mail.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeHelpers.js : contient des méthodes utilitaires DQE génériques ainsi que des méthodes permettant de récupérer les préférences DQE.
• cartridges/int_dqe/cartridge/scripts/dqe/dqePhoneValidator.js : fournit des méthodes permettant de valider les numéros de téléphone.

Modèles DQE

Ces modèles associent les réponses de l'API DQE à des objets JavaScript utilisables dans SFCC.

1. addressSuggestions.js : associe les réponses de suggestion d'adresse DQE.
   • API Adresse — Valider une adresse unique (SINGLEV2)
2. completeAddressDetails.js : associe les réponses de complétion d'adresse DQE.
   • API Adresse — Valider une adresse avec complétion (COMPLV2)

Gabarits DQE

Les gabarits sont utilisés pour afficher les suggestions d'adresse et les résultats de validation :

• Suggestions d'adresse : addressSuggestions.isml
• Résultats de validation d'adresse : addressValidationSuggestions.isml

Validation des e-mails

Le point d'entrée pour la validation des e-mails est la méthode validate du fichier scripts/dqe/dqeEmailValidator.js. Elle reçoit une valeur de chaîne représentant un e-mail et la valide via l'API DQE, en utilisant les préférences DQE actuelles et les mappings de codes de réponse DQE.

Le résultat de la validation des e-mails est représenté sous la forme d'un objet comportant les propriétés suivantes :

• status (chaîne de caractères) : statut de validation. Les valeurs possibles sont valid, invalid et warn.
• message (chaîne de caractères) : message de validation.
• suggestions (tableau de chaînes de caractères) : valeurs suggérées, le cas échéant.
• error (booléen) : indique si une erreur s'est produite pendant la validation.

Validation des téléphones

Le point d'entrée pour la validation des téléphones est la méthode validate du fichier scripts/dqe/dqePhoneValidator.js. Elle reçoit des valeurs de chaîne de caractères correspondant au numéro de téléphone et au code pays, et les valide via l'API DQE, en utilisant les préférences DQE actuelles et les mappings de codes de réponse DQE.

Le résultat de la validation des téléphones est représenté sous la forme d'un objet comportant les propriétés suivantes :

• status (chaîne de caractères) : statut de validation. Les valeurs possibles sont valid, invalid et warn.
• message (chaîne de caractères) : message de validation.
• error (booléen) : indique si une erreur s'est produite pendant la validation.

Validation d'adresse

Toutes les méthodes liées aux adresses se trouvent dans le fichier scripts/dqe/dqeAddress.js. Ce fichier fournit des méthodes permettant de récupérer et de compléter les suggestions d'adresse, ainsi que de valider les détails d'une adresse.

Pour valider une adresse à l'aide de la méthode validateAddress, les champs suivants sont obligatoires : address1, postalCode, city et countryCode. Les champs address2 et placeName sont facultatifs.

Ces champs sont associés à la chaîne Adresse de l'API Adresse — Vérifier et contrôler une adresse comme suit :

Il est également possible de valider une adresse en fournissant la chaîne Adresse complète à l'aide de la méthode validateAddressString du fichier scripts/dqe/dqeAddress.js.

La validation d'adresse utilise l'API DQE et prend en compte les préférences DQE actuelles ainsi que les mappings de codes de réponse DQE.

Le résultat de la validation d'adresse est représenté sous la forme d'un objet comportant les propriétés suivantes :

• status (chaîne de caractères) : statut de validation. Les valeurs possibles sont valid, invalid et warn.
• message (chaîne de caractères) : message de validation.
• suggestions (tableau de chaînes de caractères) : valeurs suggérées, le cas échéant.
• error (booléen) : indique si une erreur s'est produite pendant la validation.

Mapping des codes DQE

Toute la logique de validation DQE repose sur les préférences DQE actuelles et sur les mappings de codes de réponse DQE.

Techniquement, les mappings de codes DQE sont stockés dans SFCC sous forme d'objets personnalisés. Les définitions de types d'objets personnalisés suivantes font partie de la cartouche :

• dqeEmailValidationConfigs
• dqePhoneValidationConfigs
• dqeAddressValidationConfigs

Chaque entité d'objet personnalisé possède les attributs suivants :

• dqeCode : attribut clé associé au code de réponse DQE.
• status : statut de validation. Les valeurs possibles sont valid, warning et blocking.
• displayMessage : message localisable affiché à l'utilisateur comme résultat de validation.

Pour améliorer les performances et éviter des requêtes constantes vers les bases de données d'objets personnalisés, un mécanisme de cache personnalisé DQE est mis en place. Il met en cache les codes DQE, les statuts de validation et les valeurs des messages.

Un module Business Manager DQE correspondant est mis en place pour permettre à certains marchands de configurer les mappings de codes DQE.

Extensions Business Manager

Toutes les personnalisations DQE de Business Manager font partie de la cartouche bm_dqe. Elle comprend les modules suivants.

Liens DQE

La section des liens DQE dans BM contient des liens utiles liés à DQE, accessibles depuis Business Manager.

Mappings des codes DQE

Un module Business Manager DQE correspondant est mis en place pour permettre à certains marchands de configurer les mappings de codes DQE. En interne, tous les mappings sont stockés dans le système sous forme d'objets personnalisés.

Préférences de site DQE

Le module Préférences de site DQE peut être utilisé comme méthode alternative pour configurer les préférences de site liées à DQE. Il peut être utilisé lorsqu'un rôle utilisateur BM n'a pas accès à tous les modules de préférences de site mais doit tout de même gérer les paramètres liés à DQE.