|
|
|
# Inhoud #
|
|
|
|
- [Inleiding](/Gebruikershandreiking)
|
|
|
|
- [Instructies voor lokaal gebruik](/Gebruikshandreiking/Instructies-voor-lokaal-gebruik)
|
|
|
|
- [Instructies voor centraal gebruik](/Gebruikshandreiking/Instructies-centraal-gebruik)
|
|
|
|
- [Gebruikersscenario's](/Gebruikshandreiking/Gebruikersscenario's)
|
|
|
|
# Inhoud
|
|
|
|
|
|
|
|
* [Inleiding](/Gebruikershandreiking)
|
|
|
|
* [Instructies voor lokaal gebruik](/Gebruikshandreiking/Instructies-voor-lokaal-gebruik)
|
|
|
|
* [Instructies voor centraal gebruik](/Gebruikshandreiking/Instructies-centraal-gebruik)
|
|
|
|
* [Gebruikersscenario's](/Gebruikshandreiking/Gebruikersscenario's)
|
|
|
|
|
|
|
|
# Voor wie zijn deze instructies?
|
|
|
|
|
|
|
|
# Voor wie zijn deze instructies? #
|
|
|
|
Houdt u zich bezig met het vastleggen van indicatoren voor het kwaliteitsregister? Dan zult u gebruik gaan maken van de KIK-Starter decentraal.
|
|
|
|
|
|
|
|
# Uitgangspunten #
|
|
|
|
# Uitgangspunten
|
|
|
|
|
|
|
|
Voor een optimaal gebruik van de decentrale KIK-Starter moet worden voldaan aan de volgende punten:
|
|
|
|
- U bent bekend met het concept van de ontologie.
|
|
|
|
- U beschikt over een digitale versie van de globale VPH ontologie, zodat validatiecriteria uitvoerbaar zijn.
|
|
|
|
- U weet hoe u data uit uw bronsysteem kunt (laten) omzetten naar linked data.
|
|
|
|
- U heeft de decentrale KIK-Starter geïnstalleerd conform de instructies op deze website.
|
|
|
|
- U bent bekend met de manier waarop Docker omgaat met gegevens in het geheugen.
|
|
|
|
|
|
|
|
# Opslag van gegevens in Docker #
|
|
|
|
* U bent bekend met het concept van de ontologie.
|
|
|
|
* U beschikt over een digitale versie van de globale VPH ontologie, zodat validatiecriteria uitvoerbaar zijn.
|
|
|
|
* U weet hoe u data uit uw bronsysteem kunt (laten) omzetten naar linked data.
|
|
|
|
* U heeft de decentrale KIK-Starter geïnstalleerd conform de instructies op deze website.
|
|
|
|
* U bent bekend met de manier waarop Docker omgaat met gegevens in het geheugen.
|
|
|
|
|
|
|
|
# Opslag van gegevens in Docker
|
|
|
|
|
|
|
|
Als u voor uw KIK-Starter Decentraal de software van Docker op een server draait, heeft u een uur de tijd om uw validatie te doen of data te (up)loaden. Zolang Docker draait op uw server, dan houdt Docker de data voor maximaal een uur vast. Zodra Docker wordt uitgeschakeld dan is alles wat u had geladen weg. Behalve wanneer u reeds data heeft geüpload naar KIK-Starter Centraal.
|
|
|
|
|
|
|
|
# Hoe gebruik ik de decentrale KIK-Starter? #
|
|
|
|
# Hoe gebruik ik de decentrale KIK-Starter?
|
|
|
|
|
|
|
|
Hieronder wordt stap voor stap toegelicht hoe u de decentrale KIK-Starter gebruikt. U heeft de decentrale KIK-Starter binnen uw netwerkomgeving geïnstalleerd volgens de instructies op deze website. Daarbij heeft u rekening gehouden met het aantal gebruikers en de minimale beveiligingsmaatregelen die op deze website zijn voorgesteld. Zie installatiehandleiding.
|
|
|
|
|
|
|
|
## Stap 1: extractie/export data uit bronsysteem ##
|
|
|
|
U dient uw data als triples (RDF-formaat) aan te leveren. Extraheer uw data vanaf uw bronsysteem. Verwerk de data tot RDF-data op basis van de KIK-V Verpleeghuisontologie en eventueel op basis van uw lokale ontologie. Daarbij moet uw lokale ontologie in lijn zijn met de KIK-V Verpleeghuisontologie.
|
|
|
|
De data moet in RDF-ondersteunend formaat worden aangeleverd: Turtle, JSON-LD of RDF/XML.
|
|
|
|
## Stap 1: extractie/export data uit bronsysteem
|
|
|
|
|
|
|
|
U dient uw data als triples (RDF-formaat) aan te leveren. Extraheer uw data vanaf uw bronsysteem. Verwerk de data tot RDF-data op basis van de KIK-V Verpleeghuisontologie en eventueel op basis van uw lokale ontologie. Daarbij moet uw lokale ontologie in lijn zijn met de KIK-V Verpleeghuisontologie. De data moet in RDF-ondersteunend formaat worden aangeleverd: Turtle, JSON-LD of RDF/XML.
|
|
|
|
|
|
|
|
## Stap 2a: uploaden ontologie en RDF
|
|
|
|
|
|
|
|
## Stap 2a: uploaden ontologie en RDF ##
|
|
|
|
Open vanaf uw browser de decentrale KIK-Starter op het adres dat binnen uw netwerkomgeving daarvoor is gereserveerd. De KIK-Starter heeft tijd nodig om te laden. Daarom kan er een melding in beeld verschijnen dat de dataset niet beschikbaar is.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Ontologie en triples ###
|
|
|
|
Upload een lokale ontologie in een OWL-bestand samen met de RDF-data. De KIK-Starter Centraal bevat een nationale VPH-ontologie en eventueel andere nationale ontologieën en deze worden automatisch door de Update service van KIK-Starter naar uw KIK-Starter Decentraal gedownload.
|
|
|
|
Voor testdoeleinden [download hier](https://repository.istandaarden.nl/kik-v/starter/-/wikis/home#demo) een OWL-bestand.
|
|
|
|
### Ontologie en triples
|
|
|
|
|
|
|
|
Upload een lokale ontologie in een OWL-bestand samen met de RDF-data. De KIK-Starter Centraal bevat een nationale VPH-ontologie en eventueel andere nationale ontologieën en deze worden automatisch door de Update service van KIK-Starter naar uw KIK-Starter Decentraal gedownload. Voor testdoeleinden [download hier](https://repository.istandaarden.nl/kik-v/starter/-/wikis/home#demo) een OWL-bestand.
|
|
|
|
|
|
|
|
Zodra u de bestanden heb gekozen, druk op de knop "Upload".
|
|
|
|
|
|
|
|
Zodra u de bestanden heb gekozen, druk op de knop "Upload". 
|
|
|
|
|
|
|
|
## Stap 2b: Bestaande data
|
|
|
|
|
|
|
|
## Stap 2b: Bestaande data ##
|
|
|
|
Indien u eerder een ontologie met RDF-data heeft geüpload dan kunt u die selecteren. Dit is alleen mogelijk voor zolang uw applicatie actief is. Zodra u de applicatie deactiveert in Docker, is de data niet langer beschikbaar. Dit moet de volgende keer opnieuw worden ingeladen.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Stap 3: Valideren ##
|
|
|
|
## Stap 3: Valideren
|
|
|
|
|
|
|
|
U kiest de juiste versie gegevensset/ontologie en geeft aan dat het systeem de data moet valideren. Het systeem gebruikt vervolgens de gespecificeerde validatieregels en toont het resultaat.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Kies de versie van de ontologie.
|
|
|
|
|
|
|
|
Klik op de knop "Valideer". En de decentrale KIK-Starter toont de resultaten van de validatie in een tabel met welk element is gecontroleerd en wat er fout aan is. Betekenis van rondje met kruisje is dat het een fout betreft, dus blokkerend voor verwerking van dat gegeven. Dat gegeven zal dus in een latere uitvraag niet worden meegenomen. Het is echter niet blokkerend voor het uploaden van de gegevens. Dit heeft echter wel gevolgen voor de mate van compleetheid van het queryresultaat.
|
|
|
|
Het symbool met driehoek is een waarschuwing. Dit heeft echter geen gevolgen voor de compleetheid en is niet blokkerend.
|
|
|
|
Klik op de knop "Valideer". En de decentrale KIK-Starter valideert de data op basis van de vastgestelde validatieregels (_verwijzing naar validatieregels komt hier_).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Bij fouten in de validatie is het de bedoeling de oorzaak daarvan in de eigen bronsysteem te herstellen.
|
|
|
|
De KIK-Starter meldt wanneer er wel/geen fouten zijn gevonden. Voor een rapport van de validatie klik op "Download als Excel". Bij fouten in de validatie is het de bedoeling de oorzaak daarvan in de eigen bronsysteem te herstellen.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
U kunt de resultaten downloaden in Excel-bestand. Daarvoor klikt u op de knop "Download als Excel".
|
|
|
|
Het rapport is opgedeeld in een aantal tabbladen:
|
|
|
|
|
|
|
|
1. Voorpagina: details over ontologie, dataset, modelgegevens, datum en toepassingsversie.
|
|
|
|
2. Resultaten
|
|
|
|
3. Toegepaste validatieregels
|
|
|
|
|
|
|
|
### Resultaten
|
|
|
|
|
|
|
|
Hieronder een toelichting op de attributen op tabblad "Resultaten".
|
|
|
|
|
|
|
|
* Type: ernst van de fout, fout is blokkerend.
|
|
|
|
* Element: Gegevenselement zoals Contract, Arbeidsovereenkomst
|
|
|
|
* Pad : Relatie tussen subject en object.
|
|
|
|
* Fout: toelichting op wat de fout inhoudt.
|
|
|
|
1. 
|
|
|
|
|
|
|
|
### Toegepaste validatieregels
|
|
|
|
|
|
|
|
Op tabblad "Toegepaste validatieregels" treft u de volgende informatie aan:
|
|
|
|
|
|
|
|
* De Fout: omschrijving van de fout.
|
|
|
|
* Geactiveerd: de toegepaste regel. Indien er Geactiveerd = 0 betekent dat de regel niet is toegepast.
|
|
|
|
* Fouten: het aantal gedetecteerde fouten; het aantal keer dat een relevant gegeven niet voldeed aan de validatieregel.
|
|
|
|
* Voldaan: procentuele verhouding van het aantal relevante gegevens dat voldeed aan de validatieregel ten opzichte van het totaal aantal gecontroleerde relevante gegevens.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Stap 4: Raadplegen
|
|
|
|
|
|
|
|
## Stap 4: Raadplegen ##
|
|
|
|
Het is mogelijk om een standaard query toe te passen voor uw raadpleging. Tevens kunt u uw eigen SPARQL-query invoeren.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Stap 5: Uitkomst query exporteren ##
|
|
|
|
Net zoals bij de uitkomst van het valideren van de data, is het ook mogelijk de uitkomst van een query te exporteren.
|
|
|
|
Klik daarvoor op de knop "Download als Excel".
|
|
|
|
## Stap 5: Uitkomst query exporteren
|
|
|
|
|
|
|
|
Net zoals bij de uitkomst van het valideren van de data, is het ook mogelijk de uitkomst van een query te exporteren. Klik daarvoor op de knop "Download als Excel".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Converteren naar linked data
|
|
|
|
Indien u uw data heeft geexporteerd uit uw bronsysteem in de vorm van relationele data, dan kunt u met de KIK-Starter decentraal de relationele data omzetten naar linked data.
|
|
|
|
Hiervoor moet de relationele data wel overeenkomen met een sjabloon of referentieontwerp. Indien dat niet het geval is, dan moet er mogelijk een sjabloon voor de conversie op maat worden gemaakt.
|
|
|
|
|
|
|
|
Kies bij "Conversie*" voor "Upload".
|
|
|
|
Indien u uw data heeft geexporteerd uit uw bronsysteem in de vorm van relationele data, dan kunt u met de KIK-Starter decentraal de relationele data omzetten naar linked data. Hiervoor moet de relationele data wel overeenkomen met een sjabloon of referentieontwerp. Indien dat niet het geval is, dan moet er mogelijk een sjabloon voor de conversie op maat worden gemaakt.
|
|
|
|
|
|
|
|
Kies bij "Conversie\*" voor "Upload".
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Kies bestand met specificaties hoe de conversie moet worden uitgevoerd.
|
|
|
|
Kies het bestand met de juiste ontologie.
|
|
|
|
Kies het databestand met ruwe data uit het bronsysteem
|
|
|
|
Kies bestand met specificaties hoe de conversie moet worden uitgevoerd. Kies het bestand met de juiste ontologie. Kies het databestand met ruwe data uit het bronsysteem
|
|
|
|
|
|
|
|
|
|
|
|
|
| ... | ... | @@ -102,4 +135,5 @@ Het is zichtbaar (donkere weergave en statusbalk) dat de toepassing aan het werk |
|
|
|
U kunt de data nu raadplegen, valideren en de query resultaten uploaden naar KIK-Starte Centraal.
|
|
|
|
|
|
|
|
# Uploaden query resultaten
|
|
|
|
|
|
|
|
Indien de standaard query resultaten geeft, dan kunt u ervoor kiezen de resultaten te uploaden naar de KIK-Starter decentraal. Let op: zodra u de standaard query wijzigt, en het niet meer standaard is, dan is het ook niet meer mogelijk de resultaten daarvan te uploaden. |
|
|
\ No newline at end of file |
