OIO standardservice til Sag. Servicevejledning til operationen Sag Passiver (Eksporter) KMD Sag Version KMD A/S Side 1 af 15

Transkript

1 OIO standardservice til Sag Servicevejledning til operationen Sag Passiver (Eksporter) KMD Sag Version KMD A/S Side 1 af 15

2 Servicevejledning til Sag Passiver (Eksporter) Ekstern standardservice til KMD Sag Opdateret KMD A/S Side 2 af 15

3 Indholdsfortegnelse 1. Version Generelt Vejledningernes opbygning Vejledningernes formål Brug af vejledningerne Kontakt Forretningsregler Teknisk beskrivelse Input til Sag Passiver (Eksporter) Output fra Sag Passiver (Eksporter) Statuskoder fra Sag_Passiver (Eksporter) KMD A/S Side 3 af 15

4 1. Version Version Dato Ændring Version Der er ikke foretaget ændringer i OIO Sag XML skemaerne. Der er foretaget en korrektur af servicebeskrivelsen, så den stemmer overens med XML skemaerne og OIO Sag standarden Ud over sproglige justeringer er følgende ændringer og rettelser foretaget i denne version 1.2 af anvendelsesvejledningen til standardservicen: Afsnit 5.1 opdateret angående oplysninger om XMLskemaer og WSDL-filer Note om tjek af ejerskabsregler tilføjet i afsnit 5.2 om sikkerhed. AktoerRef og URNIdentifikator ændret til valgfrit felt i output ifm. sag:registrering (afsnit 9.2) FremdriftStatusKode ændret til krævet felt i output ifm. sag:tilstandliste (afsnit 9.2) Ansvarlig ændret til krævet felt i output ifm. sag:relationliste (afsnit 9.2) Ejer ændret til krævet felt i output ifm. sag:relationliste (afsnit 9.2) En reference er fjernet fra Referenceliste (afsnit 13). Afsnit 10 revideret angående dataejerskab. Afsnit 11 udvidet angående ændringer af services Generel omstrukturering af vejledninger til OIO servicerne I KMD Sag er begrebet Kassation udgået, og erstattet med Tilgængelighed. Mapning ifm. Output til FremdriftStatusKode ændret (afsnit 4.2). Der er desuden ændret visse formuleringer. KMD A/S Side 4 af 15

5 2. Generelt 2.1 Vejledningernes opbygning Der er udarbejdet følgende vejledninger Tilslutningsguide, som indeholder information gældende for alle OIO servicerne 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 servicerne 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. 2.3 Brug af vejledningerne Beskrivelserne 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. servicevejledningerne og spørgsmål til servicerne i øvrigt kan ske til: KMD A/S Side 5 af 15

6 3. Forretningsregler OIO standarden definerer følgende tilstande af en sag: Opstået, Oplyst, Afgjort, Bestilt, Udført og Afsluttet. KMD Sags statusbegreb med aktive og passive sager relateres i servicen til sagens tilstand, og ikke til sagens livscyklus. KMD Sag er ikke på nuværende tidspunkt i stand til at understøtte tilstandene Oplyst, Afgjort og Bestilt. Anvendelse af Sag Passiver (Eksporter) vil medføre at en sag i KMD Sager med status aktiv ændres til passiv, og derefter blive gjort ikke tilgængelig. En ikke tilgængelig sag kan ikke opdateres. Med speciel autorisation kan sagen dog tilgås og genoptages manuelt i KMD Sager. KMD forstår operationen Passiver (Eksporter)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. Servicen Sag Passiver (Eksporter) skal ikke anvendes til at opdatere en aktiv sags status i KMD Sager til passiv. Til dette formål anvendes servicen Sag Ret. Forretningsreglerne for servicen følger, så vidt det er muligt, de regler som er gældende for sager som passiveres via KMD Sager applikationen. Forretningsregler i relation til de enkelte operationer er beskrevet samlet i Generel servicevejledning til Sag. KMD A/S Side 6 af 15

7 4. Teknisk beskrivelse I dette afsnit gennemgås de data, som udveksles ved kald af servicen. Kun de felter, som understøttes af KMD Sag enten ved input eller output, er beskrevet nærmere. De felter, som ikke understøttes, nævnes kun med en note om at de ignoreres eller ikke returneres. Dataværdier I nedenstående input/output skemaer beskrives under de enkelte felter formatet af URNIdentifikator. Et eksempel kan være urn:oio:kmd:sag:klenr_handlingsfacet:<>;<>. Optionalitet I skemaet benyttes følgende værdisæt til at angive om et felt skal udfyldes eller ej: = Krævet oplysning Opt= Valgfri oplysning ()= betinget krævet i visse tilfælde At et felt er mandatory, (), er et krav i OIO-standarden, men ikke altid et krav i KMD Sag. Sådanne felter kan overføres uden indhold ved at sende tom streng. Det fremgår af feltbeskrivelsen for det enkelte felt, om tom streng kan fremsendes. KMD A/S Side 7 af 15

8 4.1 Input til Sag Passiver (Eksporter) Overordnet struktur af input til Sag Passiver (Eksporter) ifølge OIO standardens xsd-skema, med KMD s lokaludvidelse: INPUT til Sag Passiver (Eksporter) Format og feltlængde M/O Beskrivelse sd:uuidnoteinput UUID Char (36) UUID på sagen NoteTekst - - Ignoreres - understøttes ikke sd:lokaludvidelse kmdsag:inputlokaludvidelse LeverandoerKode Char(20) Store bogstaver Identifikation af den leverandør og det system, som passiverer (eksporterer) sagen. Skal være kendt af KMD Sag. Aftales med den enkelte leverandør og fremgår af tilslutningsaftalen med kommunen. KMD A/S Side 8 af 15

9 4.2 Output fra Sag Passiver (Eksporter) Overordnet struktur for output fra Sag Passiver (Eksporter) ifølge OIO standardens xsd-skema: OUTPUT fra Sag Passiver (Eksporter) Format og feltlængde M/O Beskrivelse sd:standardretur StatusKode Integer Returkode om passivering af sag er gået OK eller fejlet. (Se liste over returkoder). FejlbeskedTekst Char(512) Beskrivende tekst til statuskoden. sag:registrering Tidspunkt: TidsstempelDatoTid DatoTid Returnerer tidspunkt for seneste opdatering. GraenseIndikator - - Optionelt felt - returneres ikke KMD A/S Side 9 af 15

10 OUTPUT fra Sag Passiver (Eksporter) Format og feltlængde M/O Beskrivelse LivscyklusKode Char (10) Sagens tekniske fremdrift ift. eksistens. Værdi afhængig af operation: Sag Passiver: Passiv AktoerRef: Opt UUID - - Optionelt felt - returneres ikke URNIdentifikator URN (32)+(8) Opt Returnerer den bruger-id der har kaldt operationen. Identificeres via certifikat og omsættes til bruger_racfid. urn:oio:kmd:sag:sagsbehandlerid:<> CommentText - - Optionelt felt - returneres ikke Virkning ifm. Registrering Virkning understøttes ikke. FraTidspunkt: Opt TidsstempelDatoTid - - Optionelt felt - returneres ikke GraenseIndikator - - Optionelt felt - returneres ikke TilTidspunkt: Opt TidsstempelDatoTid - - Optionelt felt - returneres ikke GraenseIndikator - - Optionelt felt - returneres ikke AktoerRef: UUID URNIdentifikator URN (32)+(8) Returnerer den bruger-id der har kaldt operationen. Identificeres via certifikat og omsættes til bruger_racfid. urn:oio:kmd:sag:sagsbehandlerid:<> CommentText - - Optionelt felt - returneres ikke sag:attributliste sag:egenskaber AfleveretIndikator - - Optionelt felt - returneres ikke BeskrivelseTekst Char (1024) Sagsbeskrivelse i fri tekst. Evt. supplerende beskrivelse af indhold og formål. HjemmelSpecifikation- - - Optionelt felt - returneres ikke Tekst KassationskodeTekst Char (4) Værdisæt: K: Kan kasseres efter afslutning TitelAlternativTekst - - Optionelt felt - returneres ikke UndtagetOffentlighed- - - Optionelt felt - returneres ikke HjemmelTekst SagPrincipielIndikator - - Optionelt felt - returneres ikke SagsnummerIdentifikator - Understøttes ikke - returnerer tom streng TitelTekst Char (125) Officiel sagstitel, som benyttes som sagens overskrift. Virkning ifm. Attributliste VirkningType understøttes ikke. FraTidspunkt: Opt TidsstempelDatoTid - - Optionelt felt - returneres ikke GraenseIndikator - - Optionelt felt - returneres ikke TilTidspunkt: Opt TidsstempelDatoTid - - Optionelt felt - returneres ikke KMD A/S Side 10 af 15

11 OUTPUT fra Sag Passiver (Eksporter) Format og feltlængde M/O Beskrivelse GraenseIndikator - - Optionelt felt - returneres ikke AktoerRef: UUID URNIdentifikator URN (32)+(8) Returnerer den bruger-id der har kaldt operationen. Identificeres via certifikat og omsættes til bruger_racfid. urn:oio:kmd:sag:sagsbehandlerid:<> CommentText - - Optionelt felt - returneres ikke sag:tilstandliste sag:fremdrift FraTidspunkt: Opt TidsstempelDatoTid DatoTid Opt Returnerer dato og tid for statusskift. GraenseIndikator - - Optionelt felt - returneres ikke AktoerRef: UUID URNIdentifikator URN (32)+(8) Returnerer den bruger-id der har kaldt operationen. Identificeres via certifikat og omsættes til bruger_racfid. urn:oio:kmd:sag:sagsbehandlerid:<> CommentText - - Optionelt felt - returneres ikke FremdriftStatusKode Char (10) KMD Sag er ikke på nuværende tidspunkt i stand til at returnere værdierne Oplyst, Afgjort og Bestilt. Mapning af værdisæt: KMD Sag OIO. Aktiv Opstaaet Passiv Udfoert Ikke tilgængelig Afsluttet sag:relationliste AndreBehandlere - - Optionelt felt - returneres ikke AndreKlasser - - Optionelt felt - returneres ikke AndreSager - - Optionelt felt - returneres ikke Ansvarlig URNIdentifikator Arkiv URNIdentifikator Ejer URNIdentifikator URN (49)+(26) Ansvarlig afdeling for sagen. urn:oio:kmd:sag:administrativenhed_kaldena vnkort:<>;<> - datory felt - returnerer tom streng URN (35)+(15) Den aktør (organisation/kommune), der har det myndighedsmæssige ejerskab. urn:oio:kmd:sag:administrativenhed:<> Parter - - Optionelt felt - returneres ikke. (KMD har i lokaludvidelse implementeret udvidet partbegreb). KMD A/S Side 11 af 15

12 OUTPUT fra Sag Passiver (Eksporter) PrimaerBehandler URNIdentifikator PrimaerKlasse URNIdentifikator Format og feltlængde URN (49)+(26) eller URN (32)+(8) Ifm. KLE: URN (22)+(12) ;x99 eller M/O Opt Beskrivelse Aktør, som arbejder med/behandler sagen. Dette er den primære behandler af sagen. Kan enten være en sagsbehandler eller en administrativ enhed i kommunen. Returnerer lagret værdi. urn:oio:kmd:sag:administrativenhed:kaldenav nkort:<>;<> eller urn:oio:kmd:sag:sagsbehandlerid:<> Klasse i et klassifikationssystem, der klassificerer denne sag. Dette er den primære klassifikation af sagen. Returnerer lagret værdi (sammensat af KLEnr;Handlingsfacet). Ældre sager kan være uden handlingsfacet. URN (37)+(12) ;x99 Ifm. KMD Sagstype: URN (28)+(11) eller URN (43)+(15) ; x99 Format for KLE: urn:oio:kmd:sag:klenr:<> eller urn:oio:kmd:sag:klenr_handlingsfacet:<>;<> Ældre KMD Sag sager kan indeholde KMD sagstype i stedet for KLE. Format for KMD Sagstype: urn:oio:kmd:sag:kmdsagstype:<> eller urn:oio:kmd:sag:kmdsagstype_handlingsfacet :<>;<> Praecedens - - Optionelt felt - returneres ikke UdlaantTil - - Optionelt felt - returneres ikke UnderSager - - Optionelt felt - returneres ikke LokalUdvidelse (sag:relationliste) kmdsag:sagpart PartPrimaerKode Char (1) Angiver om parten er relateret til sagen som primær eller sekundær part. Kun én part kan have markeringen for primær part. Værdisæt: P - Primær part S - Sekundær part KMD A/S Side 12 af 15

13 Format og feltlængde M/O Beskrivelse PartTypeKode Num (2) Parttypen beskriver hvilken type parten er, f.eks. personnummer, CVR/SE-nummer eller et frit valg nr. Værdisæt: 02 = Personnummer 03 = SE/CVR-nummer 13 = Frit 14 = Ejendom 15 = Produktionsenhedsnummer PartIdentifikator Num (10) () En identifikation af relaterede parter til sagen, f.eks. personnummer. OUTPUT fra Sag Passiver (Eksporter) PartTilhoersKommune- Kode Num (4) Altid 4 cifre med foranstillede nuller. () En identifikation af den kommune hvori parten er kendt. Hvis PartTypeKode = 02, 03, 15: Feltet må ikke være udfyldt. Hvis PartTypeKode = 13, 14 skal feltet være udfyldt PartNavn Char (100) () En identifikation af parten når denne er af typen 13. Hvis PartTypeKode = 02, 03, 14, 15: Feltet må ikke være udfyldt. Hvis PartTypeKode = 13, skal feltet være udfyldt PartRolleKode Char (11) En identifikation af relateret parts rolle i forhold til en sag. F.eks. ÆGT(ægtefælle), FBN(fælles barn) sag:journalpost Journalpost understøttes ikke af KMD i denne version. Dog returneres følgende elementer som følge af optionaliteten i standardskema. sag:journalpostegenskaber JournalPostFeltTekst - Returnerer tom streng. TilhoersforholdKode - Returnerer Tilakteret Virkning ifm. JournalPostEgenskaber AktoerRef: URNIdentifikator URN (32)+(8) Returnerer den bruger-id der har kaldt operationen. Identificeres via certifikat og omsættes til bruger_racfid. urn:oio:kmd:sag:sagsbehandlerid:<> KMD A/S Side 13 af 15

14 5. Statuskoder fra Sag Passiver (Eksporter) Sag Passiver Statuskodegruppe Beskrivelse Anbefalet reaktion samt -1200/ /2052 Sag specifikke fejl Sagen må ikke sendes ind igen, før fejlårsag er rettet (skyldes fx mangelfuld udfyldning, ugyldige værdier eller brud på forretningsregler i KMD Sag). Ifm. batchkørsel skal den fejlende sag fjernes, hvorefter kørslen kan fortsætte Midlertidig fejl System kortvarigt utilgængeligt prøv at kalde igen Systemfejl hos KMD Fejl der helt stopper alle kald Kontakt KMD på telefon eller kmdsag@kmd.dk Alle sager vil fejle. Derfor må der ikke kaldes igen, før fejlen er rettet (skyldes fx manglende autorisation eller forkert udfyldning af XML). StatusKode FejlbeskedTekst OK - Sag passiveret Sag med angivne UUID findes ikke Leverandør (AttributListeLokalUdvidelse.LeverandoerKode) er ikke udfyldt Sag UUID (Sag.UUID) er ikke udfyldt Leverandør (AttributListeLokalUdvidelse.LeverandoerKode) findes ikke Leverandør (AttributListeLokalUdvidelse.LeverandoerKode) har ikke en gyldig tilslutningsaftale Leverandør (AttributListeLokalUdvidelse.LeverandoerKode) har ingen tilslutningsaftale for kommunen Sag UUID (Sag.UUID) indeholder ikke en gyldig UUID værdi Der er opstået en midlertidig fejl ved adgang til databaseressourcerne ved kald af servicen - operationen er ikke udført Der er opstået en systemfejl ved kald af servicen - operationen er ikke udført Bruger er ikke autoriseret til at kalde operationen for denne sag Det anvendte klientcertifikat er ikke tilknyttet en RACF bruger i KSP Brugeren er ikke autoriseret til at kalde operationen Servicen er midlertidigt lukket - forventes genåbnet <dato> <tid> Denne version af servicen er udgået og må ikke længere anvendes (gives først når denne version på et tidspunkt udgår) Sagen kan ikke passiveres, da den er styret af et af KMD's fagsystemer Sagen har en KMD Sag sagstype og sagen må derfor ikke passiveres KMD A/S Side 14 af 15

15 LokalUdvidelse (Input.LokalUdvidelse) elementet er ikke angivet KMD A/S Side 15 af 15