Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 7.53 KB

readme.md

File metadata and controls

26 lines (21 loc) · 7.53 KB
Raw

Hier vind je de Archi scripts die worden gebruikt bij maken en onderhouden van het GEMMA ArchiMate-modellen en de VNGR projectarchitecturen (zoals de projectarchitectuur omgevingswet).

Zie de pagina Archi scripting voor een handleiding installeren van de jArchi plugin.

Hoe de scripts gebruikt moeten worden, is (meestal) bovenin het script beschreven. Kijk hieronder voor welke scripts er zijn en wat deze doen. De tabel is niet uitputtend, opgesomd worden de meest gebruikte scripts:

Folder Scripts
_lib Door de scripts gebruikte generieke functies. Naast enkele node javascript libraries vind je hier:
  • common.js: generieke functies voor logging en debugging
  • selection.js: generieke functies voor het selecteren van objecten in de model tree of in een view
Modules hebben de extensie .js en zijn niet zichtbaar in Archi. Een uitvoerbaar Archi script heeft de extensie .ajs
root folder Veel gebruikte scripts, geplaatst in de root om met minder klikken te kunnen draaien
  • addProperty: Voeg een property met inhoud/waarde toe aan de geselecteerde concepten
  • copyFormat: Selecteer in een view een object en draai dit script. Alle objecten op de view hebben nu dezelfde opmaak
  • mergeElement: Maak van meerdere elementen met dezelfde naam en van hetzelfde Archimate-type één element. Alle relaties, view-occurences en properties worden overgezet en blijven dus bewaard
  • mergeRelation: Idem, maar nu voor relaties
  • removeBendpoints: Selecteer een view of relaties op een view en verwijder alle bendpoints
  • reverseRelation: Selecteer één of meerdere relaties en keer de richting van de relaties om
Appearance Scripts voor het opmaken van views (selecteer een view of objecten in en view)
  • toggleFigure: Toggle de figure van objecten in een view
  • colorByProperty: Wijzig de kleur van objecten op basis van de waarde van een te kiezen property
  • setDefaultFormat: Reset het uiterlijk van objecten op views naar de jouw Archi settings
Beheren Scripts voor het in bulk vinden of bewerken van objecten
  • createProjectmodel: save a copy of the reference model and keep only the for the project relevant objects
  • deleteUnusedElements: Verwijderd alle concepten die niet op een view voorkomen
  • deleteEmptyFolders: Verwijderd in een geselecteerde model of folder de lege folders
  • findDuplicateRelations: Toont een lijst met id's van dubbele relaties in de console
  • find_Id_or_Name_InModels: Zoek op Object ID, id of naam in geopende modellen in de model tree
Convert to Scripts voor het wijzigen van het ArchiMate-type van een concept (bijvoorbeeld een Application Function naar een Application Service).
Vanaf versie 5.1 van Archi is dit een standaard functie (rechts klikken op object > set concept type).
Extra functie van het script: meer logging en tijdens het omzetten ongeldige relatietypen worden na afloop waar mogelijk teruggezet naar het oorspronkelijke relatietype
Develop Scripts nuttig voor het ontwikkelen van scripts
  • plotID: Toon in de view de Archi-id's van de objecten
  • plotColorCode: Toon in de view de color codes van de objecten
GEMMA Scripts specifiek voor het beheer van het GEMMA ArchiMate-model of afgeleide modellen
  • setObjectID: Controleer of er geen dubbele Object ID's zijn. Geef alle elementen, relaties en views in een model een uniek Object ID
  • createReleaseModel: Maak een tijdelijk gefilterd model als bron voor het exporteren van een AMEFF bestand.
    • setObjectID, zie hierboven
    • filter: verwijder views zonder publiceren=GEMMA online, verwijder ongebruikte elementen en lege folders
    • Set model property release=<today>
  • plotObjectID: Toon in de view de Object ID's van de objecten
  • plotBetrouwbaarheidSom: Script voor view Betrouwbaarheidscriteria, toont de BIV-waarden en kleurt de objecten met de som van deze waarden
De folder used_once bevat scripts voor een eenmalige bulk acties. Eén van deze scripts is change_AF2AS, gebruikt voor het doorvoeren van een GEMMA kennismodel wijziging in het GEMMA ArchiMate-model
GGM Scripts voor het importeren en exporteren van de GGM CSV bestanden. Op de redactieomgeving van GEMMA online is de koppeling met GGM gedocumenteerd
ImportExport_CSV Scripts voor het exporteren en weer importeren van elementen, relaties en views met alle hun properties.
  • export_element: exporteer van de geselecteerde folder, view of set van objecten alle elementen naar een csv-bestand
  • export_relation: idem, maar nu voor relaties
  • export_view: idem, maar nu voor views
  • import: Gewijzigde properties worden bijgewerkt, properties met de waarde <remove> worden verwijderd
Archi maakt het gebruik van het import script veilig. Als de import niet doet wat je wilt kun je met een simpele Ctrl-z alles weer ongedaan maken.
Tip: gebruik voor het bewerken van de CSV's bij voorkeur LibreOffice Calc en niet Excel (reden is de default gebruikte characterset)
Report Genereren van een rapport gedefinieerd in een view. Gebaseerd op het script van Richard Heward - Tame Blue Lion Ltd
  • exportImage: Genereer een markdown tekst met view en tabel van de getoonde elementen van de geselecteerde view(s)
  • generate_report: Genereer een markdown rapport zoals gedefinieerd in een 'driving view'
Sync from CSV Importeren van CSV bestanden. Uit het CSV bestand kunnen meerdere objecttypen en relaties worden aangemaakt en bijgewerkt.
View Genereren van views met een directed layout. Het gedrag is configureerbaar en is gedocumenteerd in de readme.md.

Scripts en het default gedrag:
  • _generate: Genereer een view van de geselecteerde elementen. Als je één element selecteerd, wordt een view gegenereerd met dit element én alle gerelateerde elementen
  • _generate_multiple: Genereer voor ieder geselecteerd element een view
  • _layout_LR en _layout_TB: Selecteer een view en maak een layout van Links_naar_Recht of van Top_to_Bottom
  • _layout_nested_LR en _layout_nested_TB: Selecteer een view en maak een layout met nesting van Links_naar_Recht of van Top_to_Bottom. Default worden aggregation-relations genest
  • _expand: Selecteer één of meerdere elementen op een view. In de view worden van de geselecteerde elementen de gerelateerde elementen toegevoegd
Nesting is beperkt ondersteund en geeft soms fouten.

Licentie

De scripts zijn vrij beschikbaar onder de Europese Union Public Licence (EUPL). Dit betekent dat u de scripts vrij kunt gebruiken, aanpassen en verspreiden, zolang u de oorspronkelijke auteurs vermeldt en eventuele wijzigingen onder dezelfde licentie deelt.

Ondersteuning

De scripts worden zonder enige vorm van garantie of ondersteuning beschikbaar gesteld. We kunnen geen hulp bieden bij installatie, configuratie of het oplossen van problemen die zich kunnen voordoen bij het gebruik van deze scripts. Het gebruik ervan is geheel op eigen risico en verantwoordelijkheid.