Komponenten-Integrationen

Integrationskomponenten

Die Cartridge int_dqe ist die Kernimplementierung für die Integration der DQE-Funktionalität in SFCC. Dieser Artikel bietet einen Überblick über ihre Komponenten.

DQE-Dienste

Diese Dienste interagieren mit den DQE-APIs und bieten Funktionen für die Validierung und Vorschläge von E-Mail, Telefon und Adresse.

Implementierte Dienste

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

Verwendete DQE-APIs

• Adressvorschläge
• Adressvalidierung
• E-Mail-Validierung
• Telefonvalidierung

DQE-Skripte und Helfer

Alle DQE-Skripte, Hilfsdateien und zugehörige Logik befinden sich unter cartridges/int_dqe/cartridge/scripts/dqe. Dieser Ordner enthält die grundlegende SFCC-DQE-Funktionalität für Adressvorschläge und -validierung, E-Mail- und Telefonvalidierung, die Verarbeitung der DQE-Konfiguration und DQE-Serviceaufrufe.

• cartridges/int_dqe/cartridge/scripts/dqe/dqeAddress.js: enthält DQE-Adressmethoden zum Abrufen von Adressvorschlägen und zur Adressvalidierung.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeAPI.js: stellt Methoden für die Arbeit mit der DQE-API bereit. Sie fungiert als Middleware zwischen den DQE-Skripten und den DQE-Diensten.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeCache.js: stellt Methoden für die Arbeit mit dem benutzerdefinierten DQE-Cache bereit. Der Cache speichert Validierungsergebnisse für DQE-Antwortcodes und hilft, übermäßige Abfragen an benutzerdefinierte Objekte in der Datenbank zu vermeiden.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeConstants.js: enthält DQE-Konstanten, die in anderen Integrations- und Erweiterungsdateien verwendet werden.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeEmailValidator.js: stellt Methoden zur Validierung von E-Mail-Werten bereit.
• cartridges/int_dqe/cartridge/scripts/dqe/dqeHelpers.js: enthält generische DQE-Hilfsmethoden und Methoden zum Abrufen von DQE-Einstellungen.
• cartridges/int_dqe/cartridge/scripts/dqe/dqePhoneValidator.js: stellt Methoden zur Validierung von Telefonwerten bereit.

DQE-Modelle

Diese Modelle bilden DQE-API-Antworten auf JavaScript-Objekte zur Verwendung in SFCC ab.

1. addressSuggestions.js: bildet DQE-Adressvorschlagsantworten ab.
   • Address API — Eine einzelne Adresse validieren (SINGLEV2)
2. completeAddressDetails.js: bildet DQE-Antworten zur Adressvervollständigung ab.
   • Address API — Eine Adresse mit Vervollständigung validieren (COMPLV2)

DQE-Templates

Templates werden zur Darstellung von Adressvorschlägen und Validierungsergebnissen verwendet:

• Adressvorschläge: addressSuggestions.isml
• Adressvalidierungsergebnisse: addressValidationSuggestions.isml

E-Mail-Validierung

Der Einstiegspunkt für die E-Mail-Validierung ist die Methode validate in der Datei scripts/dqe/dqeEmailValidator.js. Sie erhält einen E-Mail-Zeichenkettenwert und validiert ihn mit der DQE-API unter Verwendung der aktuellen DQE-Einstellungen und DQE-Antwortcode-Zuordnungen.

Das Ergebnis der E-Mail-Validierung wird als Objekt mit folgenden Eigenschaften dargestellt:

• status (string): Validierungsstatus. Mögliche Werte sind valid, invalid und warn.
• message (string): Validierungsmeldung.
• suggestions (Array von Strings): vorgeschlagene Werte, falls vorhanden.
• error (boolean): gibt an, ob während der Validierung ein Fehler aufgetreten ist.

Telefonvalidierung

Der Einstiegspunkt für die Telefonvalidierung ist die Methode validate in der Datei scripts/dqe/dqePhoneValidator.js. Sie erhält Telefon- und Ländercode-Zeichenkettenwerte und validiert sie mit der DQE-API unter Verwendung der aktuellen DQE-Einstellungen und DQE-Antwortcode-Zuordnungen.

Das Ergebnis der Telefonvalidierung wird als Objekt mit folgenden Eigenschaften dargestellt:

• status (string): Validierungsstatus. Mögliche Werte sind valid, invalid und warn.
• message (string): Validierungsmeldung.
• error (boolean): gibt an, ob während der Validierung ein Fehler aufgetreten ist.

Adressvalidierung

Alle adressbezogenen Methoden befinden sich in der Datei scripts/dqe/dqeAddress.js. Diese Datei stellt Methoden zum Abrufen und Vervollständigen von Adressvorschlägen sowie zur Validierung von Adressdetails bereit.

Um eine Adresse mit der Methode validateAddress zu validieren, sind folgende Felder Pflicht: address1, postalCode, city und countryCode. Die Felder address2 und placeName sind optional.

Diese Felder werden wie folgt der Adresse-Zeichenkette der Address API — Eine Adresse prüfen und verifizieren zugeordnet:

Es ist auch möglich, eine Adresse zu validieren, indem der vollständige Adresse-String mit der Methode validateAddressString in scripts/dqe/dqeAddress.js angegeben wird.

Die Adressvalidierung verwendet die DQE-API und berücksichtigt die aktuellen DQE-Einstellungen und DQE-Antwortcode-Zuordnungen.

Das Ergebnis der Adressvalidierung wird als Objekt mit folgenden Eigenschaften dargestellt:

• status (string): Validierungsstatus. Mögliche Werte sind valid, invalid und warn.
• message (string): Validierungsmeldung.
• suggestions (Array von Strings): vorgeschlagene Werte, falls vorhanden.
• error (boolean): gibt an, ob während der Validierung ein Fehler aufgetreten ist.

DQE-Codezuordnung

Die gesamte DQE-Validierungslogik stützt sich auf die aktuellen DQE-Einstellungen und DQE-Antwortcode-Zuordnungen.

Technisch werden DQE-Codezuordnungen in SFCC als benutzerdefinierte Objekte gespeichert. Die folgenden Definitionen für benutzerdefinierte Objekttypen sind Teil der Cartridge:

• dqeEmailValidationConfigs
• dqePhoneValidationConfigs
• dqeAddressValidationConfigs

Jede Entität eines benutzerdefinierten Objekts hat folgende Attribute:

• dqeCode: Schlüsselattribut, das dem DQE-Antwortcode zugeordnet ist.
• status: Validierungsstatus. Mögliche Werte sind valid, warning und blocking.
• displayMessage: lokalisierbare Meldung, die dem Benutzer als Validierungsergebnis angezeigt wird.

Um die Leistung zu verbessern und ständige Abfragen an benutzerdefinierte Objektdatenbanken zu vermeiden, ist ein DQE-Cache-Mechanismus implementiert. Er speichert DQE-Codes, Validierungsstatus und Meldungswerte zwischen.

Ein entsprechendes DQE Business-Manager-Modul ist implementiert, damit bestimmte Händler DQE-Codezuordnungen konfigurieren können.

Business-Manager-Erweiterungen

Alle Anpassungen des DQE Business Manager sind Teil der Cartridge bm_dqe. Sie umfasst die folgenden Module.

DQE-Links

Der BM-Bereich „DQE-Links" enthält nützliche DQE-bezogene Links, auf die über den Business Manager zugegriffen werden kann.

DQE-Codezuordnungen

Ein entsprechendes DQE Business-Manager-Modul ist implementiert, damit bestimmte Händler DQE-Codezuordnungen konfigurieren können. Intern werden alle Zuordnungen im System als benutzerdefinierte Objekte gespeichert.

DQE-Site-Einstellungen

Das Modul DQE-Site-Einstellungen kann als alternative Möglichkeit zur Konfiguration DQE-bezogener Site-Einstellungen verwendet werden. Es kann eingesetzt werden, wenn eine BM-Benutzerrolle nicht auf alle Site-Einstellungsmodule zugreifen kann, aber dennoch DQE-bezogene Einstellungen verwalten muss.