Composants d'intégration

Composants d'intégration

La cartouche int_dqe est l'implémentation centrale pour 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 emails, les téléphones 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'email
• Validation de téléphone

Scripts et helpers DQE

Tous les scripts, fichiers helpers et logiques associées DQE se trouvent dans cartridges/int_dqe/cartridge/scripts/dqe. Ce dossier contient les fonctionnalités DQE de base SFCC pour les suggestions et la validation d'adresse, la validation d'email et de téléphone, la gestion de la configuration DQE et les appels aux services DQE.

• cartridges/int_dqe/cartridge/scripts/dqe/dqeAddress.js : contient les méthodes d'adresse DQE utilisées pour obtenir des suggestions d'adresse et valider les adresses.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeAPI.js : fournit des méthodes pour travailler avec l'API DQE. Il agit comme intergiciel 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. Le cache stocke les résultats de validation pour les codes de réponse DQE et permet d'éviter des requêtes excessives aux objets personnalisés dans 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 pour valider les valeurs d'email.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeHelpers.js : contient des méthodes helper génériques DQE et des méthodes pour récupérer les préférences DQE.
• cartridges/int_dqe/cartridge/scripts/dqe/dqePhoneValidator.js : fournit des méthodes pour valider les valeurs de téléphone.

Modèles DQE

Ces modèles font correspondre les réponses de l'API DQE à des objets JavaScript pour une utilisation dans SFCC.

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

Templates DQE

Les templates 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 d'email

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

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

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

Validation de téléphone

Le point d'entrée pour la validation de téléphone est la méthode validate du fichier scripts/dqe/dqePhoneValidator.js. Elle reçoit des valeurs de téléphone et de code pays sous forme de chaînes et les valide via l'API DQE, en utilisant les préférences DQE actuelles et les correspondances de codes de réponse DQE.

Le résultat de la validation de téléphone est représenté sous forme d'objet avec les propriétés suivantes :

• status (chaîne) : statut de validation. Les valeurs possibles sont valid, invalid et warn.
• message (chaîne) : 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 à l'adresse se trouvent dans le fichier scripts/dqe/dqeAddress.js. Ce fichier fournit des méthodes pour récupérer et compléter les suggestions d'adresse et valider les détails d'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 optionnels.

Ces champs sont mappé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 dans scripts/dqe/dqeAddress.js.

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

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

• status (chaîne) : statut de validation. Les valeurs possibles sont valid, invalid et warn.
• message (chaîne) : message de validation.
• suggestions (tableau de chaînes) : 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 les correspondances de codes de réponse DQE.

Techniquement, les correspondances de codes DQE sont stockées dans SFCC en tant qu'objets personnalisés. Les définitions de type d'objet personnalisé suivantes font partie de la cartouche :

• dqeEmailValidationConfigs
• dqePhoneValidationConfigs
• dqeAddressValidationConfigs

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

• dqeCode : attribut clé mappé 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 la validation.

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

Un module Business Manager DQE correspondant est implémenté pour permettre à des marchands spécifiques de configurer les correspondances de codes DQE.

Extensions Business Manager

Toutes les personnalisations DQE de Business Manager font partie de la cartouche bm_dqe. Elle inclut les modules ci-dessous.

Liens DQE

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

Mappings des codes DQE

Un module Business Manager DQE correspondant est implémenté pour permettre à des marchands spécifiques de configurer les correspondances de codes DQE. En interne, toutes les correspondances sont stockées dans le système en tant qu'objets personnalisés.

Préférences de site DQE

Le module Préférences de site DQE peut être utilisé comme moyen alternatif de 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.