ZibExtraction Config

Uit Zorginformatiebouwstenen
Versie door Albert-Jan Spruyt (overleg | bijdragen) op 28 nov 2018 om 11:46 (ZibExtraction configuraties gebruikersinterface)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Ga naar: navigatie, zoeken

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 configuraties gebruikersinterface

Het configuratie deel van het programma ZibExtraction kent de volgende besturingselementen:

Configuratie UI.png
Figuur 1: ZibExtraction Configuraties gebruikersinterface
  1. Publicatie Informatie
    Zib categorie: wordt niet meer gebruikt.
    Publicatienaam: dropdownlist met alle publicaties die met Groep en publicatiebeheer zijn aangemaakt.
    Release info: publicatie omschrijving. Wordt automatisch gevuld met de Nederlandstalige informatie uit Groep en publicatiebeheer. Readonly.
    Zib prefix: volledige prefix van de bouwstenen die in ZibExtraction geselecteerd worden, bijvoorbeeld nl.zorg of nl.zorg.part
    Publicatietaal: Taal waarin de publicatie produkten aangemaakt worden.
  2. Bestandslocaties
    Voorbeeldbestanden: Locatie van de bronbestanden van de voorbeelden uit sectie Example Instances van bouwsteen.
    Afbeeldingen: Locatie van een aantal afbeeldingen die in de spreadsheet uitvoer worden gebruikt.
    Configuratie: Locatie van het groep en publicatie definitie bestand en de label definitiebestand.
    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.
  3. Bits gegevens
    Velden met informatie die nodig is om de issue beschrijvingen uit Bits op te halen.
    URL Jira API: URL voor het aanspreken dan de API van de Bits applicatie
    Gebruiker: Bits gebruikersnaam ten behoeve van de inloggen via de API van Bits Wachtwoord: Bijbehorend wachtwoord. Het wachtwoord wordt nooit getoond. Het kan wel ingevoerd worden.
    Issue prefix:Prefix bvan de issues in bits die betrekking hebben op de bouwstenen.
    Statussen: Bits statussen waarvan de issue informatie opgehaald wordt. De statussen moeten exact overeenkomen met de benamingen in Bits.
  4. Wikisite gegevens
    Velden met informatie die nodig is om de wikipagina's te kunnen maken en om de bestanden te kunnen uploaden naar de wikiserver.
    URL Wiki API: URL voor het aanspreken dan de API van de Wiki server. Hiermee kan gekozen worden voor de test of de produktie server
    Gebruiker: Bits gebruikersnaam ten behoeve van de inloggen via de API van de wiki server.
    Wachtwoord: Bijbehorend wachtwoord. Het wachtwoord wordt nooit getoond. Het kan wel ingevoerd worden.
    AD repository: ART DECOR repository waar de wiki pagina's naar verwijzen. ReadOnly. Wordt gevuld met informatie uit het publicatiebeheer.
  5. Enterprise Architect RTF template gegevens
    Sjabloon: 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.
  6. Additionele wikipagina gegevens
    Hoofdpagina: Naam van het (meertalige) label dat de link bevat naar publicatie startpagina.
    TOC sectie#: 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.
    Legenda: Naam van het (meertalige) label dat de link bevat naar de legenda pagina.
  7. Nieuwe configuratie
    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. Actie knoppen
    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.
  10. Header
    Geeft de naam van de gekozen configuratie weer.

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

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