Datenwörterbuch data-dictionary

CAUTION
AEM 6.4 hat das Ende der erweiterten Unterstützung erreicht und diese Dokumentation wird nicht mehr aktualisiert. Weitere Informationen finden Sie in unserer technische Unterstützung. Unterstützte Versionen suchen here.

Einführung introduction

Ein Datenwörterbuch ermöglicht es Geschäftsbenutzern, Informationen aus Back-End-Datenquellen zu verwenden, ohne technische Details über ihre zugrunde liegenden Datenmodelle zu kennen. Ein Datenwörterbuch besteht aus Datenwörterbuchelementen (DDEs). Sie verwenden diese Datenelemente, um Back-End-Daten als Eingabe für die Verwendung in einer Kundenkorrespondenz in die Briefe zu integrieren.

Ein Datenwörterbuch ist eine unabhängige Darstellung von Metadaten, die die zugrunde liegenden Datenstrukturen und die zugehörigen Attribute beschreibt. Ein Datenwörterbuch wird mithilfe des Geschäftsvokabulars erstellt. Sie kann einem oder mehreren zugrunde 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“. Einfache DDEs sind Primitive-Elemente wie Zeichenfolgen, Zahlen, Daten und boolesche Werte, die Informationen wie einen 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 Sammlung ist eine Liste ähnlicher Simple- oder Composite-DDEs. Beispiel: ein Kunde mit mehreren Standorten oder unterschiedlichen Abrechnungs- und Versandadressen.

Correspondence Management verwendet das Back-End, den Kunden, ``oder empfängerspezifische Daten, die gemäß der Datenwörterbuchstruktur gespeichert werden, um Korrespondenz für verschiedene Kunden zu erstellen. Beispielsweise kann ein Dokument mit Anzeigenamen wie "Lieber {Vorname}", "Herr, erstellt werden. {Nachname}".

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.

Datenwörterbuch-Workflow data-dictionary-workflow

  1. Autor erstellt das Datenwörterbuch entweder ein Schema oder von Grund auf neu hochladen.
  2. Der Verfasser erstellt Briefe und interaktive Kommunikation 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-Dateien ändern, welche als Testdaten mit dem Datenwörterbuch verknüpft werden können. 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 vorbefüllten 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.

Voraussetzung prerequisite

Installieren Sie das Kompatibilitätspaket, um die Option Datenwörterbücher auf der Seite Formulare anzuzeigen.

Datenwörterbuch erstellen createdatadictionary

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 erweitern, indem Sie weitere erforderliche Informationen hinzufügen, darunter auch Felder. Unabhängig davon, wie das Datenwörterbuch erstellt wurde, benötigt der Eigentümer des Geschäftsprozesses keine Kenntnisse über die Back-End-Systeme. Er muss nur über Kenntnisse zu Domain-Objekten und deren Definitionen verfügen.

NOTE
Für mehrere Briefe, für die ähnliche Elemente erforderlich sind, können Sie ein gemeinsames Datenwörterbuch erstellen. Ein Wörterbuch mit großen Datenmengen mit einer großen Anzahl von Elementen kann jedoch zu Leistungsproblemen bei der Verwendung des Datenwörterbuchs und beim Laden der Elemente führen, z. B. in Briefen und Dokumentfragmenten. Wenn Leistungsprobleme auftreten, versuchen Sie, separate Datenwörterbücher für verschiedene Briefe zu erstellen.
  1. Auswählen Forms > Datenwörterbücher.

  2. Tippen Sie auf Datenwörterbuch erstellen.

  3. Fügen Sie im Bildschirm „Eigenschaften“ Folgendes hinzu:

    • Titel: (Optional) Geben Sie den Titel für das Datenwörterbuch ein. Titel müssen nicht eindeutig sein und dürfen Sonderzeichen und nichtenglische Zeichen enthalten. Briefe und andere Dokumentfragmente werden (sofern verfügbar) mit ihrem Titel referenziert, z. B. in Miniaturansichten und Asset-Eigenschaften. Datenwörterbücher werden mit ihren Namen und nicht mit Titeln referenziert.

    • Name: Der eindeutige Name für das Datenwörterbuch. Im Feld Name können Sie nur englische Sprachzeichen, Zahlen und Bindestriche eingeben. Das Feld Name wird automatisch auf der Grundlage des Felds Titel ausgefüllt und die Sonderzeichen, Leerzeichen, Zahlen und nicht englischen Zeichen im Feld Titel werden durch Bindestriche ersetzt. Obwohl der Wert im Feld „Titel“ automatisch in das Feld „Name“ kopiert wird, können Sie den Wert bearbeiten.

    • Beschreibung: (Optional) Beschreibung des Datenwörterbuchs.

    • Tags:(Optional) Um einen benutzerdefinierten Tag zu erstellen, geben Sie einen Wert in das Textfeld ein und drücken Sie die Eingabetaste. Sie können den Tag unterhalb des Textfeldes der Tags sehen. Wenn Sie diesen Text speichern, werden auch die neu hinzugefügten Tags erstellt.

    • Erweiterte Eigenschaften: (Optional) Klicken Sie auf Feld hinzufügen, um Metadatenattribute für Ihr Datenwörterbuch anzugeben. Geben Sie in der Spalte Eigenschaftsname einen eindeutigen Eigenschaftsnamen ein. Geben Sie in der Spalte Wert einen Wert ein, der mit der Eigenschaft verknüpft werden soll.

    Eigenschaften des Datenwörterbuchs auf Deutsch

  4. (Optional) Wenn Sie eine XSD-Schemadefinition für Ihr Datenwörterbuch hochladen möchten, klicken Sie im Bereich „Datenwörterbuchstruktur“ auf XML-Schema hochladen. Navigieren Sie zu der gewünschten XSD-Datei, wählen Sie diese aus und klicken Sie auf Öffnen. Ein Datenwörterbuch wird basierend auf dem hochgeladenen XML-Schema erstellt. Sie müssen die Anzeigenamen und Beschreibungen der Elemente im Datenwörterbuch anpassen. Dazu müssen Sie die Namen der Elemente wählen, indem Sie darauf tippen und dann ihre Beschreibungen, Anzeigenamen und andere Details in den Feldern im rechten Bereich ändern.

    Weitere Informationen zu berechneten DD-Elementen finden Sie unter Berechnete Datenwörterbuchelemente.

    note note
    NOTE
    Sie können das Hochladen der Schemadatei überspringen und Ihr Datenwörterbuch von Grund auf mithilfe der Benutzeroberfläche erstellen. Überspringen Sie dazu diesen Schritt und fahren Sie mit den nächsten Schritten fort.
  5. Tippen Sie auf Weiter.

  6. Fügen Sie im Bildschirm Eigenschaften hinzufügen die Elemente zum Datenwörterbuch hinzu. Sie können auch Elemente hinzufügen/löschen und deren Details bearbeiten, wenn Sie ein Schema hochgeladen haben, um eine grundlegende Struktur des Datenwörterbuchs zu erhalten.

    Sie können auf die drei Punkte auf der rechten Seite eines Elements tippen und ein Element zur Datenwörterbuchstruktur hinzufügen.

    1_2_createanelement

    Wählen Sie entweder Composite-Element, Collection-Element oder Primitive-Element aus.

    • 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.
    • Primitive-DDEs sind Primitive-Elemente wie Zeichenfolgen, Zahlen, Daten und boolesche Werte, die Informationen wie z. B. den Stadtnamen enthalten.
    • Eine Sammlung ist eine Liste ähnlicher Simple- oder Composite-DDEs. Beispiel: ein Kunde mit mehreren Standorten oder unterschiedlichen Abrechnungs- und Versandadressen.

    Im Folgenden finden Sie einige Regeln zum Erstellen eines Datenwörterbuchs:

    • Nur der Composite-Typ ist als DDE der obersten Ebene in einem Datenwörterbuch zulässig.
    • Name, Referenzname und Elementtypen sind obligatorische Felder für Datenwörterbücher und DDEs.
    • Der Referenzname muss eindeutig sein.
    • Ein übergeordnetes DDE (Composite) darf nicht zwei untergeordnete DDE mit demselben Namen haben.
    • Enums enthalten nur Primitive-String-Typen.

    Weitere Informationen zu Composite-, Collection- und Primitive-Elementen und zum Arbeiten mit Datenwörterbuchelementen finden Sie unter Zuordnen von Datenwörterbuchelementen zum XML-Schema.

    Weitere Informationen zu Überprüfungen im Datenwörterbuch finden Sie unter Überprüfungen des Datenwörterbucheditors.

    2_addddpropertiesbasic

  7. (Optional) Nach der Auswahl eines Elements können Sie auf der Registerkarte „Erweitert“ Eigenschaften (Attribute) hinzufügen. Sie können auch auf Feld hinzufügen tippen und die Eigenschaften eines DD-Elements erweitern.

    3_addddpropertiesadvanced

  8. (Optional) Sie können ein Element durch Tippen auf die drei Punkte auf der rechten Seite eines Elements und durch Auswahl von Löschen entfernen.

    4_deleteelement

    note note
    NOTE
    Durch das Löschen eines Composite-/Collection-Elements mit untergeordneten Knoten werden auch seine untergeordneten Knoten gelöscht.
  9. (Optional) Wählen Sie ein Element im Bereich "Datenwörterbuchstruktur"und im Bereich "Feld- und Variablenliste"aus. Ändern Sie die dem Element zugeordneten erforderlichen Attribute oder fügen Sie sie hinzu.

  10. Tippen Sie auf Speichern.

Erstellen von Kopien eines oder mehrerer Datenwörterbücher create-copies-of-one-or-more-data-dictionary

Um schnell ein oder mehrere Datenwörterbücher mit Eigenschaften und Elementen zu erstellen, die vorhandenen Datenwörterbüchern ähnlich sind, können Sie sie kopieren und einfügen.

  1. Wählen Sie in der Liste der Datenwörterbücher die entsprechenden Datenwörterbücher aus. Auf der Benutzeroberfläche wird das Symbol Kopieren angezeigt.
  2. Tippen Sie auf Kopieren. Auf der Benutzeroberfläche wird das Symbol Einfügen angezeigt.
  3. Tippen Sie auf Einfügen . Das Dialogfeld "Einfügen"wird angezeigt. Das System weist den neuen Datenwörterbüchern automatisch Namen und Titel zu.
  4. Bearbeiten Sie bei Bedarf den Titel und den Namen, mit denen Sie die Kopie des Datenwörterbuchs speichern möchten.
  5. Tippen Sie auf Einfügen . Die Kopie des Datenwörterbuchs wird erstellt. Jetzt können Sie die erforderlichen Änderungen an Ihrem neu erstellten Datenwörterbuch vornehmen.

Anzeigen der Dokumentfragmente oder Dokumente, die auf ein Datenwörterbuchelement verweisen see-the-document-fragments-or-documents-that-refer-to-a-data-dictionary-element

Beim Bearbeiten oder Anzeigen eines Datenwörterbuchs können Sie sehen, welche Elemente im Datenwörterbuch in welchen Texten, Bedingungen, Briefen und interaktiver Kommunikation referenziert werden.

  1. Führen Sie einen der folgenden Schritte aus, um das Datenwörterbuch zu bearbeiten:

    • Bewegen Sie den Mauszeiger über ein Datenwörterbuch und tippen Sie auf Bearbeiten.
    • Wählen Sie ein Datenwörterbuch aus und tippen Sie dann in der Kopfzeile auf Bearbeiten .
    • Bewegen Sie den Mauszeiger über ein Datenwörterbuch und tippen Sie auf Auswählen . Tippen Sie dann in der Kopfzeile auf Bearbeiten .

    Oder tippen Sie auf ein Datenwörterbuch, um es anzuzeigen.

  2. Tippen Sie im Datenwörterbuch auf ein einfaches Element, um es auszuwählen. Composite- und Collection-Elemente haben keine Verweise.

    Zusammen mit den grundlegenden und erweiterten Eigenschaften des Elements wird auch geliehener Inhalt angezeigt.

  3. Tippen Sie auf „Geliehener Inhalt“.

    Die Registerkarte "Geliehener Inhalt"wird wie folgt angezeigt: Texte, Bedingungen, Briefe und interaktive Kommunikation. Jede dieser Überschriften zeigt auch die Anzahl der Verweise auf das ausgewählte Element an.

  4. Tippen Sie auf eine Überschrift, um den Namen der Assets anzuzeigen, die auf das Element verweisen.

    lentcontent

  5. Um geliehenen Inhalt für ein anderes Element anzuzeigen, tippen Sie auf das Element.

  6. Um ein Asset anzuzeigen, das auf ein Element verweist, tippen Sie auf seinen Namen. Der Browser zeigt das Asset, den Brief oder die interaktive Kommunikation an.

Arbeiten mit Testdaten working-with-test-data

  1. Tippen Sie auf der Seite „Datenwörterbücher“ auf Auswählen.

  2. Tippen Sie auf ein Datenwörterbuch, für das Sie Testdaten herunterladen möchten, und tippen Sie dann auf XML-Beispieldaten herunterladen.

  3. Tippen Sie bei der Warnmeldung auf OK. Eine XML-Datei wird heruntergeladen.

  4. Öffnen Sie die XML-Datei mit Notepad oder einem anderen XML-Editor. Die XML-Datei hat dieselbe Struktur wie das Datenwörterbuch und die Platzhalterzeichenfolgen in den Elementen. Ersetzen Sie die Platzhalterzeichenfolgen durch die Daten, mit denen Sie einen Brief testen möchten.

    code language-xml
    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <Company>
    <Name>string</Name>
    <Type>string</Type>
    <HeadOfficeAddress>
    <Street>string</Street>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    </HeadOfficeAddress>
    <SalesOfficeAddress>
    <Street>string</Street>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    </SalesOfficeAddress>
    <HeadCount>1.0</HeadCount>
    <CEO>
    <PersonName>
    <FirstName>string</FirstName>
    <MiddleName>string</MiddleName>
    <LastName>string</LastName>
    </PersonName>
    <DOB>string</DOB>
    <CurrAddress>
    <Street>string</Street>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    </CurrAddress>
    <DOJ>14-04-1973</DOJ>
    <Phone>1.0</Phone>
    </CEO>
    </Company>
    
    note note
    NOTE
    In diesem Beispiel erstellt XML Platz für drei Werte für ein Collection-Element, aber die Anzahl der Werte kann je nach Anforderung reduziert bzw. erhöht werden.
  5. Nachdem die Dateneinträge vorgenommen wurden, können Sie diese XML-Datei verwenden, wenn Sie einen Brief mit Testdaten in der Vorschau anzeigen.

    Sie können diese Testdaten mit DD hinzufügen (Wählen Sie DD und tippen Sie auf Testdaten hochladen und laden Sie diese XML-Datei hoch)

    Wenn Sie danach also einen Brief normal in der Vorschau anzeigen (nicht benutzerdefiniert), werden diese XML-Daten in einem Brief verwendet. Sie können auch auf Benutzerdefiniert tippen und diese XML hochladen.

Stichproben samples

Die folgenden Codebeispiele zeigen Implementierungsdetails für das Datenwörterbuch.

Beispielschema, das in das Datenwörterbuch hochgeladen werden kann sample-schema-that-can-be-uploaded-to-the-data-dictionary

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns="DCT" targetNamespace="DCT" xmlns:xs="https://www.w3.org/2001/XMLSchema"
  elementFormDefault="qualified" attributeFormDefault="unqualified">
  <xs:element name="Company">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Name" type="xs:string"/>
        <xs:element name="Type" type="xs:anySimpleType"/>
        <xs:element name="HeadOfficeAddress" type="Address"/>
        <xs:element name="SalesOfficeAddress" type="Address" minOccurs="0"/>
        <xs:element name="HeadCount" type="xs:integer"/>
        <xs:element name="CEO" type="Employee"/>
        <xs:element name="Workers" type="Employee" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:complexType name="Employee">
    <xs:complexContent>
      <xs:extension  base="Person">
        <xs:sequence>
          <xs:element name="CurrAddress" type="Address"/>
          <xs:element name="DOJ" type="xs:date"/>
          <xs:element name="Phone" type="xs:integer"/>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>
  <xs:complexType name="Person">
    <xs:sequence>
      <xs:element name="PersonName" type="Name"/>
      <xs:element name="DOB" type="xs:dateTime"/>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Name">
    <xs:sequence>
      <xs:element name="FirstName" type="xs:string"/>
      <xs:element name="MiddleName" type="xs:string"/>
      <xs:element name="LastName" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Address">
    <xs:sequence>
      <xs:element name="Street" type="xs:string"/>
      <xs:element name="City" type="xs:string"/>
      <xs:element name="State" type="xs:string"/>
      <xs:element name="Zip" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Allgemeine Attribute, die mit einem DDE verknüpft sind common-attributes-associated-with-a-dde

In der folgenden Tabelle sind die allgemeinen Attribute aufgeführt, die mit einem DDE verknüpft sind:

Attribut
Typ
Beschreibung
Name
Zeichenfolge
Erforderlich.
Name des DDE. Er muss eindeutig sein.
Referenz
Name
Zeichenfolge
Erforderlich. Eindeutiger Referenzname für das DDE, der Verweise auf das DDE ermöglicht, die unabhängig von Hierarchie- oder Strukturänderungen des Datenwörterbuchs sind. Textmodule werden mit diesem Namen zugeordnet
Anzeigename
Zeichenfolge
Ein optionaler benutzerfreundlicher Name des DDE.
description
Zeichenfolge
Beschreibung des DDE.
elementType
Zeichenfolge
Erforderlich. Der Typ des DDE: STRING, NUMBER, DATE, Boolean, COMPOSITE, SAMMLUNG.
elementSubType
Zeichenfolge
Der Untertyp für DDE: ENUM. Nur für STRING und NUMBER elementType zulässig.
Schlüssel
Boolesch
Ein boolesches Feld, das angibt, ob ein DDE ein Schlüsselelement ist.
Berechnet
Boolesch
Ein boolesches Feld, das angibt, ob ein DDE berechnet wird. Ein berechneter DDE-Wert ist eine Funktion anderer DDE-Werte. JSP-Ausdrücke werden standardmäßig unterstützt.
Ausdruck
Zeichenfolge
Der Ausdruck für das "berechnete" DDE. Der standardmäßig versandte Ausdrucksauswertungsdienst unterstützt JSP-EL-Ausdrücke. Sie können den Ausdrucksdienst durch eine benutzerdefinierte Implementierung ersetzen.
valueSet
Liste
Ein Satz zulässiger Werte für ein DDE vom Typ Enum . Beispielsweise kann der Kontotyp nur Werte (Speichern, Aktuell) enthalten.
extendedProperties
Object
Eine Zuordnung von benutzerdefinierten Eigenschaften, die dem DDE hinzugefügt wurden (benutzeroberflächenspezifische oder andere Informationen).
Erforderlich
Boolesch
Das Flag gibt an, dass die Quelle der Instanzdaten, die dem Datenwörterbuch entsprechen, den Wert dieses bestimmten DDE enthalten muss.
Bindung
BindingElement
Die XML- oder Java-Bindung des Elements.

Berechnete Datenwörterbuchelemente computedddelements

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 Referenzieren eines Datenwörterbuchelements im Ausdruck wird der Referenzname des DDE verwendet. Der Referenzname 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.

Datentypzuordnung zwischen XSD und Datenwörterbuch data-type-mapping-between-xsd-and-data-dictionary-br

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

XSD
Datenwörterbuch
DDI (Datentyp für Instanzwert)
xs:element des Typs "Composite"
DDE des Typs COMPOSITE
java.util.Map
xs:element, wobei maxOccurs > 1
DDE des Typs COLLECTION
Ein DDE-Knoten wird neben dem COLLECTION-DDE erstellt, das Informationen aus dem übergeordneten COLLECTION-Knoten erfasst. Derselbe Knoten wird für die Collection der Simple-/Composite-Datentypen erstellt. Wenn Sie eine SAMMLUNG des Typs "Composite"haben, erfasst die Baumstruktur des Datenwörterbuchs die einzelnen Felder in den untergeordneten Elementen des DDE, die zum Erfassen von Typinformationen erstellt wurden.
- DDE (COLLECTION)
- DDE(COMPOSITE für Typinfo)
- DDE(STRING) field1
- DDE(STRING) field2
java.util.List
Attribut des Typs „xs:ID“
DDE des Typs STRING
java.lang.String
xs:attribute/xs:element des Typs "xs:string"
DDE des Typs STRING
java.lang.String
xs:attribute/xs:element des Typs „xs: boolean“
DDE des Typs „Boolean“
java.lang.Boolean
xs:attribute/xs:element des Typs „xs:date“
DDE des Typs DATE
java.lang.String
xs:attribute/xs:element des Typs „xs:integer“
DDE des Typs NUMBER
java.lang.Double
xs:attribute/xs:element des Typs "xs:long"
DDE des Typs NUMBER
java.lang.Double
xs:attribute/xs:element des Typs "xs:double"
DDE des Typs NUMBER
java.lang.Double
Element des Enum-Typs und baseType - xs:string
DDE des
Typs - STRING
subtype - ENUM
valueSet - der zulässige Wert für ENUM
java.lang.String

Beispieldatendatei aus einem Datenwörterbuch herunterladen download-a-sample-data-file-from-a-data-dictionary

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

  1. Tippen Sie auf der Seite „Datenwörterbücher“ auf Auswählen und tippen Sie dann auf ein Datenwörterbuch, um es auszuwählen.

  2. Wählen Sie XML-Beispieldaten herunterladen.

  3. Tippen Sie bei der Warnmeldung auf OK.

    Correspondence Management erstellt eine XML-Datei, die auf der ausgewählten Datenwörterbuchstruktur basiert und lädt sie auf Ihren Computer mit dem Namen <data-dictionary-name>-SampleData. Jetzt können Sie diese Datei in einem XML- oder einem Texteditor bearbeiten, um beim Erstellen eines Briefs Dateneinträge vorzunehmen.

Internationalisierung von Metadaten internationalization-of-meta-data

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

Datenwörterbuch lokalisieren localize-data-dictionary

  1. Tippen Sie auf der Seite „Datenwörterbücher“ auf Auswählen und tippen Sie dann zum Auswählen auf ein Datenwörterbuch.

  2. Tippen Sie auf Lokalisierungsdaten herunterladen.

  3. Tippen Sie bei der Warnmeldung auf OK. Correspondence Management lädt eine ZIP-Datei auf Ihrem Computer mit dem Namen DataDictionary-<DDname>.zip herunter.

  4. Die ZIP-Datei enthält eine Datei des Typs „.properties“. Diese Datei definiert das heruntergeladene Datenwörterbuch. Der Inhalt der Eigenschaftendatei ähnelt dem folgenden:

    code language-none
    #Wed May 20 16:06:23 BST 2015
    DataDictionary.EmployeeDD.description=
    DataDictionary.EmployeeDD.displayName=EmployeeDataDictionary
    DataDictionaryElement.name.description=
    DataDictionaryElement.name.displayName=name
    DataDictionaryElement.person.description=
    DataDictionaryElement.person.displayName=person
    

    Die Struktur der Eigenschaftendatei definiert jeweils eine Zeile für die Beschreibung und den Anzeigenamen für das Datenwörterbuch und jedes Datenwörterbuchelement im Datenwörterbuch. Darüber hinaus definiert die Eigenschaftendatei eine Zeile für einen Enum-Wert, der für jedes Datenwörterbuchelement festgelegt wird. Wie bei einem Datenwörterbuch kann die entsprechende Eigenschaftendatei über mehrere Datenwörterbuchelementdefinitionen verfügen. Darüber hinaus kann die Datei die Definitionen für einen oder mehrere Enum-Wertesätze enthalten.

  5. Um die .properties-Datei in einem anderen Gebietsschema zu aktualisieren, aktualisieren Sie die Anzeigenamen- und Beschreibungswerte in der Datei. Erstellen Sie weitere Instanzen der Datei für jede Sprache, die Sie lokalisieren wollen. Nur Französisch, Deutsch, Japanisch und Englisch werden unterstützt.

  6. Speichern Sie die verschiedenen aktualisierten Eigenschaftsdateien unter den folgenden Namen:

    _fr_FR.properties Französisch

    _de_DE.properties Deutsch

    _ja_JA.properties Japanisch

    _en_EN.properties Englisch

  7. Archivieren Sie die .properties-Datei (oder bei mehreren Gebietsschemas die Dateien) in einer einzelnen ZIP-Datei.

  8. Wählen Sie auf der Seite „Datenwörterbuch“ Mehr > Lokalisierungsdaten hochladen und wählen Sie die ZIP-Datei mit lokalisierten Eigenschaftendateien.

  9. Um die Lokalisierungsänderungen anzuzeigen, ändern Sie das Gebietsschema Ihres Browsers.

Validierungen von Datenwörterbüchern ddvalidations

Der Datenwörterbucheditor erzwingt folgende Validierungen beim Erstellen oder Aktualisieren eines Datenwörterbuchs.

  • Nur der Composite-Typ ist als Element der obersten Ebene in einem Datenwörterbuch zulässig.
  • Composite- und Collection-Elemente sind auf Blattebene nicht zulässig. Nur Primitive-Elemente (String, Datum, Zahl, Boolesch) sind auf Blattebene zulässig. Diese Überprüfung stellt sicher, dass es kein Composite- und Collection-Element ohne untergeordnetes DDE gibt.
  • Beim Hochladen einer XSD-Datei zum Erstellen eines Datenwörterbuchs werden Sie vom Datenwörterbucheditor aufgefordert, ein Element der obersten Ebene einzugeben, falls mehrere vorhanden sind, um das Datenwörterbuch zu erstellen.
  • 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 können 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 der Sammlung angibt (das sind die einzigen untergeordneten Elemente eines Collection-Elements).
  • Leere Schlüssel oder doppelte Schlüssel sind in extendedProperties für ein Datenwörterbuch oder DDE nicht zulässig.
  • Verwenden Sie nicht die Zeichen "colon(:)"oder "vertical bar(|)"innerhalb des Schlüssels oder Werts einer erweiterten Eigenschaft. Es gibt keine Validierung für die Verwendung dieser unzulä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 Datenwörterbuchelement der obersten Ebene enthalten.
  • Nur der Composite-Typ ist als Element der obersten Ebene in einem Datenwörterbuch zulässig.

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

  • Alle DDE-Namen dürfen nicht null sein und dürfen keine Leerzeichen enthalten.
  • Alle DDEs müssen den Elementtyp "nicht null/nicht null"aufweisen.
  • 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, Datum, Zahl, Boolesch) sind auf Blattebene zulässig. Diese Überprüfung stellt sicher, dass es kein Composite- und Collection-Element ohne untergeordnetes DDE gibt.
  • Ein übergeordnetes Composite-DDE darf nicht zwei untergeordnete Elemente mit demselben Namen enthalten.
  • Der ENUM-Untertyp wird nur für String- und Number-Elemente verwendet.
  • Collection- und Composite-Elemente können nicht berechnet werden.
  • Ein DDE kann nicht sowohl berechnet als auch 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 Untertyps 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 angezeigt werden. Das @ ist nur zulässig, wenn ein Attributname folgt.

Zuordnen von Datenwörterbuchelementen zum XML-Schema mappingddetoschema

Sie können ein Datenwörterbuch aus einem XML-Schema erstellen oder es mithilfe der Datenwörterbuch-Benutzeroberfläche erstellen. Alle Datenwörterbuchelemente (DDEs) innerhalb eines Datenwörterbuchs verfügen über ein XML-Bindungsfeld, in dem die Bindung des DDE an ein Element im XML-Schema gespeichert wird. 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.

Zuordnen einfacher (Primitive-)Elemente mapping-simple-primitive-elements

Ein primitives DDE stellt ein Feld oder Attribut dar, das atomisch ist. Primitive-DDEs, die außerhalb des Bereichs eines komplexen Typs (Composite DDE) oder eines sich wiederholenden Elements (Collection DDE) definiert sind, können an einem beliebigen Speicherort innerhalb des XML-Schemas gespeichert werden. Der Speicherort der Daten, die einem Primitive-DDE entsprechen, hängt nicht von der Zuordnung des übergeordneten DDE ab. Das Primitive-DDE verwendet die Zuordnungsinformationen aus dem XML-Bindungsfeld, um den Wert zu bestimmen, und die Zuordnungen werden in eine der folgenden Sprachen übersetzt:

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

Das folgende Beispiel zeigt ein einfaches Schema.

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="https://www.w3.org/2001/XMLSchema">
  <xs:element name='age' type='integer'/>
  <xs:element name='price' type='decimal'/>
</xs:schema>
Datenwörterbuchelement
XML-Standardbindung
Alter
/Alter
Preis
/Preis

Zuordnen von Composite-Elementen mapping-composite-elements

Die Bindung wird für Composite-Elemente nicht unterstützt. Wenn Bindung bereitgestellt wird, wird sie ignoriert. Die Bindung für alle untergeordneten DDEs des primitiven Typs muss absolut sein. Die Zulassung der absoluten Zuordnung für untergeordnete Elemente eines Composite-DDE bietet mehr Flexibilität in Bezug auf die XPath-Bindung. Wenn Sie ein Composite-DDE einem komplexen Typelement im XML-Schema zuordnen, wird der Bindungsbereich für die untergeordneten Elemente begrenzt.

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

<xs:element name="note">
    <xs:complexType>
        <xs:sequence>
            <xs:element name="to" type="xs:string"/>
            <xs:element name="from" type="xs:string"/>
            <xs:element name="heading" type="xs:string"/>
            <xs:element name="body" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>
</xs:element>
Datenwörterbuchelement
XML-Standardbindung
Hinweis
empty(null)
in
/note/to
von
/note/from
Überschrift
/note/heading
body
/note/body

Zuordnen von Sammlungselementen mapping-collection-elements

Ein Kollektionselement wird nur einem anderen Kollektionselement mit Kardinalität > 1 zugeordnet. Die untergeordneten DDEs eines Collection-DDE haben eine relative (lokale) XML-Bindung in Bezug auf die XML-Bindung des übergeordneten DDE. Da die untergeordneten DDEs eines Kollektionselements dieselbe Kardinalität wie die des übergeordneten Elements aufweisen müssen, ist die relative Bindung erforderlich, um die Kardinalität zu gewährleisten, sodass die untergeordneten DDEs nicht auf ein nicht wiederholendes XML-Schemaelement verweisen. Im folgenden Beispiel muss die Kardinalität von "TokenID"mit "Tokens"identisch sein, dem übergeordneten Collection-DDE.

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

  • Geben Sie keine Bindung für das DDE an, das den Typ des Collection-Elements darstellt. Wenn angegeben, wird die Bindung ignoriert.

  • Die Bindung für alle untergeordneten DDEs muss relativ zum übergeordneten Collection-Element sein.

Das nachstehende XML-Schema deklariert ein Element mit dem Namen Tokens und dem Attribut maxOccurs mit dem Namen "unbound". Daher ist Tokens ein Kollektionselement.

<?xml version="1.0" encoding="utf-8"?>
<Root>
  <Tokens>
    <TokenID>string</TokenID>
    <TokenText>
      <TextHeading>string</TextHeading>
      <TextBody>string</TextBody>
    </TokenText>
  </Tokens>
  <Tokens>
    <TokenID>string</TokenID>
    <TokenText>
      <TextHeading>string</TextHeading>
      <TextBody>string</TextBody>
    </TokenText>
  </Tokens>
  <Tokens>
    <TokenID>string</TokenID>
    <TokenText>
      <TextHeading>string</TextHeading>
      <TextBody>string</TextBody>
    </TokenText>
  </Tokens>
</Root>

Die mit diesem Beispiel verknüpfte Token.xsd lautet:

<xs:element name="Root">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Tokens" type="TokenType" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:complexType name="TokenType">
  <xs:sequence>
    <xs:element name="TokenID" type="xs:string"/>
    <xs:element name="TokenText">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="TextHeading" type="xs:string"/>
          <xs:element name="TextBody" type="xs:string"/>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
  </xs:sequence>
</xs:complexType>
Datenwörterbuchelement
XML-Standardbindung
Stamm
empty(null)
Token
/Root/Tokens
Gemischt
empty(null)
TokenID
TokenID
TokenText
empty(null)
TokenHeading
TokenText/TextHeading
TokenBody
TokenText/TextBody
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da