XML-Export

Wertauflöser - Kurzfassung

Zweck: Gibt den Inhalt eines XML-Exports für das Bezugsobjekt als Text (String) zurück.

Siehe auch: Server XML aus Objekt erzeugen (Wertauflöser), Export (Ereignisaktion)

images/download/attachments/91131544/image2023-1-26_16-34-19-version-1-modificationdate-1674747259988-api-v2.png

Der XML-Export-Wertauflöser gibt den Inhalt eines XML-Exports für das Bezugsobjekt als Text (String) zurück. Der Eingabewert wird ignoriert.

  • Für eine einzelne Entität als Eingabewert entspricht der ausgegebene Text exakt dem Inhalt den der Ribbon-Befehl "Export/XML anzeigen" (s. Verfügbare Befehle) in einem neuen Browser-Tab ausgibt.

  • Der Rückgabewert entspricht weitgehend (oft auch exakt) dem Rückgabewert eines Server XML aus Objekt erzeugen-Wertauflösers, dem das Bezugsobjekt als Eingabewert übergeben wird.

►HINWEIS◄ Der XML-Export-Wertauflöser steht in einem Client Workflow nicht zur Verfügung.

Unterschiede zwischen XML-Export und "Server-XML"

Inhaltliche Abweichungen zwischen dem Rückgabewert des XML-Export-Wertauflösers und einem "Server XML" für dasselbe Bezugsobjekt (s. Server XML aus Objekt erzeugen) gehen auf die besondere Aufbereitung durch den ExportManager zurück, von dem nur der XML-Export-Wertauflöser seinen Rückgabewert bezieht.

  • Der XML-Export-Wertauflöser liefert exakt die XML-Struktur, die eine Export-Ereignisaktion mit demselben Bezugsobjekt an das aufgerufene Profil übergibt.

  • Der Server XML aus Objekt erzeugen-Wertauflöser liefert die XML-Struktur, die ein Profilaufruf-Wertauflöser mit demselben Eingabewert bzw. eine Profil aufrufen-Ereignisaktion mit dem Eingabewert als Bezugsobjekt an das aufgerufene Profil übergibt.

Beispiel: Für Dokumente beinhaltet das "Server XML" nicht den Dateiinhalt (documentContent), da dieser sehr umfangreich sein kann. Beim XML-Export bindet der ExportManager das entsprechende "Inhalt"-Objekt in das XML ein.

Konfiguration

Der XML-Export-Wertauflöser verarbeitet das Bezugsobjekt und ignoriert den Eingabewert.

Die Konfiguration verwendet keine Parameter.

Beispiel

Eine Ereignisbehandlung soll die XML-"Rohdaten" aller in der Adresse der Firma der Session hinterlegten Adresskontakte, die dem Kontakttyp "Mitarbeiter" (EMPLOYEE) angehören, per Hinweis anzeigen-Ereignisaktion anzeigen.

Mit dieser Funktion sollen berechtigte Benutzer die per Schnittstelle ins Firmenkonto eingespielten Daten einsehen können, ohne dass dazu alle Adressmerkmale in der Erfassungsmaske für Firmen abgebildet werden müssten.

Konfiguration:

In einer Ereignisbehandlung wird eine Für jeden Eintrag wiederholen (Schleife)-Ereignisaktion wie rechts abgebildet parametriert:

  • Im Parameter Wertauflöser für Einträge wird die Liste der Kontaktadressen aller "Mitarbeiter" der angemeldeten Firma durch die folgende Wertauflöserkette beschafft:

    • Der Firma der Session-Wertauflöser ermittelt das zur Anmeldung verwendete Firmenkonto.

    • Der Objekt-Feld-Wertauflöser gibt die "Adresse" der (address) der Firma zurück.

    • Ein Typisierte plurale Attribute (Wertauflöser)-Wertauflöser liefert alle Instanzen des "Adresskontakt"-Attributs mit dem Subtyp "Mitarbeiter" (EMPLOYEE).

    • Unsere Auswertung betrifft die je Mitarbeiter hinterlegte "Adresse" (Address) im contactAddress-Feld der "Adresskontakt"-Attributs. Der Sammle Werte-Wertauflöser extrahiert diese Adressen als Liste aus der Liste aller "Mitarbeiter"-Adresskontakte.

  • Im Aktionsblock der Schleife liegt damit je Iteration eine "Adresse" als Bezugsobjekt an, die in einer Hinweis anzeigen-Ereignisaktion wie folgt verarbeitet wird:

    • Der Titel für den Hinweis vom Typ "Alert" wird ausgehend vom Bezugsobjekt ("Adresse") per Vorlage-Wertauflöser so formatiert, dass die Lokalisierung für den Kontakttyp "Mitarbeiter" gefolgt von allen "Name"-Feldern aus der Adresse erscheint.

    • In der Meldung gibt der XML-Export-Wertauflöser die anzuzeigende "Server XML"-Struktur der "Mitarbeiter"-Adresse zurück. Der verkettete Text ersetzen-Wertauflöser ersetzt hier unter Verwendung der Funktion Regulärer Ausdruck alle Leerzeichen im "Server XML" durch Zeichenumbrüche, um ein kompakteres und übersichtliches Format der Struktur im Popup zu erzielen (s. Laufzeitbeispiel unten).

      ►ANMERKUNG◄ Auf die simple Aufbereitung durch Ersetzen der Leerzeichen durch Zeilenumbrüche sollte verzichtet werden, wenn die Textmerkmale der Adresse selbst Leerzeichen enthalten können. Hier gehen wir davon aus, dass für Adresskontakte v. a. die Name-Felder gefüllt sind, wo keine Leerzeichen zu erwarten sind.

images/download/attachments/91131544/image2023-1-27_11-28-31-version-1-modificationdate-1674815311656-api-v2.png images/download/attachments/91131544/image2023-1-27_11-29-10-version-1-modificationdate-1674815350091-api-v2.png

Laufzeitbeispiel: Meldung mit den Adressdaten für einen Mitarbeiter "Max Mustermann"

images/download/attachments/91131544/image2023-1-27_12-14-55-version-1-modificationdate-1674818095806-api-v2.png

  • Der XML-Export zeigt alle ausgefüllten Felder der im Firmenkonto hinterlegten Kontaktadresse, unabhängig davon ob diese in den Erfassungsmaske für das Firmenkonto dargestellt werden.

  • Konkret könnte hier die im Feld "Match code" (accMatchCode) hinterlegte E-Mail-Adresse (s. Auswahl im Screenshot) interessieren, die aus dem angezeigten "Alert" z. B. in die Zwischenablage übernommen werden kann.