...
Hierzu kann unter "Add-Ons » Externe Datenquellen für Listen" eine neue Datenquelle angelegt werden. Zu dieser Konfiguration gehören folgende Parameter:
Einstellung | Beschreibung |
|---|---|
Bezeichnung | Interne Bezeichnung der Datenquelle |
Basis-Endpunkt | Grundlegender Endpunkt der Schnittstelle (bspw. https://api.dev.local/) |
Authorisierungs-Parameter | Name des Parameters für die Autorisierung |
| Authorisierungs-Key | Autorisierungsschlüssel / Passwort |
| Caching-Dauer | Angabe in Sekunden, wie lange die Antwort in einem temporären Cache vorgehalten werden soll, um Anfragen zu reduzieren (die Angabe "0" deaktiviert diesen Cache und erzwingt Anfragen in Echtzeit) |
Nachdem eine externe Datenquelle angelegt wurde, kann diese jederzeit nachträglich bearbeitet oder gelöscht werden. Sie wird sofort in der tabellarischen Übersicht auf der Konfigurationsseite dargestellt.
...
Das Beispiel nutzt das Standardschema zur Erklärung der Funktionsweise. In diesem Standardschema sind die Endpunkte, die Rückgabewerte und Abhängigkeiten fest vorkonfiguriert.
| Codeblock | ||||
|---|---|---|---|---|
|
...
| Codeblock | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"_embedded": {
"brand": [
{
"id": 123,
"name": "Lead Print",
"nameShort": "lp",
"matchCode": "LP",
"designVariant": "lp"
} ,
{
"id": 142,
"name": "Be.Beyond GmbH & Co KG",
"nameShort": "bb",
"matchCode": "BB",
"designVariant": "bb"
}
]
}
} |
| Codeblock | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "_embedded": { "companyCode": [ { "companyCode": "0100", "clientCodeHr": "100", "debitorNumber": "123456", "name1": "Mustermann KG", "name2": "", "name3": "", "name4": "", "countryIso3166Alpha3": "DEU", "city": "Willich" } ] } } |
| Codeblock | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"_embedded": {
"person": [
{
"clientCodeHr": "100",
"personalNumber": "12345",
"sapCompanyCode": "0100",
"sapLocationCode": "0100",
"sdf": null,
"name": "Mustermann",
"firstname": "Max",
"salutation": "Herr",
"title": ""
}
]
}
} |
Für die Optionen der Listenauswahl werden ausgewählte Parameter der jeweiligen Endpunkte genutzt, während für die Personalisierung alle verfügbaren Parameter (also bspw. "nameShort") bereitgestellt werden.
Auf diesen Parameter kann in der Druckvorlage dann wie auf eine normale Personalisierungsvariable zugegriffen werden (also bspw. "{$nameShort}").
Verfügbare Endpunkte des Standardschemas
In der Standardkonfiguration wird davon ausgegangen, dass die externe Schnittstelle die folgenden Endpunkte bereitstellt:
Endpunkt | Beschreibung |
|---|---|
brands | |
| companyCode | abhängig von brands |
| person | abhängig von companyCode |