ZibExtraction UI: verschil tussen versies

Uit Zorginformatiebouwstenen
Naar navigatie springen Naar zoeken springen
Geen bewerkingssamenvatting
 
(74 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
{{DISPLAYTITLE:Zorginformatiebouwstenen: Zib extractie}}
{{ZIBS_ManualPages}}
{{ZIBS_ManualPages}}
==Korte beschrijving==
==Korte beschrijving==
Voor de correcte verwerking van een publicatie heeft is de applicatie ZibExtraction afhankelijk van een aantal locale gebruikersininstellingen, zoals bestandslocaties, publicatiejaar en taal, etc. <br>
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.<br>
(Zie, voor een overzicht van alle configureerbare items, de [[ZibExtraction_UI#Korte beschrijving | beschrijving]] van ZibExtraction).<br>
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.<br>
De gebruikersinstellingen zijn variabel en hiervoor is een gebruikersinterface aanwezig. Deze pagina beschrijft de werking van de configuratie gebruikersinterface.<br>
Bovendien wordt een inhoudsopgave gegenereerd die vermeldt welke zibs en welke versie tot een publicatie behoren.<br>
Omdat een deel van de configuratie keuzemogelijkheden tijdens het openen van de eap file uit dit bestand gelezen worden moet de te gebruiken configuratie tijdens het openen van de eap file gekozen worden en kan daarna de keuze ook niet meer gewijzigd worden. Wel kunnen individuele velden gewijzigd worden.<br>
Om dit mogelijk te maken moeten zibs
Om te voorkomen dat de gebruiker iedere keer dat de applicatie gebruikt wordt een groot aantall instelllingen moet aanpassen, biedt het configuratie schermde mogelijheid om gekozen set van instelligen te bewaren als voorgedefinieerde configuratie. Zo kan bijvoorbeeld een configuratie gemaakt worden die standaard een publicatie in het Engels naar de testwiki stuurt.<br>
* meertalig zijn
De configuraties worden opgeslagen in een lokaal XML bestand, met de naam 'ZibExtraction.cfg'. De locatie van het bestand is [[ZibExtraction_Config#Vaste gegevens | hier]] te vinden<br>
* aan een aantal eisen voldoen.
Na verloop van tijd kunnen er op deze manier een groot aantal configuraties ontstaan en de wens om één of meerdere configuraties te verwijderen. Dit kan niet met deze interface. Hiervoor is een optie aanwezig in het menu [[ZibExtraction_UI | beheer]] van de applicatie ZibExtraction.
De eisen zijn beschreven op de [https://zibs.test-nictiz.nl/wiki/Zib_afspraken documentatie pagina's] en kunnen getest worden met een [[ZibTools |add-in]] voor Enterprise Architect.<br>  
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.<br>
Hiervoor kent ZibExtraction hulpprogramma's, in dit geval het [[GroupRelease |groep en release beheer]] programma.<br>
<br>
Het complete proces dat doorlopen moet worden om tot een publicatie te komen in beschreven op een [[ZibExtraction |  aparte pagina]].<br>
<br>
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. [[ZibExtraction_Config|Hier]] wordt de userinterface beschreven.
* Gemeenschappelijke:
** Groep en publicaties configuratie bestand (ZibReg.cfg). Bevat informatie over indelingen van zibs in groepen en publicaties.[[GroupRelease|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.[[ZibLabelEditor|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.<br>


==ZibExtraction configuraties gebruikersinterface==
==ZibExtraction gebruikersinterface==
Het configuratie deel van het programma ZibExtraction kent de volgende besturingselementen:<br>
Het programma ZibExtraction kent de volgende besturingselementen:<br>
{|
{|
|[[Bestand:ZibExtractionUI.png]]
|[[Bestand:ZibExtractionUI.png]]
|[[Bestand:Configurations_UI.png]]
|-
|-
|align= "center"| Figuur 1: ZibExtraction Configuraties gebruikersinterface
|align= "center" colspan="2| Figuur 1: ZibExtraction gebruikersinterface
|}
|}
<ol>
<ol>
<li>'''Publicatie Informatie'''<br>
<li>'''Menubalk'''<br>
<span style="font-variant: small-caps;">Zib categorie</span>: wordt niet meer gebruikt.<br>
<span style="font-variant: small-caps;">File</span>: Heeft drie submenu items:
<span style="font-variant: small-caps;">Publicatienaam</span>: dropdownlist met alle publicaties die met [[GroupRelease | Groep en publicatiebeheer]] zijn aangemaakt.<br>
<ul><li><span style="font-variant: small-caps;">Open</span>: Roept een file dialoog op om een te openen eap file te selecteren.</li>
<span style="font-variant: small-caps;">Release info</span>: publicatie omschrijving. Wordt automatisch gevuld met de Nederlandstalige informatie uit  Groep en publicatiebeheer. Readonly.<br>
<li><span style="font-variant: small-caps;">Sluiten</span>: Sluit de eap file maar niet de applicatie.</li>
<span style="font-variant: small-caps;">Zib prefix</span>: volledige prefix van de bouwstenen die in ZibExtraction geselecteerd worden, bijvoorbeeld nl.zorg of nl.zorg.part<br>
<li><span style="font-variant: small-caps;">Exit</span>: Sluit de eap file en de applicatie.</li></ul>
<span style="font-variant: small-caps;">Publicatietaal</span>: Taal waarin de publicatie produkten aangemaakt worden.
<span style="font-variant: small-caps;">Configuratie</span>: Opent het [[ZibExtraction_Config | configuratiescherm]]. Knop wordt actief nadat tijdens het openen van de eap file de configuratie gekozen is.<br>
<span style="font-variant: small-caps;">Beheer</span>: Heeft vier submenu items:
<ul>
<li><span style="font-variant: small-caps;">Publicaties en groepen</span>: Start de [[GroupRelease | publicaties en groepen beheer]] module</li>
<li><span style="font-variant: small-caps;">Taallabels</span>: Start de [[ZibLabelEditor | label editor]] module</li>
<li><span style="font-variant: small-caps;">Codecheck</span>: Start de [[ZibCodeCheck | code check]] module</li>
<li><span style="font-variant: small-caps;">Configuraties</span>: Opent de configuratie beheer dialoog (zie 9)</li>
</ul>
<span style="font-variant: small-caps;">Help</span>: Heeft twee submenu items:
<ul>
<li><span style="font-variant: small-caps;">Over Zib Extraction</span>: Informatie over de applicatie<br></li>
<li><span style="font-variant: small-caps;">Help pagina</span>: Gebruiksaanwijzing van de applicatie (deze pagina)</li>
</ul>
</li>
</li>
<li>'''Bestandslocaties'''<br>
<li>'''Project boomstructuur'''<br>
<span style="font-variant: small-caps;">Voorbeeldbestanden</span>: Locatie van de bronbestanden van de voorbeelden uit sectie Example Instances van bouwsteen.<br>
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.
<span style="font-variant: small-caps;">Afbeeldingen</span>: Locatie van een aantal afbeeldingen die in de spreadsheet uitvoer worden gebruikt.<br>
<span style="font-variant: small-caps;">Configuratie</span>: Locatie van het groep en publicatie definitie bestand en de label definitiebestand.<br>
De overige velden geven de locaties van de uitvoer van ZibExtraction aan voor de verschillende types uitvoer. Getoonde loccaties zijn de default locaties, die automatisch aangemaakt worden als de velden leeg zijn.
</li>
</li>
<li>'''Bits gegevens'''<br>
<li>'''Meldingenvenster'''<br>
Velden met informatie die nodig is om de issue beschrijvingen uit Bits op te halen.<br>
Toont tijdens het genereren van de resultaatsbestanden voortgangsmeldingen, waarschuwingen en fouten.<br>
<span style="font-variant: small-caps;">URL Jira API</span>: URL voor het aanspreken dan de API van de Bits applicatie<br>
Het venster heeft een contextmenu (rechter muisclick)met twee waarden:
<span style="font-variant: small-caps;">Gebruiker</span>: Bits gebruikersnaam ten behoeve van de inloggen via de API van Bits
<ul>
<span style="font-variant: small-caps;">Wachtwoord</span>: Bijbehorend wachtwoord. Het wachtwoord wordt nooit getoond. Het kan wel ingevoerd worden.<br>
<li><span style="font-variant: small-caps;">Clear</span>: Wist het venster.</li>
<span style="font-variant: small-caps;">Issue prefix</span>:Prefix bvan de issues in bits die betrekking hebben op de bouwstenen.<br>  
<li><span style="font-variant: small-caps;">Copy</span>: Kopieert de inhoud van het venster naar het klembord</li>
<span style="font-variant: small-caps;">Statussen</span>: Bits statussen waarvan de issue informatie opgehaald wordt. De statussen moeten exact overeenkomen met de benamingen in Bits.<br>
</ul></li>
<li>'''Actiekeuzes'''<br>
De volgende acties zijn mogelijk:<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Registreer Zib's</span>: Registreren van de geselecteerde zib's in het publicaties en groepen configuratie bestand. Pas na registratie zijn deze zib's in de beheermodule beschikbaar.<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Registreer verwijzingen</span>: Registreren van de verwijzingen naar andere zib's van de geselecteerde zib's in het publicaties en groepen configuratie bestand. Pas na registratie kunnen de verwijzingen in de wiki pagina's juist vermeld worden.<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> XML en XMI waardenlijsten</span>: Aanmaken door EA van het XMI bestand en het converteren van de valuesets uit de RFT bestanden naar XML.<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Eentalig maken</span>: Converteert de multilanguage zib's naar singlelanguage zib's in de gekozen publicatietaal.<br>
{|
|rowspan = "2" valign = "top" |[[Bestand: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.
|}
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Wiki pagina's aanmaken</span>: Aanmaken van de zib wikipagina.<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> PDF/DOCX bestanden maken</span>: Aanmaken PDF of DOCX representatie van de zib, aan de hand van het gekozen sjabloon .<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> XLSX bestanden maken</span>: Aanmaken spreadsheet representatie van de zib.<br>
{|
|rowspan = "2" valign = "top" |[[Bestand:Warning-icon.png]]
| De volgende acties zijn niet Zib gebonden en kunnen op iedere zib of verzameling zibs uitgevoerd worden.
|}[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Inhoudsopgave maken</span>: 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.<br>
[[Bestand:RadioButton.png]]<span style="font-variant: small-caps;"> Wiki pagina's uploaden</span>: Het uploaden van de wikipagina's, datamodel afbeeldingen, PDF/DOCX bestanden, spreadsheets en inhoudsopgave naar de wikiserver die in de configuratie opgegeven is.<br>
</li>
</li>
<li>'''Wikisite gegevens'''<br>
<li>'''Actieknoppen'''<br>
Velden met informatie die nodig is om de wikipagina's te kunnen maken en om de bestanden te kunnen uploaden naar de wikiserver.<br>
<span style="font-variant: small-caps;">OK</span>: Start het uitvoeren van de geselecteerde actie(s).<br>
<span style="font-variant: small-caps;">URL Wiki API</span>: URL voor het aanspreken dan de API van de Wiki server. Hiermee kan gekozen worden voor de test of de produktie server<br>
<span style="font-variant: small-caps;">Cancel</span>: Stopt het uitvoeren van de geselecteerde actie(s). Stoppen kan soms niet meteen. Op de statusblak is dan zichtbaar dan het proces gestopt wordt.<br>
<span style="font-variant: small-caps;">Gebruiker</span>: Bits gebruikersnaam ten behoeve van de inloggen via de API van de wiki server.<br>
[[Bestand:CheckBox.png]] <span style="font-variant: small-caps;">Batch acties</span>: Verandert bij aanvinken de actie radioknoppen in checkboxen, zodat meer dan één actie geselecteerd kan worden.<br>
<span style="font-variant: small-caps;">Wachtwoord</span>: Bijbehorend wachtwoord. Het wachtwoord wordt nooit getoond. Het kan wel ingevoerd worden.<br>
Bij batch acties wordt de inhoud van het resultaatvenster in een tekstfile weggeschreven en opgeslagen in resultaat basisfolder.<br>
<span style="font-variant: small-caps;">AD repository</span>: ART DECOR repository waar de wiki pagina's naar verwijzen. ReadOnly. Wordt gevuld met informatie uit het publicatiebeheer.<br>
De registratie acties kunnen niet in batch uitgevoerd worden, omdat voor en na het uitvoeren van deze acties handmatig zaken aangepast moeten worden. In de batch setting zullen deze acties uitgegrijst zijn.
</li>
</li>
<li>'''Enterprise Architect RTF template gegevens'''<br>
<li>'''Opties'''<br>
<span style="font-variant: small-caps;">Sjabloon</span>: Dropdownlist met alle RTF templates die de geopende .eap file bevat. Hieruit moet een template gekozen worden die overeenkomt met de gekozen publicatietaal. De template wordt gebruikt bij het generereren van de PDF output.<br><li>'''Additionele wikipagina gegevens'''<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Forceer herregistratie</span>: 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<br>
<span style="font-variant: small-caps;">Hoofdpagina</span>: Naam van het (meertalige) label dat de link bevat naar publicatie startpagina.<br>  
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Maak backup</span>: Indien aangevinkt wordt voordat zib registraties en verwijzingen opgeslagen wordt, eerst een backup gemaakt van het groeps-en publicatiebestand.<br>
<span style="font-variant: small-caps;">TOC sectie#</span>: Nummer van de sectie van de publicatie startpagina waarin de opsomming van de in de publicatie opgenomen bouwstenen zich bevindt. Indien de indeling van de startpagina gewijzigd wordt, kan dit evt. aangepast worden.<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Oud format</span>: 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.<br>
<span style="font-variant: small-caps;">Legenda</span>: Naam van het (meertalige) label dat de link bevat naar de legenda pagina.
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Tijdelijke folders behouden</span>: Standaard worden bij het afsluiten een aantal bestanden en folders weggegooid. Dit vinkvak voortkomt dat.<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Document in DOCX format</span>: Maak de uitvoerbestanden aan in DOCX format in  plaats van als PDF.<br>
[[Bestand:CheckBox.png]] <span style="font-variant: small-caps;">Pagina's preview</span>: Als het vinkvak aangevinkt wordt, wordt na het genereren van de wikipagina deze als tekst in het resultaat venster getoond.<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Valuesets in AD format</span>: Voor de valuesets zijn twee XML formats beschikbaar. Kies voor de export naar ART-DECOR het AD format (standaard aangevinkt).<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Negeer certificaat fouten</span>: 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<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Refresh Wiki pagina's</span>: Purged na het laden alle pagina's van de publicatie in de publicatietaal om oude versies van de pagina's te verwijderen.
<li>'''Resultaat locatie'''<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Bewaren</span>: Indien aangevinkt worden de resutaten ook in een subdirectory structuur onder de resultaat locatie.<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Hergebruiken</span>: Indien aangevinkt worden de eerder bewaarde gegevens gebruikt voor de upload. (Knop wordt actief als Upload als enige actie geselecteerd is).<br>
<span style="font-variant: small-caps;">Resultaat locatie</span>: 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.<br>
Als de resultaat locatie bij bewaren al een bestand bevat met dezelfde naam, verschijnt een dialoog met keuzes voor al dan niet overschrijven.
</li>
</li>
<li>'''Nieuwe configuratie'''<br>
<li>'''Instellingen venster'''<br>
[[Bestand:Checkbox.png]] <span style="font-variant: small-caps;">Bewaar als nieuwe configuratie</span>: Als het vinkvak aangevinkt wordt, kan in het 'Configuratienaam' veld een naam voor de nieuwe configuratie ingevuld worden.<br>
Overzicht van de naam van de geopende eap file en de ingestelde configuratie items
Als daarna op 'OK' wordt gedrukt zal de huidige setting opgeslagen worden onder de nieuwe naam. Indien de naam al in gebruik is, volgt een foutmelding en de gelegenheid om een andere naam te kiezen.<br>
Bij het opslaan zal de oorspronkelijke configuratie niet gewijzigd worden. De nieuwe configuratie kan daarna gekozen worden bij het openen van een eap bestand.
</li>
</li>
<li>'''Actie knoppen'''<br>
<li>'''Beheer configuraties'''<br>
<span style="font-variant: small-caps;">OK</span>: Ingevoerde wijzigingen opslaan en scherm sluiten<br>
Met deze mini dialoog kunnen configuraties geselecteerd worden die uit de lijst met configuraties verwijderd moeten worden.<br>
<span style="font-variant: small-caps;">Annuleren</span>: Scherm sluiten en eventuele wijzigingen negeren.<br>
<span style="font-variant: small-caps;">Annuleer</span>: Sluit het dialoogvenster zonder wijzigingen aan te brengen.<br>
<span style="font-variant: small-caps;">Verwijder</span>: Verwijdert de geselecteerde configuratie en sluit het dialoogvenster.<br>
[[Bestand:CheckBox.png]]<span style="font-variant: small-caps;"> Maak een backup</span>: Voordat de configuraties verwijderd worden, wordt een kopie gemaakt van het oorspronkelijke configuraties bestand.<br>
Deze heeft naam van het configuratie bestand plus een timestamp en wordt op dezelfde locatie opgeslagen als het configuraties bestand.
</li>
</li>
<li>'''Statusbalk'''<br>
<li>'''Statusbalk'''<br>
Geeft de locatie aan waar de configuratie file is opgeslagen.
Geeft de locatie aan waar de configuratie file is opgeslagen.
</li>
<li> '''Header '''<br>
Geeft de  naam van de gekozen configuratie weer.
</li>
</li>
</ol>
</ol>


==Gebruik==
==Gebruik==
Het gebruik van het configuratie scherm is intuitief en behoeft weinig uitleg.<br>
Voor het gebruik van ZibExtraction wordt verwezen naar de [[ZibExtraction |wikipagina over het publiceren van zib's]].
Ieder locatieveld heeft een knop 'Bladeren' waarmee een standaard folder dialoog gestart wordt.<br>
Zoals bij de besturingselementen beschreven is, worden de locatievelden voor de XML, Wiki, XLSX en PDF resultaten default gevuld met een door de applicatie aangemaakte locatie.<br>
De basis van deze locatie staat [[ZibExtraction_Config#Configureerbare gegevens | hier]]. De output per sessie wordt uniek gemaakt door een subdirector met een timestamp als naam.<br>
Indien de genoemde velden in het configuratie scherm gevuld worden zal de ingevulde locatie gebruikt worden zonder toevoeging van enige subdirectory.<br>
Om de default locatie te herstellen, volstaat het om deze locatievelden leeg te maken en de configuratie op te slaan.<br>
[[Bestand:Warning-icon.png]] Wees terughoudend met het wijzigen van de 'Configuratie' locatie.
Het wijzigen van de 'Configuratie' locatie heeft grote impact op de werking van de applicatie. Daarom zal na het wijzigen van dit veld bij het verlaten van het scherm via de OK knop een dialoog verschijnen met de vraag of dit echt de bedoeling is.<br>
Indien daarop positief geantwoord wordt, zal de applicatie afsluiten, zodat bij de volgende start labels, groepen en publicaties vanaf de nieuwe locatie geladen kunnen worden.<br>
Als de  ingevulde locatie niet verwijst naar een folder waar de label en groep/publicatie configuratiebestanden staan, zal dit tot veel foutmeldingen leiden.<br>
Ook als de bestanden er wel staan, kunnen initieel meldingen komen over niet gevonden publicaties en discrepaties tussen de setting en de eap file gegevens. Deze zullen echter na de eerste start verdwijnen.


==Configureerbare gegevens==
==Configureerbare gegevens==
Regel 88: Regel 130:
! scope="column"|Gebruik
! scope="column"|Gebruik
! scope="column"|Locatie
! scope="column"|Locatie
! scope="column"|Huidige waarde
! scope="column"|Waarde na installatie/default waarde
! scope="column"|Wijzigbaar via UI
! scope="column"|Wijzigbaar via UI
|-
|-
Regel 102: Regel 144:
|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
|-
|UserConfigLocation
|Locatie locaal bestand met configuraties
|Voorgeconfigureerde publicatie settings
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction*
||Nee
||Nee
|-
|-
Regel 108: Regel 157:
|Locatie gedeelde configuratiedata
|Locatie gedeelde configuratiedata
|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">ZibAppsStart.cfg </span>
|C:\ProgramData\Nictiz\ZibExtraction\Config
|C:\ProgramData\Nictiz\ZibExtraction\Config*
||Ja
||Ja**
|-
|ImageLocation
|Locatie gedeelde afbeeldingen
|Afbeeldingen die gebruikt worden bij uitvoer naar spreadsheet
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|<leeg>
||Ja**
|-
|Snomed_languageRefsetId_NL
|Id van de gebruikte NL ref set
|Ophalen NL definitie van SNOMED term
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|31000146106
|Nee
|-
|Snomed_languageRefsetId_EN
|Id van de gebruikte EN ref set
|Ophalen EN definitie van SNOMED term
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|900000000000509007
|Nee
|-
|TerminologyServiceLink
|Base adres van de terminologie services
|Ophalen van SNOMED en LOINC data
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|<nowiki>https://terminologie.nictiz.nl/terminology/</nowiki>
|Nee
|-
|TerminologyPageLink
|Base adres van de terminologie webpagina's
|Tonen van SNOMED en LOINC data in ART-DECOR terminology omgeving
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|<nowiki>https://terminologie.nictiz.nl/art-decor/</nowiki>
|Nee
|-
|CodeTranslateFromYear
|Publicatie vanaf waar vertaling van codes plaatsvindt
|Vertalen SNOMED CT en LOINC codes op NL wiki pagina's
|<span title= "C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction">ZibAppsStart.cfg </span>
|2018
|Nee
|}
|}
<nowiki>*</nowiki> Dit is de defaultwaarde als het veld in de configuratie file leeg is<br>
<nowiki>**</nowiki> Via het [[ZibExtraction_Config#ZibExtraction configuraties gebruikersinterface | publicatie configuratiescherm]]


==Vaste gegevens==
==Vaste gegevens==
Regel 124: Regel 218:
|Basis configuratie bestand
|Basis configuratie bestand
|Bevat opstartconfiguratiedata voor Zib app's
|Bevat opstartconfiguratiedata voor Zib app's
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction
|-
|ZibExtraction.cfg
|Configuraties bestand
|Bevat voorgedefinieerde publicatie configuraties
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction
|C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction
|}
|}


<br>
<br>

Huidige versie van 28 jan 2020 om 01: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 Registreer verwijzingen: Registreren van de verwijzingen naar andere zib's van de geselecteerde zib's in het publicaties en groepen configuratie bestand. Pas na registratie kunnen de verwijzingen in de wiki pagina's juist vermeld worden.
    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
    OK: Start het uitvoeren van de geselecteerde actie(s).
    Cancel: Stopt het uitvoeren van de geselecteerde actie(s). Stoppen kan soms niet meteen. Op de statusblak is dan zichtbaar dan het proces gestopt wordt.
    CheckBox.png Batch acties: Verandert bij aanvinken de actie radioknoppen in checkboxen, zodat meer dan één actie geselecteerd kan worden.
    Bij batch acties wordt de inhoud van het resultaatvenster in een tekstfile weggeschreven en opgeslagen in resultaat basisfolder.
    De registratie acties kunnen niet in batch uitgevoerd worden, omdat voor en na het uitvoeren van deze acties handmatig zaken aangepast moeten worden. In de batch setting zullen deze acties uitgegrijst zijn.
  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 Maak backup: Indien aangevinkt wordt voordat zib registraties en verwijzingen opgeslagen wordt, eerst een backup gemaakt van het groeps-en publicatiebestand.
    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 Waarde na installatie/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 ZibAppsStart.cfg C:\ProgramData\Nictiz\ZibExtraction\Config* Ja**
ImageLocation Locatie gedeelde afbeeldingen Afbeeldingen die gebruikt worden bij uitvoer naar spreadsheet ZibAppsStart.cfg <leeg> 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
** Via het publicatie configuratiescherm

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


Overgenomen van "https://zibs.test-nictiz.nl/index.php?title=ZibExtraction_UI&oldid=18999"