ZibExtraction

---

Voorbereiden publicatie

Het verdient de aanbeveling al deze stappen eerst uit te voeren op een test versie van de EA file en tegen https://zibs.test-nictiz.nl/ (de test wiki). Waarna bij succes de stappen herhaald kunnen worden voor http://www.zibs.nl (de productie wiki).

1. Controleer in Enterprise Architect of de lokale voorkeuren (preferences) juist staan zie Tips en Tricks onder aan deze pagina
2. Open de eap/qea(x) files die de zib's van de publicatie bevatten en check of er geen zibs meer gelocked zijn. Als deze er zijn, unlock deze dan. Hiervoor moet je als admin de EA file openen.
3. Maak een nieuwe directory (map) aan onder "ZIB centrum - Documenten\9. Overig\9.6. Publicaties", hierin plaats je de .ea files en alle resultaten van testen en zibextractor. De mapnaam heeft het volgende formaat P(rep)ublicatieversie <jaartal>(-<prepublicatie volgnummer>)
4. Maak een nieuw leeg EA project aan, naam format: (V)ZIBS P(rep)ublicatieversie <jaartal>(-<prepublicatie volgnummer>), dus b.v. ZIBS Publicatieversie 2017 of ZIBS Prepublicatieversie 2017-1.
6. Maak een lokale kopie van de server (EA > Settings > Transfer > Full porject transfer via connection) met optie: DBMS to File (Source database: DBType=1;Connect=Provider=MSOLEDBSQL19.1;Persist Security Info=False;User ID=wouter.zanen@nictiz.nl;Initial Catalog=enterprisearchitect;Data Source=zibs.database.windows.net;Initial File Name="";Use Encryption for Data=Strict;Server SPN="";Authentication=ActiveDirectoryInteractive;Access Token="";Host Name In Certificate="";Server Certificate=""). Target project is het zojuist aangemaakte lege EA project. (We doen dit omdat acties direct op de server uitvoeren nu nog te traag is.)
7. Lock nu alle zibs op de server tot dat de publicatie volledig gereed is
8. Vervolg actie op de lokale kopie doen !
9. Maak op grond van de behandelde issues een lijst van de gewijzigde zibs. Deze kan automatisch uit Bits gegenereerd worden vanuit ZibExtraction. (ZibExtraction> Beheer > Publicaties en groepen | tabblad Releases > Exporteren > Release Document > Uitvoerkeuzes > Losse lijst ). Kies wel de gewenste (pre-)publicatie(s).
10. 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<)
    Check ook de codes uit de 'eigen' zib codestelsels op foute of verlopen codes. Dit kan ook met ZibCodeCheck met Kies codesystem > Overige code reports.
    Dit levert ook rapportages over deprecated codes op die je later nodig hebt.
11. Test in EA met de de add-in iedere zib op fouten. (EA plugin voor zibs)
    Iedere melding in het opmerkingen veld komt overeen met een fout, waarschuwing of mededeling.
    Beoordeel en verbeter eventueel de fouten.
    Sommige fouten zijn schijnfouten zoals een id fout bij een bouwsteen verwijzing met een subconcept.
    Beoordeel ook de waarschuwingen en de informatie mededelingen.
12. Check of van de gewijzigde zibs ook een (aangepast) voorbeeld bestand met de juiste versie aanwezig is in de voorbeeldbestand folder van de publicatie.
    Dit wordt in de test automatisch gedaan. Indien geen voorbeeldfile met de correcte versie gevonden wordt, zal dit als een warning aangegeven worden.
13. Zet in Enterprise Architect de publicatietag's van alle zibs (alle eap/qea(x) files, alle subset’s: subzibs, basiszib etc.) (EA plugin voor zibs). Het zetten van de publicatie tags doe je in de EA plugin - Tools, heb je deze optie niet vraag deze dan aan bij de functioneelbeheerder
    Check hierbij in het Zib Report scherm of de revision history datum van alle gewijzigde zibs uit de hierboven aangemaakte lijst aangepast wordt, zo niet check dit handmatig.
14. Maak een kopie van de eap/qea(x) 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.

 Vanaf dit punt mogen er geen wijzigingen meer uitgevoerd worden op de eap/qea(x) files van de nieuwe publicatie!

15. Open de nieuwe eap/qea(x) (werk)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.

 Als een prerelease tot release wordt gepromoveerd, moeten de eap/qea(x)  bestandsnamen en de bovengenoemde HCIM tags aangepast worden!

16. 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.

 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.

17. Reset in Enterprise Architect voor de eap/qea(x) files van de nieuwe werkversie de publicatietag's van alle zibs (alle eap/qea(x) ’s, alle subset’s: subzibs, basiszib etc.) (EA plugin voor zibs)

De volgende acties worden uitgevoerd op de eap/qea(x) files van de nieuwe publicatie, en dus niet op de eap/qea(x) files van de werkversie.

15. Zet in de eap/qea(x) files van de nieuwe publicatie het gebruikersbeheer uit ( EA Settings > Administer > Enable Security). Hiervoor moet je als admin de EA file openen. Tevens heb je de autorisatie sleutel nodig.
16. 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 Releases)
17. Registeer eerst alle bouwstenen van de publicatie incl. basis en subbouwstenen (ZibExtraction, actie “Registreer Zib’s”).
    Indien de zibs uit meer dan één bestand komen, dient dit voor al deze bestanden gedaan te worden. De volgorde maak niet uit.
18. 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 groepen)
    2. Voeg in het 'Releases' tabblad de nieuwe bouwstenen toe aan de nieuwe publicatie.
    3. Ga hierna verder zoals hieronder in aangegeven.
19. 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. (ZibExtraction> Beheer>Publicaties en groepen | tabblad Releases).
20. Open een van de .eap/qea(x) bestanden in ZibExtration en maak eventueel de nieuwe configuraties aan (ZibExtraction> Configuraties).
21. Registreer voor alle bouwstenen de referenties (ZibExtraction, actie “Registreer referenties”).
    Doe dit voor alle eap/qea(x) . bestanden van de (pre)release.

 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

 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#’
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/qea(x) file.
2. Het configuratiekeuze window zal verschijnen waarin de gewenste configuratie gekozen kan worden.
   Indien de gekozen configuratie in strijd is met de .eap/qea(x) 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.
   De gewenste taal zal sowieso in het configuratiescherm gekozen moeten worden. Blijkt uit de waarden dat de verkeerde standaardconfiguratie gekozen is, dient de .eap/qea(x) file gesloten en opnieuw geopend te worden om de correcte configuratie te kiezen.
   Check met name op de locatie van de voorbeeldbestanden staan juist is.
   Selecteer tenslotte het sjabloon voor de PDF bestanden. Let op dat het sjabloon voor de gekozen taal geselecteerd is.
   Een andere standaardconfiguratie kiezen terwijl de .eap/qea(x) file open is, is helaas niet mogelijk, omdat een aantal waarden uit de .eap/qea(x) 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. Omdat op dit moment de generatie van pdf bestanden niet goed werkt, vinken we "Documenten in docx" aan. De docx bestanden moeten met een pdf converter (bijv PDF24) omgezet worden naar pdf. Vervolgens voegen we deze toe aan de Temp directory [Gebruiker folder]\AppData\Local\Temp\ZibExtraction\[Temp map huidige datum/tijd]\zrtf. Deze bestanden worden dan automatisch mee geupload naar de wiki.
8. 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.
9. Druk tenslotte op Uitvoeren om de bewerkingen te starten.

Indien de .eap/qea(x) 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/qea(x) 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/qea(x) file eerst gesloten worden en eventueel met een andere configuatie geopend te worden.

	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

Release Notes

Maak de release notes aan. (ZibExtraction> Beheer > Publicaties en groepen | tabblad Releases > Exporteren > Release Document > Uitvoerkeuzes > Release notes ).
Kies wel de gewenste (pre-)publicatie(s). De release notes worden in het Nederlands en Engels aangemaakt.

Code systemen

Maak nieuwe publicatie items aan voor de zib 'eigen' codestelsels en upload deze.(ZibExtraction> Beheer > Zib Codestelsel beheer > Akties > Publiceer codestelsels)

Uitgegeven zib Id's

Als de publicatie nieuwe zibs bevat, moet ook het overzicht van uitgegeven zib id's vernieuwd worden. (ZibExtraction> Beheer > Zib Id beheer > Akties > Export wiki pagina)
Deze en de vorige bullet resulteren in een upload omgeving die met de ZibExtraction applicatie ge-upload kan worden.(zie Tips en Tricks)
Dit kan gecombineerd worden met de upload van de bestanden uit het volgende punt.

Wiki

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 gebruikelijke 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:

4. Pas op de hoofdpagina de verwijzing naar Huidige (pre)publicatie en Current (pre)release.
5. Voeg de nieuwe (pre)publicatie op de ZIB hoofdpagina (ZIB_Hoofdpagina en HCIM_Mainpage) aan de sectie 'Publicaties' cq. 'Releases' toe.
6. 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.
7. Pas het Sjabloon: https://zibs.test-nictiz.nl/index.php?title=Sjabloon:HCIMReleases(NL) aan zodat de huidige publicatie op het nieuwe jaartal staat.

Nieuwe werkbestanden

Indien de publicatie geen pre-publicatie betreft maar een publicatie moeten in de nieuwe werkversies alle [Deprecated] codes uit de betreffende waardenlijsten verwijderd worden.
Een overzicht de deze codes is aan te maken vanuit ZibExtraction. (ZibExtraction> Beheer> CodeCheck optie 'Overige code reports'<)

Publicatie bestanden

Zet de eap/qea(x) bestanden (met standaard window functionaliteit) op readonly, om abusievelijk wijzigen te voorkomen

Bestand met Zib namen

Maak een nieuw bestand aan met de zib namen van de nieuwe publicatie. (ZibExtraction> Beheer > Publicaties en groepen | tabblad Releases > Exporteren > XML Zib Lijst).
Dit bestand wordt gebruikt in de EA Add-in om verwijzen naar andere zibs mogelijk te maken. Verzend dit bestand aan alle gebruikers van de add-in ter vervanging van het huidige bestand. (Standaard locatie: ..\Documents\Nictiz).

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 upload omgeving kent de volgende subfolders:

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/qea(x) 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.

Enterprise Architect Preferences

De Zib Extractor opent een instantie van enterprise architect op uw pc (zonder een installatie van Enterprise Architect kan de Zib Extractor niet werken. Binnen Enterprise Architect zijn een 3-tal voorkeuren belangrijk voor de juiste weergave van plaatjes en XMI bestanden die uit Enterprise architect geextraheerd worden. De volgende voorkeuren moeten worden ingesteld in Enterprise Architect, deze vind je in Enterprise Architect 16.1 onder Start->Preferences->Preferences:

1. Diagram -> Scale Saved Bitmaps to: 100%
2. Themes -> Name:Enterprise Architect 14
3. XML Specification -> Code Page: UTF-8