Definieren von XDM-Feldern in der Benutzeroberfläche
Mit dem Wert "Schema Editor"in der Adobe Experience Platform-Benutzeroberfläche können Sie Ihre eigenen Felder in benutzerdefinierten Experience-Datenmodell (XDM)-Klassen und Schemafeldgruppen definieren. In diesem Handbuch werden die Schritte zum Definieren von XDM-Feldern in der Benutzeroberfläche beschrieben, einschließlich der verfügbaren Konfigurationsoptionen für jeden Feldtyp.
Voraussetzungen
Dieses Handbuch setzt ein Verständnis des XDM-Systems voraus. Eine Einführung in die Rolle von XDM im Experience Platform-Ökosystem finden Sie in der XDM-Übersicht und in den Grundlagen der Schemakomposition , um zu erfahren, wie Klassen und Feldgruppen Felder zu XDM-Schemas beitragen.
Für dieses Handbuch ist zwar nicht erforderlich, Sie sollten jedoch auch das Tutorial zum Erstellen eines Schemas in der Benutzeroberfläche 🔗 befolgen, um sich mit den verschiedenen Funktionen von Schema Editor vertraut zu machen.
Ressource auswählen, der Felder hinzugefügt werden sollen select-resource
Um neue XDM-Felder in der Benutzeroberfläche zu definieren, müssen Sie zunächst ein Schema innerhalb des Schema Editor öffnen. Je nachdem, welche Schemas Ihnen derzeit in der Schema Library zur Verfügung stehen, können Sie ein neues Schema erstellen oder ein vorhandenes Schema auswählen, um es zu bearbeiten.
Sobald Sie die Schema Editor geöffnet haben, werden Steuerelemente zum Hinzufügen von Feldern auf der Arbeitsfläche angezeigt. Diese Steuerelemente werden neben dem Namen des Schemas sowie allen Feldern vom Typ Objekt angezeigt, die unter der ausgewählten Klasse oder Feldergruppe definiert wurden.
Um der Ressource ein neues Feld hinzuzufügen, wählen Sie auf der Arbeitsfläche das Symbol Plus (+) neben dem Namen des Schemas oder neben dem Feld vom Typ "Objekt", unter dem das Feld definiert werden soll.
Je nachdem, ob Sie ein Feld direkt zu einem Schema oder seiner zugehörigen Klasse und Feldergruppen hinzufügen, variieren die erforderlichen Schritte zum Hinzufügen des Felds. Der Rest dieses Dokuments konzentriert sich auf die Konfiguration der Eigenschaften eines Felds, unabhängig davon, wo dieses Feld im Schema erscheint. Weiterführende Informationen zu den verschiedenen Methoden zum Hinzufügen von Feldern zu einem Schema finden Sie in den folgenden Abschnitten des Handbuchs zur Schemabenutzeroberfläche:
Definieren der Eigenschaften eines Felds define
Nach Auswahl des Symbols plus (+) wird auf der Arbeitsfläche ein Platzhalter für das Feld Unbenannt angezeigt.
In der rechten Leiste unter Feldeigenschaften können Sie die Details des neuen Felds konfigurieren. Für jedes Feld sind folgende Informationen erforderlich:
Ein eindeutiger, beschreibender Name für das Feld. Beachten Sie, dass der Feldname nach dem Speichern des Schemas nicht mehr geändert werden kann. Dieser Wert wird verwendet, um das Feld im Code und in anderen nachgelagerten Anwendungen zu identifizieren und zu referenzieren
Der Name sollte idealerweise in camelCase geschrieben werden. Es kann alphanumerische Zeichen, Bindestriche oder Unterstriche enthalten, aber darf nicht mit einem Unterstrich beginnen.
- Korrekt:
fieldName - Acceptable:
field_name2,Field-Name,field-name_3 - Falsch:
_fieldName
Hinweis: Wenn Sie den Datentyp Zuordnung auswählen, wird die Eigenschaft Map value type angezeigt.
Sie können auch Erweiterte Suche nach Typ auswählen, um vorhandene Datentypen zu suchen und zu filtern und den gewünschten Typ leichter zu finden.
Weitere Informationen zu typspezifischen Feldeigenschaften finden Sie in der Übersicht über Felder definieren .
Sie können auch für jedes Feld eine Beschreibung und Notizen angeben. Verwenden Sie das Feld Beschreibung , um Kontext hinzuzufügen und die Funktionalität des Zuordnungs-Datentyps zu beschreiben. Dies trägt zur Wartbarkeit und Lesbarkeit der Implementierung bei. Sie können auch Notizen hinzufügen, um die ursprüngliche Beschreibung zu ergänzen. Dies sollte detailliertere und spezifischere Informationen bieten, die Entwicklern dabei helfen, die Zuordnung im Kontext der Codebasis effektiv zu verstehen, zu verwalten und zu nutzen. |
Nachdem Sie die Konfiguration des Felds abgeschlossen haben, wählen Sie Anwenden aus.
Die Arbeitsfläche wird aktualisiert und zeigt das neu hinzugefügte Feld an, das sich in einem Objekt befindet, das mit Ihrer eindeutigen Mandanten-ID benannt ist (im Beispiel unten als _tenantId angezeigt). Alle benutzerdefinierten Felder, die einem Schema hinzugefügt werden, werden automatisch in diesen Namespace eingefügt, um Konflikte mit anderen Feldern von von Adobe-bereitgestellten Klassen und Feldergruppen zu vermeiden. In der rechten Leiste wird jetzt der Pfad des Felds zusätzlich zu den anderen Eigenschaften aufgelistet.
Sie können die oben beschriebenen Schritte fortsetzen, um dem Schema weitere Felder hinzuzufügen. Nach dem Speichern des Schemas werden seine Basisklasse und Feldgruppen auch dann gespeichert, wenn Änderungen an ihnen vorgenommen wurden.
Typspezifische Feldeigenschaften type-specific-properties
Beim Definieren eines neuen Felds werden in der rechten Leiste je nach dem für das Feld ausgewählten Typ zusätzliche Konfigurationsoptionen angezeigt. In der folgenden Tabelle sind diese zusätzlichen Feldeigenschaften zusammen mit den kompatiblen Typen aufgeführt:
Hinweis: Alle über die API erstellten Zuordnungs-Datentypen, die weder vom Typ String noch vom Typ Integer sind, werden als Datentyp "Komplex"angezeigt. Über die Benutzeroberfläche können keine Datentypen vom Typ "Komplex"erstellt werden.
Die Standardwerte werden zum Zeitpunkt der Aufnahme nicht im Datensatz gespeichert, da sie sich im Laufe der Zeit ändern können. Die im Schema festgelegten Standardwerte werden von nachgelagerten Platform-Diensten und -Anwendungen abgeleitet, wenn sie die Daten aus dem Datensatz lesen. Wenn beispielsweise die Daten mit Query Service abgefragt werden und das Attribut einen NULL-Wert hat, der Standardwert jedoch auf Schemaebene auf
5 festgelegt ist, wird erwartet, dass Query Service anstelle von NULL 5 zurückgibt. Beachten Sie, dass dieses Verhalten derzeit nicht für alle AEP-Dienste einheitlich ist.Wählen Sie aus einer Liste vordefinierter Formate für Zeichenfolgen aus, denen der Wert entsprechen muss. Zu den verfügbaren Formaten gehören:
Spezielle Feldtypen special
Die rechte Leiste enthält mehrere Kontrollkästchen, mit denen Sie spezielle Rollen für das ausgewählte Feld festlegen können. Die Anwendungsfälle für einige dieser Optionen beinhalten wichtige Aspekte in Bezug auf Ihre Datenmodellierungsstrategie und die beabsichtigte Verwendung nachgelagerter Platform-Dienste.
Weitere Informationen zu diesen speziellen Typen finden Sie in der folgenden Dokumentation:
Obwohl es sich technisch nicht um einen speziellen Feldtyp handelt, wird empfohlen, die Anleitung zum Definieren von Objekttypfeldern aufzurufen, um mehr über das Definieren verschachtelter Unterfelder zu erfahren, wenn Ihre Schemastrukturen vorhanden sind.
Nächste Schritte
Dieses Handbuch bietet einen Überblick darüber, wie XDM-Felder in der Benutzeroberfläche definiert werden. Beachten Sie, dass Felder nur mithilfe von Klassen und Feldergruppen zu Schemas hinzugefügt werden können. Weitere Informationen zum Verwalten dieser Ressourcen in der Benutzeroberfläche finden Sie in den Handbüchern zum Erstellen und Bearbeiten von Klassen und Feldergruppen.
Weitere Informationen zu den Funktionen des Arbeitsbereichs Schemas finden Sie in der Übersicht über den Arbeitsbereich Schemas.