Aangepaste velden laten je extra gestructureerde data toevoegen aan artikelen, paginacategorieën, beslissingsbomen en API-documentatie. In plaats van alleen te vertrouwen op standaardmetadata zoals tags, SEO-titel of beschrijving, kun je aangepaste velden je eigen velden definiëren en informatie vastleggen die specifiek is voor je documentatieworkflow.
Een productdocumentatieteam wil bijvoorbeeld velden toevoegen zoals productversie, eigenaar van functies, releasestatus of datum van contentbeoordeling. Deze velden worden op projectniveau aangemaakt en vervolgens per artikel geconfigureerd.
Aangepaste velden helpen teams om content effectiever te organiseren, consistente data over artikelen te behouden en integraties te ondersteunen die gestructureerde metadata uit de kennisbank vereisen.
Wanneer aangepaste velden te gebruiken
- Je team moet metadata bijhouden die niet door de standaardvelden van Document360 wordt gedekt, bijvoorbeeld een productversienummer of een datum van de compliance-beoordeling.
- Je wilt consistente gegevensinvoer afdwingen over alle artikelen in een project.
- Je integreert Document360 met een extern systeem dat gestructureerde velden uit je kennisbank vereist.
- Je wilt dat bepaalde veldwaarden exclusief via de API worden beheerd, zodat ze alleen-lezen in het portaal blijven.
Toegang tot aangepaste velden
- Ga naar Instellingen () > Kennisbankportaal in de linker navigatiebalk.
- Selecteer aangepaste velden in het linker navigatiepaneel.
De pagina Aangepaste velden toont een raster van alle bestaande aangepaste velden, inclusief de veldnaam en veldtype.
Maak een aangepast veld aan
- Klik op de pagina Aangepaste velden aanmaken.
- Configureer in het menu 'Aangepast veld' maken het volgende:
| Veld | Beschrijving |
|---|---|
| Veldnaam | Een unieke naam voor het vakgebied. Verplicht. Maximaal 30 tekens. |
| Veldtype | Het type data dat het veld opslaat. Kan niet worden veranderd na de creatie. Zie veldtypen hieronder. |
| Tijdelijke tekst | Optioneel. Inhoud die in het veld verschijnt voordat een waarde wordt ingevoerd. |
| Helptekst | Optioneel. Richtlijnen voor bijdragers, weergegeven als tooltip naast het veld in artikelinstellingen. |
| Bewerking alleen via API | Wanneer ingeschakeld, is het veld alleen-lezen in het portaal. Waarden kunnen alleen via de API worden bijgewerkt. |
- Klik op Aanmaken.
Eenmaal aangemaakt, verschijnt het veld in het raster en wordt het beschikbaar in artikelinstellingen.
Het veldtype kan niet worden gewijzigd na het aanmaken. Als een ander veldtype nodig is, verwijder dan het bestaande veld en maak een nieuw aan.
Veldtypen
| Veldtype | Beschrijving | Tekenlimiet |
|---|---|---|
| Tekst | Tekstinvoer met één regel. | 30 personages |
| Tekstgebied | Meerregelige tekstinvoer. | 150 personages |
| Dropdown (enkele selectie) | Selecteer één optie uit een vooraf gedefinieerde lijst. | 30 tekens per optie |
| Dropdown (multi-select) | Selecteer meerdere opties uit een vooraf gedefinieerde lijst. | 30 tekens per optie |
| Datum | Input van de datumkeuze. | |
| Booleans | Waar/onwaar-schakelaar. | |
| Aantal | Numerieke invoer. |
Beheer aangepaste velden
Ga naar Instellingen () > Kennisbankportaal > Aangepaste velden en beweeg met de muis over een veld om de beschikbare acties te tonen.
- Bewerking: Klik op het pictogram Bewerken () (). Werk de veldgegevens bij en klik op Updaten. Wijzigingen gelden voor alle artikelen waarin het veld wordt gebruikt.
- Kopieer unieke code: Klik op het More () icoon en selecteer unieke code kopiëren. Dit kopieert de unieke identificatie van het veld voor gebruik in API-aanroepen.
- Verwijderen: Klik op het More () icoon en selecteer Verwijderen, of selecteer het selectievakje naast het veld en klik op Verwijderen Geselecteerd in de werkbalk. Typ JA in het bevestigingsvenster en klik op Verwijderen om te bevestigen.
Het verwijderen van een aangepast veld verwijdert permanent de waarden ervan uit alle bijbehorende artikelen. Verwijderde velden kunnen niet worden hersteld.
Gebruikers met Editor-rechten kunnen aangepaste velden aanmaken, bewerken en verwijderen. Voor aangepaste rollen moet de toestemming voor aangepaste velden zijn ingeschakeld. Om aangepaste veldwaarden in artikelinstellingen bij te werken, moeten gebruikers de Rechtschrift / Beslissingsboominstellingen hebben. Bijdragers kunnen aangepaste veldwaarden bijwerken tenzij het veld alleen via API als Bewerken is geconfigureerd.
Configureer aangepaste velden in een artikel
Zodra een aangepast veld is aangemaakt, kunnen bijdragers waarden instellen in de artikelinstellingen.
- Open het artikel in het kennisbankportaal.
- Klik op het Meer () icoon in de artikelkop en selecteer opties voor Meer artikelen.
- Vind in het artikelinstellingenpaneel het gedeelte Aangepaste velden .
- Voer voor elk veld de juiste waarde in of selecteer deze.
- Klik op Opslaan.
Aangepaste veldwaarden worden opgeslagen voor de laatst gepubliceerde versie van een artikel en zijn niet versiespecifiek.
Teamauditing
Alle aangepaste veldacties worden vastgelegd in Team-auditing, inclusief het aanmaken, bijwerken en verwijderen van velden, evenals het bijwerken van veldwaarden binnen artikelen. Ga naar Instellingen () > Knowledge Base-portaal > Teamauditing om het activiteitenlogboek te bekijken. Lees meer over teamauditing →
Best practices
- Plan je velden voordat je ze maakt. Het veldtype kan na het aanmaken niet worden gewijzigd. Bepaal van tevoren of een veld tekst, dropdown, datum of een ander type moet zijn.
- Gebruik Help-tekst gul. Bijdragers zien de hulptekst als tooltip in de artikelinstellingen. Een korte beschrijving van wat je moet invoeren, bijvoorbeeld "Voer de productversie in X.X.X-formaat in", voorkomt inconsistente gegevensinvoer.
- Gebruik Bewerken via API alleen voor systeembeheerde velden. Als een veld wordt gevuld met een externe integratie of script, schakel dan alleen Bewerken via API in om handmatige overschrijvingen in het portaal te voorkomen.
- Ruim ongebruikte velden op. Ongebruikte aangepaste velden voegen ruis toe aan artikelinstellingen. Verwijder velden die niet langer nodig zijn om het artikelinstellingenpaneel schoon te houden.
FAQ
Kan ik het veldtype veranderen nadat ik een aangepast veld heb aangemaakt?
Nee. Het veldtype kan niet worden aangepast na het aanmaken. Als een ander veldtype nodig is, verwijder dan het bestaande veld en maak een nieuw aan met het juiste type.
Wat gebeurt er als een aangepast veld wordt verwijderd?
Het verwijderen van een aangepast veld verwijdert het permanent en alle waarden ervan uit elk artikel waarin het is gebruikt. Verwijderde velden kunnen niet worden hersteld.
Wat doet de optie 'alleen bewerken via API'?
Wanneer ingeschakeld, kunnen bijdragers de veldwaarde van het portaal niet wijzigen. Het veld wordt alleen-lezen in artikelinstellingen en kan alleen via de API worden bijgewerkt. Dit is nuttig voor velden die worden beheerd door externe integraties of geautomatiseerde scripts.
Worden aangepaste veldwaarden per artikelversie opgeslagen?
Nee. Aangepaste veldwaarden worden opgeslagen voor de laatst gepubliceerde versie van een artikel en zijn niet versiespecifiek.
Wie kan aangepaste velden aanmaken en beheren?
Gebruikers met Editor-rechten kunnen aangepaste velden aanmaken, bewerken en verwijderen. Voor aangepaste rollen moet de toestemming voor aangepaste velden zijn ingeschakeld. Bijdragers kunnen veldwaarden aanpassen in artikelinstellingen, tenzij het veld alleen via API op Bewerken is ingesteld.