Knowmax Quest kan voor documenten, documentversies, documentnodes en collecties metadata vastleggen. Voor iedere soort metadata is een metadatadefinitie beschikbaar die een beschrijving geeft van het soort metadata. Iedere metadatadefinitie hoort bij een familie van metadatadefinities.

Bij Knowmax Quest generatie 4 worden de metadatadefinities direct gebruikt voor de zoekindex. Vanaf Knowmax Quest generatie 5 zijn er aparte indexdefinities beschikbaar. Deze indexdefinities kunnen verwijzingen naar meerdere metadatadefinities bevatten.

De API van Knowmax Quest heeft verschillende endpoints om met metadata te werken.

Beschikbare metadata definities

Er is een overzicht met alle beschikbare metadatadefinities. Tijdens het importeren van documenten worden metadatadefinities automatisch aangemaakt indien deze voor een bepaald soort metadata nog niet bestaan.

Er bestaat ook standaard metadata die Knowmax Quest automatisch voor alle documenten beheerd. De metadatadefinities voor deze standaard metadata kunnen niet bewerkt worden.

Identificatie

De identificatie van metadatadefinities is opgebouwd uit een label en het label van de familie waar de metadatadefinitie onderdeel van is. Binnen een familie moeten de labels van metadatadefinities uniek zijn.

Bewerken van metadata

Metadata die door middel van een importer is toegevoegd wordt altijd aan een documentversie (of documentnode, dus een onderdeel van een documentversie) gekoppeld. Deze metadata is achteraf niet te bewerken (read-only). De enige mogelijkheid om deze metadata te wijzigen is door het document opnieuw te importeren. Metadata die na de import aan een document, documentversie of documentnode is toegevoegd is wel bewerkbaar.

Let op! Knowmax Quest kent de mogelijkheid om metadata die na de import aan een documentversie of documentnode is toegevoegd te kopiëren naar de te importeren versie. Afhankelijk van de importeermethode zoals beschreven in onderdeel importers wordt een kopieerstrategie gekozen van welke versie de metadata wordt gekopieerd. Dit gebeurt op onderstaande manier:

Importeermethode	Metadata kopieerstrategie
New Version	Metadata van vorige versie wordt gekopieerd
OverwriteLastVersion	Metadata van de laatste versie wordt gekopieerd
OverWriteVersion	Metadata van de te overschrijven versie wordt gekopieerd
ResetVersion	Er wordt geen metadata gekopieerd
Auto	Heeft de Autofunctie bepaald dat een versie wordt overschreven, dan geldt dezelfde kopieerstrategie als voor OverwriteVersion. Heeft de Autofunctie bepaald dat een versie wordt toegevoagd of tussengevoegd dan geldt de New Version kopieerstrategie.

Het is ook mogelijk om de metadata kopieerfunctie uit te zetten. Er zal dan geen metadata worden gekopieerd ongeacht welke importeermethode wordt gebruikt.

Meerdere waarden voor metadatadefinitie

Er kunnen meerdere waarden voor metadata volgens een bepaalde metadatadefinitie voorkomen voor een document, documentversie of documentnode. Als voor een metadatadefinitie meerdere waarden zijn toegestaan, moeten scheidingstekens (fieldMultiValueSeparators) om meerdere waarden te herkennen gedefinieerd zijn voor die metadatadefinitie om met de API endpoint voor metawaarde mutaties te werken.

De endpoints voor het muteren van metadata zullen de waarden voor een bepaalde metadatadefinitie splitsen op basis van de eventueel ingestelde scheidingstekens. De API endpoints voor de mutatie van metawaarden accepteren de waarde alleen als string waarbij de opgegeven scheidingstekens gebruikt worden om de waarde te splitsen. Er kan dus geen JSON array van strings gebruikt worden.

Voorbeeld: scheidingstekens ,/;

Waarde	Interpretatie
a,b,c	3 waarden: a, b en c
a;b;c	3 waarden: a, b en c
a/b;c	3 waarden: a, b en c
a-b,c	2 waarden: a-b en c

Achteraf instellen van scheidingstekens

Als de scheidingstekens voor de metadatadefintie tijdens het vastleggen van de waarde niet opgegeven zijn, zal de waarde als één waarde worden opgeslagen. Als na het vastleggen van de waarde scheidingstekens worden gedefinieerd, zullen de waarden die al zijn vastgelegd niet alsnog worden gesplitst. Mochten waarden van deze metadatadefinitie gebruikt worden in een zoekindex, dan zal de indexer van het zoeksysteem de waarden alsnog gesplitst (dus als meerdere waarden) opnemen in de zoekindex. De eigenlijke waarde van de metadata wordt niet aangepast.

Importers

Voor metadata die tijdens het importeren van documenten door de importer worden vastgelegd, wordt geen gebruik gemaakt van de scheidingstekens om waarden te splitsen. Importers hanteren hun eigen regels om voor een bepaalde metadatadefinitie meerdere waarden vast te leggen.

Automatisch opschonen metadatadefinities

Periodiek zullen ongebruikte metadatadefinities automatisch verwijderd worden. Een metadatadefinitie geldt als ongebruikt als er geen documenten, documentversies, document nodes of collecties zijn die waarden voor een metadatadefintie hebben.

Automatisch opschonen voorkomen

Om te voorkomen dat een metadatadefinitie verwijderd wordt tijdens het opschonen, kan het veld preserve de waarde true krijgen. Als dit veld true is, zal de metadatadefinitie niet verwijderd worden tijdens het opschonen.

Datatype hint

Alle waarden voor metadata worden als tekst opgeslagen. Met een datatype hint kan worden aangegeven hoe de waarde te interpreteren is. Het ingebouwde zoeksysteem kan deze hint gebruiken om metadata op de juiste wijze te indexeren. Daarnaast kunnen specifieke client systemen de hint gebruiken om de metadata op een bepaalde manier te verwerken. De volgende datatypen zijn beschikbaar.

Parameter	Omschrijving
Date	Datum notatie volgens ISO 8601.
DateTime	Datum en tijd notatie volgens ISO 8601.
Boolean	Gebruik 0 voor false en 1 voor true.
Integer	Geheel getal.
Double	Gebroken getal. Gebruik punt als scheidingsteken.
Textarea	Groot tekstveld.
QuestId	Kan een refentie naar een Quest document bevatten. Bij het opvragen van dit veld kan Knowmax Quest automatisch de gegevens van het gerefereerde Quest document meegeven.
Markdown	Verrijkte tekst volgens markdown standaard toegestaan. Als het veld opgenomen wordt in de zoekindex zal de inhoud worden omgezet naar tekst zonder verrijking.
Json	Waarde uitgedrukt als JavaScript Object Notation.

Knowmax Octa

Optioneel kan Knowmax Quest een koppeling hebben met Knowmax Octa voor het beheren van domeinen van metadata. In Knowmax Quest kunnen metadatadefinities dan gekoppeld worden met een domein in Knowmax Octa. Bij het bewerken van metadata kan dan gebruik gemaakt worden van de waarden die in het domein zijn vastgelegd. Naast de gekozen waarde wordt ook het unieke label van het domein en de domeinwaarde uit Knowmax Octa opgeslagen.