Koder som används i Informationsleden

I den här artikeln beskrivs de koder som använts i Suomi.fi-informationsleden.

I version 6 av X-Road ges varje organisation som anslutit sig till Informationsleden samt dess subsystem och tjänst som anslutits till Informationsleden en globalt unik kod. Syftet med koden är att stöda X-Roads federationsegenskap, som gör det möjligt att koppla flera olika X-Road-instanser till varandra.

X-Roads interna meddelandeöverföring och hantering av användarrättigheter grundar sig på unika koder för organisationer, subsystem och tjänster både inom en enskild X-Road-instans och inom en helhet som består av många olika instanser.

Kodernas struktur

Organisationsspecifika koder består av tre separata delar, subsystemspecifika av fyra separata delar och tjänstespecifika av sex separata delar. Koderna är hierarkiska. Koderna för subsystemen innehåller alltid koden för den organisation som äger dem. Tjänsternas koder innehåller på motsvarande sätt alltid både subsystemets och organisationens koder.

Organisationers koder (member)

I version 6 av X-Road består koderna för organisationer som anslutit sig till Informationsleden av tre delar enligt följande:

Organisation: [X-Road instance]/[member class]/[member code]

• X-Road instance = kod som identifierar X-Road-instansen. Koden ska bestå av en landskod enligt ISO-standarden och en bilaga som specificerar Informationsledens tekniska miljö (FI-DEV, FI-TEST, FI). Informationsledsoperatören ställer in koden för miljön i samband med installationen av centralservern.
• Member class = unik kod som anger organisationens typ inom en enskild instans. I Informationsledens test-, produktions- och utvecklingsmiljöer klassificeras organisationerna på följande sätt:

GOV: institutioner inom statsförvaltningen

COM: kommersiella aktörer

MUN: kommuner

EDU: undervisnings- och utbildningssektorn

ORG: icke-vinstdrivande organisationer, till exempel föreningar och stiftelser (endast i test- och produktionsmiljön)

PRI: privatpersoner (endast i utvecklingsmiljön)

• Member code = identifieringskod för en enskild organisation, som ska vara unik åtminstone inom den valda organisationstypen. För tydlighetens skull är det dock bättre att de koder som används är unika på hela instansnivån. FO-numret används som identifieringskod för organisationen.

Member code -preciseringar

Organisationerna kan ansluta sig till alla miljöer i Informationsleden. I fråga om organisationer registreras FO-numret som Member codex utan FI-prefix, dvs. i formatet 0920632-0. Om den anslutande organisationen inte har något FO-nummer ger administrationen av Informationsleden organisationen den kod som används som Member code.

Privatpersoner kan endast ansluta sig till Informationsledens utvecklingsmiljö. När du vill ansluta dig till utvecklingsmiljön som privatperson ska du först kontakta Informationsledens stöd palveluvayla@palveluvayla.fi. De som upprätthåller tjänsten ger dig de anslutningsuppgifter som behövs för utvecklingsmiljön (member name och member code). Som Member code för privatpersoner används löpande numrering 0000001-0, 0000002-0 osv. istället för FO-nummer.

Vi rekommenderar inte att man använder sitt eget namn till exempel som namn på en anslutningsserver eller ett subsystem. Använd hellre ett påhittat namn och diskutera namngivningen med Informationsledens stöd.

Till exempel identifierar koden nedan ett privat företag som hör till FI-DEV-instansen, det vill säga utvecklingsmiljön, vars FO-nummer är 12345:

Organisation: FI-DEV/COM/12345

Koder för subsystem

Ett subsystem (consumer) som utnyttjar uppgifter via Informationsleden ska alltid ha en kod på subsystemnivå.

Med subsystem avses ett enskilt datasystem eller en logisk tjänste-/systemhelhet som organisationen anslutit till X-Road. Koden för ett subsystem består av koden för den organisation som äger systemet (subsystem owner) och koden som identifierar subsystemet på organisationsnivå (subsystem code).

Organisationerna kan själva bestämma vilka koder (subsystem code) som ges till subsystemen. Det rekommenderas dock att man använder en namngivningspraxis av CamelCase-typ för subsystem. I praktiken innebär detta att namnen på subsystem som består av flera olika ord skrivs så att orden skrivs ihop med stora begynnelsebokstäver (t.ex. TestSystem).

Subsystem: [subsystem owner]/[subsystem code]

Koden nedan identifierar till exempel subsystemet HighSecurity, som tillhör organisationen FI-DEV/COM/12345.

Subsystem: FI-DEV/COM/12345/HighSecurity

Koder för tjänster (service)

En tjänst som tillhandahåller information via Informationsleden (provider) ska alltid ha en kod på servicenivå som innehåller ett subsystem.

Med tjänst avses en enskild SOAP-tjänst som publicerats i Informationsleden via ett subsystem. Tjänstens kod består av koden för det subsystem som den publicerat, tjänstens unika kod och tjänstens versionsnummer.

Versionsnumret används för att skilja tjänstens olika versioner från varandra. Det är obligatoriskt att använda den. Tjänstens kod ska vara unik på nivån i det subsystem som publicerar. Den som publicerar kan själv besluta om tjänstens kod och definiera den i WSDL-beskrivningar som innehåller gränssnittsbeskrivningar för anslutna tjänster. Versionsnumret består av bokstaven V och ett heltal som anger versionsnumret.

Tjänst: [service provider]/[service code]/[version]

Koden nedan identifierar till exempel version 1 av getSecureData-tjänsten, som tillhör subsystemet FI-DEV/COM/12345/HighSecurity som presenterades i exemplet ovan.

Tjänst: FI-DEV/COM/12345/HighSecurity/getSecureData/v1

Användning av koder

Alla tjänster som tillhandahåller information (provider) och system som utnyttjar information (consumer) som ansluts till Informationsleden ska anslutas via subsystem. Även om det är tekniskt möjligt att ansluta tjänster direkt under organisationer eller att bjuda in tjänster som organisation, möjliggör användningen av subsystem en finare definition av åtkomsträttigheterna. Genom att använda subsystem säkerställer man dessutom en så enhetlig struktur som möjligt i koderna för de system och tjänster som anslutits till Informationsleden.

Ett system som använder uppgifter via Informationsleden ska alltid ha en kod på subsystemnivå och en tjänst som tillhandahåller information ska ha en kod på servicenivå som ingår i subsystemet. För en organisation som angetts som ägare till en anslutningsserver räcker däremot en kod på membernivå om organisationen inte erbjuder uppgifter till Informationsleden och inte använder uppgifter som finns där. I samband med anslutningen till Informationsleden får alla organisationer först en kod på membernivå, varefter det är möjligt att lägga till nya subsystem och tjänster samt skapa de koder som krävs för dem.

Användningen av koder beskrivs närmare i artikeln X-Road-dataöverföringsprotokoll.