D V1 van de browse en zoek applicatie

Transcriptie

1 D V1 van de browse en zoek applicatie Hennie Brugman Auteur : Hennie Brugman 16/09/ :09:00 AM page 1 of 10

2 1 Documenteigenschappen Rapportage datum: 16 september 2010 Rapportage periode: October 2009 december 2009 Versie: Concept / definitief Eventuele wijzigingen nvt tov vorige versie? 1.1 Document locatie Bestandsadres: content/uploads/2010/09/d browseen zoek app.doc 1.2 Historie Versie Datum Veranderingen Opdrachtgever Auteur(s) (concept/definitief) /9/10 Marius Snyders Hennie Brugman 1.3 Goedkeuring Dit document heeft de volgende goedkeuringen nodig. Naam Rol Opmerkingen Datum projectleider verantwoordelijke projectbureau Stuurgroep advies akkoord 1.4 Distributie De volgende personen hebben een exemplaar ontvangen. Naam Functie Datum Marius Snyders Projectleider CATCHPlus 16/9/10 Auteur : Hennie Brugman 16/09/ :09:00 AM page 2 of 10

3 Inhoud 1 Documenteigenschappen Document locatie Historie Goedkeuring Distributie... 2 Management samenvatting Bericht van oplevering Paragraaf 1... Fout! Bladwijzer niet gedefinieerd. 3 Gedetailleerde beschrijving van de deliverable Paragraaf 1... Fout! Bladwijzer niet gedefinieerd Subparagraaf 1... Fout! Bladwijzer niet gedefinieerd. 4 Licentie Demonstraties, toepassingen... Fout! Bladwijzer niet gedefinieerd. 6 Performance Conclusie Bijlagen... Fout! Bladwijzer niet gedefinieerd. Auteur : Hennie Brugman 16/09/ :09:00 AM page 3 of 10

4 Management samenvatting De Vocabulaire browser is primair een webgebaseerde generieke gebruikers interface voor de Vocabulary and Alignment Repository (VAS). Een gebruiker ziet in eerste instantie een overzicht van alle in de repository aanwezige vocabulaires, en kan daaruit een keuze maken. Indien aanwezig wordt dan een lijst van subthesauri getoond, anders een alfabetisch gerangschikte lijst van concepten. Deze lijst kan met behulp van autocompletion worden gefilterd. Selecteren van een concept geeft vervolgens informatie over dat concept, en stelt de gebruiker in staat verder te navigeren op basis van alle soorten relaties die dat concept mogelijk heeft met andere concepten (bredere/nauwere/gerelateerde concepten). De browser is een zelfstandig draaiende webapplicatie, die los van de VAS kan worden gehost. De vocabulaire browser heeft een aantal doelen: 1. visueel en interactief illustreren van het VAS repository concept 2. proof of concept: de browser is een prototype voor een willekeurige andere applicatie die over internet de VAS repository wil raadplegen 3. evalueren van verschillende thesauri met het oog op gebruik voor collectiebeschrijvingstaken. 4. Selecteren van concepten voor het beschrijven van digitale objecten, vooral door documentalisten/collectie beheerders. De browser is gefaseerd ontwikkeld en opgeleverd. Dit document betreft de eerste versie ervan. De browser is conform de specificaties opgeleverd, alle gerapporteerde bugs en tekortkomingen zijn inmiddels adequaat aangepakt. Alle hierboven genoemde doelen zijn gehaald. Vooral doel 2 is belangrijk geweest, in die zin, dat inmiddels breed draagvlak is ontstaan voor de VAS oplossing (als architectuurprincipe, als API en als werkende service). Auteur : Hennie Brugman 16/09/ :09:00 AM page 4 of 10

5 2 Bericht van oplevering 2.1 Beschrijving van de deliverable Opgeleverd is de eerste versie van een browse en zoek applicatie bij de Vocabulary and Alignment Repository (VAS) versie 1, deliverable D Deze applicatie is uitgevoerd als een op zichzelf draaiende en zelfstandig gehoste web applicatie. De data, die in deze applicatie wordt gebruikt en getoond komt uit de VAS, en wordt uitsluitend over internet opgehaald met behulp van de VAS REST API. Voor deze applicatie is in onderling overleg tussen het CATCHPlus projectbureau en de bouwer (de firma Q42) in meerdere iteraties een gebruikersinterface ontworpen en vervolgens gebouwd. De webapplicatie stelt gebruikers in staat te browsen over alle vocabulaires, die door de VAS worden gepubliceerd. Binnen zo n vocabulaire kan over concepten en de relaties tussen concepten worden genavigeerd. Vervolgens wordt beschikbare informatie getoond voor het actueel geselecteerde concept. De enige zoekfunctionaliteit die in deze versie wordt ondersteund is autocompletion over de termen van een geselecteerde (sub)thesaurus. De laatste versie van de webapplicatie wordt momenteel nog gehost door Q42. Een korte handleiding met betrekking tot implementatie, installatie en configuratie hoort bij de oplevering. De broncode is open source, maar nog niet op een publiek toegankelijke site als SourceForge gepubliceerd. Dit gebeurt nog in een later stadium 2.2 Gegevens met betrekking tot de oplevering Opleverdatum: 15 december 2009 Plaats: kantoor Q42, Den Haag Aanwezig: Hennie Brugman, Marius Snyders, Kars Veling (Q42) 2.3 Mate van succes De deliverable is geheel conform de initiële specificaties. Deze specs voorzagen al in een fasering in minimaal twee versies. Bovendien waren ze bewust redelijk globaal, omdat user interface design expliciet deel van de opdracht uitmaakte. Alle gevonden en gerapporteerde bugs zijn opgelost, en de performance van de applicatie is uitstekend. De ontworpen user interface is functioneel en effectief, en ziet er aantrekkelijk uit. De applicatie beantwoordt daarmee aan zijn doelen. De beschikbaarheid van de vocabulaire browser heeft in aanzienlijke mate bijgedragen aan het succes van de VAS zelf. Auteur : Hennie Brugman 16/09/ :09:00 AM page 5 of 10

6 3 Gedetailleerde beschrijving van de deliverable De Vocabulaire browser is primair een webgebaseerde generieke gebruikers interface voor de Vocabulary and Alignment Repository. Een gebruiker ziet in eerste instantie een overzicht van alle in de repository aanwezige vocabulaires, en kan daaruit een keuze maken. Indien aanwezig wordt dan een lijst van subthesauri getoond, anders een alfabetisch gerangschikte lijst van concepten. Deze lijst kan met behulp van autocompletion worden gefilterd. Selecteren van een concept geeft vervolgens informatie over dat concept, en stelt de gebruiker in staat verder te navigeren op basis van alle soorten relaties die dat concept mogelijk heeft met andere concepten (bredere/nauwere/gerelateerde concepten). Deze versie van de browser kent geen voorzieningen voor gebruikers authenticatie (de corresponderende versie v1 van de VAS trouwens ook niet). De browser is een zelfstandig draaiende webapplicatie, die los van de VAS kan worden gehost. Communicatie met de VAS gaat uitsluitend over internet via (REST) http requests. Data wordt aan de browser aangeleverd in JSON formaat. De vocabulaire browser heeft een aantal doelen: visueel en interactief illustreren van het VAS repository concept proof of concept: de browser is een prototype voor een willekeurige andere applicatie die over internet de VAS repository wil raadplegen evalueren van verschillende thesauri met het oog op gebruik voor collectiebeschrijvingstaken. Selecteren van concepten voor het beschrijven van digitale objecten, vooral door documentalisten/collectie beheerders. 3.1 Onderdelen van de deliverable De vocabulaire browser deliverable omvat verschillende componenten: Installatie en configuratie handleiding: content/uploads/2010/09/technische documentatie vocrepbrowser.docx Gebruikershandleiding: De gebruikersinterface wordt geacht zonder gebruikershandleiding te kunnen worden gebruikt. Een aparte handleiding is daarom overbodig bevonden. Broncode: is open source, maar nog niet online beschikbaar gemaakt. Bij de afronding van de laatste versie van de vocabulaire browser wordt de broncode door Q42 op SourceForge gepubliceerd. De actuele versie van de browser is momenteel online beschikbaar op: Deze hosting door Q42 is nog tot eind 2010 toegezegd, daarna draagt het CATCHPlus projectbureau zorg voor hosting elders. Auteur : Hennie Brugman 16/09/ :09:00 AM page 6 of 10

7 3.2 Bugs en beperkingen Alle gerappporteerde bugs voor deze versie zijn inmiddels afgehandeld. Nog bestaande beperkingen worden aangepakt in versie 2 van deze applicatie. Voor een beschrijving van deze beperkingen, zie toekomstperspectief. 3.3 Toekomstperspectief Er is van meet af aan voorzien in een tweede versie van de vocabulaire browser (zie D 1.1.9). Deze versie omvat de volgende functionaliteit: Sorteren van smallere, bredere en gerelateerde concepten op alfabet Tonen en browsen van Alignments Een zoekfunctie, met eenvoudig en gestructureerd zoeken, over de hele repository, die het onder meer mogelijk maakt op language te zoeken, te specificeren in welke labels wordt gezocht (preflabel voorkeursterm, altlabel nietvoorkeursterm), en welke type matching wordt gebruikt (complete string, substring, reguliere expressie, etc) Een elementaire vorm van authenticatie, waardoor netjes kan worden omgegaan met licentievoorwaarden op de vocabulaires in de repository Compatibiliteit met de meest gangbare internet browsers (Firefox, Internet Explorer) Beschikbaar stellen van de source code op SourceForge. Auteur : Hennie Brugman 16/09/ :09:00 AM page 7 of 10

8 4 Licentie De broncode komt beschikbaar onder de voorwaarden van de GNU Public License versie 3.0. Auteur : Hennie Brugman 16/09/ :09:00 AM page 8 of 10

9 5 Performance Er zijn geen performance problemen gesignaleerd gedurende de periode waarin de browser in gebruik is. Performance problemen zijn ook niet te verwachten: de bottleneck ligt bij de centrale vocabulary service en bij de communicatie over internet. Fs;dlf Auteur : Hennie Brugman 16/09/ :09:00 AM page 9 of 10

10 6 Conclusie De eerste versie van de browse en zoekapplicatie voor de CATCHPlus Vocabulary and Alignment Service is succesvol opgeleverd. Deze browser is inmiddels frequent gebruikt voor demonstraties en voor het inspecteren van de inhoud van de VAS, door leden van het projectbureau, door bedrijven en door erfgoedprofessionals. Het beschikbaar zijn van deze browser heeft bekendheid met, en draagvlak voor de VAS benadering en implementatie sterk vergroot. Auteur : Hennie Brugman 16/09/ :09:00 AM page 10 of 10