SmartConnectArchiMateHelp nl

Uit ROSA Wiki
Ga naar: navigatie, zoeken

SmartConnectArchiMate

SmartConnectArchiMate is een door XL&Knowledge ontwikkelde extensie voor het importeren, tonen en exporteren van ArchiMate-modellen. ArchiMate is een Open Group standaard voor het modelleren van enterprisearchitectuur. Meer informatie over ArchiMate is te vinden op de website van The Open Group. Met SmartConnectArchiMate kunt u architectuurmodellen importeren die voldoen aan de ArchiMate 2 en ArchiMate 3 standaard. U kunt modellen van beide versies naast elkaar, tegelijk in de wiki tonen.


Op deze pagina treft u informatie over:


Bekijken van en navigeren door ArchiMate-modellen

Vertrekpunt voor het bekijken van ArchiMate-modellen is de overzichtspagina DisplayArchiMateModels. Die pagina toont voor alle geïmporteerde ArchiMate-modellen een samenvatting bestaande uit statistieken (aantal elementen, relaties en views in het model), metadata, en documentatie. Als geen metadata en/of documentatie getoond wordt, dan waren die gegevens niet in het importbestand aanwezig.


Klik op de naam van een ArchiMate-model om te springen naar de detailpagina van het model. U ziet op de overzichtspagina de beschikbare metadata en documentatie van het model. Daaronder, verdeeld over drie kolommen, groeperingen van elementen (naar architectuurlaag) en relaties (naar relatiecategorie) en views. Indien het model een zeer groot aantal views bevat, dan worden niet alle views getoond om een lange laadtijd van de pagina te voorkomen. Wel wordt onderaan de views-kolom een link getoond naar een overzichtspagina voor het tonen van alle views.

Indien u bij het importeren heeft gekozen voor het mee-importeren van eventuele in het importbestand opgenomen folderstructuren, dan worden die op het modeloverzicht getoond in een apart kader onder de ArchiMate-relaties.


Klik vanuit het modeloverzicht op een categorie van ArchiMate-elementen (bijvoorbeeld BusinessActors) om te springen naar een overzicht van alle elementen van de betreffende categorie. Als er zeer veel elementen in de betreffende categorie aanwezig zijn, dan worden niet alle elementen getoond maar verschijnt onderaan de lijst een link waarmee u door de totale lijst kunt bladeren.


Klik vanuit het modeloverzicht op een categorie van ArchiMate-relaties (bijvoorbeeld AccessRelationships) om te springen naar een overzicht van alle relaties van de betreffende categorie. Als er zeer veel relaties in de betreffende categorie aanwezig zijn, dan worden niet alle relaties getoond maar verschijnt onderaan de lijst een link waarmee u door de totale lijst kunt bladeren.


Overal waar de naam van een element wordt getoond, kunt u daarop klikken om te springen naar de elementdetailpagina voor dat element. Die pagina toont alle eigenschappen van het element, inclusief in welke views het element gebruikt wordt en welke relaties naar het element verwijzen. Daaronder wordt een contextdiagram getoond. Dat toont het element met daaromheen alle andere elementen waarvoor relaties gedefinieerd zijn.


Overal waar de naam van een relatie wordt getoond, kunt u daarop klikken om te springen naar de relatiedetailpagina voor die relatie. Die pagina toont alle eigenschappen van de relatie, inclusief in welke views de relatie gebruikt wordt. Daaronder wordt een grafische weergave van de relatie getoond.


Voor een aantal typen ArchiMate-elementen en -relaties zijn geavanceerde analyses beschikbaar. Voor die elementen en relaties wordt op de detailpagina een apart kader getoond met daarin een lijst van beschikbare analyses. Klik op een item in de lijst om de desbetreffende analyse uit te voeren. De resultaten worden op een nieuwe pagina getoond, in de vorm van een lijst, een tabel of een diagram. Naast de resultaten staat een toelichting op de betekenis van de analyse.


Klik vanuit het modeloverzicht op een view om te springen naar de viewpagina voor die view. Daarop wordt het viewdiagram getoond, met daaronder een lijst van de elementen en de relaties in de view. Klik op een element of relatielabel om naar de detailpagina van het element resp. de relatie te springen. NB. Viewdiagrammen worden dynamisch samengesteld op basis van de semantische informatie in de wiki. Bij grote views kan het daarom enige seconden duren voordat de view zichtbaar wordt.


Het is mogelijk dat zeer uitgebreide views dusdanig teruggeschaald worden, dat de (labels van de) afzonderlijke elementen niet goed leesbaar meer zijn. Klik in dat geval op de link "Ware grootte" direct onder de view. De view wordt dan op een nieuwe pagina op ware grootte getoond. Ook kunt u met deze link het achterliggende svg-bestand downloaden.


Views zijn opgebouwd uit vormen (die groepen of elementen representeren) en verbindingslijnen (die relaties representeren). Indien u de technische details van de vormen en verbindingslijnen wilt bekijken, klik dan op de link "technische details" direct onder de view. De view wordt dan op een nieuwe pagina op ware grootte getoond met daaronder een lijst van alle vormen en verbindingslijnen met hun belangrijkste kenmerken. Klik in die lijst op een vorm of verbindingslijn om alle technische eigenschappen te bekijken.


Klik vanuit het modeloverzicht op een hiërarchie om te springen naar pagina waar de volledige hiërarchie wordt getoond. N.B. Bij een zeer uitgebreide hiërarchie zal deze worden afgekapt en verschijnt een waarschuwing dat niet alle items in de hiërarchie kunnen worden getoond.


Bovenaan elke ArchiMate-pagina in de wiki wordt een kruimelpad getoond dat aangeeft waar de getoonde pagina zich in de hiërarchie van het ArchiMate-model bevindt. De elementen in het kruimelpad zijn klikbaar; u kunt hiermee snel terug omhoog in de hiërarchie navigeren.


Importeren van ArchiMate-modellen

Ga voor het importeren naar de pagina Speciaal:SmartConnectArchiMate en klik op de radiobutton "Importeren ArchiMate-model". Vul de invoervelden op de juiste wijze in en klik vervolgens op "Importeer" om de import uit te voeren. Het importbestand wordt dan geüpload en ingelezen. Het daadwerkelijk aanmaken en/of actualiseren van pagina's in de wiki kan, afhankelijk van de omvang van het te importeren ArchiMate-model, enige tijd in beslag nemen en gebeurt daarom op de achtergrond. U kunt de voortgang volgen via het overzicht van wijzigingen op Speciaal:RecenteWijzigingen.


Hieronder volgt een toelichting bij het invullen van de velden op het scherm.


Te importeren bestand

Klik op de button om het bestand te selecteren dat de te importeren modellen bevat. Het bestand moet extensie .xml hebben, en moet voldoen aan de specificaties van het Open Group ArchiMate Exchange Format. SmartConnectArchiMate ondersteunt zowel versie 2 als versie 3 van deze standaard. De juiste versie wordt automatisch gedetecteerd; u hoeft dit niet te specificeren. U maakt een dergelijk bestand normaal gesproken door een model te exporteren vanuit een architectuurmodelleertool zoals Archi.


Voorkeurstaal

Met deze optie kunt u een voorkeurstaal instellen voor de benaming van de te importeren pagina's. Dit is alleen relevant wanneer objecten in uw ArchiMate-modellen voorzien zijn van labels in meerdere talen. Normaliter wordt voor de paginatitel van geïmporteerde objecten gezocht naar het label in de standaardtaal van de wiki (in deze wiki is dat "nl"), maar u kunt daar desgewenst van afwijken. Indien u niet wilt afwijken, laat deze optie dan staan op "Geen voorkeur".


Mee-importeren folderstructuur

Met deze optie kunt ervoor kiezen de folderstructuur waarin de ArchiMate-objecten in de bronapplicatie zijn georganiseerd, mee te importeren (als die in het ArchiMate-bestand aanwezig is). De optie is standaard uitgeschakeld. U heeft de folderstructuur in beginsel niet nodig om ArchiMate-modellen te bekijken, maar mee-importeren kan wenselijk zijn in verband met herexporteren of om een specifieke structuur in de wiki te kunnen gebruiken voor de navigatie. NB. Het verwerken van de import met folderstructuur duurt aanmerkelijk langer dan zonder.


Toevoegen zelfgedefinieerde eigenschappen

Met deze optie kunt u de definities van zelfgedefinieerde eigenschappen automatisch laten toevoegen in de wiki. Het gaat hier om de custom properties die u in veel ArchiMate-modelleertools kunt toevoegen. Bij de import worden de waarden die aan die eigenschappen zijn toegekend altijd opgenomen bij de desbetreffende objecten. Om die waarden op de juiste wijze als semantische eigenschap aan de objecten toe te kennen, moeten de eigenschappen met hun datatype in de wiki gedefinieerd worden. U kunt dit automatisch laten doen. Schakel deze optie uit als u dit niet wilt.
N.B. Deze optie wordt nog niet (volledig) ondersteund.


Geheel vervangen te importeren pagina's

Met deze optie kunt u ervoor kiezen pagina's die geactualiseerd worden, volledig te vervangen. Het is met SmartConnectArchiMate mogelijk om geïmporteerde pagina's te verrijken met informatie uit andere bronnen (zoals een CMDB) of met handmatig toegevoegde informatie. Bij een herimport van het ArchiMate-model kunt u die toegevoegde informatie behouden of verwijderen. Schakel deze optie in om pagina's geheel te vervangen. NB. Alle extra toegevoegde informatie gaat daarbij verloren (maar is nog wel via de revisiehistorie terug te vinden, zij het niet in semantische vorm).


Importwijze

Met deze optie kunt u bepalen wat er gebeurt met eerder geïmporteerde versies van ArchiMate-modellen. Selecteer een van de volgende opties:

  • Incrementeel
    Als u voor deze optie kiest, worden alle objecten in het bestand geïmporteerd. Daarbij worden bestaande objecten uit eerdere imports geactualiseerd en worden nieuwe objecten toegevoegd. Objecten uit eerdere imports die niet in de nieuwe import zitten, worden niet verwijderd en blijven dus in de wiki aanwezig. Hiermee kunt incrementele importen uitvoeren, dat wil zeggen een deel van een ArchiMate-model toevoegen aan de bestaande content. Dit kan praktisch zijn bij zeer grote modellen. Nadeel van deze methode is dat objecten die bewust uit een model verwijderd zijn, niet automatisch uit de wiki verwijderd worden.
  • Volledig
    Ook als u voor deze optie kiest, worden alle objecten in het bestand geïmporteerd. Daarbij worden bestaande objecten uit eerdere imports geactualiseerd, worden nieuwe objecten toegevoegd, én worden eerder geïmporteerde objecten (behorende bij de modellen in het importbestand) die niet in de nieuw te importeren versie zitten verwijderd. Hiermee kunt u een volledige synchronisatie van ArchiMate-modellen bereiken. Dit is de aanbevolen importwijze voor normaal gebruik.


Versturen e-mailnotificatie bij voltooiing

Met deze optie kunt u een e-mailnotificatie laten versturen na voltooiing van de verwerking van een importopdracht. Deze optie is met name zinvol bij het importeren van grote modellen, waarbij de verwerking enige tijd in beslag kan nemen. NB. U kunt alleen een e-mailnotificatie ontvangen wanneer bij uw voorkeuren een e-mailadres is ingevuld en dat e-mailadres door u is bevestigd.


Exporteren van ArchiMate-modellen

Ga voor het exporteren van een ArchiMate-model naar de pagina Speciaal:SmartConnectArchiMate en klik op de radiobutton "Exporteren ArchiMate-model". Vul de invoervelden op de juiste wijze in en klik vervolgens op "Exporteer" om het geselecteerde model te exporteren naar een ArchiMate-bestand. Het daadwerkelijk creëren van het exportbestand kan, afhankelijk van de omvang van het betreffende ArchiMate-model, enige tijd in beslag nemen en gebeurt daarom op de achtergrond. U ontvangt na voltooiing een e-mail met daarin een URL-link waarmee u het exportbestand kunt downloaden.

NB. Her-exporteren van een eerder geïmporteerd ArchiMate-model werkt alleen goed als dat ArchiMate-model is geïmporteerd na het beschikbaar komen van deze export-functie (1 september 2016).

Hieronder volgt een toelichting bij het invullen van de velden op het scherm.


Selecteer een ArchiMate-model

Selecteer in de uitklaplijst het ArchiMate-model dat u wilt exporteren.


Versturen e-mailnotificatie bij voltooiing

Met deze optie kunt u een e-mailnotificatie laten versturen na voltooiing van de verwerking van een exportopdracht. Deze optie is bij exporteren verplicht aangevinkt, aangezien u de e-mailnotificatie nodig heeft om het exportbestand te kunnen downloaden. NB. U kunt alleen een e-mailnotificatie ontvangen wanneer bij uw voorkeuren een e-mailadres is ingevuld en dat e-mailadres door u is bevestigd. Als u geen bevestigd e-mailadres heeft, kunt u niet exporteren.


Verwijderen van ArchiMate-modellen

Ga voor het verwijderen naar de pagina Speciaal:SmartConnectArchiMate en klik op de radiobutton "Verwijderen ArchiMate-model". Vul de invoervelden op de juiste wijze in en klik vervolgens op "Verwijder" om het geselecteerde model uit de wiki te verwijderen. Het daadwerkelijk verwijderen van pagina's in de wiki kan, afhankelijk van de omvang van het betreffende ArchiMate-model, enige tijd in beslag nemen en gebeurt daarom op de achtergrond. U kunt de voortgang volgen via het overzicht van wijzigingen op Speciaal:RecenteWijzigingen.

Hieronder volgt een toelichting bij het invullen van de velden op het scherm.


Selecteer een ArchiMate-model

Selecteer in de uitklaplijst het ArchiMate-model dat u wilt verwijderen. Let op: als u eenmaal op de knop "Verwijder" klikt, worden alle pagina's van het geselecteerde model zonder meer verwijderd.


Versturen e-mailnotificatie bij voltooiing

Met deze optie kunt u een e-mailnotificatie laten versturen na voltooiing van de verwerking van een verwijderopdracht. Deze optie is met name zinvol bij het verwijderen van grote modellen, waarbij de verwerking enige tijd in beslag kan nemen. NB. Deze optie is alleen beschikbaar wanneer bij uw voorkeuren een e-mailadres is ingevuld en dat e-mailadres door u is bevestigd.


Gebruiken van ArchiMate-views elders in de wiki

Tonen van een view op een andere wiki-pagina

U kunt geïmporteerde ArchiMate-views hergebruiken in andere wiki-pagina's. Dit doet u met behulp van de sjabloon Sjabloon:DisplayArchiMateDiagram.

In de aanroep van bovenstaande sjabloon:

  • vult u verplicht de parameter page met de paginatitel (= het laatste gedeelte in de url-balk in uw browser) van de view die (of het contextdiagram dat) u wilt tonen. U kunt hier ook de semantische naam van de view opgeven.
  • vult u optioneel de parameter maxwidth met de maximale breedte die de view op het scherm mag hebben, in pixels. Als u deze parameter achterwege laat, wordt de breedte automatisch bepaald.
  • vult u optioneel de parameter nolinks met om het even welke waarde als u wilt dat de objecten in de view niet 'klikbaar' zijn. Als u deze parameter achterwege laat, zijn objecten wel klikbaar en kunt u op die wijze vanuit de view naar objecten navigeren.
  • Vult u optioneel de parameter customproperty met de naam van een eigenschap die gebruikt moet worden als basis voor de inkleuring van de elementen.
  • Vult u optioneel de parameter nopanel met de waarde 'true' als u het legendapaneel aan de rechterzijde wilt onderdrukken.


Tonen van een downloadlink naar een view op een wiki-pagina

Als u op een wiki-pagina in plaats van een viewdiagram alleen een download-link naar een view wilt tonen, dan gebruikt de sjabloon Sjabloon:DisplayArchiMateDiagramUrl.

In de aanroep van bovenstaande sjabloon:

  • vult u verplicht de parameter page met de paginatitel (= het laatste gedeelte in de url-balk in uw browser) van de view (of het contextdiagram) waarnaar u een hyperlink wilt tonen.
  • vult u optioneel de parameter label met een tekst die u wilt tonen in de hyperlink.


Dynamische views

Wanneer u gebruik maakt van 'custom properties' in uw architectuurmodellen, dan verschijnt bij het tonen van ArchiMate-views rechts op het scherm een paneel waarmee u de waarden voor deze eigenschappen zichtbaar kunt maken in de elementen in de view. Klik hiertoe op de radiobutton van de te tonen eigenschap in het paneel.

NB. In de legenda worden geen eigenschappen opgenomen die:

  • Niet voorkomen bij de elementen in de view
  • Alleen waarden hebben met een lengte van meer dan 30 lettertekens
  • Teveel verschillende waarden hebben in de view
  • Onderdrukt worden als gevolg van een configuratie-instelling. Zie Configuratie-instellingen voor informatie over hoe eigenschappen in de legenda te onderdrukken.


Het kleurenpalet dat gebruikt wordt in de dynamische views is afhankelijk van het type eigenschap.

  • Voor eigenschappen die zijn gedefinieerd als enumeratie wordt een kleurenschaal van groen tot rood gebruikt. Hiermee wordt het mogelijk om bijvoorbeeld heatmaps te maken van kosten of aantallen incidenten per element. Het is mogelijk om de kleurenschaal om te keren. Kleurenschalen ondersteunen tot 10 verschillende eigenschapwaarden. Zie Configuratie-instellingen voor informatie over hoe enumeraties voor eigenschappen te definiëren.
  • Voor overige eigenschappen wordt een palet van willekeurige, hoogcontrasterende kleuren gebruikt. Dit kleurenpalet ondersteunt tot 20 verschillende eigenschapwaarden.

NB. Eigenschappen met meer verschillende waarden in de view dan het van toepassing zijnde kleurenpalet ondersteunt, worden niet in de legenda getoond.


U kunt een dynamische view op een andere wikipagina tonen met behulp van de sjabloon Sjabloon:DisplayArchiMateDiagram zoals beschreven onder Gebruiken van ArchiMate-views elders in de wiki.

ArchiMate queries

SmartConnectArchiMate is geïntegreerd met de query-mogelijkheden van Semantic MediaWiki. Om, bijvoorbeeld, een tabel te genereren van alle applicatiecomponenten en de modelelementen die door die applicatiecomponenten worden bediend, gebruikt u de volgende query:

{{#ask: [[Categorie:ApplicationComponents]] |mainlabel=Applicatiecomponent|?ServingRelationship=Bedient|format=table|source=archimate}}

De toevoeging 'source=archimate' stuurt de query naar de SmartConnectArchiMate queryprocessor, die er zorg voor draagt dat de gevraagde relaties correct worden geïnterpreteerd. Wanneer in de query naar een AccessRelationship wordt gevraagd, zijn de volgende opties mogelijk:

AccessRelationship
toont alle AccessRelationships, ongeacht hun type (read, write, read/write of leeg)
ReadAccessRelationship
toont alle AccessRelationships van het type 'read' of 'read/write'
StrictReadAccessRelationship
toont alle AccessRelationships van het type 'read'
WriteAccessRelationship
toont alle AccessRelationships van het type 'write' of 'read/write'
StrictAccessWriteRelationship
toont alle AccessRelationships van het type 'write'
ReadAccessWriteRelationship
toont alle AccessRelationships van het type 'read/write'

Configuratie-instellingen

Van een aantal functies kan de werking nader geconfigureerd worden op de SmartConnectArchiMate configuratiepagina Project:SmartConnectArchiMate. De mogelijke instellingen zijn hieronder beschreven. De instellingen moeten gedefinieerd worden als SemanticMediaWiki-eigenschappen. Aanvullende uitleg en andere tekst kan toegevoegd worden; deze wordt verder genegeerd.


Configureren van dynamische views

Gebruik de configuratie-instelling {SuppressCustomProperties} om een eigenschap in de legenda te onderdrukken:

Syntax: [[SuppressCustomProperties::<Customproperty name> [,<Customproperty name>]* ]]

Voorbeeld: [[SuppressCustomProperties::Business value, Supplier]]


Gebruik de configuratie-instelling {<Custom property> enumeration} om voor een eigenschap een kleurenschaal van groen naar rood te tonen in de legenda. Met de toevoeging 'Reverse' loopt de kleurenschaal terug, dus van rood naar groen. Alle enumeraties moeten gedeclareerd worden met de configuratie-instelling {CustomPropertyEnumerations}:

Syntax: [[CustomPropertyEnumerations::<custom property name> [,<custom property name>]*]]
  [[<Customproperty name> enumeration::<enumeration value> [,<enumeration value>]* [,Reverse] ]]

Example: [[CustomPropertyEnumerations::Business value, TechStatus]]
  [[Business value enumeration::Low, Medium, High, Very high, Reverse]]
  [[TechStatus enumeration::Current, Nearly current, Behind, Outdated]]