JavaScript Address API

Diese Dokumentation gibt einen umfassenden Einblick in die Erstellung von Adressobjekten über eine JavaScript-API.

Voraussetzungen

Sie benötigen JavaScript-Kenntnisse.
Sie benötigen Verständnis für die verschiedenen Bibliotheken von agorum core.

Hinweis: Für bestimmte Parameter, etwa target und path, siehe JavaScript-Bibliothek common/objects.

Verwendung

Die folgende Bibliothek muss stets zu Beginn eines Skripts stehen:

let address = require('address/objects');

Verwendbare Objekte

Adressbuch

D4wAddressBook
- name
- description
- items()

Firma

D4wAddressOrganisation
- name
- additionalName1
- additionalName2
- customerNumber
- salesTaxIdentificationNumber (USt-Id)
- taxNumber (Steuernummer)
- description
- items()

Abteilung

D4wAddressDepartment
- name
- additionalName1
- additionalName2
- customerNumber
- salesTaxIdentificationNumber
- taxNumber
- description
- addressLinks
- addressPhoneNumbers
- items()

Person

D4wAddressPerson
- salutation
- title
- givenName
- familyName
- familyStatus
- dateOfBirth
- description
- myContainers
- sex (male (männlich) , female (weiblich), unknown (unbekannt))
- placeOfBirth
- maidenName
- welcomeMessage

Zusatzinformation zur Person

D4wAddressInfo
- jobTitle
- activityRate

Tatsächliche Adresse

D4wAddressData
- street1
- zip
- city
- state
- country
- postBox
- zipPostBox
- cityPostBox
- houseNumber1

AddressContainer

Dieser Container bildet den Link zwischen Person und Adressbuch, Firma oder Abteilung. Auf alle untergeordneten Objekte können Sie ausschließlich get ausführen.

D4wAddressContainer
- d4wAddressPerson
- d4wAddressData (Holt die Adresse, die es für das Objekt gibt.)
- d4wMyAddressData (Holt ausschließlich die Adresse, die zu dem aktuellen Objekt belegt wurde.)
- firstAddressImage
- d4wAddressInfo
- addressEmails
- addressLinks
- addressPhoneNumbers

Hinweis: Bei d4wAddressData vererbt das System die geholten Adressen. Hat eine Firma eine Adresse, liefert das System diese auch bei Personen zurück, sofern diese unter der Firma verknüpft sind. Hat eine Person eine eigene Adresse, erhalten Sie diese zurück. Wenn die Person unterhalb einer Abteilung mit übergeordneter Firma, also Firma > Abteilung > Person, verknüpft ist, erhalten Sie Folgendes zurück:

die eigene Adresse oder
die Adresse der Abteilung, sofern diese eine eigene Adresse und die Person keine eigene hat, oder
die Adresse der Firma, wenn weder die Person noch die Abteilung eine eigene Adresse hat

Hinweis: In JavaScript liefert address.getData() die Adressdaten wie d4wAddressData einschließlich vererbter Adressen. Ausschließlich die eigene Adresse eines Objekts liefert address.getMyData(). Hat das Objekt keine eigene Adresse, ist das Ergebnis ein leeres Array. Siehe JavaScript Address API - get.

Hinweis zum Löschen von Adressobjekten: Die address/objects-API bietet keine delete-Funktion. Zum Löschen einzelner Adressobjekte (z. B. Telefonnummern, E-Mail-Adressen, Links) verwenden Sie objects.trash() aus der Bibliothek common/objects. Beachten Sie, dass objects.trash() das Objekt in den Papierkorb verschiebt.

Adressobjekte indizieren

Folgende Adressobjekte indiziert das System automatisch mit den aufgeführten Informationen, um die Adressobjekte gezielter finden zu können:

Adressobjekt	Beschreibung
addressname	Enthält den Namen einer Organisation oder Abteilung.
mymailaddresses	Enthält ausschließlich die E-Mail-Adressen des zugehörigen Adressobjekts, nicht die vererbten.
mydefaultmailaddresses	Enthält ausschließlich die Standard-E-Mail-Adressen des zugehörigen Adressobjekts.
mylinks	Enthält ausschließlich die Links des zugehörigen Adressobjekts, nicht die vererbten.
mydefaultlinks	Enthält ausschließlich die Standard-Links des zugehörigen Adressobjekts.
mysubjects	Enthält ausschließlich die Link-Betreffe des zugehörigen Adressobjekts, nicht die vererbten.
mydefaultsubjects	Enthält ausschließlich die Standard-Link-Betreffe des zugehörigen Adressobjekts.
myfullnumbers	Enthält ausschließlich die Telefonnummer des zugehörigen Adressobjekts, nicht die vererbten.
mydefaultfullnumbers	Enthält ausschließlich die Standard-Telefonnummern des zugehörigen Adressobjekts.

Hinweis: Wenn Sie agorum core auf Windows oder Linux aktualisieren, indiziert das System alle vorhandenen Adressobjekte erneut. Je nach Menge der Adressobjekte erhöht sich kurzfristig die Indizierungsaktivität.