Zweck

Mit der Funktion Parameter hinzufügen können einer Dokumentvorlage Parameter zur manuellen Eingabe von Informationen hinzugefügt werden.

Parameter ermöglichen es, Informationen während der Dokumenterstellung durch den Benutzer erfassen zu lassen und diese anschließend innerhalb der Dokumentvorlage weiterzuverarbeiten.

Sie eignen sich insbesondere zur Ergänzung fehlender Auftragsdaten oder zur Steuerung unterschiedlicher Dokumentvarianten innerhalb einer gemeinsamen Dokumentvorlage.

Verwendung

Nach Auswahl der Funktion öffnet sich ein Dialog zur Konfiguration eines neuen Parameters.

Eine Dokumentvorlage kann beliebig viele Parameter enthalten.

Name

Technischer Name des Parameters.

Über diesen Namen wird innerhalb der XML-Dokumentvorlage auf den Parameter zugegriffen.

Der Name sollte möglichst kurz, eindeutig und sprechend gewählt werden.

Anzeige

Bezeichnung des Parameters innerhalb der Benutzerschnittstelle.

Sie dient dem Anwender als Eingabeaufforderung und sollte den gewünschten Inhalt möglichst kurz und eindeutig beschreiben.

Abhängigkeit

Ermöglicht die Definition einer Abhängigkeit zu einem bereits vorhandenen Parameter.

Der aktuelle Parameter wird erst angezeigt, wenn die definierte Bedingung erfüllt ist.

Typische Einsatzfälle sind beispielsweise:

• Checkboxen (Bool)
• Dropdown-Parameter

Bei Dropdown-Parametern kann zusätzlich definiert werden, bei welchem Eintrag der abhängige Parameter eingeblendet werden soll.

Typ

Legt den Typ des Parameters fest.

Für intracon:bk werden hauptsächlich folgende Parametertypen verwendet:

Parametertyp	Beschreibung
SingleText	Einzeilige Texteingabe
MultiText	Mehrzeilige Texteingabe
Numeric	Numerische Eingabe
Bool	Checkbox (Ja/Nein)
Date	Datumsauswahl (Date-Picker
Dropdown	Auswahlliste
Address	Adressparameter
Currency	Währungswert
Separator	Optische Trennlinie zwischen Parametern
Group	Gruppierung mehrerer zusammengehöriger Parameter

Weitere Parametertypen stehen aus technischen Gründen zur Verfügung, besitzen jedoch innerhalb von intracon:bk in der Regel keine fachliche Bedeutung.

Zusätzliche Eigenschaften

Je nach ausgewähltem Parametertyp werden weitere Konfigurationsmöglichkeiten eingeblendet.

Eigenschaft	Verfügbar für
Vorgegebener Wert	SingleText, MultiText, Numeric, Bool, Date, Currency
Erforderlich	SingleText, MultiText, Numeric, Date, Address, Currency
Ist Empfänger	Address

Dropdown-Parameter

Für Parameter vom Typ Dropdown stehen zusätzliche Konfigurationsmöglichkeiten zur Verfügung.

Neben den allgemeinen Parametereigenschaften werden hier die auswählbaren Einträge des Dropdown-Parameters definiert und deren Reihenfolge festgelegt.

Auswahlwerte

Ein Dropdown-Parameter besteht aus einer Liste von Auswahlwerten.

Jeder Eintrag setzt sich aus folgenden Informationen zusammen:

• Inhalt der Variable

  • Technischer Wert des Eintrags.
  • Dieser Wert wird innerhalb der XML-Dokumentvorlage verarbeitet und steht beispielsweise für Ausgaben oder Bedingungen (<Variable>, <Case>) zur Verfügung.

• Auswahl Starter

  • Bezeichnung, die dem Mitarbeiter während des interaktiven Erstellungsprozesses im Dropdown-Feld angezeigt wird.

Dadurch können technischer Wert und angezeigter Text voneinander abweichen.

Einträge verwalten

Für die Verwaltung der Dropdown-Einträge stehen folgende Funktionen zur Verfügung:

• Hinzufügen

  • Fügt einen neuen Eintrag zur Auswahlliste hinzu.

• Ändern

  • Übernimmt Änderungen am aktuell ausgewählten Eintrag.

• Entfernen

  • Löscht den ausgewählten Eintrag aus der Auswahlliste.

Reihenfolge der Einträge

Die Schaltflächen Nach oben und Nach unten ermöglichen das Verschieben des aktuell ausgewählten Eintrags innerhalb der Auswahlliste.

Die Reihenfolge der Einträge entspricht der Reihenfolge, in der sie dem Mitarbeiter im interaktiven Erstellungsprozess angezeigt werden.

Hinweis

Innerhalb der XML-Dokumentvorlage wird stets der technische Wert (Inhalt der Variable) verarbeitet. Der im Feld Auswahl Starter hinterlegte Text dient ausschließlich der Anzeige für den Mitarbeiter während des interaktiven Erstellungsprozesses.

Bei der Anzeige des Dropdown-Parameters wird grundsätzlich der erste Eintrag der sortierten Auswahlliste vorbelegt.

Soll der Mitarbeiter eine bewusste Auswahl treffen, kann der erste Eintrag mit einem leeren Inhalt der Variable angelegt werden. Ist der Parameter zusätzlich als Erforderlich konfiguriert, kann der Mitarbeiter den Bereich der Parameter- und Benutzereingabe erst verlassen, nachdem ein Eintrag mit einem gültigen Wert ausgewählt wurde.

Soll bereits eine fachliche Auswahl vorbelegt sein, kann der gewünschte Eintrag an die erste Position der Auswahlliste verschoben werden. Dieser Eintrag wird anschließend als Initialwert des Dropdown-Parameters angezeigt.

Sortierung

Über die Schaltflächen Auf und Ab kann die Reihenfolge der Einträge geändert werden.

Inhalt der Variable

Technischer Wert des ausgewählten Eintrags.

Dieser Wert steht anschließend innerhalb der XML-Dokumentvorlage zur Verfügung und kann beispielsweise

• ausgegeben oder
• innerhalb von <If>- oder <Case>-Strukturen ausgewertet werden.

Auswahl Starter

Anzeigetext des Eintrags innerhalb der Benutzeroberfläche.

Der angezeigte Text muss nicht mit dem technischen Wert übereinstimmen.

Dadurch können sprechende Bezeichnungen verwendet werden, während intern kompakte technische Werte verarbeitet werden.

Hinzufügen

Übernimmt den erfassten Eintrag in die Dropdown-Liste.

Ändern

Aktualisiert den aktuell ausgewählten Eintrag.

Entfernen

Löscht den ausgewählten Eintrag aus der Dropdown-Liste.

Hinweis

Parameter werden grundsätzlich vor Beginn des Renderprozesses abgefragt.

Enthält eine Dokumentvorlage Parameter, kann sie nicht vollständig ohne Benutzerinteraktion verarbeitet werden.

Jeder Parameter unterbricht daher eine mögliche Dunkelverarbeitung.

Best Practices

Parameter sind ein wirkungsvolles Mittel, um Dokumente flexibel zu gestalten und fehlende Informationen während der Dokumenterstellung zu ergänzen.

Vor dem Einsatz von Parametern sollte jedoch geprüft werden, ob die benötigten Informationen nicht bereits als Auftragsdaten zur Verfügung gestellt werden können.

Grundsätzlich bieten sich zwei unterschiedliche Vorgehensweisen an:

• Dunkelverarbeitung

  • Vollautomatische Dokumenterstellung ohne Benutzereingriffe
  • Höchste Prozessgeschwindigkeit
  • Geringe Fehleranfälligkeit durch den Verzicht auf manuelle Eingaben

• Interaktive Dokumentenerstellung

  • Ergänzung fehlender Informationen während der Dokumenterstellung
  • Flexible Steuerung unterschiedlicher Dokumentvarianten über Parameter
  • Möglichkeit, mehrere fachliche Varianten innerhalb einer gemeinsamen Dokumentvorlage abzubilden

Die Entscheidung für oder gegen Parameter sollte daher stets unter Berücksichtigung der gewünschten Prozessgestaltung erfolgen.

Technischer Hinweis

Parameter werden nach ihrer Erstellung zunächst im Komponentenbereich Parameter der Dokumentvorlage bereitgestellt.

Erst durch die Verwendung des Parametereintrags wird der entsprechende XML-Code in die Dokumentvorlage übernommen. Der Parameter kann anschließend innerhalb der XML-Dokumentvorlage beispielsweise für Ausgaben oder zur Auswertung in <If>-, <Case>- oder anderen Steuerstrukturen verwendet werden.

Unabhängig davon werden vorhandene Parameter im interaktiven Erstellungsprozess grundsätzlich zur Eingabe angeboten. Dies gilt auch dann, wenn der Parameter nicht in die Dokumentvorlage übernommen wurde und somit innerhalb des XML-Codes keine Verwendung findet.

Sie können sowohl direkt ausgegeben als auch innerhalb von Bedingungen oder Steuerstrukturen verwendet werden.

Die Reihenfolge der Parameter bestimmt gleichzeitig die Reihenfolge ihrer Anzeige innerhalb der Benutzeroberfläche.