Summary
Summary
Kurzbeschreibung
Das XML-Element
<Summary>dient dazu, zusätzliche Informationen aus einer Dokumentvorlage an nachgelagerte Prozesse zu übergeben.Es erzeugt keine Ausgabe im Dokument, sondern stellt die aufgelösten Inhalte für Folgeprozesse bereit.
Einordnung
Bereich: Inhalte
Schwierigkeitsgrad: ⭐⭐☆☆☆
Vorkenntnisse: Variable · Text
Zweck
<Summary> ermöglicht es, Informationen aus einer Dokumentvorlage für nachgelagerte Prozesse bereitzustellen.
Die Inhalte werden während der Dokumenterzeugung vollständig aufgelöst und im HTML-Format übergeben.
Dadurch können Folgeprozesse zusätzliche Informationen nutzen, ohne dass diese im eigentlichen Dokument erscheinen.
Ein typisches Einsatzgebiet ist die Erweiterung von Kontakthistorieneinträgen.
Position innerhalb der Dokumentvorlage
<Summary> wird direkt innerhalb des <Body> platziert.
Es befindet sich auf derselben Ebene wie die eigentlichen Dokumentinhalte.
<Body>
<Summary>
...
</Summary>
...
</Body>Attribute
<Summary> besitzt keine Attribute.
Inhalt
Innerhalb von <Summary> können beliebige XML-Elemente verwendet werden.
Beispielsweise:
<Text><Variable><If><Case><Reference>- weitere XML-Elemente
Alle enthaltenen Elemente werden während der Dokumenterzeugung aufgelöst.
Keine Dokumentausgabe
Die Inhalte von <Summary> erscheinen nicht im erzeugten Dokument.
Sie dienen ausschließlich der Weitergabe von Informationen an nachgelagerte Prozesse.
Dadurch können zusätzliche Informationen verarbeitet werden, ohne das eigentliche Dokument zu beeinflussen.
Hinweis
Änderungen innerhalb von
<Summary>wirken sich nicht auf das Dokumentlayout oder den Dokumentinhalt aus.
Verwendung in Folgeprozessen
Die innerhalb von <Summary> erzeugten Inhalte werden HTML-formatiert an Folgeprozesse übergeben.
Ein typisches Einsatzgebiet ist die Kontakthistorie.
Hier kann der vom Redakteur definierte Inhalt genutzt werden, um den Betreff oder ergänzende Informationen eines Kontakthistorieneintrags zu erweitern.
Dadurch können beispielsweise wichtige Dokumentinformationen unmittelbar in der Kontakthistorie sichtbar gemacht werden.
Typische Einsatzgebiete
<Summary> eignet sich beispielsweise für:
- Ergänzungen des Kontakthistorie-Betreffs
- Übergabe wichtiger Dokumentinformationen
- Bereitstellung von Variablenwerten für Folgeprozesse
- Zusammenfassung relevanter Informationen eines Dokuments
Best Practices
- Nur Informationen aufnehmen, die für Folgeprozesse tatsächlich benötigt werden.
- Inhalte möglichst kompakt halten.
- Aussagekräftige Variablen und Texte verwenden.
- Keine Informationen aufnehmen, die ausschließlich für das Dokument selbst bestimmt sind.
Developer-Tipp
Betrachten Sie
<Summary>als Informationskanal für nachgelagerte Prozesse.Alles, was innerhalb dieses Elements definiert wird, dient der Weiterverarbeitung und nicht der Darstellung im Dokument.
XML-Wissen
<Summary> wird während der Dokumenterzeugung vollständig verarbeitet.
Alle enthaltenen XML-Elemente werden aufgelöst und HTML-formatiert an die nachgelagerten Prozesse übergeben.
Das Element besitzt selbst keine sichtbare Darstellung im erzeugten Dokument.
Typische Fehler
Ausgabe im Dokument erwartet
<Summary> erzeugt grundsätzlich keine sichtbare Ausgabe.
Werden Informationen im Dokument benötigt, müssen diese zusätzlich an der entsprechenden Stelle innerhalb des Dokumentinhalts ausgegeben werden.
Zu viele Informationen übergeben
<Summary> sollte ausschließlich Informationen enthalten, die von Folgeprozessen tatsächlich benötigt werden.
Eine übermäßige Nutzung erschwert die Wartung der Dokumentvorlage.
Fazit
<Summary> erweitert eine Dokumentvorlage um Informationen, die ausschließlich für nachgelagerte Prozesse bestimmt sind.
Dadurch lassen sich beispielsweise Kontakthistorieneinträge um dokumentbezogene Informationen ergänzen, ohne den eigentlichen Dokumentinhalt zu verändern.