ZibExtraction UI: verschil tussen versies

Uit Zorginformatiebouwstenen
Ga naar: navigatie, zoeken
(ZibExtraction gebruikersinterface)
(ZibExtraction gebruikersinterface)
Regel 52: Regel 52:
 
<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>
 
<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>
 
<span style="font-variant: small-caps;">Eentalig maken</span>: Converteert de multilanguage zib's naar singlelanguage zib's in de gekozen publicatietaal.<br>
 
<span style="font-variant: small-caps;">Eentalig maken</span>: Converteert de multilanguage zib's naar singlelanguage zib's in de gekozen publicatietaal.<br>
[[Bestand:Warning-icon.png]] alle acties boven deze mogen uitsluitend op multilanguage zibs uitgevoerd worden, de acties onder deze actie kunnen alleen op singlelanguage zibs uitgevoerd worden. Het niet voldoen aan deze voorwwaarde leidt tot een foutmelding.<br>
+
{|
 +
|rowspan = "2" valign = "top" |[[Bestand:Warning-icon.png]]
 +
| Alle acties boven deze mogen uitsluitend op multilanguage zibs uitgevoerd worden, de acties onder deze actie kunnen alleen op singlelanguage zibs uitgevoerd worden.  
 +
|-
 +
|Het niet voldoen aan deze voorwaarde leidt tot een foutmelding.
 +
|}
 
<span style="font-variant: small-caps;">Wiki pagina's aanmaken</span>: Aanmaken van de zib wikipagina.<br>  
 
<span style="font-variant: small-caps;">Wiki pagina's aanmaken</span>: Aanmaken van de zib wikipagina.<br>  
 
<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>
 
<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>
Regel 60: Regel 65:
 
</li>
 
</li>
 
<li>'''Actieknoppen'''<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;">Uitvoeren</span>: Start de 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>
+
[[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.
<span style="font-variant: small-caps;">Gebruiker</span>: Bits gebruikersnaam ten behoeve van de inloggen via de API van de wiki server.<br>
 
<span style="font-variant: small-caps;">Wachtwoord</span>: Bijbehorend wachtwoord. Het wachtwoord wordt nooit getoond. Het kan wel ingevoerd worden.<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>
 
 
</li>
 
</li>
 
<li>'''Opties'''<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>
+
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Forceer herregistratie</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>
 
+
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Oud format</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>
 +
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Tijdelijke folders behouden</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>
 +
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Document in DOCX format</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>
 +
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Valuestes in AD format</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>
 +
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Negeer certificaat fouten</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>
 +
[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Refresh Wiki pagina's</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>[[Bestand:Checkbox.png]]<span style="font-variant: small-caps;">Forceer herregistratie</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>'''Resultaat locatie'''<br>
 
<li>'''Resultaat locatie'''<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>
 
[[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>

Versie van 27 nov 2018 om 15:53

Manual pagina's

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.
(Zie, voor een overzicht van alle configureerbare items, de beschrijving van ZibExtraction).
De gebruikersinstellingen zijn variabel en hiervoor is een gebruikersinterface aanwezig. Deze pagina beschrijft de werking van de configuratie gebruikersinterface.
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.
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.
De configuraties worden opgeslagen in een lokaal XML bestand, met de naam 'ZibExtraction.cfg'. De locatie van het bestand is hier te vinden
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 beheer van de applicatie ZibExtraction.

ZibExtraction gebruikersinterface

Het programma ZibExtraction kent de volgende besturingselementen:

ZibExtractionUI.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:
    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.
    XML en XMI waardenlijsten: Aanmaken door EA van het XMI bestand en het converteren van de valuesets uit de RFT bestanden naar XML.
    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 acties onder deze actie kunnen alleen op singlelanguage zibs uitgevoerd worden.
    Het niet voldoen aan deze voorwaarde leidt tot een foutmelding.

    Wiki pagina's aanmaken: Aanmaken van de zib wikipagina.
    PDF/DOCX bestanden maken: Aanmaken PDF of DOCX representatie van de zib, aan de hand van het gekozen sjabloon .
    XLSX bestanden maken: Aanmaken spreadsheet representatie van de zib.
    Inhoudsopgave maken: Genereren van lijst met zibs dit tot de publicatie behoren. Dit overzicht komt op de publicatie startpagina in de sectie die in de configuratie vastgelegd is.
    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.
  6. Opties
    Checkbox.pngForceer herregistratie: 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.
    Checkbox.pngOud format: 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.
    Checkbox.pngTijdelijke folders behouden: 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.
    Checkbox.pngDocument in DOCX format: 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.
    Checkbox.pngValuestes in AD format: 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.
    Checkbox.pngNegeer certificaat fouten: 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.
    Checkbox.pngRefresh Wiki pagina's: 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.
    Checkbox.pngForceer herregistratie: 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.
  7. Resultaat locatie
    Checkbox.png Bewaar als nieuwe configuratie: Als het vinkvak aangevinkt wordt, kan in het 'Configuratienaam' veld een naam voor de nieuwe configuratie ingevuld worden.
    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.
    Bij het opslaan zal de oorspronkelijke configuratie niet gewijzigd worden. De nieuwe configuratie kan daarna gekozen worden bij het openen van een eap bestand.
  8. Instellingen venster
    OK: Ingevoerde wijzigingen opslaan en scherm sluiten
    Annuleren: Scherm sluiten en eventuele wijzigingen negeren.
  9. Statusbalk
    Geeft de locatie aan waar de configuratie file is opgeslagen.

Gebruik

Het gebruik van het configuratie scherm is intuitief en behoeft weinig uitleg.
Ieder locatieveld heeft een knop 'Bladeren' waarmee een standaard folder dialoog gestart wordt.
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.
De basis van deze locatie staat hier. De output per sessie wordt uniek gemaakt door een subdirector met een timestamp als naam.
Indien de genoemde velden in het configuratie scherm gevuld worden zal de ingevulde locatie gebruikt worden zonder toevoeging van enige subdirectory.
Om de default locatie te herstellen, volstaat het om deze locatievelden leeg te maken en de configuratie op te slaan.

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.
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.
Als de ingevulde locatie niet verwijst naar een folder waar de label en groep/publicatie configuratiebestanden staan, zal dit tot veel foutmeldingen leiden.
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

Naam Beschrijving Gebruik Locatie Huidige 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
CommonConfigLocation Locatie gedeelde configuratiedata Acties op het groep/release configuratie bestand ZibExtraction.cfg C:\ProgramData\Nictiz\ZibExtraction\Config Ja

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
ZibExtraction.cfg Configuraties bestand Bevat voorgedefinieerde publicatie configuraties C:\Users\[gebruikersnaam]\AppData\Local\Nictiz\ZibExtraction