Features und Installation - addresssolutions/as-address-solutions-validator GitHub Wiki

Das Modul as-address-solutions-validator ist zur Verwendung mit serverseitigem JavaScript entwickelt und lässt sich auf einfache Art und Weise in Webseiten integrieren, die diese Technik verwenden, vorzugsweise in Node JS.

Es werden Funktionen für das Prüfen und Korrigieren von Adressdaten bereitgestellt, die in Webseiten zur Erfassung von sogenannten Kunden-Stammdaten eingebaut werden können. Somit kann sichergestellt werden, dass schon bei der Erfassung der Stammdaten, wie Vor- und Nachname, Titel, Anrede, PLZ, Ort, Straße und Hausnummer (um die wichtigsten zu nennen), diese korrekt und in einer standardisierten Art in das hinter der Webseite liegende System gelangen.

Um einen direkten Eindruck eines möglichen Einsatzszenarios zu bieten, haben wir unter http://185.82.86.101:9001/address_validation_mask einmal ein Beispiel einer typischen Erfassungsmaske bereitgestellt, bei der das Modul zum Einsatz kommt und einen möglichen Anwendungsfall zeigt.

Dieses Modul bietet Schnittstellen zum Aufruf verschiedener Validierungsfunktionen für Namen und Adressen. In der ersten Version werden die folgenden Funktionalitäten unterstützt:

Features

Validierung von Namenselementen (Anrede, Titel, Vorname, Nachname) auf Feldebene (z.B.: enthält ein Vornamensfeld tatsächlich einen gültigen Vornamen)
Strukturierung von Namen und Verteilung von Namenselementen auf die vorgesehenen Felder
Anredegenerierung und -korrektur
Prüfung der postalischen Daten und Korrektur/Autoergänzung bei zweifelsfreier Rerferenz (z.B. "52223 Stollberg, Keiserplatz 6" korrigieren nach "52222 Stolberg, Kaiserplatz 6"
Generieren von Auswahllisten für PLZ, Ort und Straßenname

Installation

Zur Installation Clonen Sie das Repository https://github.com/addresssolutions/as-address-solutions-validator.git oder laden Sie das ZIP-File per Download herunter und entpacken es. Kopieren oder verschieben Sie das Verzeichnis in die bei Ihnen übliche Verzeichnisstruktur für node-Drittsoftware innerhalb Ihres Projekts, z.B. in /public/vendor/as-address-solutions-validator/dist/. Abschließend führen Sie mit npm noch die Installation des xmlrpc Moduls durch, die für die Kommunikation mit den Services benötigt wird.

... fertig!

Beispiel (Windows)

Angenommen Sie benutzen üblicherweise das Verzeichnis C:\develop\node\ für Ihre Node JS Entwicklungen. Kopieren Sie dann den Inhalt des Clone-Verzeichnis bzw. des ZIP-Files as-address-solutions-validator-master unterhalb dieses Verzeichnisses, so dass Sie folgende Struktur erhalten:

C:\
+-- develop\
    +-- node\
        +-- as-address-solutions-validator-master\
               README.md
               package.json
               as_validate.js
            +--doc\
            +--dist\
                  as-address-solutions-validator.js
                  as_credentials.js
                  as_language_pack.js

Öffnen Sie eine Command Shell und wechseln Sie dann in das neue Verzeichnis C:\develop\node\as-address-solutions-validator-master\

und führen Sie dann den Befehl

npm install [Return]

aus. Hierdurch wir die benötigte XmlRpc-Komponenten installiert. Die Ausgabe der Installationsroutine sollte etwa wie folgt aussehen: 
[email protected] C:\develop\nodejs\as-address-solutions-validator
 -- [email protected]
  +-- [email protected]
   -- [email protected]

npm WARN [email protected] No repository field.
npm WARN [email protected] No license field.

Die eventuell erscheinenden Warnungen bzgl. repository und license können Sie ignorieren.
Danach testen Sie die Funktionsfähigkeit mit 

node as_validate.js [Return]

Als Ausgabe sollten folgende Zeilen erscheinen:
==============================================
ReleaseInfo            : 3.1
GeneralStatus          : 0
ValidationCode         : 0
ValidationMessage      :
==============================================

Neben der Einsatzmöglichkeit als Online-Prüfmodul innerhalb von Eingabemasken kann die Schnittstelle natürlich auch als Prüffunktion für bereits vorhandene Bestandsdaten genutzt werden. Für Massenabfragen mit mehreren tausend Datensätzen ist es aber aufgrund des hohen Overheads an Metadaten, die bei den Abfragen als Request und Response hin- und hergeschickt werden, aus Performancegründen nicht zu empfehlen. Hierfür bieten wir andere Techniken. Sprechen Sie uns an.