Definiera XDM-fält i användargränssnittet

The Schema Editor i Adobe Experience Platform användargränssnitt kan du definiera egna fält i anpassade Experience Data Model-klasser (XDM) och schemafältgrupper. Den här guiden beskriver stegen för att definiera XDM-fält i användargränssnittet, inklusive tillgängliga konfigurationsalternativ för varje fälttyp.

Förutsättningar

Handboken kräver en fungerande förståelse för XDM System. Se XDM - översikt en introduktion till XDM:s roll i Experience Platform-ekosystemet, och grunderna för schemakomposition om du vill lära dig hur klasser och fältgrupper bidrar till fält i XDM-scheman.

Även om det inte krävs för den här guiden rekommenderar vi att du också följer självstudiekursen på skapa ett schema i användargränssnittet för att bekanta dig med de olika funktionerna i Schema Editor.

Välj en resurs att lägga till fält i select-resource

Om du vill definiera nya XDM-fält i användargränssnittet måste du först öppna ett schema i Schema Editor. Beroende på vilka scheman som är tillgängliga i Schema Librarykan du välja att skapa ett nytt schema eller välj ett befintligt schema att redigera.

När du har Schema Editor öppna visas kontroller för att lägga till fält på arbetsytan. Dessa kontroller visas intill schemats namn, liksom alla objekttypsfält som har definierats under den valda klassen eller fältgruppen.

Schemaredigeraren med Lägg till-ikonerna markerade.

WARNING
Om du försöker lägga till ett fält i ett objekt som tillhandahålls av en standardfältgrupp, kommer den fältgruppen att konverteras till en anpassad fältgrupp och den ursprungliga fältgruppen kommer inte längre att vara tillgänglig. Se avsnittet om lägga till fält i standardfältgrupper i gränssnittshandboken för scheman om du vill ha mer information.

Om du vill lägga till ett nytt fält i resursen väljer du plus (+) -ikonen bredvid schemats namn på arbetsytan eller bredvid det objekttypsfält som du vill definiera fältet under.

Schemaredigeraren med en Lägg till-ikon markerad.

Beroende på om du lägger till ett fält direkt i ett schema eller dess klass och fältgrupper för beståndsdelar, varierar stegen som krävs för att lägga till fältet. Resten av det här dokumentet fokuserar på hur du konfigurerar ett fälts egenskaper oavsett var det fältet visas i schemat. Mer information om olika sätt att lägga till fält i ett schema finns i följande avsnitt i gränssnittshandboken för scheman:

Definiera egenskaperna för ett fält define

När du har valt plus (+) ikon, en Untitled field platshållaren visas på arbetsytan.

Schemaredigeraren med ett nytt namnlöst fält markerat.

I den högra listen under Field properties kan du konfigurera informationen för det nya fältet. Följande information krävs för varje fält:

Fältegenskap
Beskrivning
Field name

Ett unikt, beskrivande namn för fältet. Observera att fältets namn inte kan ändras när schemat har sparats. Det här värdet används för att identifiera och referera till fältet i koden och i andra program i senare led

Namnet ska helst skrivas i camelCase. Den kan innehålla alfanumeriska tecken, bindestreck eller understreck, men den får inte börja med ett understreck.

  • Korrigera: fieldName
  • Godtagbart: field_name2, Field-Name, field-name_3
  • Felaktig: _fieldName
Display name
Ett visningsnamn för fältet. Det här namnet kommer att användas för att representera fältet på arbetsytan i Schemaredigeraren. Fältnamnet kan ändras till visningsnamnet med växla visningsnamn.
Type
Den typ av data som fältet innehåller. I den här listrutan kan du välja något av standardtyper av skalärbilder stöds av XDM, eller ett av flera fält datatyper som tidigare har definierats i Schema Registry.
Obs! Om du väljer datatypen Map Map value type visas.

Du kan också välja Advanced type search om du vill söka efter och filtrera befintliga datatyper och hitta den önskade typen enklare.
Map value type
Detta värde krävs om du väljer Map som datatyp för fältet. Tillgängliga värden för kartan är String och Integer. Välj ett värde i listrutan med tillgängliga alternativ.
Mer information om typspecifika fältegenskaper, se översikten över definierade fält.

Du kan också välja att ange en beskrivning och anteckningar för varje fält. Använd Description för att lägga till kontext och beskriva kartdatatypen. Detta bidrar till att implementeringen blir enkel och lättläst. Du kan också lägga till anteckningar som komplement till den inledande beskrivningen. Detta bör ge mer detaljerad och specifik information för att hjälpa utvecklare att förstå, underhålla och använda kartan effektivt i kodbasen. |

NOTE
Beroende på Type som du har valt för fältet kan ytterligare konfigurationskontroller visas i den högra listen. Se avsnittet om typspecifika fältegenskaper om du vill ha mer information om dessa kontroller.
Den högra listen innehåller även kryssrutor för att ange särskilda fälttyper. Se avsnittet om specialfälttyper för mer information.

När du har konfigurerat fältet väljer du Apply.

The Field properties -avsnittet i Schemaredigeraren är markerat.

Arbetsytan uppdateras för att visa det nya fältet, som finns i ett objekt som har ett namn som är kopplat till ditt unika innehavar-ID (visas som _tenantId i exemplet nedan). Alla anpassade fält som läggs till i ett schema placeras automatiskt i det här namnutrymmet för att förhindra konflikter med andra fält från klasser och fältgrupper som tillhandahålls av Adobe. Den högra listen visar nu fältets sökväg förutom dess andra egenskaper.

Ett nytt fält i schemagrafiken och dess motsvarande sökväg i Field properties -avsnittet är markerat.

Du kan fortsätta följa stegen ovan för att lägga till fler fält i schemat. När schemat har sparats sparas även dess basklass och fältgrupper om några ändringar har gjorts i dem.

NOTE
Alla ändringar du gör i fältgrupperna eller klassen för ett schema kommer att återspeglas i alla andra scheman som använder dem.

Typspecifika fältegenskaper type-specific-properties

När du definierar ett nytt fält kan ytterligare konfigurationsalternativ visas i den högra listen beroende på Type du väljer för fältet. I följande tabell visas de här extra fältegenskaperna tillsammans med deras kompatibla typer:

Fältegenskap
Kompatibla typer
Beskrivning
Map value type
Map
The Map value type egenskapen visas bara i användargränssnittet om du väljer värdet för kartan på menyn Type alternativ i listrutan. Du kan välja mellan värdetyperna String och Integer för kartan.
Schemaredigeraren med fälten för typ och mappningsvärdetyp markerade. {width="100" modal="regular"}
Obs! Alla mappningsdatatyper som skapas via API som inte är antingen en sträng eller en heltalstyp visas som 'Complex' datatyp. Du kan inte skapa 'Complex' datatyper via användargränssnittet.
Default value
String, Double, Long, Integer, Short, Byte, Boolean
Ett standardvärde som tilldelas det här fältet om inget annat värde anges vid inmatningen. Värdet måste överensstämma med fältets valda typ.

Standardvärdena sparas inte i datauppsättningen vid tidpunkten för inmatningen eftersom de kan ändras över tid. De standardvärden som anges i schemat härleds av plattformstjänster och program som är längre fram i kedjan när de läser data från datauppsättningen. Om attributet har ett NULL-värde när data efterfrågas med hjälp av tjänsten Query, men standardvärdet är inställt på 5 på schemanivå förväntas frågetjänsten returnera 5 i stället för NULL. Observera att detta för närvarande inte är enhetligt i alla AEP-tjänster.
Pattern
String
A reguljärt uttryck att värdet för detta fält måste överensstämma med för att kunna accepteras vid förtäring.
Format
String

Välj i en lista över fördefinierade format för strängar som värdet måste överensstämma med. Tillgängliga format:

Minimum length
String
Det minsta antal tecken som strängen måste innehålla för att värdet ska accepteras vid förtäring.
Maximum length
String
Det maximala antal tecken som strängen måste innehålla för att värdet ska accepteras vid förtäring.
Minimum value
Double
Det lägsta värdet för Double som ska accepteras vid förtäring. Om det inmatade värdet exakt matchar det som anges här, accepteras värdet. När du använder den här begränsningen visasExclusive minimum valuebegränsningen " måste lämnas tom.
Maximum value
Double
Det högsta värdet för Double som ska accepteras vid förtäring. Om det inmatade värdet exakt matchar det som anges här, accepteras värdet. När du använder den här begränsningen visasExclusive maximum valuebegränsningen " måste lämnas tom.
Exclusive minimum value
Double
Det högsta värdet för Double som ska accepteras vid förtäring. Om det inmatade värdet exakt matchar det som anges här, avvisas värdet. När du använder den här begränsningen visasMinimum value" (icke-exklusiv) begränsning måste lämnas tom.
Exclusive maximum value
Double
Det högsta värdet för Double som ska accepteras vid förtäring. Om det inmatade värdet exakt matchar det som anges här, avvisas värdet. När du använder den här begränsningen visasMaximum value" (icke-exklusiv) begränsning måste lämnas tom.

Speciella fälttyper special

Den högra listen innehåller flera kryssrutor för att ange speciella roller för det markerade fältet. Användningsexempel för vissa av dessa alternativ inbegriper viktiga överväganden som rör er datamodelleringsstrategi och hur ni tänker använda plattformstjänster längre fram i kedjan.

Mer information om dessa specialtyper finns i följande dokumentation:

Även om det inte är en speciell fälttyp rekommenderar vi att du går till guiden på definiera objekttypsfält om du vill veta mer om hur du definierar kapslade underfält om schemastrukturen.

Nästa steg

Den här guiden ger en översikt över hur du definierar XDM-fält i användargränssnittet. Kom ihåg att fält bara kan läggas till i scheman med hjälp av klasser och fältgrupper. Om du vill veta mer om hur du hanterar de här resurserna i användargränssnittet läser du i handböckerna om hur du skapar och redigerar klasser och fältgrupper.

Mer information om funktionerna i Schemas arbetsytan, se Schemas arbetsyta - översikt.

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07