Gå til hovedindhold
Mapper og et illustrativt ikon

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
 

  1. Du er oprettet som leverandørorganisation og har adgang til Fælleskommunalt Administrationsmodul
  2. Dit it-system er registreret i  Fælleskommunalt Administrationsmodul
  3. 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. 

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: 

  1. Vælg Serviceaftaletypen "Uden videregivelse af data", uanset om du skal kunne læse eller redigere metadata
     
  2. Vælg følgende services:
    • "SagDokumentIndeks - v 5.0"
    • "Sagdokumentindeks2" (vælges automatisk, når du vælger ovenstående)
  3. Sæt dette parameter på "SagDokumentIndeks - v 5.0":
    • Tilføj rollen "Dummy" 
  4. 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
  5. 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: 

Du har desuden brug for følgende: 

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. 

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. 

XML eksempler

Eksempler på web service requests mod Serviceplatformen og tilhørende responses findes som XML-filer, der kan tilrettes og afprøves. Disse filer samt uddybende notat kan hentes i zip-filen SF1470 v5 - Test eksempler.

Valideringstool

Valideringstoolet kan bruges til at validere de XML-strukturer, der angives som input ved kald til webservices. Formålet med toolet er at give hjælp til opbygning og forståelse af datastrukturer i indekset​. 

Toolet fungerer på denne måde:

  • Toolet tager den samme XML-struktur som den tilsvarende operation som input
  • Toolet foretager først skemavalidering - hvis der er fejl, returneres hele skemafejlbeskeden
  • Toolet validerer obligatoriske felter i henhold til anvisningerne 
  • Toolet returnerer detaljerede og informative fejlbeskeder, bl.a. med referencer til det sted i anvisningerne, hvor strukturen/kravene er beskrevet
  • Toolet understøtter pt." Importer"- og "Opdater"-operationerne for Sags- og Dokumentindekset.

Valideringstoolet kan anvendes uden indgåelse af serviceaftaler. Toolet kaldes (både med og uden Security Token) mod følgende endepunkt: https://virtualize01.serviceplatformen.dk/service/SF1470-Validation/5 

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"
  • Vha. "Import" i brugergrænsefladen til Sags- og Dokumentindeks
  • 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 kdi@kombit.dk for mere information.