Zorginformatiebouwstenen: publicaties en groepen

Uit Zorginformatiebouwstenen
Versie door Albert-Jan Spruyt (overleg | bijdragen) op 21 jan 2019 om 21:33 (Groep en Release beheer gebruikersinterface)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Ga naar: navigatie, zoeken

Manual pagina's

Korte beschrijving

De functionaliteit van de applicatie GroupRelease bestaat uit twee delen, het beheer van groepen en het beheer van (pre)publicaties.

Warning-icon.png Voor het configureren van zowel groepen als publicatie moeten de zib's eerst geregistreerd worden (met applicatie ZibExtraction)

Groepen

Op de wikistartpagina van een publicatie staan de beschikbare zib's opgesomd ingedeeld in groepen. Dit is uitsluitend een hulpmiddel om het zoeken eenvoudiger te maken.
Met de applicatie GroupRelease is het mogelijk de groepen te beheren. Zib's kunnen hiermee in en uit groepen geplaatst worden, nieuwe groepen kunnen aangemaakt worden en oude verwijderd.
de indeling in een groep is geen eigenschap van de zib's en staat los van de publicatie indelingen. De groepsindeling kan dus ook op ieder gewenst moment als gevolg van nieuwe inzichten gewijzigd worden, zonder dat dit wijzigingen aan de zib's of publicaties met zich mee brengt.
De indeling is echter niet dynamisch: de wikistartpagina moet opnieuw met ZibExtraction aangemaakt worden om de indeling actueel te maken, maar de zib's wikipagina's hoeven niet opnieuw gemaakt te worden.

Warning-icon.png De groepsindeling staat los van de publicaties. Dit houdt in dat als de startpagina van een oudere publicatie opnieuw gegenereerd wordt, de nieuwe indeling toegepast wordt.

Publicaties

Van vrijwel iedere zib zijn meerdere versies beschikbaar. Omdat zib's (versieloos) naar andere zibs verwijzen, is er een afspraakmechanisme bovenop de zib's nodig om te komen tot consistente sets van zib's.
De verschijningsvorm van deze afspraken zijn (pre)publicaties. In deze afspraken wordt eenduidig vastgelegd welke versie van welke zib onderdeel uitmaakt van een bepaalde set.
Omdat alleen verwezen mag worden naar zib's die in deze set opgenomen zijn, is hiermee tevens duidelijk naar welke versie van een zib's verwezen wordt binnen de context van een set.
Omdat een bepaalde versie van een zib dus per definitie in meerdere (pre)publicaties kan voorkomen, moet de inhoud van een publicatie los van de zib's vastgelegd worden.
Ook hiervoor is de applicatie GroupRelase beschikbaar. Hiermee kan voor een (pre)publicatie aangegeven worden welke zib's (en in welke versie) deel uitmaken van deze (pre)pubicatie.
Het identificerende kenmerk van een publicatie is het jaartal van verschijnen. Conform de afspraken is er per jaar maximaal één publicatie.
Prepublicatie's hebben als kenmerk ook het jaartal van verschijnen. Een volgende (pre)publicatie in hetzelfde jaar overschrijft - zoals afgesproken - de eerdere prepublicatie, voor zover die aanwezig is.
Indien in een jaar uitsluitend een prepublicatie verschijnt, wordt deze bij het verschijnen van de (eerste pre)publictie van het volgende jaar verwijderd uit de lijst van beschikbare publicaties.

Groep en Release beheer gebruikersinterface

Het programma GroupRelease kent de volgende besturingselementen:

Groepen

GroepReleaseUI 1.png
Figuur 1: Groep mode gebruikersinterface
  1. Menubalk
    Opslaan: Opslaan van de wijzigingen en afsluiten van de applicatie
    Sluiten: Afsluiten van de applicatie. Als er wijzigingen zijn gedaan, wordt gevraagd of deze opgeslagen moeten worden.
    Backup: Heeft één submenu item:
    • Maak backup voor afsluiten: Vinkvak: Indien aangevinkt wordt voor het opslaan van de wijzigingen eerst een backup gemaakt.1
    Help: Heeft twee submenu items:
    • Over: Informatie over de applicatie
    • Help pagina: Gebruiksaanwijzing van de applicatie (deze pagina)
  2. Alle Zib's
    De listbox toont de namen van alle geregistreerde zib's.
  3. Beschikbare versies
    Indien in de bovenliggende lijst een zib geselecteerd is, worden alle geregistreerde versies van die zib getoond.
  4. Groepen/Releases tabbladen
    Kiezen voor beheer van groepen of releases
  5. Alle Zib groepen
    Tekstbox toont alle groepen en biedt de mogelijkheid er één te selecteren.
  6. Nieuwe groep aanmaken
    In de tekstvelden onder de titel kan de naam van de nieuwe groep in de ondersteunde talen ingevoerd worden.
  7. Actieknoppen
    Verwijderen: Verwijderen geselecteerde groep.
    Toevoegen: Aanmaken nieuwe groep. Knop wordt actief na vullen groepsnamen.
  8. Groepslistboxen
    Rechter paneel geeft de zibs aan die tot de geselecteerde groep behoren, de linker toont de zibs die tot geen één groep behoren.
  9. Actieknoppen
    Wis selectie: Wis de selectie in het betreffende paneel (2x).
    Verwijder uit groep: Verwijder geselecteerde zib's uit de groep
    Toevoegen aan groep: Voeg geselecteerde zib's toe aan groep
  10. Statusbalk
    Geeft de locatie aan waar de groep/release configuratie file is opgeslagen.

1 De naam van de backupfile is ZibReg_Backup_[yyyyMMddHHmmss].cfg. Het terugzetten van een backup dient handmatig gedaan te worden door de gewenste backup te hernoemen naar ZibReg.cfg

Publicaties

GroepReleaseUI 2.png
Figuur 2: Release mode gebruikersinterface
  1. Groepen/Releases tabbladen
    Kiezen voor beheer van groepen of releases
  2. Alle Releases
    Tekstbox toont alle groepen en biedt de mogelijkheid er één te selecteren.
  3. Nieuwe release aanmaken
    In het tekstveld 'Release jaar' kan het nieuwe releasejaar ingevuld worden. Als het veld gevuld wordt, wordt de knop 'Toevoegen' actief en de releaseomschrijvingsvelden gewist.
  4. Release omschrijving aanmaken/wijzigen
    De velden tonen de omschrijving van de geselecteerde release. Bij een nieuwe release dienen hier de beschrijvingen in de ondersteunde talen ingevuld te worden.
  5. ART-DECOR gegevens
    Gegevens noodzakelijk voor de juiste koppeling naar ART-DECOR. Vulling in overleg ART-DECOR beheerder
  6. Actieknoppen
    Verwijderen: Verwijderen geselecteerde release.
    Wijzigen: Wijzigen releaseomschrijving van de geselecteerde groep. Knop wordt actief na vullen releaseomschrijving velden
    Toevoegen: Aanmaken nieuwe release. Knop wordt actief na vullen releasejaar veld.
  7. Release listboxen
    Rechter paneel geeft de zibs en hun versie aan die tot de geselecteerde release behoren, de linker toont de zibs die niet tot de release behoren.
  8. Versie keuze pop-up
    Dialoog wordt getoond als een zib, waar meer dan één versie van bestaat, toegevoegd wordt aan de release.
  9. Actieknoppen
    Wis selectie: Wis de selectie in het betreffende paneel (2x).
    Wijzig versie: Verander de versie van een zib uit de release
    Verwijder: Verwijder geselecteerde zib's uit de release
    Voeg toe: Voeg geselecteerde zib's toe aan release
    CheckBox.png Hoogste versie: Voeg van de voor toevoegen geselecteerde zib's de hoogste versie toe.
  10. Statusbalk
    Geeft de locatie aan waar de groep/release configuratie file is opgeslagen.

Gebruik

Groepen

Warning-icon.png Om nieuwe groepen aan te maken of zib's aan een groep toe te voegen, moeten er groeploze zib's zijn.
Om een nieuwe indeling te maken, moeten eerst oude groepen weggegooid te worden. De vrijgekomen zib's komen dan automatisch in de lijst 'Groeploze zib's'
Nieuwe groep aanmaken

Type in de velden onde de kop 'Nieuwe groep aanmaken' de naam van de nieuwe groep in de ondersteunde talen.
Selecteer in de listbox 'Groeploze ZIB's de zib's die aan de groep moeten worden toegevoegd.
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk op de knop 'Voeg toe aan groep' om de zibs toe te voegen.
Herhaal de stappen eventueel om meer zib's toe te voegen.

Groep verwijderen

Selecteer in de lijst 'Alle ZIB groepen' de te verwijderen groep.
Druk op de knop 'Verwijderen' om de geselecteerde groep te verwijderen.
De zib's die tot de verwijderde groep behoorden, verschijnen nu in de lijst met groeploze zib'.

Zib's aan groep toevoegen

Selecteer in de listbox 'Alle ZIB groepen' de groep waar de zib's aan toegevoegd moeten worden.
Selecteer in de listbox 'Groeploze ZIB's' de zib's die aan de groep moeten worden toegevoegd..
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk op de knop 'Voeg toe aan groep' om de zibs toe te voegen.
Herhaal de stappen eventueel om meer zib's toe te voegen.

Zib's uit groep verwijderen

Selecteer in de listbox 'Alle ZIB groepen' de groep waaruit de zib's verwijderd moeten worden.
Selecteer in de linker listbox de zib's die uit de groep verwijderd moeten worden.
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk op de knop 'Verwijder uit groep' om de zibs te verwijderen.
Herhaal de stappen eventueel om meer zib's te verwijderen.

Publicaties

In onderstaande beschrijving worden de term publicatie en release door elkaar gebruikt voor hetzelfde begrip. 
Op de zib wikipagina's is de term publicatie gereserveerd voor de Nederlandse pagina's en de term release voor de Engelse.
Nieuwe publicatie aanmaken

Type in de veld 'Release jaar' onder de kop 'Nieuwe release' het verschijningjaar van de nieuwe release. Het jaar mag nog niet ingebruik zijn.
Om het vullen van de release te vereenvoudigen, kan eerst een bestaande release geselecteerd worden en het vinkvak 'Kopieer release' aan te vinken.
De nieuwe release wordt dan al gevuld met de zibs die voor de eerder geselecteerde release gekozen waren.
Door het vullen van het releasejaar worden de release omschrijving velden en de ART-DECOR velden gewist en wordt de knop 'Toevoegen' actief.
Vul de release omschrijving velden met de omschrijvingen van de nieuwe release in de ondersteunde talen. De ART-DECOR velden wordtn na het correct invullen van het release jaar automatisch gevuld.
Check, eventueel in overleg met de ART-DECOR beheerder, of de voorgestelde waarden correct zijn en indien nodig, verbeter ze.
Druk op de knop 'Toevoegen' om de release aan te maken. De listbox 'ZIB's in release nnnn' wordt gewist indien vinkvak 'Kopieer release' niet aangevinkt is en anders met de vulling van de gekopieerde release.
De listbox 'Niet in release' bevat nu de zib's die niet in de release zitten. Indien vinkvak 'Kopieer release' niet aangevinkt is zijn dit dus alle zib's.
Volgens moet de release gevuld worden. Daartoe worden de volgende stappen gedaan worden:
Selecteer in de listbox 'Niet in release' de zibs die aan de release toegevoegd moeten worden.
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk vervolgens op de knop 'Voeg toe' om de zibs toe te voegen. Indien van een zib meerdere versies bestaan, zal het versiedialoog venster geopend worden en kan de gewenste versie gekozen worden.
Als het vinkvak 'Hoogste versie' aangevinkt is zal automatisch de hoogste versie genomen worden en zal het dialoogvenster niet verschijnen.
Herhaal de stappen eventueel om meer zib's toe te voegen.
Indien bij het aanmaken van de nieuwe release een eerdere release gekopieerd werd, kan het voorkomen dat de nieuwe release een foutieve (oudere) versie van een aantal zibs bevat.
Om dit te corrigeren kan de betreffende zib geselecteerd worden in de 'ZIB's in release nnnn' listbox.
Indien vervolgens op de knop 'Wijzig versie' gedrukt wordt, zal het het versiedialoog venster geopend worden en kan de gewenste versie gekozen worden.

Release verwijderen

Selecteer in de lijst 'Alle releases' de te verwijderen release.
Druk op de knop 'Verwijderen' om de geselecteerde release te verwijderen.

Release informatie wijzigen

Selecteer in de lijst 'Alle releases' de release waarvan de informatie gewijzigd moet worden.
De release informatie van de geselecteerde release verschijnt in de velden 'Release informatie' en de ART-DECOR velden.
Wijzig de informatie naar behoefte. Op moment dat de informatie in de velden gewijzigd wordt, zal de knop 'Wijzigen' actief worden.
Mocht het wijzigen om welke reden dan ook afgebroken moeten worden, volstaat het om in de 'Alle releases' listbox een andere release te selecteren. De al aangebrachte wijzigingen worden daarmee gewist.
Als de wijzigingen wel goed aangebracht zijn en opgeslagen moeten worden, wordt op de knop 'Wijzigen' gedrukt.

Zib's aan release toevoegen

Selecteer in de listbox 'Alle releases' de release waar de zib's aan toegevoegd moeten worden.
Selecteer in de listbox 'Niet in release' de zibs die aan de release toegevoegd moeten worden.
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk vervolgens op de knop 'Voeg toe' om de zibs toe te voegen. Indien van een zib meerdere versies bestaan, zal het versiedialoog venster geopend worden en kan de gewenste versie gekozen worden.
Als het vinkvak 'Hoogste versie' aangevinkt is zal automatisch de hoogste versie genomen worden en zal het dialoogvenster niet verschijnen.
Herhaal de stappen eventueel om meer zib's toe te voegen.

Zib's uit release verwijderen

Selecteer in de listbox 'Alle ZIB groepen' de groep waaruit de zib's verwijderd moeten worden.
Selecteer in de linker listbox de zib's die uit de release verwijderd moeten worden.
Er kunnen meerdere zibs geselecteerd worden op de in Windows gebruikelijke methode met de Ctrl en Shift toetsen.
Indien de selectie foutief is, kan deze met de knop 'Wis selectie' onder de listbox gewist worden.
Druk op de knop 'Verwijder' om de zibs te verwijderen.
Herhaal de stappen eventueel om meer zib's te verwijderen.

Afsluiten van de applicatie

De applicatie kan gesloten worden met de menu knoppen en op de gebruikelijke Windows manieren (rode kruis, alt F4 etc.)

Warning-icon.png De knoppen 'Wijzigen', 'Toevoegen' en 'Verwijderen' wijzigen alleen de configuratie in het geheugen, niet in het configuratie bestand.
Daarom moeten na wijzigingen altijd ook nog het menu item 'Opslaan' geselecteerd worden. Hiermee worden de wijzigingen ook in het bestand opgeslagen.

Als er wijzigingen aangebracht zijn en de applicatie op een of andere wijze afgesloten wordt zonder dat de wijzigingen opgeslagen zijn,
wordt een dialoog getoond worden met de vraag of de wijzigingen alsnog opgeslagen moeten worden.

Configureerbare gegevens

Naam Beschrijving Gebruik Locatie Huidige waarde Wijzigbaar via UI
WikiBase De basis url van deze wiki Hiermee wordt de url van deze pagina aangemaakt. ZibAppsStart.cfg https://zibs.nl/wiki Nee
UserConfigLocation Locatie locaal bestand met configuraties Voorgeconfigureerde publicatie settings ZibAppsStart.cfg C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction Nee
CommonConfigLocation Locatie gedeelde configuratiedata Acties op het groep/release configuratie bestand ZibExtraction.cfg C:\ProgramData\Nictiz\ZibExtraction\Config Ja

Vaste gegevens

Naam Beschrijving Gebruik Vaste locatie
ZibAppsStart.cfg Basis configuratie bestand Bevat opstartconfiguratiedata voor Zib app's C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction