In de praktijk zie ik regelmatig problemen (die je als projectmanager natuurlijk "uitdagingen" zou noemen) met metadata (kolommen) en metadata sets (Content Types) in SharePoint omgevingen. Regelmatig worden wijzigingen doorgevoerd waarna onverwachte en vervelende situaties ontstaan. Veel van die situaties zijn te herleiden tot te weinig begrip metadata(sets) binnen SharePoint en de wijze waarop SharePoint hiermee omgaat. Daarom in dit artikel een praktische inleiding hierop, aangevuld met praktische tips en valkuilen. Dit artikel zal ik de komende tijd verder uitbreiden, reden om regelmatig terug te keren.
Metadatering in SharePoint
Dat metadatering belangrijk is, daar ga ik in dit artikel niet op in, dat is te lezen in Metadata: belang, inleiding en hoe ermee om te gaan. Laat ik beginnen met uit te leggen hoe metadatering in het algemeen en binnen SharePoint is geïmplementeerd...
Metadata in lijsten en bibliotheken
Lijsten en bibliotheken kunnen voorzien worden van kolommen. Wanneer een item aan een lijst, of een document aan een bibliotheek wordt toegevoegd, kunnen deze kolommen worden gebruikt om het betreffende lijstitem of document te beschrijven. De kolommen zijn dan kenmerken van de items resp. de documenten. Veelgebruikte kolommen zijn bijvoorbeeld: auteur, datum van opslag en titel.
Op deze manier wordt ieder item in een lijst en ieder document in een bibliotheek voorzien van dezelfde kenmerken, dezelfde "metadata set", namelijk de kolommen die voor de lijst resp. de bibliotheek zijn gedefinieerd.
Wanneer je echter verschillende typen documenten hebt, en je wilt voor ieder type document of item een andere verzameling kenmerken (metadata set) wilt gebruiken, dan volstaat de bovenstaande aanpak niet. Ook als je metadata sets wilt hergebruiken voor meerdere lijsten of bibliotheken is er meer nodig dan alleen kolommen in een lijst of bibliotheek. En als metadata sets elkaar overlappen en je wilt deze metadata sets doelmatig onderhouden, dan is er meer nodig dan alleen kolommen.
Wat hierbij helpt zijn Content Types, herbruikbare metadata sets.
Herbruikbare metadata sets: Content Types
Alle content; documenten (web pagina's, Office documenten, plaatjes, PDF's en alle andere typen bestanden), maar ook lijstitems kunnen worden beschreven door er kenmerken (b.v. titel, auteur, datum aanmaak) aan te koppelen. Deze kenmerken, kolommen, worden ondergebracht in verzamelingen, metadata sets. Deze metadatasets worden binnen SharePoint "Content Types" genoemd. Aan documenten en lijstitems kunnen binnen SharePoint dus Content Types worden gekoppeld die deze documenten of lijstitems beschrijven. Deze Content Types worden opgenomen in zogenaamde "Site Content Type Galleries" (bibliotheken met Content Types). Iedere site kent een Site Content Type Gallery.
Binnen een bibliotheek of lijst kunnen documenten en items worden opgenomen. Aan een bibliotheek of lijst kunnen zowel losse kolommen (zoals in een spreadsheet) als Content Types worden toegevoegd. Door Content Types te koppelen aan de kenmerken (properties) van document templates (b.v. Word, PDF, Excel) worden alle kenmerken van documenten als kolommen in de bibliotheek of lijst opgenomen wanneer deze documenten in de bibliotheek of lijst worden opslagen.
Overlappende Content Types
Wanneer je meerdere Content Types hebt gedefinieerd die erg op elkaar lijken, bijvoorbeeld als bepaalde kolommen in ieder van deze Content Types voorkomen, kun je ervoor kiezen om deze Content Types in een hiërarchie onder te brengen. Hierin kunnen "gedeelde" kolommen in een "parent" Content Type worden ondergebracht waarbij de kolommen in het "parent" Content Type automatisch worden opgenomen in de "child" Content Types. Zodoende kunnen wijzigingen in Content Types met minder moeite worden doorgevoerd. Hier zitten echter wel wat haken en ogen aan, maar meer daarover later in dit artikel.
Standaard biedt SharePoint al een aantal Content Types die als basis kunnen worden gebruikt voor zelfgedefinieerde Content Types. Deze Content Types zijn ondergebracht in een hierarchie waarvan het parent Content Type van het type "Item" is. Daaruit zijn andere standaard Content Types als "Document", "Event" en "Task" afgeleid, welke bekend zullen voorkomen omdat deze standaard in bepaalde voorgedefinieerde bibliotheken met dezelfde naam worden gebruikt.
Standaard kolommen: Site Columns
Naast Content Types kunnen ook standaard kolommen (Site Columns) binnen SharePoint worden gedefinieerd. Deze standaard kolommen kunnen vervolgens in Content Types, lijsten en bibliotheken worden gebruikt. Dit is handig omdat je op die manier slechts een maal een kolom definitie, bijvoorbeeld een keuzelijst met standaard status waarden (draft, concept, final), hoeft te definiëren. Deze Site Columns worden opgenomen in zogenaamde "Site Column Galleries" (bibliotheken met Site Columns). Iedere site kent een Site Column Gallery.
Standaard biedt SharePoint al een aantal Site Columns die gebruikt kunnen worden voor lijsten, bibliotheken en Content Types.
Metadatering op verschillende niveaus: SharePoint Farm, Site (Collection) en lijst/bibliotheek niveau
Zowel Columns als Content Types kunnen op verschillende niveau's in een SharePoint Farm worden gedefinieerd en (her)gebruikt:
- Op Farm niveau; te gebruiken binnen een heel SharePoint farm;
- Op Site niveau: te gebruiken binnen sites en subsites;
- Op bibliotheek / lijst niveau: te gebruiken binnen lijsten en bibliotheken.
Meta datering op Farm niveau
Sinds SharePoint 2010 kunnen Content Types op Farm niveau worden gedefinieerd en op deze manier worden (her)gebruikt (gepubliceerd) binnen meerdere Site Collecties. Daarnaast kunnen sinds SharePoint 2010 ook taxonomieën (Managed Metadata, zie Managed metadata overview (SharePoint Server 2010) en Plan terms and term sets (SharePoint Server 2010)) op Farm niveau worden gedefinieerd en in het gehele Farm worden (her)gebruikt.
Meta datering op Site Collectie, Site en Subsite niveau
Vanaf SharePoint 2007 kunnen Content Types en Site Columns op ieder niveau binnen een Site Collectie worden gedefinieerd en worden gebruikt in de sites eronder. Definieer je een Site Column of Content Type in een bepaalde Site, dan verschijnt deze ook in de Site Column Gallery resp. Site Content Type Gallery in alle Subsites van de betreffende Site.
Meta datering op lijst - en bibliotheek niveau
Op het niveau van lijsten en bibliotheken kunnen kolommen en Site Columns (die gedefinieerd zijn in de site waarin de lijst of bibliotheek zich bevindt of een van de parent sites erboven) worden toegevoegd. Van een geselecteerde Site Column wordt een onafhankelijke kopie gemaakt die, als List Column, wordt gebruikt binnen de betreffende lijst of bibliotheek.
Ook kunnen Content Types worden toegevoegd die gedefinieerd zijn in de site waarin de lijst of bibliotheek zich bevindt en Content Types die in de sites erboven zijn gedefinieerd. Van het geselecteerde Content Type wordt dan een onafhankelijke kopie gemaakt die, als List Content Type, wordt gebruikt binnen de betreffende lijst of bibliotheek.
Beginnen met Content Types gebruiken in lijsten en bibliotheken
Om Content Types in lijsten en bibliotheken te kunnen gebruiken moet eerst in de instellingen van de betreffende lijst of bibliotheek ingesteld worden dat er gebruik wordt gemaakt van Content Types. Dit gaat via het menu: List settings > Advanced Settings > Allow management of content types.
Wanneer dit ingesteld is kunnen Site Content Types en Content Types van de bovenliggende sites worden toegevoegd
Wijzigingen doorvoeren in Columns en Content Types
Wanneer je een wijziging wilt doorvoeren in Content Types is het belangrijk een aantal zaken goed in de gaten te hebben en te houden:
- Op welk niveau de wijziging wordt doorgevoerd en welke consequenties dat heeft voor de onderliggende niveaus. De betrokken menu schermen zien er namelijk verradelijk eender uit;
- Welke consequenties de verschillende mogelijkheden die SharePoint biedt om additionele wijzigingen door te voeren hebben voor andere Content Types, lijsten en bibliotheken op hetzelfde niveau of andere niveaus.
Wat meer in detail...
Wijzigen in meta data structuren
Op de verschillende genoemde niveaus kunnen lijst/bibliotheek kolommen, Site Columns en Content Types gewijzigd worden. Deze wijzigingen kunnen vaak, naar believen ook op onderliggende niveaus worden doorgevoerd. Vantevoren nadenken over wijzigingen is aan te raden, omdat wijzigingen nadelige gevolgen kunnen hebben. Daarom hieronder uitleg over wat mogelijk is en wat hierbij de overwegingen kunnen zijn.
Toevoegen van Site Columns aan lijsten en bibliotheken
Wanneer een Site Column wordt toegevoegd aan lijsten of bibliotheken kan ervoor gekozen worden dat deze ook toegevoegd wordt aan alle Content Types die aan de betreffende lijst of bibliotheek zijn toegevoegd.
Toevoegen van Site Columns aan Site Content Types
Wanneer een Site Column wordt toegevoegd aan een Site Content Type kan ervoor gekozen worden dat deze ook toegevoegd wordt aan alle Content Types die afgeleid zijn van dit Content Type, zowel List – als Site Content Types. SharePoint vraagt dan: “Update all content types inheriting from this type?”
Toevoegen van Site Columns aan List Content Types
SharePoint biedt hier niet de mogelijkheid om alle Content Types met de toegevoegde Site Column bij te werken (Update all content types inheriting from this type?). Dat is logisch, want een List Content Type kent geen verdere afgeleide Content Types; het is immers een zelfstandige kopie van een bestaand Site Content Type.
Wijzigen van Site Columns
Een Site Column kan op het (site) niveau waarin het is aangemaakt, worden gewijzigd. Hierbij kan gekozen worden de wijziging door te voeren in alle Content Types, zowel List – als Site Content Types en in alle lijsten en bibliotheken (op alle niveau’s) die gebruik maken van de betreffende Site Column.
Wijzigen van List Columns
Een List Column (ook wanneer deze is afgeleid van een Site Column) kan direct in een lijst of bibliotheek worden gewijzigd. Wanneer een List Column deel uitmaakt van een List Content Type dan verandert dat niet doordat de betreffende List Column wordt gewijzigd. In de lijst/bibliotheek settings wordt achter de betreffende kolom nog steeds weergegeven dat de List Column uitmaakt van de oorspronkelijke List Content Type bij de betreffende kolom .
Wijzigen van het type van een (List) Column
Wanneer het type van een List Column (b.v. van een tekst naar een numerieke waarde) wordt gewijzigd geeft SharePoint een waarschuwing: “Changing the type of this column may result in loss of data. Are you sure that you want to change this column from <Type> to <Other Type>?”. De wijziging kan worden doorgevoerd, maar de afhankelijk van de Site Column waar de betreffende kolom van is afgeleid gaat deels verloren. Bestaande waarden worden omgezet in waarden van het nieuwe kolom type. Hierbij kan informatie verloren gaan. Hoe waarden worden omgezet is een nieuwe blogpost waard :).
Verwijderen van Site Columns
Site Columns kunnen niet verwijderd worden als ze nog in gebruik zijn in Site - en List Content Types Wanneer dit toch geprobeerd wordt, geeft SharePoint de volgende foutmelding: “Site Columns which are included in content types cannot be deleted. Remove all references to this prior to deleting it.”.
Wanneer een Site Column als losse kolom aan een lijst of bibliotheek is toegevoegd en de betreffende Site Column wordt verwijderd geeft SharePoint een waarschuwing (“This site column will be removed and list columns which were created from it will be permanently orphaned. Are you sure you want to delete this site column?”). Wanneer de betreffende Site Column toch wordt verwijderd, dan blijven de kopies die gemaakt zijn in de lijsten of bibliotheken bestaan, onder dezelfde naam, maar kunnen niet meer in een slag worden gewijzigd. Wijzigingen zullen dan in iedere lijst of bibliotheek apart moeten worden doorgevoerd.
Toevoegen van Content Types aan lijsten en bibliotheken
Wanneer een Site Content Type wordt toegevoegd aan een lijst of bibliotheek worden alle kolommen hierin opgenomen als kolommen in de betreffende lijst of bibliotheek. In de lijst/bibliotheek settings wordt dan achter de betreffende kolom weergegeven in welk List Content Type de betreffende kolom voorkomt.
Wijzigen van Site Content Types
Een Site Content Type kan op het (site) niveau waarin het is aangemaakt, worden gewijzigd. Hierbij kan gekozen worden de wijziging door te voeren in alle Content Types, zowel List – als Site Content Types (op alle niveau’s) die afgeleid zijn van het betreffende Content Type.
Wijzigen van List Content Types
Een List Content Type kan direct worden gewijzigd. Hierbij kan niet gekozen worden de wijziging door te voeren in afgeleide Content Types. Immers: een List Content kent geen afgeleide Content Types.
Verwijderen van Site Content Types
Wanneer Site Content Type in gebruik is binnen een lijst of bibliotheek, kan deze niet worden verwijderd. Wordt dit toch geprobeerd dan geeft SharePoint een foutmelding: “The content type is in use. Troubleshoot issues with Windows SharePoint Services. ”.
Verwijderen van List Content Types
Wanneer een List Content Type wordt verwijderd, worden de kolommen in dit List Content Type niet uit de lijst verwijderd, maar blijven bestaan als onafhankelijke List Columns.
Let op: als vervolgens een nieuw (List Content Type) wordt toegevoegd aan de lijst met een of meer kolomnamen die al in de lijst voorkomen, dan zullen in de betreffende lijst dubbele kolomnamen lijken voor te komen. In werkelijkheid geeft SharePoint aan deze nieuw toegevoegde kolommen nieuwe (interne) namen, gebaseerd op de kolomnaam waaraan een volgnummer is toegekend (b.v. MijnKolom0). Deze namen zijn zichtbaar in de URL van het edit formulier waarin de betreffende kolom details kunnen worden bekeken (FldEdit.aspx).
Valkuilen, voetangels en klemmen
In de bovenstaande wijzigingen heb ik al gehint naar risico’s. Voordat wijzigingen worden doorgevoerd zullen deze risico’s goed afgewogen moeten worden tegen de voordelen ervan.
Onderstaand een (niet compleet) lijstje van veel tegengekomen situaties…
Wijzigen van kolom typen kan verlies van data veroorzaken.
Doorvoeren van “uitzonderingen” op lagere niveaus verlaagt de beheerbaarheid van de informatie architectuur.
Hoe meer uitzonderingen, hoe groter de moeite die gedaan moet worden de uitzonderingen te beheren en hoe groter de kans dat uitzonderingen (maatwerk) worden overschreven door andere wijzigingen die ook doorgevoerd worden op lagere niveaus. Vooral de uitrol van Solutions waarbij de bestaande informatie architectuur “globaal” wordt gewijzigd (gestandaardiseerd) kan zorgen voor onverwachte wijzigingen.
Preventie:
- Beperken van uitzonderingen, documenteren ervan;
- Read-only maken van Site – en List Content types;
- Bepalen en implementeren van duidelijke regels voor het wijzigen van Content Types
In de “Advanced settings” van een Site – en List Content Type kan gekozen worden voor het read-only maken ervan (“Choose whether the content type is modifiable. This setting can be changed later from this page by anyone with permissions to edit this type. “).
Van een Site Content Type kan (in de advanced settings) gekozen worden voor het automatisch bijwerken van afgeleide Site – en List Content Types (“Specify whether all child site and list content types using this type should be updated with the settings on this page. This operation can take a long time, and any customizations made to the child site and list content types will be lost. Update all content types inheriting from this type? “).
Gelijktrekken van Site - en List Content Types
Wanneer Site Content Types en List Content Types niet meer gelijk zijn, dan kun je, door wijzigingen in het Site Content Type aan te brengen en deze wijzigingen in de onderliggende List Content Types door te laten voeren, de Site - en Lijst Content Types weer gelijk maken.
Voorbeeld:
Worden in een Site Content Type kolommen verwijderd en staan deze nog in de afgeleide List Content Types, dan kunnen deze verwijderde kolommen niet meer allemaal in een keer worden gewijzigd (b.v. Required / Optional gemaakt worden). De kolommen bevinden zich immers niet meer in het Site Content Type.
Wanneer de ontbrekende kolommen weer aan het Site Content Type worden toegevoegd kunnen wijzigingen hierop weer automatisch in de onderliggende List Content Types (waarin de kolommen dezelfde naam / type hebben) worden doorgevoerd. Soms is het nodig om daarbij kolom eigenschappen een extra keer te wijzigen om alle kolom eigenschappen weer gelijk te krijgen (b.v. Required / Optional maken).
Wees voorzichtig met het verwijderen van Site Columns
Wanneer een Site Column als losse kolom aan een lijst of bibliotheek is toegevoegd en de betreffende Site Column wordt verwijderd, dan blijven de kopies die gemaakt zijn in de lijsten of bibliotheken bestaan, onder dezelfde naam. Helaas kunnen deze kolommen niet meer in een slag worden gewijzigd. Wijzigingen zullen dan in iedere lijst of bibliotheek apart moeten worden doorgevoerd. Needless to say dat dit niet bevorderlijk is voor de beheersbaarheid.
Gelijktrekken van Site - en List Content Types
Wanneer Site Content Types en List Content Types niet meer gelijk zijn, dan kun je, door wijzigingen in het Site Content Type aan te brengen en deze wijzigingen in de onderliggende List Content Types door te laten voeren, de Site - en Lijst Content Types weer gelijk maken.
Voorbeeld:
Worden in een Site Content Type kolommen verwijderd en staan deze nog in de afgeleide List Content Types, dan kunnen deze verwijderde kolommen niet meer allemaal in een keer worden gewijzigd (b.v. Required / Optional gemaakt worden). De kolommen bevinden zich immers niet meer in het Site Content Type.
Wanneer de ontbrekende kolommen weer aan het Site Content Type worden toegevoegd kunnen wijzigingen hierop weer automatisch in de onderliggende List Content Types (waarin de kolommen dezelfde naam / type hebben) worden doorgevoerd. Soms is het nodig om daarbij kolom eigenschappen een extra keer te wijzigen om alle kolom eigenschappen weer gelijk te krijgen (b.v. Required / Optional maken).
Wees voorzichtig met het verwijderen van Site Columns
Wanneer een Site Column als losse kolom aan een lijst of bibliotheek is toegevoegd en de betreffende Site Column wordt verwijderd, dan blijven de kopies die gemaakt zijn in de lijsten of bibliotheken bestaan, onder dezelfde naam. Helaas kunnen deze kolommen niet meer in een slag worden gewijzigd. Wijzigingen zullen dan in iedere lijst of bibliotheek apart moeten worden doorgevoerd. Needless to say dat dit niet bevorderlijk is voor de beheersbaarheid.
Content Types met dezelfde naam kunnen op verschillende site niveaus worden aangemaakt.
Dit wekt natuurlijk verwarring en zal voorkomen moeten worden.
Preventie: gebruik unieke namen voor alle Content Types.
Verander standaard SharePoint Content Types niet
SharePoint kent een aantal standaard Content Types. Verander deze liever niet omdat ze de basis vormen van SharePoint en veel standaard (out of the box) lijsten en bibliotheken hierop zijn gebaseerd.
Content Type en Column Menus lijken veel op elkaar: verwar ze niet met elkaar
Door niet goed in de gaten te hebben op welk niveau een menu wordt gebruikt, kunnen onbedoeld wijzigingen worden doorgevoerd.
Remedie: goed letten op het niveau waarin de het menu zich evindt en de titel van het menu, b.v. “List Content Type” of “Site Content Type”.
Let op in welke groep je een kolom toevoegt
Let op in welke groep je een kolom toevoegt
Als je een kolom per ongeluk aan een verkeerde groep hebt toegevoegd en je hebt ervoor gekozen deze wijziging door te voeren op de onderliggende niveaus, dan wordt de betreffende kolom ook op de onderliggende niveaus in de verkeerde groep ondergebracht.
Remedie: goed opletten.
Let bij het wijzigen van Columns op het gebruik ervan in custom Page Layouts
Weleens gehoord van de SharePoint “Unknown error”? Een van de oorzaken hiervan kan zijn dat in een custom (aangepast) Page Layout wordt verwezen naar een Column die is gewijzigd.
Remedie: aanpassen van de betreffende Page Layout.
