Kurzbeschreibung

Das XML-Element <Variable> dient zur Ausgabe dynamischer Inhalte innerhalb einer Dokumentvorlage.

Während ein <Text> immer denselben Inhalt ausgibt, wird der Wert einer Variable erst während der Dokumentenerzeugung anhand eines Variablenpfades ermittelt.

Variablen gehören zu den am häufigsten verwendeten XML-Elementen innerhalb von intracon:bk und bilden die Grundlage nahezu jeder Dokumentvorlage.

Einordnung

Bereich: Inhalte

Schwierigkeitsgrad: ⭐⭐☆☆☆

Vorkenntnisse: Text

Empfohlener nächster Artikel: Setter

Zweck

Das XML-Element <Variable> dient zur Ausgabe dynamischer Werte innerhalb einer Dokumentvorlage.

Im Gegensatz zum XML-Element <Text> ist der auszugebende Inhalt nicht fest innerhalb der Dokumentvorlage hinterlegt. Stattdessen wird der tatsächliche Wert erst während der Dokumentenerzeugung anhand eines Variablenpfades ermittelt.

Je nach verwendetem Variablenpfad kann eine Variable beispielsweise auf

• Daten des BK-Auftrags,
• Dokumentparameter,
• Konstanten,
• Benutzerinformationen,
• Barcodeinformationen,
• Systeminformationen oder
• zuvor innerhalb der Dokumentvorlage berechnete Werte

zugreifen.

Dadurch lassen sich Dokumente vollständig dynamisch erzeugen.

Typische Einsatzgebiete sind beispielsweise:

• Namen und Anschriften
• Versicherungsnummern
• Datumswerte
• Beträge
• Sachbearbeiterinformationen
• Konstanten
• Ergebnisse aus <Setter>
• Ergebnisse aus <Math>

Grundsyntax

Die einfachste Form einer Variablen besteht ausschließlich aus dem Attribut Path.

<Variable Path="source.name">
</Variable>

Während der Dokumentenerzeugung wird der zum angegebenen Variablenpfad gehörende Wert gelesen und an der aktuellen Position ausgegeben.

Position innerhalb der Dokumentvorlage

Das XML-Element <Variable> wird innerhalb eines <Content> verwendet.

<Block>

    <Content>

        <Text Content="Versichertennummer: ">
        </Text>

        <Variable Path="source.kvnr">
        </Variable>

    </Content>

</Block>

Ergebnis

Versichertennummer: A123456789

Grundlagen der Variablen

Der wichtigste Bestandteil einer Variable ist der Variablenpfad.

Er bestimmt

• aus welcher Datenquelle ein Wert gelesen wird,
• welcher Wert ausgegeben wird und
• welche Informationen der Developer über die IntelliSense bereitstellt.

Ein Variablenpfad besteht grundsätzlich aus zwei Bestandteilen.

Variablenstamm.Variablenname

Beispiel

<Variable Path="source.name">
</Variable>

Dabei gilt:

Der Variablenstamm bestimmt somit die Herkunft der Daten.

Der zweite Bestandteil legt fest, welcher Wert aus dieser Datenquelle gelesen werden soll.

IntelliSense

Der Developer unterstützt den Redakteur beim Erstellen von Variablen durch eine integrierte IntelliSense.

Sobald hinter einem Variablenstamm ein Punkt (.) eingegeben wird, öffnet sich automatisch eine Liste aller für diesen Variablenstamm verfügbaren Einträge.

Beispiele

source.
custom.
constant.
general.
user.

Dadurch müssen Variablennamen in der Regel nicht auswendig bekannt sein.

Die IntelliSense zeigt ausschließlich die für den jeweiligen Variablenstamm verfügbaren Variablen an.

Developer-Tipp

Nutzen Sie nach Möglichkeit die IntelliSense zur Auswahl von Variablen.

Dadurch werden Schreibfehler vermieden und gleichzeitig alle verfügbaren Variablen des jeweiligen Variablenstamms sichtbar.

Herkunft der Variablen

Nicht alle Variablen greifen auf dieselbe Datenquelle zu.

Der erste Bestandteil des Variablenpfades – der Variablenstamm – bestimmt, aus welchem Bereich der gewünschte Wert gelesen wird.

Je nach Anwendungsfall stehen hierfür unterschiedliche Variablenstämme zur Verfügung.

Einige liefern Informationen aus dem BK-Auftrag, andere greifen auf Benutzerinformationen, Dokumentparameter, Konstanten oder Systeminformationen zu.

Übersicht der Variablenstämme

Die Variablenstämme lassen sich nach ihrem typischen Einsatzgebiet gruppieren.

Häufig verwendete Variablenstämme

Diese Variablenstämme bilden die Grundlage der meisten Dokumentvorlagen.

Empfehlung

Diese vier Variablenstämme gehören zum täglichen Handwerkszeug eines Redakteurs und sollten zuerst kennengelernt werden.

Benutzerbezogene Variablen

Diese Variablenstämme stellen Informationen zu Sachbearbeitern und deren Profilen bereit.

Spezielle Variablenstämme

Diese Variablenstämme werden für besondere fachliche oder technische Anwendungsfälle verwendet.

Obsolete Variablenstämme

Die folgenden Variablenstämme gehören zwar zur XML-Sprache, werden innerhalb von intracon:bk jedoch nicht verwendet.

Sie stehen ausschließlich im Zusammenhang mit intracon:kv beziehungsweise mit kundenspezifischen Erweiterungen zur Verfügung.

• context
• arbeitgeber
• fami
• kasse
• pool
• recipient
• versicherter
• wiedervorlage

Hinweis

Die einzelnen Variablenstämme werden in den folgenden Abschnitten ausführlich beschrieben.

Die Variablenstämme

Der erste Bestandteil des Variablenpfades bestimmt, aus welcher Datenquelle der Wert gelesen wird.

Beispiel:

<Variable Path="source.name">
</Variable>

Hierbei bezeichnet source den Variablenstamm.

Je nach Aufgabenstellung stehen unterschiedliche Variablenstämme zur Verfügung.

Die folgende Reihenfolge orientiert sich an der typischen täglichen Arbeit eines Redakteurs und nicht an der alphabetischen Sortierung.

Häufig verwendete Variablenstämme

Die folgenden Variablenstämme bilden die Grundlage nahezu jeder Dokumentvorlage und werden im täglichen Einsatz am häufigsten verwendet.

source

Zweck

Der Variablenstamm source stellt sämtliche Daten des aktuellen BK-Auftrags zur Verfügung.

Er gehört zu den wichtigsten und am häufigsten verwendeten Variablenstämmen innerhalb von intracon:bk.

Nahezu jede Dokumentvorlage verwendet Variablen dieses Stammes.

Herkunft

Die Daten stammen unmittelbar aus dem aktuell verarbeiteten BK-Auftrag.

Hierzu gehören beispielsweise:

• Empfängerdaten
• Falldaten
• Dokumentdaten
• Fachinformationen
• Auftragsinformationen

IntelliSense

Nach Eingabe von

source.

zeigt der Developer sämtliche für den aktuellen Auftrag verfügbaren Variablen an.

Beispiel

<Variable Path="source.name">
</Variable>

Typische Einsatzgebiete

• Empfängeranschrift
• Versicherungsnummer
• Aktenzeichen
• Beträge
• Falldaten

Empfehlung

Der Variablenstamm source ist die wichtigste Datenquelle innerhalb von intracon:bk und sollte bevorzugt verwendet werden, wenn Informationen direkt aus dem BK-Auftrag benötigt werden.

custom

Zweck

Der Variablenstamm custom stellt sämtliche innerhalb des Developers definierten Parameter zur Verfügung.

Diese Parameter werden beim Testen einer Dokumentvorlage im Developer gepflegt beziehungsweise beim produktiven Dokumentlauf an die Dokumentvorlage übergeben.

Herkunft

Alle Werte stammen aus den Parametern der Dokumentvorlage.

IntelliSense

Nach Eingabe von

custom.

zeigt der Developer alle definierten Dokumentparameter an.

Beispiel

<Variable Path="custom.Vertragsnummer">
</Variable>

Typische Einsatzgebiete

• Dokumentparameter
• Testdaten
• Übergabeparameter
• fachliche Steuerwerte

constant

Zweck

Der Variablenstamm constant stellt sämtliche im System definierten Konstanten bereit.

Herkunft

Die Werte stammen aus der Konstantenverwaltung des Systems.

IntelliSense

Nach Eingabe von

constant.

werden alle verfügbaren Konstanten angezeigt.

Typische Einsatzgebiete

• Telefonnummern
• Organisationsdaten
• feste Texte
• zentrale Systemwerte

general

Zweck

Der Variablenstamm general stellt allgemeine Systeminformationen und interne Funktionen des Developers bereit.

Herkunft

Die Werte werden unmittelbar durch das System bereitgestellt.

IntelliSense

Nach Eingabe von

general.

werden sämtliche verfügbaren Einträge angezeigt.

Typische Einsatzgebiete

• Datum
• Dokumentinformationen
• interne Systeminformationen
• Systemfunktionen

Hinweis

Die einzelnen Einträge des Variablenstamms general werden in einem eigenen Artikel ausführlich beschrieben.

Benutzerbezogene Variablen

Diese Variablenstämme stellen Informationen zu den beteiligten Sachbearbeitern bereit.

user

Zweck

user liefert die Standardinformationen des zuständigen Sachbearbeiters.

Herkunft

Die Informationen stammen aus den Benutzerdaten des intracon:bk-Systems.

IntelliSense

Nach Eingabe von

user.

werden sämtliche verfügbaren Benutzerinformationen angezeigt.

Typische Einsatzgebiete

• Signaturen
• Ansprechpartner
• Bearbeiterinformationen

user-profil

Zweck

user-profil liefert zusätzlich gepflegte, kundenspezifische Informationen zum zuständigen Sachbearbeiter.

Herkunft

Die Werte stammen aus den kundenspezifischen Profilinformationen des Benutzers.

IntelliSense

Nach Eingabe von

user-profil.

werden alle verfügbaren Einträge angezeigt.

user-orig

Zweck

user-orig stellt die Standardinformationen des absendenden beziehungsweise ursprünglich zuständigen Sachbearbeiters bereit.

Herkunft

Die Informationen stammen aus den Benutzerdaten des ursprünglichen Bearbeiters.

IntelliSense

Nach Eingabe von

user-orig.

werden alle verfügbaren Informationen angezeigt.

user-orig-profil

Zweck

user-orig-profil liefert kundenspezifische Zusatzinformationen zum absendenden beziehungsweise ursprünglich zuständigen Sachbearbeiter.

Herkunft

Die Werte stammen aus dessen Benutzerprofil.

IntelliSense

Nach Eingabe von

user-orig-profil.

werden sämtliche verfügbaren Einträge angezeigt.

Spezielle Variablenstämme

Diese Variablenstämme werden für besondere fachliche oder technische Anwendungsfälle verwendet.

address

Zweck

Greift auf Parameter vom Typ Address zu.

Herkunft

Die Daten stammen aus einem Address-Parameter der Dokumentvorlage.

IntelliSense

Nach Eingabe von

address.

werden sämtliche Bestandteile der Adresse angeboten.

Beispiele

<Variable Path="address.titel">
</Variable>

<Variable Path="address.name">
</Variable>

alternate

Zweck

Greift auf das im Datacenter konfigurierte Empfänger-Mapping des Betreuers zu.

Herkunft

Die Werte stammen aus dem Empfänger-Mapping.

IntelliSense

Nach Eingabe von

alternate.

werden alle verfügbaren Elemente angezeigt.

focus

Zweck

Greift auf die im Datacenter definierten Focus-Mappings zu.

Herkunft

Die Werte stammen aus dem Focus-Mapping.

IntelliSense

Nach Eingabe von

focus.

werden sämtliche verfügbaren Einträge angezeigt.

focus-alternate

Zweck

Greift auf alternative Focus-Mappings zu.

Herkunft

Die Werte stammen aus dem alternativen Focus-Mapping.

IntelliSense

Nach Eingabe von

focus-alternate.

werden sämtliche verfügbaren Einträge angezeigt.

barcode

Zweck

Stellt Informationen zum aktuellen Barcode bereit.

Herkunft

Die Daten werden durch den Barcodegenerator des Systems bereitgestellt.

Existiert für den aktuellen Auftrag noch kein Barcode, erzeugt das System diesen automatisch.

IntelliSense

Nach Eingabe von

barcode.

werden folgende Elemente angeboten:

• id
• text
• index

Beispiel

<Variable Path="barcode.text">
</Variable>

XML-Wissen

Der erste Zugriff auf den Variablenstamm barcode kann die automatische Erzeugung eines Barcodes auslösen.

Obsolete Variablenstämme

Die folgenden Variablenstämme gehören zwar zur XML-Sprache, werden innerhalb von intracon:bk jedoch nicht verwendet.

Sie stehen ausschließlich im Zusammenhang mit intracon:kv beziehungsweise mit kundenspezifischen Erweiterungen zur Verfügung.

• context
• arbeitgeber
• fami
• kasse
• pool
• recipient
• versicherter
• wiedervorlage

Hinweis

Hinter diesen Variablenstämmen befinden sich projektspezifische Prozesse oder Datenquellen.

Für die Entwicklung von Dokumentvorlagen innerhalb von intracon:bk besitzen diese Variablenstämme in der Regel keine praktische Bedeutung.