ZibExtraction UI: verschil tussen versies

Uit Zorginformatiebouwstenen
Ga naar: navigatie, zoeken
(Korte beschrijving)
(Configureerbare gegevens)
 
Regel 125: Regel 125:
 
! scope="column"|Gebruik
 
! scope="column"|Gebruik
 
! scope="column"|Locatie
 
! scope="column"|Locatie
! scope="column"|Huidige waarde
+
! scope="column"|Huidige/default waarde
 
! scope="column"|Wijzigbaar via UI
 
! scope="column"|Wijzigbaar via UI
 
|-
 
|-
Regel 139: Regel 139:
 
|Uitvoer van ZibExtraction
 
|Uitvoer van ZibExtraction
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|C:\Users\[gebruikersnaam]\AppData\Local\Temp\ZibExtraction
+
|C:\Users\[gebruikersnaam]\AppData\Local\Temp\ZibExtraction*
 
||Nee
 
||Nee
 
|-
 
|-
Regel 146: Regel 146:
 
|Voorgeconfigureerde publicatie settings
 
|Voorgeconfigureerde publicatie settings
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction
+
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction*
 
||Nee
 
||Nee
 
|-
 
|-
Regel 153: Regel 153:
 
|Acties op het groep/release configuratie bestand
 
|Acties op het groep/release configuratie bestand
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibExtraction.cfg </span>
 
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibExtraction.cfg </span>
|C:\ProgramData\Nictiz\ZibExtraction\Config
+
|C:\ProgramData\Nictiz\ZibExtraction\Config*
 
||Ja
 
||Ja
 
|-
 
|-
Regel 191: Regel 191:
 
|Nee
 
|Nee
 
|}
 
|}
 +
 +
<nowiki>*</nowiki> Dit is de defaultwaarde als het veld in de configuratie file leeg is
  
 
==Vaste gegevens==
 
==Vaste gegevens==

Huidige versie van 13 mrt 2019 om 19:59

Manual pagina's

Korte beschrijving

Het programma ZibExtraction biedt de mogelijkkheid om uitgaande van één of meer Enterprise Architect projectfiles (eap files) met zib's de bestanden te genereren en beschikbaar te maken die nodig zijn voor een (pre)publicatie van de zibs in het Nederlands en het Engels.
De zibs in de eap files worden daartoe geconverteerd naar een wiki pagina, PDF, XLSX em XML en geupload naar een mediawiki server. De wiki server moet hier wel voor ingericht zijn.
Bovendien wordt een inhoudsopgave gegenereerd die vermeldt welke zibs en welke versie tot een publicatie behoren.
Om dit mogelijk te maken moeten zibs

  • meertalig zijn
  • aan een aantal eisen voldoen.

De eisen zijn beschreven op de documentatie pagina's en kunnen getest worden met een add-in voor Enterprise Architect.
Bovendien moet de applicatie beschikken over informatie over de samenstelling van een publicatie en over de indeling van de zib's in groepen met vergelijkbare scope.
Hiervoor kent ZibExtraction hulpprogramma's, in dit geval het groep en release beheer programma.

Het complete proces dat doorlopen moet worden om tot een publicatie te komen in beschreven op een aparte pagina.

Om het programma zo aanpasbaar mogelijk te houden, wordt met een aantal configuratie bestanden gewerkt:

  • Computer (gebruiker) gebaseerd:
    • Basisconfiguratie bestand (ZibAppsStart.cfg), nodig voor het opstarten van de applicatie. Dit bestand bevat gegevens die zeer zelden gewijzigd worden. Hier is dan ook geen userinterface voor.
    • Publicatieproces configuraties bestand (ZibExtraction.cfg). Bevat een aantal voorgeconfigureerde settings voor het publiceren en wordt pas aangesproken tijden het openen van een eap file. Hier wordt de userinterface beschreven.
  • Gemeenschappelijke:
    • Groep en publicaties configuratie bestand (ZibReg.cfg). Bevat informatie over indelingen van zibs in groepen en publicaties.Hier wordt de userinterface beschreven.
    • Label configuratie bestand(ZibExtractionLabels.cfg). Bevat meertagalige labels. De begeleidende tekst =en van een zib wiki pagina is opgebouwd uit labels om meertalige wiki pagina's mogelijk te maken.Hier wordt de userinterface beschreven.

De locaties van deze bestanden is instelbaar, met uitzondering van de basisconfiguratie file. Deze staat in C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction.

ZibExtraction gebruikersinterface

Het programma ZibExtraction kent de volgende besturingselementen:

ZibExtractionUI.png Configurations UI.png
Figuur 1: ZibExtraction gebruikersinterface
  1. Menubalk
    File: Heeft drie submenu items:
    • Open: Roept een file dialoog op om een te openen eap file te selecteren.
    • Sluiten: Sluit de eap file maar niet de applicatie.
    • Exit: Sluit de eap file en de applicatie.

    Configuratie: Opent het configuratiescherm. Knop wordt actief nadat tijdens het openen van de eap file de configuratie gekozen is.
    Beheer: Heeft vier submenu items:

    Help: Heeft twee submenu items:

    • Over Zib Extraction: Informatie over de applicatie
    • Help pagina: Gebruiksaanwijzing van de applicatie (deze pagina)
  2. Project boomstructuur
    Toont (packages)boomstructuur van de geopende Enterprise Architect Project file en de zib's die deze file bevat die voldoen aan het prefix configuratie criterium.
  3. Meldingenvenster
    Toont tijdens het genereren van de resultaatsbestanden voortgangsmeldingen, waarschuwingen en fouten.
    Het venster heeft een contextmenu (rechter muisclick)met twee waarden:
    • Clear: Wist het venster.
    • Copy: Kopieert de inhoud van het venster naar het klembord
  4. Actiekeuzes
    De volgende acties zijn mogelijk:
    RadioButton.png Registreer Zib's: Registreren van de geselecteerde zib's in het publicaties en groepen configuratie bestand. pas na registratie zijn deze zib's in de beheermodule beschikbaar.
    RadioButton.png XML en XMI waardenlijsten: Aanmaken door EA van het XMI bestand en het converteren van de valuesets uit de RFT bestanden naar XML.
    RadioButton.png Eentalig maken: Converteert de multilanguage zib's naar singlelanguage zib's in de gekozen publicatietaal.
    Warning-icon.png Alle acties boven deze mogen uitsluitend op multilanguage zibs uitgevoerd worden, de drie acties onder deze actie kunnen alleen op singlelanguage zibs uitgevoerd worden.
    Het niet voldoen aan deze voorwaarde leidt tot een foutmelding.

    RadioButton.png Wiki pagina's aanmaken: Aanmaken van de zib wikipagina.
    RadioButton.png PDF/DOCX bestanden maken: Aanmaken PDF of DOCX representatie van de zib, aan de hand van het gekozen sjabloon .
    RadioButton.png XLSX bestanden maken: Aanmaken spreadsheet representatie van de zib.

    Warning-icon.png De volgende acties zijn niet Zib gebonden en kunnen op iedere zib of verzameling zibs uitgevoerd worden.
    RadioButton.png Inhoudsopgave maken: Genereren van lijst in de publicatie taal met zibs die tot de publicatie behoren. Dit overzicht komt op de publicatie startpagina in de sectie die in de configuratie vastgelegd is.

    RadioButton.png Wiki pagina's uploaden: Het uploaden van de wikipagina's, datamodel afbeeldingen, PDF/DOCX bestanden, spreadsheets en inhoudsopgave naar de wikiserver die in de configuratie opgegeven is.

  5. Actieknoppen
    Uitvoeren: Start de uitvoeren van de geselecteerde actie(s).
    CheckBox.png Batch acties: Verandert bij aanvinken de actie radioknoppen in checkboxen, zodat meer dan één actie geselecteerd kan worden. Bovendien wordt bij batch acties de inhoud van het resultaatvenster in een tekstfile weggeschreven en opgeslagen in resultaat basisfolder.
  6. Opties
    CheckBox.png Forceer herregistratie: Indien bij het registeren iets fout gegaan is, kan met dit vinkvak dit in de meeste gevallen hersteld worden. Het verwijdert de oude registratie en registreert de zib opnieuw
    CheckBox.png Oud format: Bij eerdere releases hadden nog niet alle elementen een Engelse naam in het Alias veld. Aangevinkt voorkomt dit het gebruik van de Engelse vertaling uit de alias in de Engelse publicatie.
    CheckBox.png Tijdelijke folders behouden: Standaard worden bij het afsluiten een aantal bestanden en folders weggegooid. Dit vinkvak voortkomt dat.
    CheckBox.png Document in DOCX format: Maak de uitvoerbestanden aan in DOCX format in plaats van als PDF.
    CheckBox.png Pagina's preview: Als het vinkvak aangevinkt wordt, wordt na het genereren van de wikipagina deze als tekst in het resultaat venster getoond.
    CheckBox.png Valuesets in AD format: Voor de valuesets zijn twee XML formats beschikbaar. Kies voor de export naar ART-DECOR het AD format (standaard aangevinkt).
    CheckBox.png Negeer certificaat fouten: Hoewel de servercertificaten op orde horen te zijn, kan het bij een testserver wel eens minder zijn. Vink aan om dan een crash te voorkomen
    CheckBox.png Refresh Wiki pagina's: Purged na het laden alle pagina's van de publicatie in de publicatietaal om oude versies van de pagina's te verwijderen.
  7. Resultaat locatie
    CheckBox.png Bewaren: Indien aangevinkt worden de resutaten ook in een subdirectory structuur onder de resultaat locatie.
    CheckBox.png Hergebruiken: Indien aangevinkt worden de eerder bewaarde gegevens gebruikt voor de upload. (Knop wordt actief als Upload als enige actie geselecteerd is).
    Resultaat locatie: Met de knop 'Bladeren' kan een extra locatie geselecteerd worden om de resultaten op te slaan. De folder dialoog wordt automatisch als 'Bewaren' wordt aangevinkt.
    Als de resultaat locatie bij bewaren al een bestand bevat met dezelfde naam, verschijnt een dialoog met keuzes voor al dan niet overschrijven.
  8. Instellingen venster
    Overzicht van de naam van de geopende eap file en de ingestelde configuratie items
  9. Beheer configuraties
    Met deze mini dialoog kunnen configuraties geselecteerd worden die uit de lijst met configuraties verwijderd moeten worden.
    Annuleer: Sluit het dialoogvenster zonder wijzigingen aan te brengen.
    Verwijder: Verwijdert de geselecteerde configuratie en sluit het dialoogvenster.
    CheckBox.png Maak een backup: Voordat de configuraties verwijderd worden, wordt een kopie gemaakt van het oorspronkelijke configuraties bestand.
    Deze heeft naam van het configuratie bestand plus een timestamp en wordt op dezelfde locatie opgeslagen als het configuraties bestand.
  10. Statusbalk
    Geeft de locatie aan waar de configuratie file is opgeslagen.

Gebruik

Voor het gebruik van ZibExtraction wordt verwezen naar de wikipagina over het publiceren van zib's.

Configureerbare gegevens

Naam Beschrijving Gebruik Locatie Huidige/default 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
WorkLocation Basislocatie van de resultaten Uitvoer van ZibExtraction ZibAppsStart.cfg C:\Users\[gebruikersnaam]\AppData\Local\Temp\ZibExtraction* 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
Snomed_languageRefsetId_NL Id van de gebruikte NL ref set Ophalen NL definitie van SNOMED term ZibAppsStart.cfg 31000146106 Nee
Snomed_languageRefsetId_EN Id van de gebruikte EN ref set Ophalen EN definitie van SNOMED term ZibAppsStart.cfg 900000000000509007 Nee
TerminologyServiceLink Base adres van de terminologie services Ophalen van SNOMED en LOINC data ZibAppsStart.cfg https://terminologie.nictiz.nl/terminology/ Nee
TerminologyPageLink Base adres van de terminologie webpagina's Tonen van SNOMED en LOINC data in ART-DECOR terminology omgeving ZibAppsStart.cfg https://terminologie.nictiz.nl/art-decor/ Nee
CodeTranslateFromYear Publicatie vanaf waar vertaling van codes plaatsvindt Vertalen SNOMED CT en LOINC codes op NL wiki pagina's ZibAppsStart.cfg 2018 Nee

* Dit is de defaultwaarde als het veld in de configuratie file leeg is

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