ZibExtraction: verschil tussen versies

Uit Zorginformatiebouwstenen
Ga naar: navigatie, zoeken
(Test wiki en produktie wiki)
(Test wiki en produktie wiki)
 
Regel 159: Regel 159:
 
<ol style="margin-left: 25px" type = A>
 
<ol style="margin-left: 25px" type = A>
 
<li>Het opnieuw genereren van de pagina's en bestanden, maar nu voor de produktie wiki.<br>
 
<li>Het opnieuw genereren van de pagina's en bestanden, maar nu voor de produktie wiki.<br>
Hiertoe moeten een de stappen vanaf [[#Voorbereiden Wiki | Voorbereiden Wiki]] opnieuw doorlopen worden, maar nu in paragraaf [[#Aanmaken wikipagina's en overige zib bestanden | Aanmaken wikipagina's en overige zib bestanden]], stap 3 met de produktie omgeving als wiki.
+
Hiertoe moeten de stappen vanaf [[#Voorbereiden Wiki | Voorbereiden Wiki]] opnieuw doorlopen worden, maar nu in paragraaf [[#Aanmaken wikipagina's en overige zib bestanden | Aanmaken wikipagina's en overige zib bestanden]], stap 3 met de produktie omgeving als wiki.
 
</li>
 
</li>
 
<li>Door hergebruik van de producten die voor de testomgeving gemaakt zijn en bewaard zijn.<br>
 
<li>Door hergebruik van de producten die voor de testomgeving gemaakt zijn en bewaard zijn.<br>

Huidige versie van 8 feb 2020 om 23:36


Manual pagina's

Voorbereiden publicatie

  1. Maak een kopie van de eap files die de zib's van de publicatie bevatten en hernoem deze tot de werkversie van de volgende (pre)release, format (V)ZIBS Werkversie <jaartal>-<prepublicatie volgnummer>, dus b.v. VZIBS Werkversie 2019-1.
  2. Warning-icon.png Vanaf dit punt mogen er geen wijzigingen meer uitgevoerd worden op de eap files van de nieuwe publicatie!
    
  3. Open de nieuwe eap files stuk voor stuk in Enterprise Architect en pas de HCIM tags op DCM Repository niveau aan, t.w. de tags HCIM::ReleaseYear, HCIM::ReleaseType en HCIM::PrereleaseNumber.
  4. Hernoem de huidige eap files om aan te geven dat het nu (pre)publicatie bestanden zijn, format: (V)ZIBS P(rep)ublicatieversie <jaartal>(-<prepublicatie volgnummer>), dus b.v. ZIBS Publicatieversie 2017 of ZIBS Prepublicatieversie 2017-1.
  5. Warning-icon.png Als een prerelease tot release wordt gepromoveerd, moeten de eap bestandsnamen en de bovengenoemde HCIM tags aangepast worden!
    
  6. Maak in de centrale folder van het zib-centrum met publicaties een nieuwe folder aan met als naam de naam van de publicatie: P(rep)ublicatieversie <jaartal>(-<prepublicatie volgnummer>).
  7. Verplaats de eap files van de publicatie naar deze folder.
  8. Kopieer tevens voor iedere eap file de folder met bijbehorende voorbeeldbestanden van de werkfolder naar de nieuwe publicatie folder.
  9. Indien de nieuwe werkversie een nieuw publicatiejaar heeft moeten de namen van de folders met voorbeeldbestanden in de werkfolder gewijzigd worden, bv VZIBS_Examples_2020.
  10. Warning-icon.png Iedere publicatie heeft zijn eigen set voorbeeldbestanden. In de naam van de voorbeeldfolder is het prepublicatienummer niet opgenomen. Overigens is de naam niet kritisch omdat de voorbeeldfolder tijdens het publicatieproces geselecteerd moet worden.
    
  11. Reset in Enterprise Architect voor de eap files van de nieuwe werkversie de publicatietag's van alle zibs (alle eap’s, alle subset’s: subzibs, basiszib etc.) (EA plugin voor zibslink = ZibTools)

De volgende acties worden uitgevoerd op de eap files van de nieuwe publicatie, en dus niet op de eap files van de werkversie.

  1. Maak op grond van de behandelde issues een lijst van de gewijzigde zibs.
  2. Start ZibExtraction en check alle SNOMED CT en LOINC codes of er geen foute of verlopen codes in de set zibs aanwezig zijn. (ZibExtraction> Beheer> CodeCheck<Page.png)
  3. Zet in Enterprise Architect de publicatietag's van alle zibs (alle eap’s, alle subset’s: subzibs, basiszib etc.) (EA plugin voor zibslink = ZibTools)
    Check hierbij in het Zib Report scherm of de revision history datum van de gewijzigde zibs aangepast wordt, zo niet check dit handmatig.
  4. Test in de add-in iedere zib op fouten.
    Iedere melding in het opmerkingen veld komt overeen met een fout, waarschuwing of mededeling.
    Beoordeel en verbeter eventueel de fouten ( en doe dit ook in de nieuwe werkversie als er al een afsplitsing is gemaakt).
    Sommige fouten zijn schijnfouten zoals een id fout bij een bouwsteen verwijzing met een subconcept.
    Beoordeel ook de waarschuwingen en de informatie mededelingen.
  5. Check of van de gewijzigde zibs ook een (aangepast) voorbeeld bestand met de juiste versie aanwezig is in de voorbeeldbestand folder van de publicatie.
  6. Start ZibExtraction en maak een nieuwe (pre)release aan of wijzig de prerelease omschrijving bij een tweede of latere prerelease (de juiste inhoud komt later, na de registratie van de bouwstenen: volgende stap)
    (ZibExtraction> Beheer>Publicaties en groepen | tabblad ReleasesPage.png)
  7. Registeer eerst alle bouwstenen van de publicatie incl. basis en subbouwstenen (ZibExtraction, actie “Registreer Zib’s”Page.png).
    Indien de zibs uit meer dan één bestand komen, dient dit voor al deze bestanden gedaan te worden. De volgorde maak niet uit.
  8. Indien de (pre)publicatie volledig nieuwe bouwstenen bevat, dienen een paar extra stappen gedaan te worden:
    1. Open de 'Publicaties en groepen' module en voeg in het 'Groepen' tabblad de nieuwe bouwstenen toe aan een groep naar keuze.(ZibExtraction> Beheer>Publicaties en groepenPage.png)
    2. Voeg in het 'Releases' tabblad de nieuwe bouwstenen toe aan de nieuwe publicatie.
    3. Ga hierna verder zoals hieronder in aangegeven.
  9. Stel de inhoud van de (pre)release vast of wijzig de bestaande prerelease om de van gewijzigde bouwstenen de juiste versie op te nemen. Check de versies.
    Doe dit aan de hand van de release notes. (ZibExtraction> Beheer>Publicaties en groepen | tabblad ReleasesPage.png).
  10. Open een van de .eap bestanden in ZibExtration en maak eventueel de nieuwe configuraties aan (ZibExtraction> ConfiguratiesPage.png).
  11. Registreer voor alle bouwstenen de referenties (ZibExtraction, actie “Registreer referenties”Page.png).
    Doe dit voor alle eap. bestanden van de (pre)release.
Warning-icon.png Als na dit punt een extra zib aan de publicatie wordt toe gevoegd of een versie van één van de bouwstenen wordt gewijzigd, moeten de laatste vijf stappen opnieuw doorlopen worden. De stap "Registeer referenties" moet dan uitgevoerd worden met optie "Forceer herregistratie" aangevinkt.

Voorbereiden Wiki

Warning-icon.png Voor het aanmaken en wijzigen van wiki pagina's moet je ingelogd zijn.
  1. Maak voor een nieuwe release (of eerste prerelease) een nieuwe release startpagina aan of pas deze aan bij een tweede of hogere prerelease.
    Doe dit doe de vorige te kopiëren naar een nieuwe pagina met de juiste naam. (ZIB_Publicatie_<jaartal>(NL)) als volgt:
    1. Ga naar de te kopiëren pagina, selecteer het wiki tabblad 'Bewerken' en kopieer de gehele wiki tekst van de pagina.
    2. Type in de adresbalk van de browser het adres <wikisite>/wiki/<naam van de nieuwe pagina>, <wikisite> is voor produktie bv. zibs.nl, <naam van de nieuwe pagina> is de naam zoals hierboven beschreven.<\li>
    3. Een nieuwe wiki pagina wordt geopend met de mededeling dat deze niet bestaat. Selecteer het wiki tabblad 'Bewerken' en plak de gekopieerde tekst er in.
    4. Wijzig, waar relevant, ‘release’ in ‘prerelease' of omgekeerd (ook in de pagina naam alias) en wijzig eventueel het jaartal in de namen.
    5. Wijzig ook de link naar de release notes en de links naar de downloads.Voorlopig worden dit dode links omdat die bestanden nog niet aanwezig zijn.
  2. Check de pagina op correcte informatie en voeg evt publicatie specifiek informatie toe onder het kopje ‘Overige punten’.
    De opsomming met zibs waaruit de pubicatie bestaat hoeft niet gewijzigd te worden. Dit gebeurt automatisch bij de publicatie van de zibs. Daarvoor moet de opsomming wel in de tweede sectie staan.
    Indien dit verandert, moet het in de configuratie aangepast worden. ZibExtraction > Configuratie: Groepsbox Wiki, veld ‘TOC Sectie#’Page.png
  3. Herhaal bovenstaande stappen voor de Engelse startpagina (HCIM_Release_<jaartal>(EN)).
  4. Pas op de ZIB hoofdpagina, sectie Publicaties de opsomming van publicaties aan, om de nieuwe publicatie op te nemen.
  5. Herhaal dit voor de Engelse hoofdpagina.

Aanmaken wikipagina's en overige zib bestanden

In deze beschrijving wordt er vanuit gegaan dat alle stappen van een hele publicatie in een keer gedaan worden.
Dit is niet perse noodzakelijk. De stappen kunnen ook in opeenvolgende sessies gedaan worden.

Voor het aanmaken van de bestanden moeten de volgende stappen gedaan worden:

  1. Start ZibExtraction en open met het File > Open menu de gewenste .eap file.
  2. Het configuratiekeuze window zal verschijnen waarin de gewenste configuratie gekozen kan worden.
    Indien de gekozen configuratie in strijd is met de .eap publicatie tags, zal een foutmelding volgen en informatie over het vervolg.
  3. Controleer, als het bestand geopend is, in de ZibExtraction > groupbox Instellingen of de volgende velden de gewenste waarde hebben:
    1. RTF template
    2. Voorbeeldfolder
    3. Publicatie
    4. Publicatietaal
    5. Wiki

    Indien de waarden niet juist zijn kunnen deze in het configuratie scherm gewijzigd worden. ZibExtraction > Configuratie.Page.png
    Blijkt uit de waarden dat de verkeerde standaardconfiguratie gekozen is, dient de .eap file gesloten en opnieuw geopend te worden om de correcte configuratie te kiezen.
    Een andere standaardconfiguratie kiezen terwijl de .eap fileopen is, is helaas niet mogelijk, omdat een aantal waarden uit de .eap file gehaald worden.

  4. Selecteer batch bewerkingen (ZibExtration > groupbox Uitvoeren > checkbox Batch acties)
  5. Selecteer de volgende bewerkingen (ZibExtraction > groupbox Gewenste actie)
    1. XMI en XML waardelijsten
    2. Eéntalig maken
    3. Wiki pagina's aanmaken
    4. PDF/DOCX bestanden maken
    5. XLS pagina's aanmaken
    6. Inhoudsopgave maken
  6. Selecteer eventueel gewenste opties (ZibExtraction > groupbox Opties)
  7. Indien de aangemaakte pagina's bewaard gaan worden voor hergebruik, moet dit aangegeven worden (ZibExtraction > groupbox Resultaten > checkbox Bewaren)
    Hierna zal automatisch een folderdialoog venster geopend worden om een doelfolder te selecteren.
  8. Druk tenslotte op Uitvoeren om de bewerkingen te starten.


Indien de .eap file behalve zibs ook sub-zibs en basis elementen zibs bevat, moeten bovenstaande stappen hiervoor herhaald worden
Hiervoor moet in de configuratie de zib prefix gewijzigd worden van nl.zorg in nl.zorg.part. Ook kan de file opnieuw geopend worden met een speciaal hiervoor gemaakte standaard configuratie.

Voer bovenstaande stappen uit voor alle .eap files die zibs bevatten van de publicatie.

De stappen moeten zowel voor de NL als voor de EN wiki pagina's uitgevoerd worden. Als de stappen voor één taal uitgevoerd zijn, kan dit niet in dezelfde sessie ook voor de ander taal gedaan worden.
Hiervoor moet de .eap file eerst gesloten worden en eventueel met een andere configuatie geopend te worden.

Warning-icon.png De XMI en XML bestanden zijn meertalig en hoeven maar één keer aangemaakt te worden. Wel moet dit gebeuren voordat de zibs ééntalig zijn gemaakt.
Als de volgorde van bewerkingen wordt gedaan zoal hierboven aangegeven is, gaat het goed en hoeft voor de Engelse versie de XML/XMI actie niet aan gevinkt te worden.

Laden wikipagina's en overige zib bestanden na generatie

Voor het laden van de bestanden naar de wiki site moeten de volgende stappen uitgevoerd worden:

  1. Deselecteer 'Batch acties' (ZibExtration > groupbox Uitvoeren > checkbox Batch acties)
  2. Selecteer de bewerking 'Wiki pagina' uploaden' (ZibExtraction > groupbox Gewenste actie)
  3. Deselecteer, indien nodig, 'Bewaren'
  4. Als het de laatste (of enige) upload is van de publicatie in de gekozen taal, vink dan de optie 'Refresh Wiki pagina's' aan.
  5. Druk op 'Uitvoeren' om de upload te starten.

Laden wikipagina's en overige zib bestanden bij hergebruik van bewaarde bestanden

Voor het laden van de bestanden naar de wiki site moeten in dit geval de volgende stappen uitgevoerd worden:

  1. Deselecteer 'Batch acties' (ZibExtration > groupbox Uitvoeren > checkbox Batch acties)
  2. Selecteer de bewerking 'Wiki pagina' uploaden' (ZibExtraction > groupbox Gewenste actie)
  3. Selecteer 'Hergebruiken'
    Controleer of de locatie, waar de bestanden staan, geselecteerd is en pas deze evtueel aan.
    Als de locatie leeg is, wordt automatisch een folderdialoog venster geopend worden om een doelfolder te selecteren.
  4. Vink de optie 'Refresh Wiki pagina's' aan.
  5. Druk op 'Uitvoeren' om de upload te starten.

Afrondende acties

Als alle bestanden gecontroleerd zijn, kunnen de zip bestanden, die vanaf de release startpagina te downloaden zijn, aangemaakt worden. Hiertoe wordt de inhoud van de volgende subfolders van de doelfolder op de bruikelijke wijze gezipt:

  1. xls: naam bestand: ZIBS<release>(XLSX).zip voor de Nederlandse en HCIM<release>(XLSX).zip voor de Engelse.
  2. zrtf: naam bestand: ZIBS<release>(PDF).zip voor de Nederlandse en HCIM<release>(PDF).zip voor de Engelse.
  3. xml: naam bestand: ZIBS<release>(XMI).zip (de xmi.xml bestanden zijn meertalig)

Tenslotte moeten bovenstaande drie bestanden en de release notes in PDF vorm (naam: Publicatieversie_<release>_-_Zorginformatiebouwstenen.pdf) geupload worden.
Dit kan met de standaard wiki functionaliteit gedaan worden of met de ZibExtraction applicatie (zie Tips en Tricks)

N.B. Het release veld is voor publicaties <jaartal>, bij voorbeeld 2018, en voor prepublicaties <jaartal>-<prepublicatie volgnummer>, bij voorbeeld 2018-2.

Als alles nogmaals gecontroleerd is, kan de publicatie zichtbaar gemaakt worden voor de gebruikers. Hiertoe moeten nog drie wijzigingen worden doorgevoerd:

  1. Pas op de hoofdpagina de verwijzing naar Huidige (pre)publicatie en Current (pre)release.
  2. Voeg de nieuwe (pre)publicatie op de ZIB hoofdpagina (ZIB_Hoofdpagina en HCIM_Mainpage) aan de sectie 'Publicaties' cq. 'Releases' toe.
  3. Pas in het menu (MediaWiki:Sidebar) de verwijzing naar Huidige (pre)publicatie en Current (pre)release aan, zodat naar de nieuwe (pre)publicatie verwezen wordt.

Test wiki en produktie wiki

Het verdient aanbeveling om een nieuwe publicatie eerst op de test omgeving uit te proberen en pas na gebleken correctheid op de produktie omgeving te zetten.
Het op de produktie omgeving zetten van de nieuwe (pre-)publicatie kan op twee manieren:

  1. Het opnieuw genereren van de pagina's en bestanden, maar nu voor de produktie wiki.
    Hiertoe moeten de stappen vanaf Voorbereiden Wiki opnieuw doorlopen worden, maar nu in paragraaf Aanmaken wikipagina's en overige zib bestanden, stap 3 met de produktie omgeving als wiki.
  2. Door hergebruik van de producten die voor de testomgeving gemaakt zijn en bewaard zijn.
    Om dit te doen moeten de acties uit de volgende paragrafen uitgevoerd te worden:
    1. Voorbereiden Wiki
      Hierbij kan de wikitekst van de overeenkomstige pagina's op de test wiki site als bron gebruikt worden
    2. Laden wikipagina's en overige zib bestanden bij hergebruik van bewaarde bestanden
    3. Afrondende acties

Tips en Tricks

Upload

Het upload deel van ZibExtraction is vrij generiek en daar kan 'misbruik' van gemaakt worden.
Als resultaten van een zib extractie bewaard worden, wordt een subfolderstructuur aangemaakt onder de doelfolder. Deze kent de volgende subfolders:
Subfolders.png

Deze structuur kan natuurlijk ook met de hand aangemaakt worden. Hiermee kunnen ook andere dan de gegenereerde bestanden geupload worden:

  • Wikipagina's
Maak de pagina in Notepad aan of kopieer de wiki tekst vanuit een bestaande pagina, bv. van een ander server.
Sla het bestand op in de WikiPages subfolder geef het de naam <WikipaginaNaam>.wiki.
  • PDF bestanden.
Sla het bestand op de zrtf subfolder
  • Alle andere uploadbare bestanden incl zip bestanden
Sla het bestand op de xls subfolder

Bij de volgende upload zullen al deze bestanden worden meegenomen.

Vergeten refresh

Als bij een upload de refresh optie vergeten is, kan het voorkomen dat de wikipagina's schijnbaar dode links hebben, bij voorbeeld worden dan plaatjes en transclude pagina's niet getoond.
Dit is te herstellen zonder alles opnieuw te laden. Doe hiervoor de volgende stappen:

  1. Sluit een eventueel openstaand .eap bestand en open het opnieuw: er wordt nu een nieuwe sessie gestart.
  2. Controleer of de correcte publicatie gekozen is in de gewenste taal
  3. Selecteer een willekeurige zib
  4. Deselecteer, indien nodig, de checkbox 'Batch acties'
  5. Selecteer de actie 'Wiki pagina's uploaden'
  6. Vink nu wel de optie 'Refresh Wiki pagina's' aan
  7. Controleer dat de checkboxen 'Bewaren' en 'Hergebruiken' niet aangevinkt zijn
  8. Druk op 'Uitvoeren'

De applicatie gaat nu proberen alle bestanden te uploaden (aantal is nul) en zal daarna alle pagina's van de publicatie in de gekozen taal refreshen (= purgen).
Herhaal dit indien nodig ook voor de andere taal.