Så här modellerar du ditt innehåll

Senaste uppdatering: 2023-12-05

I den här delen av AEM Headless Developer Journeyfår du lära dig att modellera innehållsstrukturen. Förverkliga sedan strukturen för Adobe Experience Manager (AEM) med Content Fragments Models och Content Fragments, för återanvändning i alla kanaler.

Story hittills

I början Läs om CMS Headless Development innehållsleverans utan extra kostnad och varför den används. Sedan Komma igång med AEM Headless as a Cloud Service beskrivs AEM Headless i ditt eget projekt.

I det föregående dokumentet om den AEM resan utan headless Vägen till din första upplevelse med AEM utan headlesslärde du dig sedan de steg som krävs för att implementera det första projektet. När du har läst den kan du göra följande:

  • Förstå och förklara viktiga planeringsöverväganden vid utformningen av ditt innehåll
  • Förstå och förklara hur ni implementerar headless, beroende på era integreringsnivåkrav.
  • Ställ in de verktyg och AEM som behövs.
  • Lär dig de bästa metoderna så att du kan göra den enkla resan smidig, hålla innehållsgenereringen effektiv och se till att innehållet levereras snabbt.

Den här artikeln bygger på dessa grundläggande funktioner så att du förstår hur du förbereder ett eget AEM headless-projekt.

Syfte

  • Målgrupp: Nybörjare
  • Syfte: Lär dig modellera innehållsstrukturen och sedan förverkliga den strukturen med AEM Content Fragment Models och Content Fragments:
    • Lägg in koncept och terminologi för data-/innehållsmodellering.
    • Lär dig varför innehållsmodellering behövs för leverans av Headless-innehåll.
    • Lär dig hur du realiserar den här strukturen med AEM Content Fragment Models (och skapar innehåll med Content Fragments).
    • Lär dig modellera innehåll, principer med grundläggande exempel.
OBSERVERA

Datamodellering är ett stort fält, som det används vid utveckling av relationsdatabaser. Det finns många böcker och onlinekällor med information.

Denna resa tar endast hänsyn till aspekter som är av intresse vid modellering av data för användning med AEM Headless.

Innehållsmodellering

Det är en stor, dålig värld där ute.

Kanske, men kanske inte. Det är verkligen en komplicerad världen där ute och datamodellering används för att definiera en förenklad representation av ett mycket (mycket) litet underavsnitt, med hjälp av den specifika information som behövs för ett visst ändamål.

OBSERVERA

När AEM behandlar innehåll kallas den här resan datamodellering för innehållsmodellering.

Till exempel:

Det finns många skolor, men de har alla olika saker gemensamt:

  • En plats
  • Huvudlärare
  • Många lärare
  • Många icke undervisande personal
  • Många elever
  • Många f.d. lärare
  • Många före detta elever
  • Många klassrum
  • Många (många) böcker
  • Många (många) utrustningsdelar
  • Många aktiviteter utanför kurserna
  • och så vidare…

Även i ett sådant litet exempel kan listan verka oändlig. Men om du bara vill att programmet ska utföra en enkel åtgärd bör du begränsa informationen till de viktigaste uppgifterna.

Exempel: annonsera specialevent för alla skolor i området:

  • Skolans namn
  • Skolans plats
  • Huvudlärare
  • Typ av händelse
  • Händelsedatum
  • Lärare som organiserar evenemanget

Concepts

Vad du vill beskriva kallas för Enheter - de"saker" som du vill lagra information om.

Informationen som du vill lagra om dem är Attribut (egenskaper), t.ex. namn, och lärarkvalifikationer.

Sedan finns det olika Relationer mellan enheterna. Till exempel har en skola bara en huvudlärare, och många lärare (och vanligtvis är huvudläraren också lärare).

Processen att analysera och definiera informationen, tillsammans med relationerna mellan dem, kallas Innehållsmodellering.

Grunderna

Oftast måste du börja med att skapa en Konceptuellt schema som beskriver enheterna och deras relationer. Vanligtvis är detta en hög nivå (konceptuell).

När detta är stabilt kan du omvandla modellerna till en Logiskt schema som beskriver enheterna, tillsammans med attributen, och relationerna. På den här nivån bör du noggrant granska definitionerna för att undvika duplicering och optimera designen.

OBSERVERA

Ibland sammanfogas dessa två steg, ofta beroende på hur komplicerat ditt scenario är.

Behöver du till exempel separata enheter för Head Teacher och Teachereller bara ytterligare ett attribut på Teacher modell?

Säkerställer dataintegritet

Dataintegritet krävs för att garantera innehållets exakthet och enhetlighet under hela dess livscykel. Detta innefattar att säkerställa att innehållsförfattare enkelt kan förstå vad de ska lagra var - så följande är viktiga:

  • en tydlig struktur
  • en struktur som är så kortfattad som möjligt (utan att offra noggrannheten)
  • validering av enskilda fält
  • vid behov begränsa innehållet i specifika fält till vad som är meningsfullt

Eliminera redundans

Dataredundans inträffar när samma information lagras två gånger i innehållsstrukturen. Detta bör undvikas eftersom det kan leda till missförstånd när innehållet skapas och fel vid frågor, för att inte tala om missbruk av lagringsutrymme.

Optimering och prestanda

Genom att optimera strukturen kan du förbättra prestandan, både när det gäller att skapa innehåll och fråga.

Allt är en balansåtgärd, men att skapa en struktur som är för komplex, eller som har för många nivåer, kan vara förvirrande för författare som skapar innehållet. Och det kan påverka prestandan avsevärt om frågan måste få åtkomst till flera kapslade (refererade) innehållsfragment för att hämta det önskade innehållet.

Innehållsmodellering för AEM Headless

Datamodellering är en uppsättning etablerade tekniker som ofta används vid utvecklade relationsdatabaser, så vad innebär innehållsmodellering för AEM Headless?

Varför?

För att ditt program ska kunna begära och ta emot nödvändigt innehåll från AEM på ett konsekvent och effektivt sätt måste det här innehållet struktureras.

Detta innebär att din ansökan i förväg vet vilken form av svar det är och därför hur den ska behandlas. Detta är enklare än att ta emot frihandsinnehåll, som måste analyseras för att avgöra vad det innehåller och därför hur det kan användas.

Introduktion till Hur?

AEM använder Content Fragments för att tillhandahålla de strukturer som behövs för Headless-leverans av ditt innehåll till dina program.

Innehållsmodellens struktur är:

  • som realiseras av definitionen av din Content Fragment Model,
  • används som bas för de innehållsfragment som används för att generera innehåll.
OBSERVERA

Modellerna för innehållsfragment används också som bas för de AEM GraphQL-scheman som används för att hämta ditt innehåll - mer om det i en senare session.

Begäranden om ditt innehåll görs med AEM GraphQL API, en anpassad implementering av GraphQL standard-API. Med AEM GraphQL API kan du utföra (komplexa) frågor på dina innehållsfragment, där varje fråga anpassas efter en viss modelltyp.

Det returnerade innehållet kan sedan användas av dina program.

Skapa strukturen med Content Fragment Models

I Content Fragment Models finns olika mekanismer som gör att du kan definiera innehållets struktur.

En innehållsfragmentmodell beskriver en enhet.

OBSERVERA

Du måste aktivera funktionen för innehållsfragment i konfigurationsläsaren så att du kan skapa modeller.

TIPS

Modellen bör namnges så att innehållsförfattaren vet vilken modell som ska väljas när ett innehållsfragment skapas.

Inom en modell:

  1. Datatyper gör att du kan definiera de enskilda attributen.
    Definiera till exempel fältet som innehåller en lärares namn som Text och deras tjänsteår som Nummer.
  2. Datatyperna Innehållsreferens och Fragmentreferens kan du skapa relationer till annat innehåll i AEM.
  3. The Fragmentreferens datatypen gör att du kan realisera flera strukturnivåer genom att kapsla dina innehållsfragment (enligt modelltypen). Detta är viktigt för er innehållsmodellering.

Till exempel:
Innehållsmodellering med innehållsfragment

Datatyper

AEM innehåller följande datatyper som du kan använda för att modellera ditt innehåll:

  • Enkelradig text
  • Flerradstext
  • Nummer
  • Boolean
  • Datum och tid
  • Uppräkning
  • Taggar
  • Innehållsreferens
  • Fragmentreferens
  • JSON-objekt

Referenser och kapslat innehåll

Två datatyper ger referenser till innehåll utanför ett visst fragment:

  • Innehållsreferens
    Detta ger en enkel referens till annat innehåll av valfri typ.
    Du kan till exempel referera till en bild på en viss plats.

  • Fragmentreferens
    Detta innehåller referenser till andra innehållsfragment.
    Den här typen av referens används för att skapa kapslat innehåll, vilket introducerar de relationer som behövs för att modellera innehållet.
    Datatypen kan konfigureras så att fragmentförfattare kan:

    • Redigera det refererade fragmentet direkt.
    • Skapa ett innehållsfragment baserat på lämplig modell

Skapa modeller för innehållsfragment

Först måste du aktivera Content Fragment Models för webbplatsen. Detta görs i Configuration Browser under verktyg > Allmänt > Konfigurationsläsaren. Du kan antingen välja att konfigurera den globala posten eller skapa en konfiguration. Till exempel:

Definiera konfiguration

OBSERVERA

Se Ytterligare resurser - Innehållsfragment i Configuration Browser

Sedan kan du skapa modellerna för innehållsfragment och definiera strukturen. Detta kan göras under verktyg > Allmänt > Modeller för innehållsfragment. Till exempel:

Content Fragment Model

OBSERVERA

Se Ytterligare resurser - modeller för innehållsfragment.

Använda modellen för att skapa innehåll med innehållsfragment

Innehållsfragment baseras alltid på en innehållsfragmentmodell. Modellen innehåller strukturen, fragmentet innehåller innehållet.

Välja lämplig modell

Det första steget till att skapa innehåll är att skapa ett innehållsfragment. Detta görs med Skapa > Innehållsfragment i den obligatoriska mappen under Resurser > Filer. Guiden vägleder dig genom stegen.

Ett innehållsfragment baseras på en viss innehållsfragmentmodell som du väljer som första steg i skapandet.

Skapa och redigera strukturerat innehåll

När fragmentet har skapats kan du öppna det i redigeraren för innehållsfragment. Här kan du göra följande:

  • Redigera innehållet i normalt läge eller helskärmsläge.
  • Formatera innehållet som antingen Fullständig text, Oformaterad text eller Markering.
  • Skapa och hantera variationer av ditt innehåll.
  • Associera innehåll.
  • Redigera metadata.
  • Visa trädstrukturen.
  • Förhandsgranska JSON-representationen.

Skapa innehållsfragment

När du har valt lämplig modell öppnas ett innehållsfragment för redigering i redigeraren för innehållsfragment:

Innehållsfragmentsredigerare

OBSERVERA

Se Ytterligare resurser - Arbeta med innehållsfragment.

Komma igång med några exempel

En grundläggande struktur som exempel finns i Struktur för exempelinnehållsfragment.

What's Next

Nu när du har lärt dig att modellera strukturen och skapa innehåll som är beroende av den, är nästa steg att Lär dig hur du använder GraphQL-frågor för att komma åt och hämta innehåll i innehållsfragment. Här presenteras GraphQL och vi diskuterar några exempelfrågor för att se hur det fungerar i praktiken.

Ytterligare resurser

På denna sida