ZibExtraction: verschil tussen versies
Regel 69: | Regel 69: | ||
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.<br> | 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.<br> | ||
Hiervoor moet de .eap file eerst gesloten worden en eventueel met een andere configuatie geopend te worden.<br> | Hiervoor moet de .eap file eerst gesloten worden en eventueel met een andere configuatie geopend te worden.<br> | ||
Let op! De XMI en XML bestanden zijn meertalig en hoeven maar één keer aangemaakt te worden. Wel moet dit gebeuren voordat de zibs ééntaig zijn gemaakt.<br> | |||
Als de volgorde van bewerkingen wordt gedaan zoal hierboven aangegeven is, gaat het goed en hoeft voor de engelse versie de XML/XMI actie neit aan gevinkt te worden. | |||
<br> | <br> | ||
Als alle bestanden gegenereerd en gecontroleerd zijn, kunnen de zip bestanden, die vanaf de release startpagina te downloaden zijn, aangemaakt worden. | Als alle bestanden gegenereerd en gecontroleerd zijn, kunnen de zip bestanden, die vanaf de release startpagina te downloaden zijn, aangemaakt worden. |
Versie van 15 nov 2018 14:54
Manual pagina's
- Enterprise Architect plug-in voor zib's
- Publicatie van zibs
- ZibExtraction user interface
- Configuratie user interface
- Controleren SNOMED CT en LOINC codes
- Beheer wikipage labels
- Beheer publicaties en groepen
Voorbereiden publicatie
- Maak een lijst van de gewijzigde zibs
- 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
)
- Zet in Enterprise Architect de publicatietag's van alle zibs (alle eap’s, alle subset’s: subzibs, basiszib etc.) (
EA plugin voor zibs
)
- Check hierbij in het Zib Report scherm of de revision history datum van de gewijzigde zibs aangepast wordt, zo niet check dit handmatig.
- 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.
- Check of van de gewijzigde zibs ook een (aangepast) voorbeeld bestand met de juiste versie aanwezig is in de voorbeeldbestand folder van de publicatie.
- Start ZibExtraction en maak een release aan of wijzig de prerelease (de juiste inhoud komt later, na de registratie van de bouwstenen: volgende stap) (
ZibExtraction> Beheer>Publicaties en groepen
)
- 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 tweemaal gedaan te worden (bestand 1, bestand 2, …., bestand 1, bestand 2, ….) om alle kruisverwijzingen vast te leggen.
- Open een van de .eap bestanden in ZibExtration en maak eventueel de nieuwe configuraties aan (
ZibExtraction> Configuraties
).
- Stel de inhoud van de publicatie vast of wijzig de prerelease om de gewijzigde bouwstenen op te nemen. Check de versies. Doe dit aan de hand van de release notes. (
ZibExtraction> Beheer>Publicaties en groepen
).
Voorbereiden Wiki
Let op! voor het aanmaken en wijzigen van wiki pagina's moet je ingelogd zijn.
- 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))
- Wijzig, waar relevant, ‘release’ in ‘prerelease' of omgekeerd (ook in de pagina naam alias).
- Wijzig ook de link naar de release notes en de links naar de downloads.
- 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#’
- Herhaal bovenstaande stappen voor de engelse startpagina (HCIM_Release_<jaartal>(EN)).
- Pas op de ZIB hoofdpagina (ZIB_Hoofdpagina en HCIM_Mainpage) de sectie 'Publicaties' cq. 'Releases' aan
- Pas in het menu (MediaWiki:Sidebar) de verwijzing naar Huidige (pre)publicatie en Current (pre)release aan.
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:
- Start Enterprise Architect en open met het
File > Open
menu de gewenste .eap file. - 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.
- Controleer, als het bestand geopend is, in de
ZibExtraction > groupbox Instellingen
of de volgende velden de gewenste waarde hebben:- RTF template
- Voorbeeldfolder
- Publicatie
- Publicatietaal
- Wiki
- Indien de waarden niet juist zijn kunnen deze in het configuratie scherm gewijzigd worden.
ZibExtraction > Configuratie.
- 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.
- Selecteer batch bewerkingen (
ZibExtration > groupbox Uitvoeren > checkbox Batch acties
) - Selecteer de volgende bewerkingen (
ZibExtraction > groupbox Gewenste actie
)- XMI en XML waardelijsten
- Eéntalig maken
- Wiki pagina's aanmaken
- PDF/DOCX bestanden maken
- XLS pagina's aanmaken
- Inhoudsopgave maken
- Selecteer eventueel gewenste opties (
ZibExtraction > groupbox Opties
) - 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.
- 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.
Let op! De XMI en XML bestanden zijn meertalig en hoeven maar één keer aangemaakt te worden. Wel moet dit gebeuren voordat de zibs ééntaig 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 neit aan gevinkt te worden.
Als alle bestanden gegenereerd en 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:
- xls: naam bestand: ZIBS<release>(XLSX).zip voor de nederlandse en HCIM<release>(XLSX).zip
- zrtf: naam bestand: ZIBS<release>(PDF).zip voor de nederlandse en HCIM<release>(PDF).zip
- xml: naam bestand: ZIBS<release>(XMI).zip (de xmi.xml bestanden zijn meertalig)
Het release veld is voor publicaties <jaartal>, bij voorbeeld 2018, en voor prepublicaties <jaartal>-<prepublicatie volgnummer>, bij voorbeeld 2018-2.
Laden wikipagina's en overige zib bestanden
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.
Hiertoe moeten een aantal stappen tweemaal uitgevoerd te worden.
- genereren wiki pagina's en overige zib bestanden.
- aanmaken release startpagina's
- wijzigen ZIB hoodfpagina's
- wijzigen menu
- laden van de nieuwe pagina's en zib bestanden
- laden Release Notes
- laden zip bestanden
Voor de gegenereerde pagina's biedt ZibExtraction de mogelijkheid deze bij het aanmaken voor de testomgeving te bewaren. ZibExtraction > Groepbox Resultaten > checkbox Bewaren
Deze kunnen op een later tijdstip, na controle, hergebruikt worden om in de produktie omgeving te laden.ZibExtraction > Groepbox Resultaten > checkbox Wiki Pagina's laden en checkbox Hergebruiken
Het kopieren van de startpagina's kan eenvoudig als volgt bereikt worden:
- kopieer in de 'Bewerken' status van de pagina de wiki tekst en plak deze in Notepad in een nieuw bestand.
- sla het bestand op en geef het de naam ZIB_Publicatie_<jaartal>(NL).wiki resp. HCIM_Release_<jaartal>(EN).wiki.
- ga naar de folder waar de gegenereerde bestanden bewaard zijn, open de subfolder WikiPages en plaats de bestanden daarin.
De pagina's worden nu automatisch met de rest van de pagina's geladen, als deze naar de produktieomgeving geladen worden.
De overige stappen onder het kopje Voorbereiden Wiki moeten opnieuw gedaan worden voor de produktie wiki.