Enterprise Architect Zib Add-in

---

Korte beschrijving

Enterprise Architect biedt de mogelijkheid om functionaliteit aan de applicatie toe te voegen door middel van add-in's.
Voor de zib's is een add-in gemaakt die de uitvoering van een aantal handelingen en testen die gedaan moeten worden om tot een succesvolle publicatie te komen, vereenvoudigen.
Allereerst kunnen de zib's op een groot aantal punten getest worden of zij voldoen aan de afspraken die over de zib's gemaakt zijn.
Deze eisen varieren van modelleringsafspraken tot afspraken ten behoeve van de import in ART-DECOR. De eisen zijn in detail beschreven in de documentatie.
Daarnaast kunnen van één zib of een set zib's de publicatie tags geset en gereset worden en kunnen de datumvelden gewist worden (wat handmatig niet mogelijk is).
Tenslotte biedt de add-in de mogelijkheid om eenvoudig een nieuwe versie aan te maken ten behoeve van het verwerken van issues.

Om ook het maken en wijzigen van zib's te vereenvoudigen, biedt de add-in ondersteuning voor het maken en aanpassen van elementen, waardelijsten, connectors en boundaries, door middel van custom invoerdialogen

Enterprise Architect Zib Add-in gebruikersinterface

De Enterprise Architect Zib Add-in bestaat functioneel uit twee delen, tw. een uitbreiding van het menu en de eigenlijke testmodule.

Menu

Bij de installatie van de EA zib add-in worden de volgende menu items toegevoegd:

	Figuur 2: Enterprise Architect hoofdmenu (versie 16)

1. Menu item Zib
   Na installatie van de add-in wordt het Specialize menu uitgebreid met het menu item 'Zib'
2. Submenu
   Het submenu kent zeven items:

   Open zib repository: Hiermee wordt de server gebaseerde Azure SQL repository geopend.

   Het menu item is alleen selecteerbaar als er nog geen repository geopend is.

   De connection string van de database staat in bestand 'ZibDbConnectionTemplate.easvr' in de configuratie folder.

   Tools: Hiermee wordt het zibtest scherm geopend in de EA add-in window.

   Als dit item uitgegrijsd is, wordt het eap/qeax bestand niet als Zib container beschouwd.

   Meestal betekent dit dat de tag HCIM::ZIBRepository ontbreekt of is false.

   Bilingual notes: Open een tweetalig editorscherm.

   Als dit item uitgegrijsd is, is geen item met tweetalige notes geselecteerd.

   Add new zib: Opent een dialoog om een nieuwe zib tot te voegen.

   Configure tools: Opent het configuratiescherm van de add-in.

   Help: Gebruiksaanwijzing van de add-in(deze pagina)

   About: Informatie over de add-in

3. Add-in Windows
   Mocht het add-in window niet verschijnen kan het met dit menu item getoond worden.

Add-in window

User interface

De EA Zib Add-in kent de volgende besturingselementen:

	Figuur 3: Enterprise Architect add-in window

1. Test Zib
   Start de test cyclus voor de zib.
   De eisen waar de zib op getest wordt, staan beschreven in de documentiepagina's.
   De resultaten worden in het add-in window weergeven.
2. Zib Report
   Maakt een rapport van de geselecteerde zib, met de teksten van alle secties (NL en EN), het informatie model, een lijst met alle elementen met hun eigenschappen en alle waardenlijsten.
   Het resultaat wordt in het add-in window getoond en kan als PDF bewaard worden.
   Deze optie is vooral bedoeld om nieuwe zibs of sterk gewijzigde zibs te kunnen bespreken.
3. Publish
   Wijzigt de publicatie tags van de zib. Voordat dat kan gebeuren, moeten eerst de twee volgende items op de juiste waarde gezet worden.
   De volgende tags worden aangepast:
   • DCM::PublicationDate : Publicatiedatum
   • DCM::PublicatieStatus: Published/Prepublished
   • DCM::LifecycleStatus : Final
4. Publicatie datum
   Datumdialoog om de gewenste publicatiedatum in te stellen.
5. Pre(publicatie)
   Dropdown list met de opties publicatie en prepublicatie.
6. Reset Tags
   Reset de publicatie tags van de zib.
   De volgende tags worden aangepast:
   • DCM::PublicationDate : leeg
   • DCM::PublicatieStatus: Unpublished
   • DCM::LifecycleStatus : Draft
   NB. De DCM::RevisionDate wordt niet gewijzigd. Deze moet gevuld worden na het aanbrengen van een wijziging.
7. Clear Tags
   Reset de publicatie tags zoals beschreven bij 'Reset tags' en wist bovendien de DCM::CreationDate en DCM::RevisionDate tags.
   Gebruik deze optie alleen om tags te wissen als een bestaande zib gebruikt wordt als basis voor een nieuwe zib.
8. New Version
   Faciliteert het maken van een nieuwe versie van een zib.
9. Save to PDF
   Biedt de mogelijkheid om de resultaten zoals weergegeven op het Zib Testreport tabblad op te slaan als PDF.
   Dit geldt zowel voor 'Zib Test' als voor 'Zib Report'. Maar ook de resultaten van 'New Version' en 'Repair OID's' kunnen worden bewaard.
10. Notes Editor
    Opent een tweetalig editorscherm.
11. Repair OID's
    Checkt van een geselecteerde zib alle id's op geldigheid binnen de zib en herstelt deze indien nodig.
12. Toggle lock
    Plaatst of verwijdert een lock op een zib.
13. Voorbeeld uitvoer
    Tijdens de test kunnen fouten (rood), waarschuwingen (oranje) en informatieve mededelingen (groen) verschijnen.
    Allen gaan vergezeld met mededeling in het opmerkingen veld.
14. Samenvatting testresultaat
    De test besluit met een overzicht van het aantal geconstateerde afwijkingen.

Gebruik

Om de add-inn te kunnen gebruiken moet eerst via het Extensions cq. Specialize menu Zib > Tools gekozen worden.

Test zib

De knop wordt pas actief als er een enkele zib of een folder met zibs geselecteerd wordt.
Na het indrukken van de knop zal de test gestart worden. De geteste punten worden per testsectie in tabelvorm weergegeven.
Bij geconstateerde afwijkingen zal de afwijkende waarde in kleur weergegeven worden en zal in de kolom 'Opmerkingen' additionale informatie getoond worden. De kleurcodering voor de afwijkingen is:

• rood: een foutconditie die opgelost moet worden voordat de zib gepubliceerd kan worden.
• oranje: een waarschuwing. De test constateert een afwijking maar kan niet vaststellen of het om een fout gaat of niet.

Voorbeeld is het ontbreken van een publicatiedatum: voor een test tijdens de ontwikkeling van de zib is dat een juiste conditie, maar bij een finale test voor de publicatie een fout.
Waarschuwingen moeten altijd beoordeeld worden op impact en noodzaak tot verbetering.

• groen: informatieve mededeling: een afwijking die geen actie vereist.

Als de test een afwijking constateert die de test zelf kan oplossen zal dit als informatie getoond worden.

Iedere mededeling in de kolom 'Opmerkingen' wijst op een geconstateerde afwijking. Idealiter verloopt de test zonder opmerkingen.
Aan het einde van de test wordt een overzicht getoond van het totaal aantal fouten, waarschuwingen en informatieve mededeingen.
Als de examplefile locatie gevuld is, zal bij het testen van een zib ook gecontroleerd worden of de voorbeeld file de juiste versie heeft.

Publish

De actie is beschikbaar voor enkele zib's en voor een folder met zib's.
Selecteer met behulp van de datumdialoog de publicatiedatum en geef met de dropdown list aan of om een publicatie gaat of om een prepublicatie
Als in de eap/qeax file de tag HCIM::ReleaseType bestaat, zal deze waarde als preset worden gebruikt. Druk vervolgens op de knop 'Publish'. De add-in zal voor iedere geselecteerde zib de publicatie tags op de gekozen waarden zetten.
. Bovendien wordt in iedere zib in de sectie 'Revison History' gezocht naar de sjabloon tekst nn-nn-nnnn en wordt dit sjabloon vervangen door de publicatiedatum

Reset

De actie is beschikbaar voor enkele zib's en voor een folder met zib's.
Een druk op de knop zal voor de geselecteerde zib's de publicatie datum wissen en de publicatiestatus velden resetten.
Deze actie is nodig als de eap met een gepubliceerde set zib's gekopieerd wordt om als werkversie voor de volgende (pre)publicaite te dienen.

Clear

De actie is beschikbaar voor enkele zib's en voor een folder met zib's.
Een druk op deze knop doet hetzelfde als Reset maar wist bovendien de DCM::RevisionDate en de DCM::CreationDate tag.
Dit is handig als een bestaande zib gebruikt wordt als basis voor een nieuwe zib.

 De gewiste datumvelden kunnen niet meer hersteld worden. Wees dus voorzichtig met deze functie.

New version

Voor het maken van een nieuwe versie van een zib moet op deze knop gedrukt worden. Dit roept een keuze scherm op met de mogelijke nieuwe versienummers.
Na het kiezen van de nieuwe versie, worden alle vermeldingen van het versienummer aangepast. Tevens wordt een nieuwe entry in de revision history gemaakt voor de nieuwe versie.
Indien het vinkvak 'Modify Example Filename' wordt geselecteerd, zal op de aangegeven locatie gezocht worden naar de example file en wordt de naam aangepast, de inhoud natuurlijk niet.
Als geen locatie ingegeven is, wordt een folder selectiedialoog gestart.
Welk van de mogelijk nieuwe versienummers gekozen wordt, hangt af van de aard van de wijziging. De criteria voor de keuze vallen buiten de scope van de handleiding en zijn elders gedocumenteerd.
Binnen één (pre-)release cyclus van de zibs kan maar één nieuwe versie van een zib gemaakt worden.
Mocht na het maken van een nieuwe versie blijken dat een volgende wijziging een ander versienummer vereist (b.v. niet 3.1.2 maar 3.2), kan opnieuw de optie 'New version' geselecteerd worden.
Het scherm met nieuwe versienummers zal dan alleen de nog mogelijke nieuwe nummers tonen.
Na selectie worden wederom alle voorkomens van het versienummer aangepast, maar wordt geen nieuwe entry in de revision history aangemaakt. In plaats daarvan wordt het versienummer in de entry aangepast.

Repair OID's

In een aantal gevallen is het gewenst om de id's van een zib (concepten en waardenlijsten) te checken op juistheid binnen de context van de zib:

• indien bij het maken van een nieuwe zib een tijdelijk, niet geregisteerd id is gebruikt en een nieuwe wel geregisteerde id beschikbaar is.
• als tengevolge van kopieer acties sommige elementen foutieve id's hebben.

Uitgangspunt bij de controle en het herstel, is de waarde van de tag DCM::Id op zib niveau.
In het eerste voorbeeld zal eerst het nieuwe id ingevuld worden in de DCM::Id tag. In het tweede voorbeeld zal het bestaande id als basis genomen worden.
Na het starten van de check/rapportage zullen alle id's waar nodig gewijzigd worden. De uitgevoerde acties worden in het report deel van de add-in weergegeven.

Toggle lock

Bij gebruik van een centrale database als EA repository, wordt gezamelijk in één repository gewerkt. Indien gelijktijdig aan dezelfde zib wordt gewerkt, kan dat tot problemen leiden.
Daarom is het noodzakelijk een zib tegen wijziging door anderen te beschermen. Dit wordt gedaan door de zib te locken m.b.v. de 'Toggle lock' knop. Selecteer een willekeurig element van de zib en druk op de knop.
Voor alle onderdelen verschijnt een blauw !, ten teken dat de zib gelocked is. Staat voor de onderdelen van een zib een rood !, dan is de zib door een ander gelocked en kan niet gewijzigd worden.
Door in een zib met blauwe ! een onderdeel te selecteren en weer op de knop te drukken, wordt de zib vrijgegeven. Bij afsluiten van een EA sessie op de centrale database worden de locks van de gebruiker sowieso vewijderd.
Om locken mogelijk te maken, moet op in EA ingelogd worden. Dit gebeurt automatisch via OpenId.

Tweetalige teksteditor

Tweetalige notes velden hebben een XML structuur om teksten in beide talen te kunnen opslaan.
Om het aanmaken en wijzigen van deze tweetalige notes velden makkelijker te maken, is een tweetalige editor beschikbaar.
De eerste keer dat een tot dan toe leeg tweetalig notes veld met de editor van tekst wordt voorzien, wordt automatisch een XML structuur aangemaakt.

		Figuur 4: Tweetalige teksteditor

1. Nederlands tekstveld
   De Nederlandse tekst van de notes. Ieder edit windows heeft een knoppen balk met de gebruikelijke edit functies.
   Als de muispointer boven de knop hover't, wordt de functie van de knop getoond.
   Het edit window heeft een Nederlandse taalcorrectie.
2. Engels tekstveld
   De Engelse tekst van de notes.
   Het edit window heeft een Engelse taalcorrectie.
3. Vertaalrichting
   NL>EN, EN>NL: Keuze van de bron en doel taal t.b.v. de vertalingen met Google translate.
4. Google vertaalservice
   Vertaal: Actieknop om de vertaling met behulp van de vertaalservice in gang te zetten. Indien geen tekst geselecteerd is wordt de hele tekst te vertaling aangeboden.
   De vertaalrichting geeft aan welke tekst aangeboden wordt, Nederlands of Engels.
   Indien wel een stuk tekst geselecteerd is, wordt alleen de geselecteerde tekst vertaald. Het resultaat kan met paste (Ctrl-V) opgehaald worden.
   Vertalingen met Google Translate kunnen slechts als eerste vertaal concept gezien worden. Het zonder meer gebruiken van de vertaling zal vaak tot niet accpetabele resultaten leiden.
   Als de knop uitgegrijst is, is in de configuratie ingesteld dat de service niet aangeboden wordt.
5. Google vertaalwebpagina
   Actieknop om de vertaling met behulp van de Google Translate webpagina. De opmerkingen bij 'Google vertaalservice' gelden hier ook.
   Hoewel vertaling met de webpagina het zelfde resultaat geeft als de service, werkt de laatste makkelijker en consistenter.
6. Actie knoppen
   Opslaan: Ingevoerde wijzigingen opslaan en scherm sluiten.

   Als beide taalvelden leeg zijn, wordt geen XML structuur aangemaakt.
   

   Annuleren: Scherm sluiten en eventuele wijzigingen negeren.
7. Naam notes veld
   Naam van de zib en het item waarvan de notes in de editor geladen is.

Invoer hulpdialogen

Concepten

De hulpdialoog van de invoer van concept eigenschappen wordt getoond als

• een Class element vanuit de toolbox
• een datatype als child uit de DCM Datatypes

in het diagram wordt gesleept. In het laatste geval zal het datatype al ingevuld en daarom uitgegrijst zijn.
Een doubleclick op een Class element zal de dialoog in edit mode openen. In deze mode zijn datatype en stereotype niet te wijzigen.
Het gedrag van deze hulpdialoog wordt beïnvloed door de keuzes in de configuratie.

		Figuur 5: Hulpdialoog voor het invoeren van conceptgegevens

1. Conceptnaam
   Naam van het concept (Nederlands en Engels). De naam mag geen spaties bevatten. Indien de naam samengeteld wordt uit meerdere losse woorden, krijgen de losse woorden in de conceptnaam een hoofdletter.
2. Stereotype
   Biedt de mogelijkheid het stereotype van het concept te kiezen.
3. Tagged values
   Deze velden vereenvoudigen het vullen van de noodzakelijke DCM tagged values. Afhankelijk van het gekozen datatype zullen één of meerdere tags uitgegrijst zijn.
   Door de muis over de velden te hoveren, kan de betekenis van de velden worden achterhaald.
   
   • DCM::ConceptId: Id van het concept. Deze tag wordt gegenereerd.
     

   In heel specifieke gevallen (element binnen een bouwsteen boundary, deze houdt zijn eigen id) moet het id gewijzigd worden.
   

   Druk hiervoor op de knop 'Id aanpassen'. Een pop-up met waarschuwingen zal getoond worden, waarna wijzigen mogelijk is. Wees voorzichtig met deze optie.

   • DCM::DefinitionCode #1 en #2: Code die de betekenis van het concept aangeeft. De tag kent drie velden: codesysteemnaam, code en codenaam.
     

   Een concept kan meer dan één definitioncodes hebben. De eerste twee zijn in deze interface te vullen en te wijzigen.
   

   Indien er meer dan twee definitioncodes zijn, worden deze in het veld 'Overige defintioncodes' getoond. Deze kunnen niet met deze dialoog gevuld of gewijzigd worden.
   

   Een druk op het rode kruis wist de velden van de betreffende definitioncode.
   

   Voor de codesystemen SNOMED CT, LOINC en eigen zib codesystemen is het mogelijk op grond van de code de naam automatisch aan te vullen (zie punt 9).
   

   Indien de concepten automatisch definitioncodes toegekend moeten worden (o.a. bij scores), kies dan voor het codestelsel 'ScoreObservaties'.
   

   • DCM::ReferencedConceptId: ConceptId van de zib waar naar verwezen wordt.De tag kent drie velden: conceptId, zib naam en Engelse zibnaam.
     

   Normaal wordt de zibnaam gekozen dmv de dropdownlijst. Indien de zib daar (nog) niet in staat, kunnen de gegevens ook handmatig ingevoerd worden na het checken van de checkbox (zie punt 8).
   

   • DCM::AssigningAuthority: Gegevens van de uitgevende organisatie van een nummersysteem (datatype II). De tag kent twee velden: nummersysteem naam en identificatie.
     
   • DCM::Example: Optioneel voorbeeld van de waarde die het concept kan aannemen.
4. Datatype
   Biedt de mogelijkheid het datatype van het concept te kiezen.
5. Aanpassingen
   Wijzig stereotype/datatype: (Alleen in editmode) Biedt de mogelijkheid stereotype en datatype te wijzigen.
   

   Een pop-up waarschuwt voor de gevolgen van de actie.

6. Waardebereiken
   Voor concepten kunnen twee waardenbereik-constraints worden opgegeven waarbinnen het resultaat moet vallen.
7. Notes
   Toont de inhoud van de concept definitietekst. Hoewel deze in dit onderdeel te wijzigen is, is het aan te bevelen dit via de tweetalige editor te doen.
8. Handmatige invoer
   Reference data:Standaard wordt bij een verwijzing naar een andere zib, deze gekozen uit een dropdown lijst. Alle gegevens worden dan automatisch gevuld.
   

   Als de zib niet in de lijst staat, kunnen na het checken van deze box, de gegevens handmatig ingevoerd worden.

9. Codenaam aanvullen
   Codenaam: Bij SNOMED CT en LOINC codes kan met deze checkbox er voor gekozen worden om de codenaam op grond van de code automatisch aan te vullen.
   

   In de configuratie is in te stellen of de Engelse naam of(indien beschikbaar) de Nederlandse naam genomen wordt.
   

10. Tweetalige notes editor
    Hiermee wordt de tweetalige editor gestart om het aanmaken en wijzigen van de tweetalige definitie te vereenvoudigen.
11. Actie knoppen
    
    • Klaar: Ingevoerde wijzigingen opslaan en scherm sluiten
      
    • Annuleer: Scherm sluiten en element niet aanbrengen.
      
    • Invoer in EA: Scherm sluiten, eventuele wijzigingen negeren en verder gaan in EA.
12. Statusbalk
    Meldingen naar aanleiding van de door de gebruiker gekozen actie.

Waardelijsten aanmaken

De hulpdialoog van de invoer van waardelijst eigenschappen wordt getoond als artifact van het type Document uit de Artifacts toolbox in het diagram wordt gesleept.
Het gedrag van deze hulpdialoog wordt beïnvloed door de keuzes in de configuratie.

		Figuur 6: Hulpdialoog voor het invoeren van waardelijstgegevens.

1. Aanwijzigen
   Instructie hoe na het aanmaken verder gegaan moet worden om de waardelijst automatisch de juiste naam te geven.
   Let op! De naam van de waardelijst zal in eerste instantie "Volgt" zijn. Laat de naam zo.
2. Tagged values
   DCM::ValueSetId: Automatisch gegenereerde OID voor de waardelijst.
   DCM::ValueSetBinding: De dropdownlijst geeft de mogelijke waarden voor de binding. Default wordt Extensible geselecteerd.
3. Actie knoppen
   Klaar: Ingevoerde wijzigingen opslaan en scherm sluiten.

Waardenlijsten vullen en wijzigen

Hulpdialoog voor en wijzigen van waardenlijsten.
Bij het aanmaken van een nieuwe waardenlijst zal initieel altijd een lege waardenlijst geladen worden. Het vullen ervan is een aparte stap die met deze dialoog gedaan kan worden.
Het aantal velden dat voor een entry gevuld moet worden in afhankelijk van het type waardenlijst. Voor iedere entry moet sowieso een codestelsel naam opgegeven worden.
Standaard kent de dialoog de codestelsels SNOMED CT, LOINC en NullFlavor. Andere codestelsels kunnen naar behoeve toegevoegd worden.
Indien een al gevulde waardenlijst geopend wordt, worden in de waardenlijst gebruikte codestelsels toegevoegd aan de genoemde drie.
Voor codes uit SNOMED CT, LOINC en de eigen zib codestelsels is het mogelijk om op grond van de conceptcode de conceptnaam automatisch te checken dan wel te vullen.
De omschrijving, die het uitgangspunt is van de entry, waar de conceptcode bijgezocht is, moet altijd handmatig gevuld worden. Lege velden zullen tot fouten leiden bij de testen.

		Figuur 7: Hulpdialoog voor het invoeren van waardelijstelementen.

De dialoog kent de volgende informatievelden en besturingselementen.

1. Waardenlijst entries
   Overzicht van de entries waar de waardenlijst uit bestaat. Het aantal kolommen dat getoond wordt, is afhankelijk van het type waardenlijst.
   De eerste kolom biedt de mogelijkheid één of meerdere entries te selecteren.
2. Entry selectie
   Selecteert alle entries.
   Deselecteert alle entries (grijs als niets geselecteerd is).
3. Aktie knoppen waardenlijst
   Opent een dialoog om waardenlijsten te importeren vanuit een CSV bestand of uit Art Decor ( zie hieronder).
   Checkt voor de geselecteerde entries de geldigheid van SNOMED CT, LOINC en 'zib eigen' codes en past de conceptnaam evt. aan.
   Zet de status van de geselecteerde entries op 'Deprecated'. Dit is niet omkeerbaar.
   Verwijdert de geselecteerde entries.
   Voegt een nieuwe entry toe aan het einde van de lijst of voor de geselecteerde entry.
4. Codestelsel lijst
   Overzicht van alle codestelsels waaruit in de waardenlijst codes toegevoegd kunnen worden.
   De eerste kolom biedt de mogelijkheid één of meerdere codestelsels te selecteren. Alleen nieuw toegevoegde codestelsels kunnen geselecteerd worden.
5. Codestelsel selectie
   Deselecteert alle codestelsels (grijs als niets geselecteerd is).
6. Aktie knoppen codestelsels
   Laad alle codestelsels uit de lijst in de 'Codestelsel' dropdown menu's.
   Verwijdert het geselecteerde codestelsel. De vaste codestelsels kunnen niet verwijderd worden.
   Voegt een nieuw codestelsel toe aan het einde van de lijst of voor de geselecteerde codestelsel.
   Vinkvak 'Voeg een eigen 'Zib codestelsel toe': wijzigt het gedrag van de 'Voeg toe (+)' knop en vult bij toevoegen de root OID van de eigen codestelsels alvast in.
   
7. Waardenlijst info
   
   • Naam: Nederlandse naam van de waardenlijst (readonly). De naam kan wel gewijzigd worden, maar uitsluitend via de knop ('Wijzig naam').

   Deze knop opent een dialoog waarmee zowel de Nederlandse als de Engelse naam aangepast kan worden.

   • OID: Waardenlijst OID (readonly).
   • Taal: Taal van de conceptnamen. Geldige waarden zijn 'NL', 'EN' en '--'. Dit item is uitsluitend belangrijk voor de export naar Art Decor.

   Voor tweetalige codestelsels (SNOMED CT, LOINC en de eigen zib codestelsels) moet '--' gekozen worden.

   • Binding: Binding strength van de waardenlijst (readonly).
   Deprecated: Hoewel wijzigen van de binding strength niet mogelijk is, kan de waardenlijst wel in zijn geheel op 'Deprecated' gezet worden. Dit is niet omkeerbaar.
   • Opm.(NL): Opmerking bij de waardenlijst. Bij het op 'Deprecated' zetten van de waardenlijst wordt een tekstsuggestie getoond.
   • Opm.(EN): Idem, in het Engels.
8. Aktie knoppen
   
   • Klaar: Ingevoerde wijzigingen opslaan en scherm sluiten
     
   • Annuleer: Scherm sluiten en element niet aanbrengen.
     
   • Invoer in EA: Scherm sluiten, eventuele wijzigingen negeren en verder gaan in EA.
     
   Maak backup: Indien aangevinkt wordt voor het opslaan een kopie van de oude waardenlijst als backup opgeslagen.

   De locatie van de backup bestanden is ...\Documents\Nictiz\EAAddIn\ValuesetDocs.

Waardenlijsten importeren

Vanuit de dialoog om waardenlijsten te vullen of wijzigen is het mogelijk waardenlijst-entries te importeren m.b.v. een bestand.
Ondersteunde bestandstypes zijn CSV en ArtDecor XML. Het eerste type is eenvoudig aan te maken met verschillende tools zoals b.v. Excel of Kladblok.
Het tweede type wordt aangemaakt door een bestaande waardenlijst uit Art Decor te exporteren.
Bij het eerste type moeten voor het succesvol inlezen van het bestand een aantal eigenschappen van het bestand ingesteld worden. Dit is hieronder beschreven.
Het verdient aanbeveling om de instellingen eerst te doen en dan het bestand pas te openen.

		Figuur 8: Hulpdialoog voor het importeren van waardelijstelementen.

1. Menubalk
   File: Heeft twee submenu items:
   • Open: Roept een file dialoog op om een te openen file te selecteren.
   • Exit: Sluit de eap file en de applicatie.
2. BestandsType
   De volgende bestandtypen worden ondersteund:
   CSV: Bestand met per rij/entry minimaal het vereiste aantal waarden gescheiden door een separator.
   AD XML: Art Decor exportbestand van een waardenlijst gemaakt in Art Decor.
3. Data selectie
   Opgave van de plaats van de waardenlijst-entry items in de rijen van het CSV bestand. Tevens kan in het eerste veld aangegeven worden op welke rij de gegevens beginnen.
   Afhankelijk van de definite van de waardenlijst waarin de rijen geimporteerd worden, kunnen velden uitgegrijsd zijn.
4. Seperator
   Opgave van de gebruikte seperator. Gekozen kan worden Puntkomma, Komma, Spatie of Tab.
5. Encoding
   Opgave van de gebruikte encoding. In de meeste gevallen zal een keuze voor Windows goed zijn. Mochten bij het inlezen onleesbare tekens verschijnen kan een andere codering geprobeerd worden.
6. Aktie knop inlezen
   Leest onder de gekozen instellingen alle rijen uit het bestand in, met inachtneming van de startregel.
7. Resultaat
   Na het inlezen worden de regels die als valide waardenlijst-entry kunnen worden ingelezen hier getoond. De items worden gescheiden door een '|'.
8. Foute regels
   Regels in het bestand die niet worden herkend als waardenlijst-entry, worden in dit tekstvlak getoond,
9. Overzicht
   Het overzicht geeft het aantal goede en het aantal foute regels op. Als dit volgens verwachting is kan verder gegaan worden.
10. Aktie knoppen
    
    • OK: Ingelezen entries in de waardenlijst importeren
      
    • Annuleren: Importeren afbreken.
      
    Huidige lijst vervangen: Indien aangevinkt wordt de inhoud van de waardenlijst overschreven, anders worden de entries toegevoegd.
11. Statusbalk
    Geeft informatie over het verloop van het inlezen.
12. Info
    Voor het openen van een ArtDecor XML bestand zijn geen extra instellingen nodig. De velden van het 'Info' blok geven informatie die in het bestand staan over de naam en de OID in Art-Decor.
    Deze hoeven niet overeen te komen met de waarden in de zib.

Connectors

Een hulpdialoog voor de invoer van connector eigenschappen wordt getoond als connector wordt aangebracht tussen een class element en een document artifact of tussen twee class elementen.
Als een connector tussen een constraint en boundary wordt aangebracht, wordt geen dialoog getoond, maar wordt wel het type connector gecontroleerd en eventueel aangepast.
Als de boundary van het type zib begrenzing is, zal de constraint gevuld worden met een standaardtekst.
Het gedrag van deze hulpdialoog wordt beïnvloed door de keuzes in de configuratie.

		Figuur 9: Hulpdialoog voor het invoeren van connector gegevens bij waardelijsten.

1. Naam waardelijst
   Automatisch gegenereerd voorstel voor de Nederlandse en Engelse naam van het concept. De naam mag geen spaties bevatten.
   Het voorstel is gebaseerd op de naam van het CO of CD concept waar de connector naar toe loopt en op de eventueel al bestaande waardelijsten die aan het concept hangen.
2. Type waardelijst
   Indien het concept waar de connector naar toeloopt datatype CD heeft kan hier aangegeven worden of de lijst uit losse elementen uit een codesysteem bestaat of uit een heel codesysteem (incl. ref sets en expressies).
   Bij datatype CO zullen de keuzes uitgegrijst zijn.
3. Actie knoppen
   Klaar: Ingevoerde wijzigingen opslaan en scherm sluiten.
   Invoer in EA: Scherm sluiten, eventuele wijzigingen negeren en verder gaan in EA.

		Figuur 10: Idem tussen classes.

1. Van .. naar
   Namen van de concepten die door de connector verbonden worden.
2. Type connector
   Type van de aangebrachte connector. Aangezien alleen composition en aggregation toegestaan zijn, zal als er een ander type gekozen is dit als fout worden aangegeven.
   EA biedt helaas niet de mogelijkheid dit vooraf in te perken.
3. Cardinaliteit
   Een dropdown lijst biedt de mogelijkheid een keuze te maken uit de in EA gedefinieerde cardinaliteiten.
4. Actie knoppen
   OK: Ingevoerde wijzigingen opslaan en scherm sluiten.
   

Boundaries

		Figuur 11: Hulpdialoog voor het invoeren van boundarygegevens.

1. Type boundary
   Voor de zibs zijn drie boundaries voorgedefinieerd. De keuzes staan vermeld als type boundary.
   Mocht een andere boundary gewenst zijn, moet het scherm via de knop Invoer in EA verlaten worden.
2. Extra gegevens
   Afhankelijk van het gekozen type zijn extra gegevens nodig. De boundary type keuze activeert één van de invoervelden.
3. Aanwijzingen
   Voor ieder type boundary worden aangepaste aanwijzingen gegeven om de boundary en de eventueel connectors op de juiste wijze aan te brengen.
4. Actie knoppen
   Klaar: Ingevoerde wijzigingen opslaan en scherm sluiten
   Invoer in EA: Scherm sluiten, eventuele wijzigingen negeren en verder gaan in EA.

Toevoegen nieuwe zib

Om een compleet nieuwe zib toe te voegen aan een folder met zibs moet een groot aantal handelingen verricht worden.
Met de hulpdialoog 'Nieuwe zib' wordt dit vereeenvoudigd tot het invoeren van de naam (NL en EN) en de OID van de zib.
Voor de OID zijn twee mogelijkheden, een geregisteerde zibOID of een tijdelijk OID. Deze laatste moet voordat de nieuwe zib in de formael set komt, vervangen worden door een gereigistreerde zibOID
Om qua nummering niet in conflict te komen met bestaande zib, wordt aangeraden voor tijdelijk OID's zib groepsnummer 90-99 te gebruiken en de nieuwe zib vanaf 1 te nummer, b.v. 99.1.
Het gebruik van tijdelijke nummers zal wel tot foutmeldingen leiden bij de test. Ook het gebruik van niet geregistreerde zibOID's leidt tot fouten.
Selecteer de folder waarin de nieuwe zib moet komen, voor deze op te slaan.

		Figuur 12: Hulpdialoog nieuwe zib

De dialoog kent de volgende velden en controls:

1. Naam
   De naam van de nieuwe zib (in NL en EN). Het rootconcept zal dezelfde naam krijgen.
2. Zib type
   Mogelijke keuzes: zib, subzib, template of process.
3. Zib Id
   Het OID van de nieuwe zib.
   Het rootId van zibs staat vast ingevuld. Alleen het zib groepsnummer en het zib volgnummer moet ingevuld worden.
4. Tijdelijk Id
   Indien aangevinkt is het ingevulde Id een tijdelijk Id, d.w.z. het Id is niet geregistreerd.
   
5. Actie knoppen
   Klaar: Aanmaken nieuwe zib.
   Annuleer: Aanmaken nieuwe zib afbreken.

Configuratie van de add-in

Een aantal aspecten van de werking van de add-in zijn configureerbaar.

		Figuur 13: Configuratiescherm van de add-in

1. Invoerdialoog keuzes
   Concept eigenschappen: Indien gecheckt zal als een nieuwe data element hetzij uit de toolbox hetzij uit de standaard datatypes op het diagram wordt gesleept, een zib specifiek invoerdialoog getoond worden.
   

   De checkbox is tristate, dwz dat er drie toestanden zijn: geen vink=geen dialoog, vink= dialoog voor nieuwe concepten en gevuld vierkant (double check)=ook edit dialoog na double click op het item.

   Waardelijst eigenschappen: Indien gecheckt zal het in het diagram slepen van een document artifact een zib specifiek invoerdialoog scherm oproepen.
   Connector eigenschappen: Indien gecheckt zal bij het aanbrengen van een connector een zib specifiek hulpscherm opgeroepen worden en zal daarna het juiste type connector worden aangebracht.
   Boundary eigenschappen: Indien gecheckt zal bij het aanbrengen van een boundary een zib specifiek hulpscherm opgeroepen worden en zullen daarna he vereiste tags worden aangemaakt en eigenschappen van de boundary aangepast worden conform de afspraken hierover.
   Delete dialoog: Indien gecheckt zal bij het verwijderen van een 'Class' element uit een diagram de vraag gesteld worden of het element ook uit de projectbrowser verwijderd moet worden. Standaard gebeurt dit niet.
   Concept Id's aanvullen: Indien gecheckt, zal bij het aanmaken van een nieuw concept gecontroleerd worden of er concepten zonder DCM::ConceptId zijn.
   

   Indien dit zo is zal de vraag gesteld worden of deze eerst gegenereerd en toegekend moeten worden voordat een nieuwe Id wordt aangemaakt.
   

   In edit mode zal indien het gekozen element geen Id heeft gevraagd worden of een Id eerst toegekend moet worden.
   

   Foutieve Id's verwijderen: Als 'Concept Id's aanvullen' gecheckt is en de vraag om nieuwe Id's te genereren met Ja is beantwoord, zullen, als dit item gecheckt is, evt. bestaande DCM::ConceptId tags verwijderd worden.
2. Vertaalservice
   Google Translate webpage: Indien gecheckt, is de knop voor vertaling via de Google Translate webpagina geactiveerd.
   Google Translate service: Indien gecheckt, is de knop voor vertaling via de Google Translate service geactiveerd.
   

   Dit is een betaalde service. Om de service te kunnen gebruiken moet de locatie van de Google credentials json file op gegeven worden.

3. Google credentials locatie
   

   Locatie waar de Google credentials json file staat. Deze file is nodig om van de vertaal service te kunnen gebruiken.
   

   Met de knop Zoeken wordt een filebrowser window geopend om de file te selecteren.

4. Taal code definities
   Indien bij een SNOMED CT of LOINC code ervoor gekozen wordt om de codeomschrijving automatisch te vullen op basis van de code, kan hier gekozen worden of dit de Engelse of (indien beschikbaar) de Nederlandse omschrijving is.
5. E-mail naam voor server db inlog
   De e-mail naam die in de connection string als username wordt gebruikt bij inloggen op de SQL server en bij OpenId inlog.
6. Actie knoppen
   Opslaan: Ingevoerde wijzigingen opslaan en scherm sluiten
   Annuleren: Scherm sluiten en eventuele wijzigingen negeren.
7. Overige opties
   Zib prefix: Als een zib niet deze prefix heeft, zullen de invoerdialogen niet getoond worden (voorlopig readonly).
8. OID bases
   Om herkend te worden als valide onderdeel van een zib en om mee te tellen bij het bepalen van id's voor nieuwe elementen, moeten de bestaand elementen de volgende(symbolische) OID's als basis hebben.
   Zibs: Root OID voor de DCM::Id's (voorlopig readonly). Als er geen geldige DCM::Id gedefinieerd is kan automatische nummering niet plaatsvinden.
   Concepten: Symbolische OID voor de concepten van een zib, inclusief het rootconcept (voorlopig readonly).

   Op grond van deze symbolische OID worden de id's voor nieuwe concepten gegenereerd.

   Voor nieuwe zibs moet alleen de basis bekend te zijn. Het informatie model van een nieuwe zib mag leeg gestart worden, zonder rootconcept.
   

   Waardenlijsten: Basis OID voor waardelijsten (voorlopig readonly).
   Codestelsels: Basis OID voor 'zib eigen' codestelsels(voorlopig readonly).

   Op grond van deze OID worden de id's voor nieuwe waardelijsten gegenereerd.

9. File locaties
   Codestelsel file: Locatie van de file met de definities van de 'zib eigen' codestelsels.

   Deze file wordt gebruikt om codes uit waardenlijsten te controleren op geldigheid.
   

   Zibnamen file: Locatie van de file met de zibnamen (NL en EN) en OID's.

   Deze file wordt gebruikt om het verwijzen naar andere zibs te faciliteren.
   

10. Statusbalk
    Geeft de locatie aan waar de configuratie file is opgeslagen.

Known issues

- Doordat in het verleden in een aantal zib's de legenda op foutieve wijze gekopieerd is hebben deze zib's feitelijk geen eigen legenda maar een verwijzing naar de legenda van een andere zib.
In de presentatie van het informatie model in EA is dit niet te zien, dit is uitsluitend te constateren in de onderliggende database. Het levert dus ook geen problemen op.
Niettemin geeft dit aanleiding tot de informatieve mededeling: 'Gedeelde legenda' en een aantal legenda's van nul in plaats van één.

- In de laatste testsectie wordt getracht vast te stellen of het aantal elementen van de zib in de projectbrowser overeen komt met het aantal in het informatie model diagram.
Om een aantal redenen is deze test nog niet helemaal betrouwbaar en geeft soms aanleiding tot onterechte meldingen.
Niettemin verdient het aanbeveling om bij deze meldingen projectbrowser en het informatie model te checken op losse elementen.
Een bekend probleem ontstaat wanneer een element in het informatie model weggegooid wordt in plaats van in de project browser: het element blijft dan wel onderdeel van de zib maar wordt niet getoond.

Configureerbare gegevens

Naam	Beschrijving	Doel	Locatie	Huidige waarde	Wijzigbaar via UI
ManualWikiLocation	De basis url van deze wiki	Hiermee wordt de url van deze pagina aangemaakt.	EAAddInStart.cfg	https://zibs.nl/wiki	Nee
Snomed_languageRefsetId_NL	Id van de gebruikte NL ref set	Ophalen NL definitie van SNOMED term	EAAddInStart.cfg	31000146106	Nee
Snomed_languageRefsetId_EN	Id van de gebruikte EN ref set	Ophalen EN definitie van SNOMED term	EAAddInStart.cfg	900000000000509007	Nee
Snomed_languageRefsetId_NLPat	Id van de gebruikte patiëntvriendelijke NL ref set	Ophalen NL patiëntvriendelijke definitie van SNOMED term	EAAddInStart.cfg	15551000146102	Nee
TerminologyServiceLink	Base adres van de terminologie services	Ophalen van SNOMED en LOINC data	EAAddInStart.cfg	https://terminologie.nictiz.nl/terminology/	Nee
CodeSystemCodesFilename	Naam van het registratiebestand van alle zib eigen codestelsels	Valideren en vertalen van gebruikte codes	EAAddInStart.cfg	codes.xml	Nee
rootConceptIdFileName	Naam van het bestand met de namen van zibs waarvan het rootconcept een afwijkend id heeft, i.e. niet 1	Voorkomen van onterechte foutmeldingen in de zib test	EAAddInStart.cfg	AfwijkendConceptIds.xml	Nee
ZibIdentifiersFilename	Naam van het registratiebestand van de zibs	Valideren van gebruikte zib id's.	EAAddInStart.cfg	ZibIds.xml	Nee
ZibNamesFilename	Naam van het bestand met de namen van alle zibs	Vullen dropdown lijsten met zib namen	EAAddInStart.cfg	Zibs.xml	Nee
DebugInEA	Switch om debugging aan/uit te zetten	Indien true wordt debug info in EA SystemOutput gegeven.	EAAddInStart.cfg	false	Nee
ForceDirInput	Switch om initiële folderdialoog te forceren	Indien true wordt de dialoog bij opstart weergegeven	EAAddInStart.cfg	false	Nee

Vaste gegevens

Naam	Beschrijving	Doel	Vaste locatie
EAAddInStart.cfg	Basis configuratie bestand	Bevat opstartconfiguratiedata voor EA add-in voor zibs	C:\Users\[gebruikersnaam]\Documenten\Nictiz\EAAddIn