Datenwörterbuch

Mit Datenwörterbücher sind die Benutzer in der Lage, Informationen aus Back-End-Datenquellen zu verwenden, ohne technische Details der zugrunde liegenden Datenmodelle zu kennen. Ein Datenwörterbuch besteht aus Datenwörterbuchelementen (DDEs). Diese Datenelemente können Sie verwenden, um Back-End-Daten als Eingaben in Briefe einzufügen, um sie bei der Kundenkorrespondenz zu verwenden. 

Ein Datenwörterbuch ist eine unabhängige Darstellung von Metadaten, die zu Grunde liegende Datenstrukturen und die dazugehörigen Attribute beschreibt. Ein Datenwörterbuch wird mit Hilfe von Unternehmensvokabular aufgebaut. Es kann einem oder mehreren zu Grunde liegenden Datenmodellen zugeordnet werden. 

Ein Datenwörterbuch besteht aus Datenwörterbuchelementen (DDEs), von denen es drei Typen gibt: Elemente des Typs „Simple“, „Composite“ und „Collection“. Simple-DDEs sind Primitive-Elemente wie Zeichenfolgen, Zahlen, Daten und boolesche Werte, die Informationen wie z. B. den Stadtnamen enthalten. Ein Composite DDE enthält andere DDEs, die vom Typ „Primitive“, „Composite“ oder „Collection“ sein können. Das kann z. B. eine Adresse sein, die aus einer Straße, einer Stadt, einem Bezirk, einem Land und einer Postleitzahl besteht. Eine „Collection“ ist eine Liste von ähnlichen Simple- oder Composite-DDEs. Beispielsweise ein Kunde mit mehreren Wohnsitzen oder mit unterschiedlicher Rechnungs- und Versandadresse.

Correspondence Management verwendet das Back-End sowie Kunden- oder Empfänger-spezifische Daten, die gemäß der Datenwörterbuchstruktur gespeichert sind, um Korrespondenz für verschiedene Kunden zu erstellen. Beispielsweise kann ein Dokument mit Anzeigenamen wie „Lieber {Vorname}“, „Herr {Nachname}“ erstellt werden.

In der Regel müssen Geschäftsbenutzer keine Kenntnisse über Metadatendarstellungen wie XSD (XML-Schema) und Java-Klassen haben. Sie müssen allerdings in der Regel Zugriff auf diese Datenstrukturen und Attribute haben, um Lösungen erstellen zu können.
 

1. Ein Autor erstellt das Datenwörterbuch entweder durch Importieren eines Schemas oder durch vollständige Neuerstellung.
2. Der Verfasser erstellt Briefe und adaptive Dokumente auf Grundlage des Datenwörterbuchs und verknüpft gegebenenfalls Datenwörterbuchelemente in Briefen und adaptiven Dokumenten. 
   
3. Ein Verfasser kann Beispieldaten-XML-Dateien herunterladen, die auf einem Datenwörterbuchschema basieren.Der Verfasser kann die Beispieldaten-XML-Datei ändern, die als Testdaten mit dem Datenwörterbuch verknüpft sein kann. Diese wird während der Briefvorschau verwendet. 
4. Bei der Vorschau eines Briefs wählt ein Verfasser den Brief mit den Daten (benutzerdefinierte Vorschau). Der Brief wird mit den vom Verfasser bereitgestellten Daten geöffnet. Er wird in „Korrespondenz erstellen“ geöffnet. Der Agent, der diesen Brief in der Vorschau anzeigt, kann den Inhalt, die Daten und die Anlagen in diesem Brief ändern und den fertigen Brief übermitteln. Weitere Informationen zum Erstellen von Briefen finden Sie unter Korrespondenz erstellen.

Verwenden Sie den Datenwörterbucheditor zum Erstellen eines Datenwörterbuchs oder laden Sie eine XSD-Schemadatei hoch, um ein Datenwörterbuch auf dieser Grundlage zu erstellen. Anschließend können Sie das Datenwörterbuch durch Hinzufügen weiterer erforderlicher Informationen, einschließlich Felder, erweitern. Unabhängig davon, wie ein Datenwörterbuch erstellt wurde, muss der Eigentümer des Geschäftsprozesses keine Kenntnisse über Back-End-Systeme haben. Er muss nur über Kenntnisse zu Domänenobjekten und deren Definitionen verfügen.

Um ein Datenwörterbuch mit den Eigenschaften und Elementen ähnlich wie einem vorhandenen Datenwörterbuch schnell zu erstellen, können Sie es kopieren und einzufügen. 

Beim Bearbeiten oder Anzeigen des Datenwörterbuchs sehen Sie, welche Elemente des Datenwörterbuchs in welchen Texten, Bedingungen, Briefe und adaptiven Dokumenten referenziert werden. 

Im Folgenden sind Codebeispiele aufgelistet, die Implementierungsdetails für das Datenwörterbuch zeigen.

In der folgenden Tabelle werden allgemeine Attribute, die mit einem DDE verknüpft sind, gezeigt:

Ein Datenwörterbuch kann auch berechnete Elemente enthalten. Ein berechnetes Datenwörterbuchelement ist immer mit einem Ausdruck verknüpft. Der Ausdruck wird geprüft, um den Wert eines Datenwörterbuchelements zur Laufzeit abzurufen. Ein berechneter DDE-Wert ist eine Funktion anderer DDE-Werte oder Literale. Standardmäßig werden JSP-Expression Language(EL)-Ausdrücke unterstützt. Die EL-Ausdrücke verwenden die ${ }-Zeichen und gültige Ausdrücke können Literale, Operatoren, Variablen (Datenwörterbuchelementverweise) und Funktionsaufrufe enthalten. Beim Verweisen auf ein Datenwörterbuchelement im Ausdruck wird der Verweisname des DDE verwendet. Der Verweisname ist für jedes Datenwörterbuchelement in einem Datenwörterbuch eindeutig.

Ein berechneter DDE PersonFullName kann mit einem EL-Verkettungsausdruck wie ${PersonFirstName} ${PersonLastName} verknüpft werden.

Das Exportieren einer XSD-Datei erfordert eine bestimmte Datenzuordnung, die in der folgenden Tabelle aufgeführt ist. Die DDI-Spalte gibt den Typ des DDE-Wertes an, wie er in der DDI verfügbar ist.

Nachdem Sie ein Datenwörterbuch erstellt haben, können Sie es in eine XML-Beispieldatendatei herunterladen, um darin Texteinträge vorzunehmen. 

Wenn Sie denselben Brief in unterschiedlichen Sprachen senden möchten, können Sie den Anzeigenamen, die Beschreibung und die Enum-Wertesätze des Datenwörterbuchs und der Datenwörterbuchelemente lokalisieren.

Der Datenwörterbucheditor erzwingt folgende Überprüfungen beim Erstellen oder Aktualisieren eines Datenwörterbuchs.

• Nur der zusammengesetzte Typ ist als DDE der obersten Ebene in einem Datenwörterbuch zulässig.
• Composite- und Collection-Elemente sind auf Blattebene nicht zulässig. Nur Primitive-Elemente (String, Date, Number, Boolean) sind auf Blattebene zulässig. Diese Überprüfung stellt sicher, dass es keine Composite- oder Collection-Elemente ohne untergeordnetes DDE gibt.
• Beim Hochladen von XSD-Dateien zum Erstellen eines Datenwörterbuchs werden Sie vom Datenwörterbucheditor aufgefordert, ein Element der obersten Ebene einzugeben, wenn mehrere dieser Elemente vorhanden sind.
• Der Name ist der einzige erforderliche Parameter für ein Datenwörterbuch.
• Ein übergeordnetes DDE (Composite) darf nicht zwei untergeordnete DDE mit demselben Namen haben.
• Stellt sicher, dass ein DDE nur als „berechnet“ gekennzeichnet ist, wenn es sich nicht um einen erforderlichen Parameter handelt. Ein erforderliches Element kann nicht berechnet werden und ein berechnetes Element kann nicht erforderlich sein. Außerdem dürfen Collection- und Composite-Elemente keine berechneten Elemente sein.
• Stellt sicher, dass ein DDE nur als „erforderlich“ gekennzeichnet ist, wenn es nicht berechnet wird. Außerdem wird sichergestellt, dass es sich nicht um das „collectionElement“ handelt, das den Typ von Collection (die einzigen untergeordneten Elemente eines Collection-Elements) angibt.
• Leere oder duplizierte Schlüssel sind nicht in den extendedProperties für ein Datenwörterbuch oder ein DDE zulässig.
• Verwenden Sie keinen Doppelpunkt (:) oder senkrechten Strich (|) im Schlüssel oder Wert einer erweiterten Eigenschaft. Es gibt keine Überprüfung für die Verwendung dieser nicht zulässigen Zeichen.
  
  

Überprüfungen, die auf Datenwörterbuchebene angewendet werden

• Der Name des Datenwörterbuchs darf nicht null sein.
• Der Name des Datenwörterbuchs darf nur alphanumerische Zeichen enthalten.
• Die Liste der untergeordneten Elemente im Datenwörterbuch darf nicht null oder leer sein.
• Das Datenwörterbuch darf nicht mehr als ein Element der obersten Ebene enthalten.
• Nur der Composite-Typ ist als DDE der obersten Ebene in einem Datenwörterbuch zulässig.

Überprüfungen, die auf Datenwörterbuchelementebene angewendet werden.

• Alle Namen des DDE dürfen nicht null sein und dürfen keine Leerzeichen enthalten.
• Alle DDEs müssen über einen Elementtyp „nicht null“ verfügen.
• Alle Verweisnamen des DDE dürfen nicht null sein.
• Alle Verweisnamen des DDE müssen eindeutig sein.
• Alle DDE-Verweise dürfen nur alphanumerische Zeichen und „_“ enthalten.
• Alle DDE-Anzeigenamen dürfen nur alphanumerische Zeichen und „_“ enthalten.
• Composite- und Collection-Elemente sind auf Blattebene nicht zulässig. Nur Primitive-Elemente (String, Date, Number, Boolean) sind auf Blattebene zulässig. Diese Überprüfung stellt sicher, dass es keine Composite- oder Collection-Elemente ohne untergeordnetes DDE gibt.
• Ein übergeordnetes Composite-DDE darf nicht zwei untergeordnete Elemente mit demselben Namen enthalten.
• Der ENUM-Subtyp wird nur für String- und Number-Elemente verwendet.
• Collection- und Composite-Elemente können nicht berechnet werden.
• Ein DDE darf nicht gleichzeitig berechnet und erforderlich sein.
• Berechnete DDEs müssen einen gültigen Ausdruck enthalten.
• Berechnete DDEs dürfen keine XML-Bindung haben.
• Ein DDE, das den Typ für ein Collection-DDE angibt, kann nicht berechnet oder erforderlich sein.
• DDEs des Subtyps ENUM dürfen keine null- oder leeren Wertesätze enthalten.
• Die XML-Bindung eines Collection-DDE darf nicht einem Attribut zugeordnet sein.
• Die XML-Bindungssyntax muss gültig sein, z. B. darf nur ein @-Zeichen erscheinen. Dieses Zeichen ist nur zulässig, wenn danach ein Attributname steht.

Sie können ein Datenwörterbuch aus einem XML-Schema erstellen oder es mithilfe der Datenwörterbuch-Benutzeroberfläche erstellen. Alle Datenwörterbuchelemente innerhalb eines Datenwörterbuchs verfügen über ein XML-Bindungsfeld, um die Bindung des DDE an ein Element im XML-Schema zu speichern. Die Bindung in jedem DDE ist relativ zum übergeordneten DDE.

Im Folgenden sind Beispielmodelle und Codebeispiele aufgelistet, die Implementierungsdetails für das Datenwörterbuch zeigen.

Ein Primitive-DDE stellt ein Feld oder ein Attribut dar, das atomisch ist. Primitive-DDEs, die außerhalb eines komplexen Typs (Composite-DDE) definiert werden, oder wiederholte Elemente (Collection-DDE) können an einem beliebigen Speicherort im XML-Schema gespeichert werden. Der Speicherort der Daten, die einem Primitive-DDE entsprechen, hängt nicht von der Zuordnung seines übergeordneten DDE ab. Ein Primitive-DDE verwendet Zuordnungsinformationen aus dem XML-Bindungsfeld, um seinen Wert zu bestimmen, und die Zuordnungen können eins der Folgenden sein:

• ein Attribut
  
• ein Element
  
• ein Textkontext
  
• nichts (ein ignoriertes DDE)
  

Das nachstehende Beispiel zeigt ein einfaches Schema.

Bindung wird nicht für Composite-Elemente unterstützt. Wenn Bindung bereitgestellt wird, wird sie ignoriert. Die Bindung für alle untergeordneten DDEs des Primitive-Typs muss absolut sein. Die Zulassung absoluter Zuordnung für untergeordnete Elemente eines Composite-DDE bietet mehr Flexibilität hinsichtlich der XPath-Bindung. Die Zuordnung eines Composite-DDE zu einem komplexen Elementtyp im XML-Schema schränkt den Bereich der Bindung für die untergeordneten Elemente ein.

Im folgenden Beispiel wird das Schema für eine Anmerkung gezeigt.

Ein Collection-Element wird nur einem anderen Collection-Element zugeordnet, das eine Kardinalität von > 1 aufweist. Die untergeordneten DDEs eines Collection-DDE verfügen über relative (lokale) XML-Bindung in Bezug auf ihre übergeordnete XML-Bindung. Da die untergeordneten DDEs eines Collection-Elements dieselbe Kardinalität wie die übergeordneten Elemente aufweisen müssen, ist die relative Bindung vorgeschrieben, um sicherzustellen, dass die Kardinalitätseinschränkungen derart sind, dass die untergeordneten DDEs nicht auf ein nicht wiederholtes XML-Schemaelement verweisen. Im nachfolgenden Beispiel muss die Kardinalität von „TokenID“ dieselbe sein wie „Token“, die die übergeordnete Collection DDE ist.

Beim Zuordnen eines Collection DDE zu einem XML-Schema muss Folgendes beachtet werden:

• Die Bindung für das DDE, das dem Collection-Element entspricht, muss der absolute XPfad sein
  
  
• Es darf keine Bindung für das DDE, das den Typ des Collection-Elements darstellt, bereitgestellt werden. Wenn eine Bindung bereitgestellt wird, wird sie ignoriert.
  
  
• Die Bindung für alle untergeordneten DDEs muss relativ zum übergeordneten Collection-Element sein.
  

Im folgenden XML-Schema wird ein Element mit den Namen „Tokens“ und ein Attribut „maxOccurs“ mit „unbounded“ gezeigt. Daher ist „Tokens“ ein Collection-Element.

Die mit diesem Beispiel verknüpfte „Token.xsd“, lautet wie folgt: