Revisionshistorik

Ordlista

Referenser

1 Inledning

Detta är en praktisk handledning att använda vid utveckling av tjänstedomäner. Dokumentet innehåller vägledning i hur olika delar i en tjänstedomän tas fram, inklusive versionshantering. Dokumentet ägs och förvaltas av Ineras Arkitektursektion.

1.1 Målgrupp och förkunskaper

Dokumentet riktar sig i första hand till de som praktiskt utvecklar och förvaltar tjänstekontrakt baserade på RIV Tekniska Anvisningar (RIV TA), men även till de som ansluter till tjänster där interaktionen beskrivs av tjänstekontrakt (tjänsteproducenter och tjänstekonsumenter).

För att använda handledningen krävs förkunskaper i användandet av versionshanteringssystem (specifikt Git), design av WSDL och XML-schema, grundläggande kunskaper i hur s.k. WSDL-first-utveckling av tjänster bedrivs i .Net och Java EE.

1.2 Syfte

Det övergripande syftet med denna handledning är att underlätta arbetet för de som utvecklar och vidareutvecklar tjänstekontrakt för att säkerställa korrekt versionshantering och release av tjänstekontrakt och tjänstedomäner.

1.3 Avgränsning

Kravhantering ingår inte i denna handledning, inte heller aktiviteter relaterade till att samordna och informera tjänstedomänens intressenter.  Detta förutsätts ske inom aktuellt projekt eller förvaltning.

Dokumentet hanterar endast de releaser och releasekandidater som är föremål för den kvalitetssäkring och publicering som Ineras Arkitektursektion ansvarar för.

1.4 Krav på utvecklingsmiljö

Dokumentet beskriver bland annat aktiviteter i versionshanteringssystem. De som ska arbeta praktiskt med tjänstekontraktsutveckling enligt denna handledning behöver ha följande verktyg installerade på sina lokala datorer:

1.5 Regelverk och mallar

Länkar till regelverk, mallar och exempel som ligger till grund för denna handledning finns på:

http://rivta.se/documents.

2 Skapa ny release av en tjänstedomän

Detta kapitel beskriver de aktiviteter som ingår vid release av tjänstedomäner tillsammans med hänvisningar till mallar, exempel och anvisningar.

För att skapa en ny release av en tjänstedomän är gången följande:

• Vid utveckling av tjänstekontrakt arbetar projektet iterativt i Git
• När projektet har en version som är klar för granskning, en så kallad release candidate (RC), görs en begäran till Ineras arkitektursektion för kvalitetssäkring
• Projektet fortsätter sitt arbete och kan vid behov leverera ytterligare RC för granskning
• Då projektet har testat en version (normalt är detta en release candidate) som man beslutat tillämpa i produktion, gör projektet en begäran om paketering och publicering genom att kontakta Ineras Arkitektursektion enligt anvisning under http://rivta.se/begaran/ .

2.1 Förberedelser

För att kunna utveckla och förvalta tjänstekontrakt krävs behörighet till nödvändiga resurser. För arbetet behövs ett konto på Bitbucket samt behörighet till aktuell tjänstedomän.

Beslut om domännamn (enbart vid framtagning av ny domän)

Vid utveckling av en ny tjänstedomän ska denna namnsättas av Ineras Arkitektursektion. Vid tillägg av ett nytt tjänstekontrakt inom befintlig domän ska Ineras Arkitektursektion ha godkänt tillägg av det nya tjänstekontraktet i den befintliga domänen.

Om det är aktuellt att skapa en ny tjänstedomän kontaktas Ineras Arkitektursektion enligt anvisning under http://rivta.se/begaran/ 

Beskriv vilken typ av information som ska hanteras, samt inom vilket verksamhetsområde. Ineras Arkitektursektion kommer då att besluta ifall en ny tjänstedomän skall skapas, samt tilldela svenskt och engelskt domännamn.

Därefter skapas ett repository på Bitbucket som ska rymma tjänstedomänens källkod, dokumentation och ärendehantering.

Ansök om behörighet i Bitbucket

Ansökan om behörighet sker genom att kontakta Inera Stödsystem. Meddela din e-postadress samt vilken tjänstedomän du ska arbeta med. Om du inte har ett Bitbucket-konto associerat med din e-postadress sedan tidigare, kommer du att få ett automatiskt välkomstmail från Bitbucket med instruktioner om hur du skapar ett konto och får behörighet.

Installera programvaror på lokal dator

Installera programvaror på din lokala dator enligt kapitel 1.4.

Klona Git-repository

Gör en s.k. ”klon” (lokal kopia) av tjänstedomänens Git-repository. Beskrivning om hur det görs finns på http://rivta.se/bitbucket/.

Skapa katalogstruktur (enbart vid framtagning av ny domän)

Om du arbetar med en helt ny tjänstedomän behöver du själv skapa dess katalogstruktur. En tjänstedomän ska strikt följa en gemensam och fastställd katalog- och filstruktur. Hur denna ser ut och hur man skapar strukturen för en ny tjänstedomän beskrivs i appendix 1.

2.2 Uppdatera eller skapa dokumentation och tekniska artefakter

Detta avsnitt beskriver hur man uppdaterar olika artefakter under utveckling/uppdatering av ett tjänstekontrakt. Processen för ny och vidareutveckling av tjänstekontrakt finns även beskriven mer ingående av Ineras Tjänstekontraktsförvaltning. För tillgång till den mer detaljerade processen, vänligen kontakta Ineras Tjänstekontraktsförvaltning, tk-forvaltningen@inera.se. 

Under arbetet med framtagning av tjänstekontraktsbeskrivning kan Ineras Arkitektursektion vara behjälplig med vägledning. Checka in dokument, tekniska artefakt och testsviter i tjänstedomänens Git-repository på Bitbucket. För mer information, se "Checka in och publicera till Bitbucket" i appendix 1.

2.2.1 Dokumentation

Skapa dokumentation

Följande dokument ska skapas när en ny domän tas fram (mallarna för dokumenten finns på: http://rivta.se/documents.html):

• Informationsspecifikation (se VI-boken för mer information, ARK_0026)
• Tjänstekontraktsbeskrivning (ARK_0015)
• Arkitekturella beslut (ARK_0023. Om inga arkitekturella beslut har fattats ska det stå ”inga avsteg gjorda” i AB-dokumentet.)
• Release notes (Se release notes för tjänstedomän)

Uppdatera dokumentation

När ett dokument ska uppdateras görs det i den senaste versionen av dokumentet som finns för den domänversion som ska uppdateras.

2.2.2 Skapa/uppdatera schemafiler

På http://rivta.se/development.html finns referens till verktyg som kan användas vid skapande/uppdatering av schemafiler. De anvisningar som finns på samma sida bör följas.

2.2.3 Skapa/uppdatera testsvit och självdeklaration

Vanligtvis tas testsviter och självdeklarationer fram av Nordic Medtest (NMT).

2.2.4 Skapa/uppdatera schematron

Schematron används för att kontrollera de logiska regler som gäller för ett visst tjänstekontrakt. Vanligtvis tas schematron fram av NMT. 

2.2.4 Journal- och läkemedelsheadern

Journal- och läkemedelsheadern (JoL-headern) är en gemensam header som används av nyare versioner av tjänstekontrakt som hanterar journal- och läkemedelsinformation.

När denna header används, läggs en kopia av fältreglerna som PDF i "docs"-katalogen. Schemat för den aktuella versionen av headern klipps in i tjänstekontraktets schemafil. Detsamma gäller för headerns schematron som klipps in i tjänstekontraktets schematron.

Dokument med JoL-headerns fältregler samt schematron finns på Bitbucket: https://bitbucket.org/rivta-domains/best-practice/wiki/Home

2.3 Kvalitetssäkring

2.3.1    RIVTA Verifiering

En ny release ska verifieras mot regelverket i RIV TA. Detta görs med hjälp av python-scriptet ”verifyRivtaDomain.py” (se kapitel 1.4).

Scriptet kontrollerar

• Att katalogstrukturen som beskrivs i RIV TA Konfigurationsstyrning följs
• Att XML-filer följer XML-scheman (XML Schema 1.0 och WSDL 1.0)
• Att WSDL-filer följer reglerna i RIV TA Basic Profile
• Att Domän- och tjänstescheman följer anvisningarna i RIV TA 

Om resultatet påvisar fel och/eller varningar i en releasekandidat, ska dessa korrigeras och hanteras före begäran om kvalitetssäkring.

Observera att ett releasepaket ska innehålla alla tjänstekontrakt, dokument, script osv. som ingår i domänen. Detta gäller oavsett om de ändrats i den nya releasen eller ej.

2.3.1   Skapa Tag i Git för releasekandidat (RC) och begär kvalitetssäkring

Formell kvalitetssäkring görs på en releasekandidat (RC) som taggats i Git. Namnsättning av tag beskrivs i appendix 3. Hur man skapar och publicerar en tag beskrivs på http://rivta.se/bitbucket.

Begäran om kvalitetssäkring sker genom att kontakta Ineras Arkitektursektion enligt anvisning under http://rivta.se/begaran/. Granskning av teknik och säkerhet görs av granskare på Ineras Arkitektursektion medan granskning av informatik/verksamhet görs genom en självgranskning. Självgranskningsprotokollet delges utvecklaren i samband med att begäran om kvalitetssäkring skett.

För att få implementera en RC i den nationella tjänsteplattformens QA-miljö (acceptanstestmiljö) krävs att den har kvalitetssäkrats och att Integrationsansvarig/Tjänsteansvarig har godkänt installation. Integrationsansvarig/Tjänsteansvarig beställer installation av tjänstekontrakt genom att skicka in en A-blankett (finns på inera.se) 

2.4 Skapa Tag i Git och begär paketering och publicering av release av tjänstedomän

En release kan skapas när acceptanstesterna är genomförda i en testmiljö (QA/ÖTM) och domänens tjänstekontrakt står inför en driftsättning i produktionsmiljö.

Skapa en Tag i Git och begär paketering och publicering genom att kontakta Ineras Arkitektursektion (se http://rivta.se/begaran/). Den skapade taggen ska referera till samma Git commit som den senast godkända releasekandidaten. Regler för namnsättning finns i appendix 3. Ange namn på tjänstedomän och aktuell release.  

Ineras Arkitektursektion skapar en zip-fil och publicerar den nya releasen på http://rivta.se/domains.

3. Versionshantering

3.1 Versionshantering av tjänstedomän

En tjänstedomänsversion utrycks med siffror i en två eller treställig kombination

Ex 2.1 eller 2.1.1

Figur 1. Beskrivning av versionering av tjänstedomän.

En tjänstedomän kan alltså innehålla tjänstekontrakt med olika versionsnummer.  Grundregeln för versionsnumrering är att tjänstedomänens major & minor-version ska motsvara den högsta versionen på något av de ingående tjänstekontrakten. Till detta kommer en tredje siffra som räknas upp vid all annan förändring.

Ingen slutsats om omfattningen av en uppdatering ska dras av att uppräkning endast sker av tredje siffran. Omfattningen av förändringar i en version ska framgå av tjänstekontraktsbeskrivningen och release notes som bifogas paketeringen.

Nya tjänstekontrakt som tillkommer ska alltid börja med version 1.0 oavsett domänens version. När ett nytt tjänstekontrakt lagts till i en domän räknas bara tredje siffran upp i domänversionen såvida det inte även skett andra förändringar som påverkar domänversionen.

De flesta tjänstedomäner innehåller flera tjänstekontrakt i olika versioner, se exempel i grön kolumn nedan. Varje tjänstedomänsversion innehåller dock bara en tjänstekontraktsversion inom varje major, dvs version 3.1 ersätter version 3.0. Det fiktiva exemplet i den röda kolumnen nedan strider således mot reglerna.

Exempel gällande domänversionering  finns under Appendix 2.

3.2 Versionshantering av scheman

3.2.1 Versionshantering av tjänstekontraktsspecifika scheman

Ändringar och tillägg för datatyper som deklareras direkt i tjänsteinteraktionsschemat ska, vid en minor-uppdatering, alltid versionshanteras via en utökningsfil. Detta för att ändringen ska vara bakåtkompatibel (se regel #9 i RIV Tekniska Anvisningar Tjänsteschema http://rivta.se/documents/ARK_0005/). Vid major-uppdateringar kan sådana ändringar göras direkt i tjänsteinteraktionsschemat.

3.2.2 Versionshantering av domängemensamma scheman

Typer som används i flera tjänstekontrakt kan deklareras i en eller flera domängemensamma schemafiler som placeras i katalogen /schemas/core_components/

Vid behov av förändringar och tillägg av gemensamma typer behöver följande beaktas:

Om förändringen är en utökning av en befintlig (komplex) typ, avser nya valfria element och ändringen ska vara bakåtkompatibel görs förändringen via ett utökningsschema. Se Regel #6 i RIV TA Domänschema http://rivta.se/documents/ARK_0006/

Helt nya element och typer läggs till direkt i den nya versionen av schemat. Där behövs det alltså inte något utökningsschema (EXT fil).

3.3 Releasekandidater

Under utvecklingsarbetet av en ny domänversion så kan justeringar behöva göras. Detta markeras som en releasekandidat (RC). Versionsnummer för releasekandidater börjar med versionsnumret för den tilltänkta releasen följt av ett underscore, RC och löpnummer. Exempel: 1.1_RC2

För att underlätta spårbarhet används samma versionsnummer i dokumentens revisionshistorik som för tjänstedomänen (exempelvis RCn i stället för PAn).

Förtydligande: Det är bara domänens paketering och numrering i dokumentation som markeras som RC och alltså inte de ingående tjänstekontrakten eller andra tekniska komponenter.

4 Ta bort release av tjänstedomän

När en release är inaktuell ansvarar Integrationsansvarig/Tjänsteansvarig för att begära borttagning av den genom att kontakta Inera Arkitektursektion enligt anvisning under http://rivta.se/begaran/. Ange namn på tjänstedomän och aktuell release som ska tas bort.

Inera Arkitektursektion tar bort zip-fil från rivta.se samt i tabeller över fastställda tjänstedomäner.

Appendix 1 – Skapa Git-repository

Om ett nytt Git-repository ska skapas för aktuell tjänstedomän på Bitbucket, behöver du själv initiera denna och skapa nödvändig katalogstruktur. Alla tjänstedomäner ska följa en gemensam och fastställd filstruktur. Denna struktur och namnstandard är inkorporerad i script och måste därför strikt följas.

Exempel:

Figur 2. Filstruktur i tjänstedomän.

docs

I "docs"-katalogen finns tjänstekontraktsbeskrivning (TKB), informationsspecifikation (IS), arkitekturella beslut (AB) och självdeklarationer. Om något eller några tjänstekontrakt i domänen använder JoL-headern, ska denna katalog även innehålla fältregeldokument för de versioner av JoL-headern som används i domänen.

Namnen på dokumenten skall baseras på tjänstedomänens engelska namn, med dess delar avskilda med underscore, och följa mönstret nedan:[1]

• TKB_ <tjänstedomännamn>.docx, ex TKB_clinicalprocess_activityprescription_actoutcome.docx
• AB_ <tjänstedomännamn>.docx, ex AB_clinicalprocess_activityprescription_actoutcome.docx
• IS_<tjänstedomännamn>.docx, ex IS_clinicalprocess_activityprescription_actoutcome.docx
• SjD_TK_<tjänstekontraktsnamn>.docx, ej obligatoriskt

Exempel:

Figur 3. Filstruktur i mappen docs.

Schemas

WSDL:er och scheman ordnas i katalogen ”schemas”. I ”schemas” ska två underkataloger finnas: ”core_components”, och ”interactions”.

Exempel:

Figur 4. Filstruktur i mappen schemas

• ”core_components” innehåller scheman som är generella för domänen (t.ex. domän-scheman och header-scheman)
• ”interactions” innehåller en underkatalog per tjänstekontrakt. I dessa ska schema och WSDL ligga som är specifika för respektive tjänstekontrakt.
• "engagementindex" (ej obligatorisk) innehåller verktyg för validering av de delar av schemat som används av engagemangsindex.

test-suite

Innehåller tester tillhörande respektive tjänstekontrakt.

README

README är en textfil som innehåller länkar till Release Notes, gemensamma datatyper samt eventuella interaktionsöverenskommelsedokument och mappningsdokument tillhörande domänen. 

Initiera Git-repository

Innan kataloger och filer kan lagras för en tjänstedomän på Bitbucket, behöver dess Git-repository initieras. Detta görs på en lokal dator. Här beskrivs hur det görs med en kommandobaserad Git-klient, men motsvarande kan även göras med grafiska verktyg.

Gör så här:

1. Skapa en lokal katalog med samma namn som det repository som skapats på Bitbucket, t.ex. ”riv.clinicalprocess.healthcond.actoutcome”.
2. Ställ dig i katalogen och skriv kommandot ”git init”.
3. Registrera sökvägen till Bitbucket. Exakta uppgifter hittar du på repository-sidan i Bitbucket, men kommandot följer detta mönster: ”git remote add origin https://username@bitbucket.org/rivta-domains/riv.xxx.yyy.zzz.git”

Skapa katalogstruktur

Skapa följande katalogstruktur i ditt Git-repository:

docs

schemas

schemas/core_components

schemas/interactions

Checka in och publicera till Bitbucket

Det är inte möjligt att checka in tomma kataloger i ett Git repository. Därför kan du checka in och publicera dina kataloger först när du fyller dem med innehåll.

För mer information om hur du arbetar med Git, se http://rivta.se/bitbucket.

Appendix 2 – Exempel versionshantering

Versionshantering för olika typer av ändringar - Exempel

Nedan figur visar ett exempel på hur olika typer av ändringar påverkar versioneringen av tjänstekontrakt och tjänstedomäner. Kolumnen Ändring visar vilken typ av ändring som skett i domänen med en streckad linje till tjänstekontraktet i vilket förändringen skett. Sista kolumnen redovisar utfallet på domänversionen baserad på den aktuella förändringen.

Figur 5. Flöde över versionering av tjänstedomän.

Appendix 3

Namnsättning av tag

Taggen namnges efter tjänstedomänens aktuella version.

• Exempel för Releasekandidat: 2.1_RC3
• Exempel för Release: 2.1

I tidigare versioner av denna anvisning ingick även tjänstedomänens namn i tag-namnet. Detta underlättade i den tidigare projektplatsen Google Code, men är överflödigt och snarare försvårar i Bitbucket. Långa tag-namn kan trunkeras i Bitbuckets webbgränssnitt. Alla nya domäner ska därför använda den nya formen av namnsättning.

Namnsättning av Zip-fil

I normalfallet skapas och publiceras ZIP-filen av Inera Arkitektursektion i samband med en godkänd T-granskning. Den ges alltid samma version som den tag den baseras på. Dessutom adderas prefixet ”ServiceContracts” till namnet:

Release:

ServiceContracts_<tjänstedomän>_<domänversion>.zip

Ex. ServiceContracts_clinicalprocess_activityprescription_actoutcome_2.1.zip

Release candidate:

ServiceContracts_<tjänstedomän>_<domänversion>_RC<RC-nummer>.zip

Ex. ServiceContracts_clinicalprocess_activityprescription_actoutcome_2.1_RC3.zip

[1] Ett tidigare krav på att filnamnet för TKB och AB även skulle innehålla versionsbeteckning har tagits bort.