Syfte

För att komponenter i SKLTP skall beskrivas på ett enhetligt och heltäckande sätt skall följande mall för arkitekturell beskrivning följas.

Note: Ett vedertaget begrepp för en arkitekturell beskrivning är SAD, Software Architecture Document, och syftar när det nämns i SKLTP dokumentation på dessa arkitekturella beskrivningar.

För befintliga arkitekturella beskrivningar av SKLTP komponenter se: arkitekturella beskrivningar.

Texter inom {} skall ersättas med text specifik för den aktuella komponenten, se vid behov exempel ovan för vägledning.

{Namn på komponent} - arkitekturbeskrivning (SAD)

Innehåll

{Innehållsförteckning}

Inledning

{Övergripande beskrivning av syfte, funktion och ev. avgränsningar med komponenten samt en beskrivande illustration}

Dokumentets delar

Dokumentet är indelat i följande delar:

1. {Länk till sida med: Exempel}
   Belysande exempel på tillämpning av Engagemangsindex
   
   
   

2. {Länk till sida med: Arkitekturella Krav}
   Beskriver de arkitekturella egenskaper som är gemensamma för aggregerande tjänster.
   
   
   

3. {Länk till sida med: Följsamhet mot T-bokens styrande principer}
   Beskriver hur implementationen av engagemangsindex följer T-bokens styrande principer
   
   
   

4. {Länk till sida med: Systemsamverkan}
   Ger en översiktlig bild av vilka system som samverkar samt dess primära roller i denna samverkan
   
   
   

5. {Länk till sida med: Användningsfall}
   Beskriver de användningsfall som har störst påverkan på designen.
   
   
   

6. {Länk till sida med: Logisk vy}
   Beskriver designens logiska uppdelning.
   
   
   

7. {Länk till sida med: Deploymentvy}
   Beskriver hur lösningen skall driftsättas i QA och produktionsmiljöer. Här skall egenskaper som gör komponenten förvaltningsbar beskrivas såsom:

   1. Hur installera och/eller uppgradera komponenten

   2. Hur konfigurera komponenten, t ex för säkerhet, kommunikation, clustring och/eller hög tillgänglighet

   3. Hur loggning sker och hur log-nivåer kan styras

   4. Hur komponenten kan övervakas

   5. Vilka vanliga fel som kan uppträda samt hur man åtgärdar dom

   6. Kapacitetsmodell, dvs hur skall man dimensionera hårdvara för att komponenten skall kunna uppnå ett visst SLA i termer av antal anrop, storlek på meddelanden, svarstider och upptid.
      
      
      

8. {Länk till sida med: Testvy-sida}
   Beskriver integrationstester som används för att säkerställa den totala lösningens funktionalitet.
   
   
   

9. {Länk till sida med: Implementationsvy}
   Beskriver centrala delar av implementationen.

Referenser

{Referenser till för komponenten relevant material}