Bilaga om livscykelhantering för SDK

Anslutning för deltagarorganisationer
Version: 1.6.0
Gäller fr o m: 2024-11-18

Sammanfattande principer för livscykelhantering av dokument inom SDK-federationen.

1. Inledning

En definierad och överenskommen livscykelhantering är viktig både för att SDK:s specifikationer och meddelandetyper ska kunna utvecklas över tid och tillgodose utvecklingsbehov, och för att deltagarorganisationer ska kunna planera för interna förvaltningsaktiviteter och anpassning av de anslutande system som tillämpar specifikationerna.

SDK:s livscykelhantering innefattar SDK anslutningsavtal, SDK regelverk, tekniska specifikationer och gemensamma komponenter (SDK adressbok och SDK testklient). Livscykelhanteringen beskriver olika typer av förändringar, processen för förändring samt regler för förändring (hur deltagarorganisation ska förhålla sig till/följa ändringen).

För att uppnå ett stabilt och kontinuerligt meddelandeutbyte mellan deltagarorganisationer behövs därför gemensamma principer för hur specifikationerna förändras över tid och kan samexistera.

Över tid finns det behov av att stödja:

  • Hur befintliga avtal, regelverk, specifikationer och meddelanden (meddelandetyper/dokumenttyper) kan förändras och utvecklas.
  • När nya avtal, regelverk, specifikationer och meddelanden (meddelandetyper/dokumenttyper) kan tillkomma.
  • När avtal, regelverk, specifikationer och meddelanden (meddelandetyper/dokumenttyper) kan behöva avvecklas
  • Förändringar i SDK-federationens gemensamma komponenter (SDK adressbok och SDK testklient).

2. Livscykelhantering

Livscykelhantering av SDK anslutningsavtal, regelverk och tekniska komponenter är en viktig process för att säkerställa att dessa är relevanta och uppdaterade under hela avtalets löptid.

2.1 Livscykelhantering av anslutningsavtal

Anslutningsavtal inom SDK innefattar följande avtal:

2.2 Regelverksbilagor till anslutningsavtal

Regelverksbilagor spelar en avgörande roll i anslutningsavtalet eftersom de specificerar krav från SDK federationsägare, såsom tillgänglighetskrav eller IT-säkerhetskrav.

Bilagorna är levande dokument som kan behöva justeras och utvecklas när nya krav eller förutsättningar uppstår. Ändringarna dokumenteras noggrant i releasenotes.

Aktuella versioner av SDK regelverk:

2.3 Livscykelhantering av tekniska komponenter

De tekniska komponenterna som används inom SDK-federationen består av SDK gemensamma komponenter (SDK adressbok och SDK testklient) samt gemensamma komponenter i Plattform för eDelivery Service Metadata Publisher (SMP) och PKI tjänst. Dessa komponentner genomgår även i en livscykelhantering.

För mer information om SDK:s tekniska komponenter och aktuella versioner se SDK adressbok handledning samt SDK testklient.

3. Typer av release

Varje release för SDK gemensamma komponenter samt styrande dokumentation inom SDK representeras av tre olika release-typer; major/stor, minor/mellan och subminor/liten.

Release typ: Stor/major (1.0)

En ”major-version” representeras av den första siffran i versionsnumret. Den ändras när det släpps en betydande ändring av anslutningsavtals- och regelverksändringar. En ny majorversion indikerar oftast strukturändringar som tekniskt bedöms påverka kompatibilitet med tidigare versioner och stora nya funktioner eller krav. En större förändring av avtalsinnehållet eller struktur.

  • Exempel:
  • När ett fält blir obligatoriskt (specifikation eller tekniskt protokoll)
  • En ny obligatorisk regel införs som deltagare SKA följa

En majorversion medför att deltagarorganisationens meddelandeklient, meddelandetjänst eller accesspunkt påverkas och behöver anpassas. En majorversion medför att deltagarorganisationens meddelandeklient, meddelandetjänst eller accesspunkt påverkas och behöver anpassas.

Release typ: Mellan/minor (1.1)

En ”minor-version” representeras av den andra siffran i versionsnumret. Den ändras när mindre förbättringar eller nya funktioner läggs till utan att bryta kompatibilitet med tidigare versionera funktioner eller krav.

Ändringen påverkar inte avtalsinnehållet eller dess struktur.

Exempel:

  • När ett nytt frivilligt fält har tillkommit där verksamheten inte bedöms påverkas av förändringen.
  • En regel har fötydligats eller utökats utan det bedöms påverka deltagare eller dess tekniska implementation.

Release typ: Liten/subminor (1.0.1)

En ”subminor-version” representeras av den tredje siffran i versionsnumret. Endast mindre korrigeringar, rättelser och buggfixar.

  • Exempel:
  • Ändring av beskrivande texter
  • Uppdatering av illustrationer

Dessa uppdateringar syftar till att förbättra stabilitet och tydlighet i SDK dokumentation samt gemensamma komponenter.

3.1 Principer för ärendehantering, utveckling och förvaltning av funktionalitet och regelverket för SDK

Följande principer gäller:

  • Alla ändringar i SDK regelverket kommuniceras tydligt och i god tid till alla berörda parter.
  • Samverkansforum för regelverks- och avtalsändringarändringar, utveckling och möjlighet att bidra med önskemål och förbättringsförslag erbjuds alla aktörer.
  • Behovsdriven utveckling gäller för teknisk funktionalitet samt förändrat regelverk där behoven tydligt skall framgå för önskad utveckling. Utveckling beslutas och styrs av federationsägaren för SDK och sker sedan i samverkan med deltagarorganisationerna och aktörer anslutna till SDK.
  • En ny release innehåller alltid en ändringslogg (releasenotes) som tydliggör vad som har ändrats och varför.
  • Federationsägare SDK beslutar och ansvarar för produktionssättning av ny funktionalitet och regelverk enligt gällande releasehantering SDK.

3.2 Hantering av flera samtidiga versioner av meddelandetyper och övriga styrande specifikationer

Hantering av flera samtidiga major-versioner av SDK:s meddelandetyper och övriga styrande specifikationer för deltagarorganisationer och leverantörer av meddelandesystem specifikationer sker enligt följande principer:

Meddelandetyper:

  • I huvudsak kommer endast major-versioner att släppas för en meddelandetyp. Det kan finnas flera meddelandetyper i SDK-federationen.
  • I undantagsfall kan minor-versioner användas efter beslut av federationsägaren.
  • Vid release av en ny version av en meddelandetyp kommer två major-versioner att vara aktiva parallellt i produktionsmiljö under en viss period.
  • Om det uppstår ett akut behov av en ny major-version kan denna produktionssättas och därmed kan antal samtidiga major-versioner utökas.
  • Upp till tre major-versioner av en meddelandetyp kan vara aktiva i SDK testmiljöer (omfattar ej akut major-version). SDK-federationsägare tillhandahåller en SDK QA-miljö som är produktionslik (dock: endast testdata får förekomma) och som också tillåter tester av nyare versioner.
  • En version av en meddelandetyp som är markerad som ”utgången” får inte användas längre.

Övriga specifikationer:

  • Hantering av major-versioner:
    • Major-versioner släpps enligt livscykelregelverkets principer.
    • Vid release av ny specifikation kan två major-versioner vara aktiva samtidigt i produktionsmiljö under en viss tidsperiod. Federationsägaren beslutar om detta från fall till fall.
    • Vid flera aktiva major-versioner kan dessa vara aktiva i SDK testmiljöer (omfattar inte akut major-version).
  • Minor-versioner släpps löpande vid behov.
  • En specifikation som är markerad som ”utgången” gäller inte längre.

3.3 Releasehantering för meddelandetyper och specifikationer

Följande regler gäller för stegning av version för deltagarorganisationer:

  • Deltagarorganisationer förbinder sig att (SKA) följa fastställd releasehantering för meddelandetyper och specifikationers livscykel.
  • Deltagarorganisationer förbinder sig att (SKA) stödja en ny major-version av meddelandetyp och specifikation senast 12 månader efter att release är fastslagen i produktion om ej annat beslutas från federationsägare.
  • Deltagarorganisationer BÖR stödja två versioner av meddelandetyper och specifikationer i produktionsmiljö.
    • SKA stödja: den version som är obligatorisk* version, dvs. tidigare (lägre) version (t.ex. 1.0)
    • BÖR stödja: senaste aktuell version (t.ex. 2.0)
      *Obligatorisk version är den version som alla deltagarorganisationer måste stödja vid anslutning till SDK-federationen.
  • Deltagarorganisation anmäler stöd för ny version till SDK-federationsägare via självdeklaration.
Hjälpte denna information dig?

Ditt svar hjälper oss att förbättra sidan

Senast uppdaterad: