OIO standardservice til Sag Generel servicevejledning KMD Sag Version 2.1 01-08-2013 KMD A/S Side 1 af 19
Generel servicevejledning til OIO Sag Ekstern standard service til KMD Sag Opdateret 01.08.2013 KMD A/S Side 2 af 19
Indholdsfortegnelse 1. Version... 4 2. Generelt... 4 2.1 Vejledningernes opbygning... 4 2.2 Vejledningernes formål... 4 2.3 Brug af vejledningerne... 5 2.4 Kontakt... 5 3. Begrebsliste... 6 4. Kort beskrivelse af KMD Sag... 7 5. Forretningsregler... 8 6. Opmærksomhedspunkter... 11 7. Hvor genfindes servicens indhold i KMD Sag... 12 8. Operationer... 12 9. Distribution af WSDL filer... 13 10. Servicens arkitektur... 13 11. Teknisk implementering... 14 11.1 OIOXML... 14 11.2 Sikkerhed... 14 11.3 Certifikater... 14 11.4 Autorisation... 15 11.5 Skemavalidering... 15 12. Bilag 1. Hvor genfindes servicens felter i KMD Sags dialog... 16 13. Referenceliste... 19 KMD A/S Side 3 af 19
1. Version Version Dato Ændring 1.0 01.06.2012 1. Version 2.0 01.02.2013 Generel omstrukturering af vejledninger til OIO servicerne 2.1 01.08.2013 I KMD Sag er begrebet Kassation udgået, og erstattet med Tilgængelighed. KassationskodeTekst bliver derfor ignoreret som input. Der er endvidere ændret diverse formuleringer. 2. Generelt 2.1 Vejledningernes opbygning Der er udarbejdet følgende vejledninger Tilslutningsguide, som indeholder information gældende for alle OIO services Generelle servicevejledninger, til hhv. Sag, Dokument og Advis, som indeholder information om KMD s OIO standardservices, som er gældende for alle de operationer som stilles til rådighed. Specifikke servicevejledninger for hver af de operationer, som stilles til rådighed. 2.2 Vejledningernes formål Det er tilslutningsguidens formål at give en introduktion til KMD Sag s OIO services og deres anvendelse. Beskriver endvidere det implementeringsforløb, som benyttes ved ibrugtagning af OIO services, samt de fokuspunkter, man skal være opmærksom på. Det er servicevejledningernes formål at give KMD s kunder og deres leverandører den information som er nødvendig for at der kan indgås aftale om et konkret implementeringsforløb. være et redskab til støtte for kommunikationen mellem kunde, leverandør og KMD under implementeringsforløbet. KMD A/S Side 4 af 19
2.3 Brug af vejledningerne Vejledningerne må ikke overdrages eller kopieres i videre omfang end forudsat i Ophavsretsloven, men kun udlånes til softwareleverandører i forbindelse med etablering af servicerne og ved ændringer i disse. 2.4 Kontakt Henvendelser vedr. vejledningerne og spørgsmål til OIO services i øvrigt kan ske til sagsnitflade@kmd.dk KMD A/S Side 5 af 19
3. Begrebsliste Begreb AWS Certifikat EWS KSP/CICS KWS OCES OWSA Model T 1.0 OIO OIOXML RACF SSL URI URN UUID WSDL KMD Sag Ejerskab KMD Sag Fordeling LOS Beskrivelse KMD s Applikation Web Services Et certifikat er et digitalt identitetsbevis. Det bliver udstedt af Danid og indeholder en række oplysninger om brugeren (certifikatholderen). KMD s Eksterne Web Services (udenfor CAP/IP) KMD s SikkerhedsProdukt til CICS KMD s interne Web Services (indenfor CAP/IP) Standarden for digital signatur, den såkaldte OCES-standard, hvor OCES står for Offentlige Certifikater til Elektronisk Service. OIO Web Service Arkitekturen, model T (OWSA Model T 1.0) angiver en punkt-til-punkt forbindelse mellem 2 sikkerhedsdomæner, hvor der er én serviceaftager og én serviceudbyder. Offentlig Information Online. Betegnelse for obligatorisk, åben standard for dataudveksling mellem offentlige myndigheder. Resource Access Control Facility. Anvendes af KMD til bla. identifikation og verifikation af bruger via bruger-id og password. Secure Sockets Layer. Protokol til krypteret kommunikation via internettet. Uniform Resource Identifier. Anvendes til at identificere et navn eller ressource, fx vha. en URL. Uniform Resource Names. En åben, ikke-proprietær standard, der tilbyder en identifikator uafhængig af placering. Universally Unique Identifier, standardiseret unik identifikator. Web Services Description Language, et XML-baseret sprog, som beskriver webtjenester, herunder hvilke data, som udveksles og hvilken protokol, der anvendes. KMD Sag modulet Ejerskab bruges til at registrere ejerskabet det myndighedsmæssige ansvar - af sager på afdelinger. Afdelingerne skal være defineret i LOS. I Ejerskab er det muligt at oprette ejerskabsregler pr. KLE-nr. og her bestemme, hvilken Sikkerhedsenhed, sager med dette KLE-nr. skal have. Ejerskabet er altså bestemmende for, hvem der kan få adgang til sagerne. KMD Sag modulet Fordeling bruges til elektronisk at fordele sager og adviser til den enkelte sagsbehandler eller sagsbehandlergruppe i kommunen. Sagsbehandlergrupperne skal være defineret i LOS, og sagsbehandlerne skal være oprettet i KSP/CICS. I Fordeling er det muligt at oprette fordelingsregler pr. KLE-nr. og her bestemme, hvilken sagsbehandler el. sagsbehandlergruppe sager med dette KLE-nr. skal have. KMD s LinjeOrganisationsSystem Med LOS er det muligt at samle og organisere oplysninger om, hvilke administrative enheder der indgår i en organisation. KMD A/S Side 6 af 19
4. Kort beskrivelse af KMD Sag KMD Sag er en overordnet betegnelse for KMD s sagsstyringskoncept og omfatter flere moduler. KMD Sag kan betragtes som sagsbehandlerens værktøjskasse ved sagsbehandling og integration til andre systemer. KMD Sag skaber overblik og samler oplysninger om sager, dokumenter, journalnotater, adviser og erindringer på tværs af kommunen. Til KMD Sag hører desuden en række forskellige administrationsmoduler, som anvendes til at tilpasse den enkelte kommunes brug af systemet. Indstillingerne i administrationsmodulerne gælder for hele kommunen og ikke for enkelte afdelinger eller brugere. Yderligere information i form af vejledninger til installation, autorisation og daglig brug af KMD Sag kan findes via KMD's hjemmeside http://www.kundenet.kmd.dk/ KMD A/S Side 7 af 19
5. Forretningsregler Forretningsreglerne for servicerne følger, så vidt det er muligt, de regler som er gældende for sager som oprettes og opdateres online via KMD Sag applikationen. Tilslutningsaftale Ved brug af servicerne tjekkes, om der for kommunen er registreret en tilslutningsaftale for den pågældende leverandør. UUID Ved oprettelse tildeles en unik UUID til sagen. Ved importer skal den medsendte UUID være unik og må ikke findes i KMD Sag i forvejen. Sikkerhedsmæssige ejerskab Det sikkerhedsmæssige ejerskab til sagen tildeles automatisk af KMD Sag Ejerskab ud fra sagens KLE-nummer. Hvis der ikke er opsat ejerskabsregler på det pågældende KLEnummer indsættes kommunes øverste administrative enhed. Sagsbehandler/-gruppe og ansvarlig afdeling Hvis sagsbehandler/-gruppe medsendes i servicen anvendes disse. Hvis sagsbehandler/-gruppe ikke medsendes, hentes oplysningerne fra KMD Sag Fordeling. Hvis der ikke er opsat fordelingsregler bliver sagsbehandler sat til kommunens øverste administrative enhed. Hvis ansvarlig afdeling medsendes i servicen anvendes denne. Hvis ansvarlig afdeling ikke medsendes, hentes oplysningerne fra KMD Sag Fordeling. Hvis der ikke er opsat fordelingsregler bliver ansvarlig afdeling blank. Man skal være opmærksom på, at hvis der vælges at medsende ovenstående oplysninger via servicen, skal man, ved en eventuel organisationsjustering, ændre oplysningerne via servicen på den enkelte sag. Hvis KMD Sag Fordeling benyttes, vil man i en sådan situation, kunne ændre tildelingen af sagsbehandler/-gruppe og ansvarlig afdeling automatisk på alle de berørte sager ved at ændre opsætningen i KMD Sag Fordeling. Ret via servicen Sager i KMD Sag kan opdateres via servicerne uafhængigt af, om de er oprettet i KMD Sag eller via servicen. Undtagelser - Sager styret af KMD s fagsystemer kan ikke opdateres. - Sager med KMD Sag sagstype kan ikke opdateres. Ret via KMD Sag Alle felter, på sager oprettet via servicen, kan rettes i KMD Sag. KMD A/S Side 8 af 19
Overtagelse af sager Sager oprettet via servicen kan ikke overtages af sager fra KMD s fagsystemer. Partstyper Der kan oprettes sager på følgende partstyper: - Personnummer - SE/CVR-nummer - Frit - Ejendom - Produktionsenhedsnummer Primær part Det er muligt at oprette sager uden primær part. Sekundære parter Det er muligt at oprette op til 30 sekundære parter. Udgåede (historiske) KLE-numre Der kan ikke oprettes sager på udgåede (historiske) KLE-numre. Status En sag i KMD Sag kan have status aktiv, passiv eller ikke tilgængelig. En aktiv sag svarer til OIO tilstandene opstået, oplyst, afgjort og bestilt. Når sagen afsluttes, får den status passiv, svarende til OIO tilstandene udført og afsluttet. Når datoen for tilgængelighed indtræder, får sagen status ikke tilgængelig. Kassationskode er i august 2013 udgået som begreb i KMD Sag. I stedet for er indført Tilgængelighedstid. Kommunen kan pr. KLEnummer kan opsætte værdier for, hvor længe sager ønskes tilgængelige/synlige i systemet. Under feltbeskrivelserne er mapning mellem OIO s tilstande og KMD Sag status detaljeret beskrevet. Passivering af sager (afslutning af sager) En sag kan ikke afsluttes (passiveres) hvis: - der er tilknyttet notater til sagen, som ikke er godkendte - der er tilknyttet dokumenter til sagen, der ikke er godkendte, løst tilknyttede eller ikke modtagne - der er aktiviteter på sagen, som ikke er færdigmeldte - der er sagskarakteristik spørgsmål på sagen, som ikke er besvarede. Statusregler En sag med status passiv i KMD Sag kan ikke opdateres. Hvis det ønskes, skal den først opdateres til status aktiv (genoptaget). Genoptagelse af afsluttede sager Afsluttede sager (passive) som har været styret af KMD s fagsystemer, kan efterfølgende være manuelt genoptaget i KMD Sag. I den situation kan primær part, sekundære parter eller KLEnummer ikke ændres. KMD A/S Side 9 af 19
Advis Hvis en sags KLE-nummer, primære part, Ejerskab eller Fordeling ændres, opdateres tilknyttede adviser med disse ændringer. Oplysninger ved opdatering Alle oplysninger skal medsendes ved opdatering af en sag. Ikke medsendte oplysninger slettes i KMD Sag. Undtagelse - Sagsbehandler/gruppe og ansvarlig afdeling. Se afsnit ovenfor vedr. Sagsbehandler/-gruppe og Ansvarlig afdeling. - Titeltekst kan undlades. I så fald indsættes beskrivelsen fra sagens KLE-nummer som TitelTekst - Handlingsfacet kan undlades. I så fald sættes den til G01. Parter ved opdatering Alle parter skal medsendes ved opdatering af en sag. Ikkemedsendte parter slettes i KMD Sag. Opdatering samtidig med statusskift - En sag kan ikke afsluttes (passiveres) samtidigt med ændring af den primære part (parter med PartPrimaerKode = P ). - En sag kan ikke afsluttes (passiveres) samtidig med ændring af primærklasse (KLE-Nummer). Aktivitetsstyring, sagskarakteristik, abonnementsadvis Der knytter sig den samme funktionalitet, mht. aktivitetsstyring, sagskarakteristik og abonnementsadvis, til sager oprettet via servicen som til sager oprettet via KMD Sag. List Der kan listes op til 50 sager ad gangen ved kald af servicen. Søg Der tillades kun søgninger, hvor et minimum af søgekriterier er udfyldt. Beskrives i den specifikke servicevejledning Operationen Passiver (Eksporter) KMD forstår operationen Passiver således, at den benyttes i de få tilfælde, hvor der foretages en eksport af sagen til et andet system, hvor sagen fremover skal vedligeholdes. Anvendelse af operationen Passiver (Eksporter) vil medføre at en sag i KMD Sag med status aktiv ændres til passiv og straks derefter være ikke tilgængelig. En ikke tilgængelig sag kan ikke opdateres. Med en speciel autorisation kan dette dog ske manuelt i KMD Sag. - Kun manuelle sager, enten oprettet via KMD Sag applikationen eller via OIO servicen, kan passiveres (eksporteres) via servicen. Sager fra KMD s fagsystemer kan ikke passivers (eksporteres) via servicen. - Manuelt genoptagne sager som har været styret af KMD s fagsystemer kan ikke passivers (eksporteres) via servicen. KMD A/S Side 10 af 19
En sag kan passiveres (eksporteres) selvom - der er tilknyttet notater til sagen, som ikke er godkendte - der er tilknyttet dokumenter til sagen, der ikke er godkendte, løst tilknyttede eller ikke modtagne - der er aktiviteter på sagen, som ikke er færdigmeldte - der er sagskarakteristik spørgsmål på sagen, som ikke er besvarede. Slet Sagen gøres ikke tilgængelig, og er dermed logisk slettet. Sager kan genoptages i KMD Sag af brugere med en speciel autorisation. - Kun manuelle sager, enten oprettet via KMD Sag applikationen eller via OIO servicen, kan slettes via servicen. Sager fra KMD s fagsystemer kan ikke slettes via servicen. - Manuelt genoptagne sager, som har været styret af KMD s fagsystemer, kan ikke slettes via servicen. - En sag kan slettes selvom - der er tilknyttet notater til sagen, som ikke er godkendte - der er tilknyttet dokumenter til sagen, der ikke er godkendte, løst tilknyttede eller ikke modtagne - der er aktiviteter på sagen, som ikke er færdigmeldte - der er sagskarakteristik spørgsmål på sagen, som ikke er besvarede. 6. Opmærksomhedspunkter Dobbelthistorik KMD Sag understøtter ikke OIO standardens dobbelthistorik og accepterer derfor kun én forekomst af sag egenskaber. KMD Sag viser altid øjebliksbilledet af sagen. Virkning Virkning for typen sag:egenskaber understøttes ikke. Alle felter ignoreres ved input og returneres ikke i output. Journalpost Journalpost, som bruges til at berige relationen mellem sager og dokumenter med yderligere information, understøttes ikke. Alle felter ignoreres ved input og returneres ikke i output. Administrativ enhed I OIO Sag servicen anvendes administrativ enhedsid og ikke kommunenummer. Den administrative enhed kan findes ved opslag i LOS- systemet i feltet Enhedsoplysninger. KMD A/S Side 11 af 19
7. Hvor genfindes servicens indhold i KMD Sag I Bilag 1 vises en oversigt over, hvor servicens felter vises i KMD Sags dialog. 8. Operationer Følgende operationer er implementeret: Opret Opretter en sag. Importer Importerer en sag. Ret Retter en sag. Benyttes også, når man ønsker at ændre sagens tilstand/status. Slet Sletter en sag. Logisk sletning. Læs Finder og returnerer en sag, der modsvarer en given identifikation. List Finder og returnerer flere sager, der modsvarer givne identifikationer. Søg Søger og returnerer identifikationer på sager, der modsvarer givne søgekriterier. Passiver (Eksporter) Passiverer en sag og gør den kassabel. Benyttes i de få tilfælde, hvor en sag skal eksporteres ud af KMD Sag. I KMD Sag vil sagen få ændret status til passiv og straks derefter blive ikke tilgængelig. KMD A/S Side 12 af 19
9. Distribution af WSDL filer WSDL filer mm. kan desværre ikke sendes via email, da de stoppes af viruskontrol. De hentes derfor via KMD s distributionscenter. De nødvendige oplysninger om leverandøren, til brug for registrering på distributionscentret, oplyses i forbindelse med Tilslutningsblankettens generelle oplysninger. 10. Servicens arkitektur Systemskitse og sikkerhedsmodel: Klient PC (Anvender-certifikat) OCES CA (NETS_DANID) Validering af: Anvendercertifikat 3. part Service (Anvender-certifikat) OIOXML EWS TDC Rodcertifikat (SOCES) Eksternt KMD XML Tilslutningsaftale bekræftes KWS Certifikat oversættes til RACFid Internt KMD Anvender Certifikater: (OCES) MOCES: Medarbejdercertifikat FOCES: Funktionscertifikat Applikationskomponent Sag KMD Sag SOCES: Servercertifikat Figur 1. KMD A/S Side 13 af 19
11. Teknisk implementering KMD anvender en teknisk driftsmodel, der udbyder mainframeservices efter OWSA-T modellen, til webservices på EWS en. Det vil sige, at services opfører sig som online services med en bruger tilknyttet. Der er ingen asynkrone led. Der vil således returneres svar om operationen er gået godt eller ej. Anvendere af servicen skal derfor overholde OWSA-T standarden. (Yderligere information findes på www.itst.dk: http://www.itst.dk/itarkitektur-og-standarder/standardisering/standarder-for-serviceorienteretinfrastruktur/standarder-for-webservices/filer-til-standarder-forwebservices/owsa%20model%20t.pdf) 11.1 OIOXML OIOXML bruges til datatyper i Eksterne Web Services (EWS). EWS baseres på sikkert transport via OIO Web Service Arkitektur, model T (OWSA-T), som består af: WS-I Basic Profile 1.1 & Simple SOAP Binding Profile 1.0 HTTPS vha. OCES certifikater (datakryptering og autentifikation) OIOXML Når der er indgået kontrakt kan XML Schemaer, WSDL filer rekvireres på følgende mailadresse sagsnitflade@kmd.dk 11.2 Sikkerhed Data leveres via 3. part Web Service, som følger OIOXML-standarden med brug af certifikat, leveret over SOAP protokollen (se også figur 1). Sikkerheden håndteres af SSL, og implementeres ved hjælp af OCES certifikater, som skal installeres på den klientmaskine, der skal kalde en eller flere webservices. 11.3 Certifikater Det er det afsendende systems ansvar at garantere brugerens identitet. Brugeren identificeres via det medsendte anvender-certifikat, som kan være medarbejder- eller funktionscertifikat, som omsættes af KSP/CICS til den KMD-brugerid, RACF_ID, som certifikatet er knyttet til. Det er kommunen, som bestiller de certifikater, man ønsker at anvende. Læs mere om certifikater i Tilslutningsguiden til OIO Standardservices. KMD A/S Side 14 af 19
11.4 Autorisation Den RACF_ID, som det medsendte anvender-certifikat omsættes til, skal som minimum være oprettet som sagsbehandler i KSP/CICS og være tildelt rolleprofilen SAG-SA-L for at kunne læse sager og rolleprofilen SA-SA- R for at kunne opdatere sager. Der skal autoriseres til alle de sikkerhedsenheder, som brugeren skal have adgang til. Det er kommunens sikkerhedsansvarlige, som opretter RACF_ID i KSP/CICS og tildeler de relevante autorisationer. Læs mere om autorisationer i Tilslutningsguiden til OIO Standardservices. 11.5 Skemavalidering Der foretages en skemavalidering af XML for overholdelse af bla. version, format og gyldighed af tags i henhold til den givne operation. Data pakkes ud via KWS en, så de kan modtages af KMD Sag applikationskomponenten. KMD A/S Side 15 af 19
12. Bilag 1. Hvor genfindes servicens felter i KMD Sags dialog OIO NAVN Feltnavn KMD Sag Fig. 1 TilstandsVirkningsFraTidspunktVises på fanen Historik; Sagssstatusdato 2 og 3 Anvendes hvis udfyldt. Ellers sættes statusdato på sagen til dags dato 2 Livscykluskode Vises ikke - 3 BeskrivelseTekst Beskrivelse 2 4 KassationskodeTekst Kassation (2) (Udgår i version 14 af KMD Sag) 5 TitelTekst Overskrift 2 6 LeverandoerKode Vises ikke - 7 FremdriftStatusKode Status 2 8 PrimaerBehandler Sagsbehandler 2 9 PrimaerKlasse Sagstype og Handlingsfacet 2 10 Ansvarlig Afdeling 2 11 Ejer Organisation 2 12 PartIdentifikator (primær part) Navn og adresselinje 2 13 Parter (sekundære parter) Vises på fanen Parter 2 KMD A/S Side 16 af 19
12 1 5 7 13 3 9 11 4 10 8 Fig. 2 KMD A/S Side 17 af 19
1 Fig. 3 KMD A/S Side 18 af 19
13. Referenceliste 1. OWSA Model T version 1.0; IT- og Telestyrelsen, 2005. 2. Specifikation af serviceinterface for Dokument, OIO-udvalget for sags- og dokumentområdet, version 1.1; IT- og Telestyrelsen, 2009. 3. Generelle egenskaber for serviceinterfaces på sags- og dokumentområdet; OIO-udvalget for sags- og dokumentområdet; IT- og Telestyrelsen, 2009. 4. Brugervejledning til sikkerhedsadministratorer KSP/CICS- Administration; KMD håndbog KMD-HDB-086; KMD A/S 2009 5. Unikke Identifikatorer til digitale objekter; Standardisering; IT- og Telestyrelsen, 2006. 6. Vejledning om anvendelse af obligatoriske, åbne standarder for software i det offentlige; IT- og Telestyrelsen, 2007. KMD A/S Side 19 af 19