Dokumentation av integrationer

Inledning

De IT-integrationer som används inom Region Halland både internt och mot externa parter skall dokumenteras i Region Hallands arkitekturrepository som är baserat på Sparx Enterprise Architect och publiceras till webbplatsen arkitektur.regionhalland.se (intern). Dokumentationen skall ske med ArchiMate 3 notation. Det är det objekt som ansvarar för integrationen som också ansvarar för att integrationen är dokumenterad.

En integration kan dokumenteras i tre olika vyer varav två är obligatoriska (integrationsöversikt och integrationsbeskrivning). Nedan beskrivs dessa vyer mer i detalj. De tre nivåerna går från övergripande till detaljerad. Se figur nedan.

Integrationsöversikt

I integrationsöversikten (det finns endast en i Region Hallands arkitekturrepository) visas att det finns en integration mellan två applikationer. Ingen annan information är tillåten i denna vy. Detaljer skall dokumenteras i de underliggande vyerna. Observera att integrationsmotorer ej skall ritas i denna vy.

Integrationsöversikten tillhör objektlagret (enligt metamodellen för Region Hallands arkitekturrepository) och de element som är tillåtna i denna vy är:

• Applikation (ritas med ArchiMate Application Component)

• Association (ritas med ArchiMate Association)

Det är tillåtet att lägga in länkar i integrationsöversikten för att kunna gå ner till mer detaljerade nivåer. Om en länk läggs bredvid en association så går länken till en integrationsbeskrivning medan om länken läggs på en applikation (i vänstra övre hörnet) så går länken till en integrationskarta.

Syftet med denna vy är att ge en snabb översikt kring vilka applikationer det finns integrationer mellan. Nedan visas exempel på hur integrationsöversikten byggs upp.

Integrationskarta

En integrationskarta syftar till att ge en mer detaljerad bild än integrationsöversikten, den utelämnar dock en del detaljer som återfinns i integrationsbeskrivningen. En integrationskarta används när man vill ge en integrationsöversikt för en enskild applikation, dvs den fokuserar endast på integrationer till och från en enskild applikation. Syftet är alltså att ge en översikt över integrationerna för en enskild applikation. Observera att integrationsmotorer ej skall ritas i denna vy.

Integrationskartan tillhör objektlagret, enligt metamodellen för Region Hallands arkitekturrepository, och de element som är tillåtna i denna vy är:

• Applikation (ritas med ArchiMate Application Component)

• Informationsmängd (ritas med ArchiMate Data Object)

• Association (ritas med ArchiMate Association)

• Flöde (ritas med ArchiMate Flow)

Det är tillåtet att lägga in länkar i integrationskartan för att kunna gå ner till mer detaljerade nivåer. Om en länk läggs bredvid en association eller ett flöde så går länken till en integrationsbeskrivning medan om länken läggs på en applikation (i vänstra övre hörnet) så går länken till en integrationskarta för en annan applikation.

Skillnaden mellan en association och ett flöde är att medan associationen endast beskriver att det finns en integration mellan två applikationer så beskriver flödet också i vilken riktning informationen i integrationen går.

I bilden nedan visas ett exempel på integrationskarta.

Här visas endast att det finns en integration mellan A och B, medans mellan B och D visas riktningen på integrationen samt vilken information som skickas.

Integrationsbeskrivning

En integrationsbeskrivning syftar till att ge en detaljerad av integrationen. Syftet är alltså att ge de nödvändiga detaljerna över hur en enskild integration är uppbyggd.

En integrationsbeskrivning skall finnas för samtliga integrationer inom Region Halland.

Integrationsbeskrivningen tillhör objektlagret, enligt metamodellen för Region Hallands arkitekturrepository, och de element som är tillåtna i denna vy är följande:

• Applikation (ritas med ArchiMate Application Component)

• Applikationstjänst, kan vara t.ex. ett API eller annan endpoint (ritas med ArchiMate Application Service)

• Informationsmängd (ritas med ArchiMate Data Object)

• Association (ritas med ArchiMate Association)

• Realisation, visar vilken applikation som realiserar vilken tjänst (ritas med ArchiMate Realization)

• Flöde (ritas med ArchiMate Flow)

• Trigger, visas hur ett flöde initieras eller ett uthopp (ritas med ArchiMate Trigger)

• Access, visar hur en komponent accessar en informationsmängd (ritas med ArchiMate Access)

I bilden nedan visas ett exempel på en integrationsbeskrivning.