/ Zoeken

Zoek in Epistola

Vind documentatie, integratiehandleidingen, tourstappen, blogposts en pagina's.

DocumentatieIntegratiesTourBlogPagina
↑↓↵esc

In ontwikkeling — Het Leren-gedeelte wordt uitgebreid; alfa-, beta- en previewmogelijkheden worden waar relevant gelabeld.

Attributen

Tenant-scoped attribuutregister met sleutels, weergavenamen, toegestane waarden en variantclassificatie.

Attributen

Met attributen beschrijf je waarom een templatevariant bestaat, bijvoorbeeld een Nederlandse versie, een variant voor een huisstijl of een e-maillay-out. Definities horen bij een tenant en kunnen binnen die tenant voor meerdere templates worden gebruikt.

Attribuutdefinities

Maak een attribuutdefinitie aan in het tenantregister Attributen. Elke definitie heeft:

  • Sleutel — Een slug-identifier (bijv. taal, merk, kanaal)
  • Weergavenaam — Een leesbaar label (bijv. “Taal”, “Merk”)
  • Toegestane waarden — Een optionele lijst van toegestane waarden. Indien leeg, wordt elke waarde geaccepteerd
  • Codelijst — Een optionele codelijst die de waarden levert, zodat je ze niet inline hoeft te beheren. Kies een codelijst óf inline toegestane waarden.

De sleutel is de stabiele identifier die in API-aanvragen en variantgegevens wordt gebruikt. Houd deze kort en consistent; gebruik bijvoorbeeld language of brand in plaats van een label dat later kan wijzigen.

Gebruik

Ken daarna sleutel-waardeparen toe aan de varianten van een template. Een template kan bijvoorbeeld varianten hebben met language=nl, language=en of brand=corporate. Een variant kan meerdere attributen tegelijk hebben.

Attributen dienen twee doelen:

  1. Variantclassificatie — Varianten worden getagd met attribuut-sleutel-waardeparen (bijv. taal=nl, merk=zakelijk) die hun kenmerken beschrijven
  2. Automatische variantresolutie — Wanneer een renderverzoek attributen bevat, matcht de resolver deze tegen variantattributen om de beste match te vinden

Een variant kiezen

Een aanvraag kan op twee manieren een variant selecteren:

  • Expliciet — Geef een variantId op wanneer je al weet welke variant moet worden gerenderd.
  • Op basis van criteria — Geef attribuutcriteria op, zoals language=nl. Markeer criteria als verplicht wanneer elke geselecteerde variant eraan moet voldoen; optionele criteria bepalen de voorkeur, maar sluiten een variant op zichzelf niet uit.

De resolver filtert eerst varianten die niet aan verplichte criteria voldoen. Daarna worden de overgebleven kandidaten gerangschikt op basis van optionele overeenkomsten en specificiteit. Als geen kandidaat aan de verplichte criteria voldoet, valt de rendering terug op de standaardvariant van het template. Een aanvraag mag niet tegelijk een expliciete variantId en attribuutcriteria bevatten.

Alleen definities die voor de tenant zijn geregistreerd, kunnen aan diens varianten worden toegekend. Waarden worden gevalideerd tegen de definitie wanneer inline toegestane waarden of een codelijst is geconfigureerd.

In de UI

De attribuutlijstpagina toont een tabel met kolommen voor:

  • Sleutel — De attribuutslug
  • Weergavenaam — Het leesbare label
  • Toegestane waarden — Weergegeven als badges

Klikken op een attribuut opent een bewerkdialoog voor het wijzigen van de weergavenaam, toegestane waarden of codelijstbron.

Meer over dit onderwerp