Bliv klar til at kode: SDI
Hvordan får du adgang til Fælleskommunalt Sags- og Dokumentindeks? Her finder du gode råd og vejledninger, så du bliver klar til at kode.
På denne side kan du læse om:
- Forudsætninger for at kunne påbegynde udvikling
- Serviceaftale
- Services
- Dokumentation og vejledning
- Eksempler og værktøjer
- Test
Forudsætninger for at kunne påbegynde udvikling
- Du er oprettet som leverandørorganisation og har adgang til Fælleskommunalt Administrationsmodul
- Dit it-system er registreret i Fælleskommunalt Administrationsmodul
- Du har anmodet om og fået godkendt de nødvendige serviceaftaler (se herunder)
Serviceaftale
For at kunne kalde webservices for Sags- og Dokumentindeks skal der oprettes en serviceaftale med jeres testmyndighed.
- Du kan læse mere om serviceaftaler og finde vejledning til oprettelse i Fælleskommunalt Administrationsmodul på denne side.
Når du skal oprette en serviceaftale for Sags- og Dokumentindeks, er der disse specifikke trin, som du skal igennem i forbindelse med oprettelsen af serviceaftalen i Administrationsmodulet:
- Vælg Serviceaftaletypen "Uden videregivelse af data", uanset om du skal kunne læse eller redigere metadata
- Vælg følgende services:
- "SagDokumentIndeks - v 5.0"
- "Sagdokumentindeks2" (vælges automatisk, når du vælger ovenstående)
- Sæt dette parameter på "SagDokumentIndeks - v 5.0":
- Tilføj rollen "Dummy"
- For at kunne læse metadata i indekset, sæt disse parametre på "Sagdokumentindeks2":
- Tilføj rollen "Udstil"
- Itsystem: Indsæt UUID for dit it-system i Administrationsmodulet
- Fjern afkrydsning i øvrige parametre
- For at kunne redigere metadata i indekset, sæt disse parametre på "Sagdokumentindeks2":
- Tilføj rollen "Rediger"
- Itsystem: Indsæt UUID for dit it-system i Administrationsmodulet
- Fjern afkrydsning i øvrige parametre
Services
Du kan læse mere om de tilgængelige webservices for Fælleskommunalt Sags- og Dokumentindeks på siden for integrationen SF1470 Sags- og Dokumentindeks.
For at kunne kalde webservices, skal du skal have installeret følgende certifikater:
- Dit eget funktionscertifikat (tilknyttet dit it-system i Administrationsmodulet)
- Certifikater til Serviceplatformen
- Certifikater til Secure Token Service
- Se også: Kom godt i gang med certifikater
Du har desuden brug for følgende:
- WSDL- og XSD-filer for de enkelte webservices - se dokumentationen for SF1470 Sags- og Dokumentindeks
- Endpoints for de enkelte webservices - se under services på siden for SF1470 Sags- og Dokumentindeks
Når ovenstående er på plads, og de nødvendige serviceaftaler er godkendt af testmyndigheden, kan du begynde at kalde webservices.
Kom godt i gang med webservices
Hvis det er første gang, du skal kalde en webservice i den fælleskommunale infrastruktur, er der hjælp at hente her:
Beskedservices
Du kan abonnere på beskeder, når sager ændrer status. Via integration til Fælleskommunal Beskedfordeler kan du abonnere på ændringer i Sags- og Dokumentindekset, så der modtages notifikationer, når sager ændrer tilstand til:
- Sag.fremdrift=status opstået (= start)
- Sag.fremdrift=status afsluttet (=slut)
Dokumentation og vejledning
Dokumentationen for SF1470 Sags- og Dokumentindeks indeholder servicebeskrivelser for integrationens webservices (herunder fejlkoder), samt et fællesdokument med generelle forhold, som gælder for alle webservices i integrationen.
Inden du som anvender kører det indledningsvise load og batch load på infrastrukturen kan det være en god idé, at forholde dig til følgende dokument, der kort opsummerer de ting, du bør have in mente med denne øvelse.
For at forstå den forretningsmæssige opbygning af Sags- og Dokumentindekset, bør leverandør og myndighed forholde sig til KOMBITs anvisninger, som beskriver alle objekter, relationer og felter i indekset. Anvisningerne beskriver det forretningsmæssige indhold af og formatet på alle felter, og hvilke oplysninger, der er obligatoriske, når der afleveres data. Anvisningerne supplerer de mere tekniske servicebeskrivelser. Du finder anvisningerne i boksen nedenfor.
Eksempler og værktøjer
Kodeeksempler
Kodeeksemplerne demonstrerer, hvordan klasser genereres på baggrund af WSDL-filerne og hvordan webservices kaldes for bl.a. Sags- og Dokumentindeks. Kodeeksemplerne for .NET understøtter .NET 4.8. Der er kendte udfordringer med OIOIDWS, hvis man anvender nyere versioner af .NET - i maj 2023 publicerede KOMBIT derfor et kodebibliotek, der er en videreudvikling af Digitaliseringsstyrelsens OIOIDWS.Net-pakke.
XML-eksempler
For integrationsversion 2.9 (serviceversioner 5.0) finder der eksempler på webservice requests mod Serviceplatformen og tilhørende responses som XML-filer, der kan tilrettes og afprøves. Disse filer samt uddybende notat kan hentes i zip-filen SF1470 v5 - Test eksempler.
Valideringstool
Som hjælp til integration mod Fælleskommunalt Sags- og Dokumentindeks, har KOMBIT udviklet et valideringstool, der kan bruges til at validere den XML-struktur, der skal angives som input i kald til Sags- og Dokumentindekset. Formålet med toolet er at hjælpe til opbygning og forståelse af datastrukturer.
Kort om toolet:
- Toolet tager den samme XML-struktur som den tilsvarende operation i integrationen som input.
- Toolet foretager først skemavalidering, hvis der er fejl returneres hele skemafejl beskeden.
- Toolet validerer obligatoriske felter i henhold til Anvisningerne som findes i dokumenterne Anvendelse af Sagsobjektet i Fælleskommunalt Sags- og Dokumentindeks og Anvendelse af Dokumentobjektet i Fælleskommunalt Sags- og Dokumentindeks
- Toolet returnerer detaljerede og informative fejlbeskeder, blandt andet med referencer til det sted i Anvisningerne, hvor strukturen/kravene er beskrevet.
Toolet kan anvendes uden indgåelse af serviceaftaler. Toolet kan kaldes med samme inputstruktur (både med og uden Security Token), som eksisterende operationer i SF1470 Sags- og Dokumentindeks, ved at kalde mod følgende endepunkt: https://virtualize01.serviceplatformen.dk/testservice/SF1470-Validation/V61
Test
Leverandører og kommuner, som anvender det eksterne testmiljø til afprøvning af konfigurationer og integrationer, skal overholde retningslinjer for anvendelse af eksternt testmiljø.
Testdata
Det er muligt at indlæse testdata i Sags- og Dokumentindekset på følgende måder:
- Vha. operationen "Importer" i servicen "SagDokumentIndeksService"
- Ved at bestille indlæsning af testdata som en fakturerbar supportydelse her.
Det er anvenderens eget ansvar at skabe testdata til indlæsning. Anvender kan indgå aftale med en anden anvender om at teste sammen med dennes indlæste sager.
Testmyndighed
Hvis I ikke har en myndighed at teste med, kan I få oprettet jeres egen testmyndighed. Kontakt FKI@kombit.dk for mere information.