Oprindelig kilde Datafordeleren
Forfatter Datafordeleren
Oprettet May 16, 2023
Version 1.0
Ændret Oct 30, 2023
Sidehistorik





Denne side beskriver hvordan du opretter et abonnement på en hændelse via Dataoversigten på Datafordeleren.

Den følgende introduktion forudsætter kendskab til webbrugere og tjenestebrugere på Datafordeleren samt det overordnede flow i opdatering af data og dannelse af datanære hændelser på Datafordeleren.





Log på Datafordeleren

Oprettelsen af et abonnement på hændelser kræver en webbruger og tjenestebruger, da abonnementet er relateret til en specifik tjenestebruger. På grund af sikkerhedshensyn kræver nogle hændelser, at registeret giver adgang til, at en tjenestebruger kan abonnere på dem. 

Brug Dataoversigten til at undersøge, hvilken brugeradgang den ønskede hændelse kræver og læs mere om Brugeroprettelse og Brugeradgang på Datafordeler.dk. Bemærk, at det kun er muligt at oprette abonnementer på hændelser med brugernavn/adgangskode eller ved bruge certifikat, og at det ikke er muligt at benytte en SSH2-nøgle.

Log på Datafordeleren med den ønskede webbruger og anmod eventuelt om adgang til de begrænsede tjenester via tjenestebrugeren, som du finder under det menupunktet Dine tjenestebrugere på din konto.

Til toppen



Opret et abonnement på en hændelse

Du kan via Dataoversigten oprette et abonnement på en hændelse. Du skal være logget ind med din webbruger for at oprette abonnement.

Du kan bruge filtrene på dataoversigten til at afgrænse oversigten, så den kun viser de tilgængelige hændelser, ved at markere Hændelser under Tjeneste i menuen til venstre. Du kan også vælge at sortere på Emner, Service, Adgang og Filformat


Til toppen


Find det register på listen, som du ønsker at abonnere på, og fold linjen ud ved at klikke på pilen til højre for registret.


Klik på Opret abonnement.




Opsætning

Du skal nu udfylde en række informationer, som led i oprettelsen af et abonnement.

Til toppen






Oplysninger


FELTER I OPSÆTNINGEN

  • Tjenestebruger
    Her vælger du den tjenestebruger, som du ønsker at tegne abonnementet med.
    Tjek efter om din tjenestebruger stemmer overens med de krav, tjenesten stiller. Er hændelsen placeret i zone 5 skal tjenestebrugeren for eksempel være oprettet med certifikat. 
  • Navn på abonnement
    Du vælger selv et sigende visningsnavn for hændelsen. 
  • Abonnementtype
    Her kan du vælge mellem Datahændelser og Forretningshændelser
    Vælg som udgangspunkt Datahændelser.
    Læs mere om Forretningsmæssige og datanære hændelser
  • Beskedtype
    I feltet kan du vælge den hændelse, som abonnementet skal knyttes til.





Til toppen

Levering

FELTER I OPSÆTNINGEN

  • Leveringstype
    Det er muligt at vælge mellem to forskellige leveringstyper; PULL eller PUSH. 
    Ved PULL henter du hændelsesbeskederne via eventservicen og ved PUSH sender Datafordeleren hændelsesbeskeder til dig. 
    Læs mere om PULL og PUSH
  • Leveringsformat
  • For hændelser kan du vælge imellem to leveringsformater XML og JSON. 



Hændelsesbesked (PULL)

Til toppen

Har du i dit abonnement valgt at hente hændelsesbeskeder (PULL-scenariet), kan du hente de hændelsesbeskeder, der bliver dannet.

Hændelsesbeskeden blive gjort tilgængelig i en RESTful tjeneste.



Eksempel på opbygning af url med brugernavn og adgangskode

<endpoint>/system/EventMessages/1.0.0/custom?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&username=xxx&password=yyy&format=zzz&page=xx&pagesize=zz


Eksempel på opbygning af url i sikkerhedszone 0 med brugernavn og adgangskode

https://services.datafordeler.dk/system/EventMessages/1.0.0/custom?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&username=xxx&password=yyy&format=zzz&page=xx&pagesize=zz


Eksempel på opbygning af url i sikkerhedszone 0 med certifikat

https://certservices.datafordeler.dk/system/EventMessages/1.0.0/custom?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&format=zzz&page=xx&pagesize=zz


Eksempel på opbygning af url i sikkerhedszone 5 med certifikat 

https://s5-certservices.datafordeler.dk/system/EventMessages/1.0.0/custom?datefrom=yyyy-mm-dd&dateto=yyyy-mm-dd&format=zzz&page=xx&pagesize=zz



INDSÆT OPLYSNINGER I URL'EN

Følgende skal tilføjes url'en for at hente hændelsesbeskeder:

  • Endpoint
    Du kan finde det korrekte endpoint på endpointoversigt og miljøer eller benytte en af de tre eksempler.
  • Datefrom og dateto
    Datoerne yyyy-mm-dd er obligatoriske parametre og skal tilføjes. 
    Det er muligt at udbygge med timer, minutter og sekunder, men det ikke obligatorisk.
    Vil du benytte timer, minutter og sekunder skal benytte formatet yyyy-mm-ddTHH:MM:SS. 
    Bemærk at hændelser kun sendes i de perioder, hvor abonnementet er aktiveret.
  • Brugernavn og adgangskode
    Brugernavn og adgangskode er obligatoriske parametre, hvis tjenestebrugeren er oprettet på den måde.
    Det er den tjenestebrugerens brugernavn og adgangskode, som skal tilføjes.
    Bemærk, at tjenestebrugeren skal svare til den tjenestebruger, som har opsat abonnementet.
  • Certifikat
    For hændelser, som er placeret i sikkerhedszone 5 er det kun muligt at oprette abonnementet med en tjenestebruger, som er oprettet med et certifikat.
  • Format
    Formatet kan enten være json eller xml.
  • Paging
    Læs mere om paging på Hændelser på Datafordeleren.

Indsæt dine oplysninger i url'en.

Søg med url'en i en browser og du har nu hentet din første hændelsesbesked.




Hændelsesbesked (PUSH)

Til toppen

Vælger du PUSH under Leveringstype skal du endvidere oplyse push-endepunkt og e-mail.

PUSH af hændelser fra Datafordeleren til anvendere er baseret på OData-standarden, og kendskab til OData er derfor en fordel, hvis man ønsker hændelsesbeskeder distribueret med PUSH.

Læs mere om PUSH af hændelser








Filtrering (valgfrit)


FELTER I OPSÆTNINGEN

  • Filtrering

    Filtre er opbygget af betingelser, som består af et felt, en operator og en værdi. 

    Det er ikke nødvendigt at opsætte filtre. Ønsker du ikke at benytte dig af muligheden tryk NÆSTE.

    Ønsker du dig at opsætte filtre vælg "Tilføj Betingelse"



Betingelser

Filtre er opbygget af betingelser, som består af et felt, en operator og en betingelses værdi. 

Det er ikke nødvendigt at opsætte filtre. Ønsker du ikke at benytte dig af muligheden tryk NÆSTE.

Ønsker du dig at opsætte filtre vælg "Tilføj Betingelse"

Til toppen

Felt

Felt henviser til et felt i en betingelse, som kan kombineres med en operator og en værdi. 

I de registerspecifikke hændelseskataloger kan du for hver enkelt beskedtype se hvordan felterne skal udfyldes ved dannelse af en datanær hændelse.

Læs mere om datanære hændelser.

Find den registerspecifikke dokumentation via Dataoversigten på Datafordeler.dk.

FELTER I BETINGELSERNE

  • Beskedtype
  • BeskedansvarligAktør
  • TværgåendeProces
  • ObjektID
  • ObjektType
  • Registreringsaktør
  • Registreringstid
  • Status
  • RegistreringsID
  • Objekthandling
  • OpgaveEmne
  • RelateretObjektID
  • RelateretObjekttype



Operator

Operator angiver sammenhængen mellem det valgte feltnavn og værdien i betingelsen.

Bemærk, at operatoren INDEHOLDER kun kan benyttes til feltet Objekthandling, hvis indhold i den forbindelse fortolkes som en liste.

Med operatorerne I og IKKE I er det muligt at angive en kommasepareret liste som værdi. 


OPERATORER I BETINGELSERNE

  • = (Lig med)
  • <> (Ikke lig med)
  • < (Mindre end)
  • <= (Mindre end eller lig med)
  • > (Større end)
  • >= (Større end eller lig med)
  • I
  • IKKE I
  • INDEHOLDER



Betingelses værdi

I de registerspecifikke hændelseskataloger kan du for hver enkelt beskedtype se hvordan værdierne skal udfyldes ved dannelse af en datanær hændelse. Tabellerne i dokumentationen er udfyldt ud fra de specifikationer, der danner grundlag for konfigurationen af de datanære hændelser. Find den registerspecifikke dokumentation via Dataoversigten på Datafordeler.dk.

Til følgende felter i betingelserne knytter sig særlige bemærkninger;

    • Beskedtype
      Undlad at filtrere på feltet beskedtype, da denne parameter allerede er angivet

    • Beskedansvarligaktør
      Undlad at filtrere på feltet beskedansvarligaktør, da der altid kun vil være en valgmulighed

    • Objekthandling
      For feltet Objekthandling er det som noget specielt muligt at filtrere på, om det indeholder et bestemt ord. Hvis Objekthandling benyttes af registeret til at angive en liste med navne på ændrede felter, kan en anvender således opsætte et filter til kun at modtage hændelser, der omhandler ændringer i et bestemt felt.

      Det er alene registeret, der bestemmer, hvorledes Objekthandling udfyldes, og der henvises derfor til den registerspecifikke dokumentation af hændelser for en beskrivelse af, hvordan felter i hændelsesbeskederne udfyldes ved dannelse af datanære hændelser på Datafordeleren.

      Feltet Objekthandling kan være udfyldt med en tekststreng af formen value1;value2;…;valueN, der fortolkes som en liste af værdier adskilt med semikolon. Ved hjælp af operatoren INDEHOLDER kan du opstille en betingelse, om at denne liste af værdier i Objekthandling indeholder en bestemt værdi. Fx vil betingelsen ([Objekthandling] INDEHOLDER ’Postnummer’) evaluere til sand, når Objekthandling er udfyldt med ”By;Postnummer;Vejnavn”.

HJÆLP TIL AT AFLÆSE DE REGISTERSPECIFIKKE HÆNDELSESKATALOGER

De registerspecifikke hændelseskataloger er knyttet til de specifikationer, som registret har specificeret i deres Dataleverancespecifikation (DLS). 

I nedenstående kan du se efter hvilke retningslinjer skemaerne i de registerspecifikke hændelseskataloger er udfyldt.

  • N/A
    Er feltet udfyldt med N/A betyder det, at feltet ikke benyttes.
  • Constant(...)
    Er feltet udfyldt med Constant betyder det, at feltet i hændelsesbeskeden altid vil være udfyldt med den viste værdi.
  • Load(...)
    Er feltet udfyldt med Load betyder det, at feltet i hændelsesbeskeden vil være udfyldt med værdien fra opdateringen. 
    Henviser til udstillingsmodellen.
  • Publish(...)
    Er feltet udfyldt med Publish betyder det, at feltet i hændelsesbeskeden vil være udfyldt med værdi fra opdateringen/databasen.
    Henviser til udstillingsmodellen.



Eksempel på opsætning af en betingelse

Et eksempel for et abonnement på en opsætning for hændelsen JordstykkeCreate. Filtrering ved, at objekthandlingen skal indeholde SAMLETFASTEJENDOMLOKALID.

I opsætningen angives værdien som ren tekst. I filter-feltet ses, at systemet automatisk tilføjer ’ ’ omkring SAMLETFASTEJENDOMLOKALID i forespørgslen.

Til toppen



Grupper

Et filter kan indeholde en eller flere betingelser. 

Den valgte betingelse eller rækken af betingelser kan endvidere grupperes og kombineres med andre grupper med de logiske operatorer OG og ELLER.







Geografisk afgrænsning (valgfrit)

Til toppen

Det er muligt at afgrænse de hændelsesbeskeder du ønsker at modtage til et bestemt geografisk område.

Du kan vælge mellem 3 forskellige typer geografiske afgrænsninger; bounding box, punkt/radius og DAGI inddeling.


Bounding box

Du kan zoome ind og ud med musen, hvis du holder shift nede, eller benytte ikonerne med + og - i venstre hjørne.

Klik det sted på kortet, hvor du vil placere et hjørne af din afgrænsning.  Herefter er det muligt at trække i punktet, som bliver en Bounding BOX. Når du har fundet det ønskede udsnit klikker du igen, og boxen markeres med rød, og koordinaterne for kortudsnittet bliver automatisk angivet i felterne.





Punkt/radius

Du kan zoome ind og ud med musen, hvis du holder shift nede, eller benytte ikonerne med + og - i venstre hjørne.

Klik det sted på kortet, hvor du vil placere centrum af din afgrænsning. Herefter er det muligt at trække i punktet, som bliver radius på cirklen. Når du har fundet det ønskede udsnit klikker du igen, og cirklen markeres med rød, og koordinaterne for kortudsnittet bliver automatisk angivet i felterne.





DAGI inddeling

Vælger du DAGI inddeling tager det lidt tid at indlæse siden. Når siden er indlæst vises der markering af kommunerne.

I drop down menuen vælger du den kommune, som du ønsker at benytte til at afgrænse dit hændelsesabonnement.








Gennemse oplysninger, og bekræft abonnement

Til toppen

Når du har valgt oplysninger, levering, filtrering og geografisk afgrænsning, skal du gennemse dine valgte oplysninger. Herefter kan du klikke på Opret, for at oprette dit abonnement, eller gå tilbage for at redigere i dine valg til abonnementet.





Når du har valgt Opret, får du en bekræftelse på at dit abonnement er under udarbejdelse. 


Herefter kan dit abonnement findes under Dine hændelser på din kontoside. Her har du mulighed for at gøre dit abonnement inaktiv/aktiv, redigere filter, geografisk afgrænsning eller slette dit abonnement igen.





Få en oversigt over oprettede hændelsesabonnementer

Du kan på din kontoside under menupunktet Mine hændelser få et overblik over de abonnementer på hændelser, som du har oprettet.

I feltet "Vis alle" kan du vælge mellem de tjenestebruger, som du har tilknyttet den webbruger, som du er logget på med. 

Når du har valgt en specifik tjenestebruger i dropdown listen, vises kun abonnementer for den specifikke tjenestebruger. 

Til toppen



ABONNEMENTSDETALJER

  • Navn
    Her vises det navn, som du har valgt til abonnementet
  • Tjenestebruger identifikation
    Den tjenestebruger, som tegner abonnementet
  • Hændelse (Beskedtype visningsnavn)
    Her vises visningsnavnet for beskedtypen
  • Logisk datamodel klassemodel
    Her vises navnet på det objekt i registeret, som beskedtypen omhandler. Dette er kaldet "Logisk entitet" i oversigten over abonnementer
  • Aktiv
    Angiver om abonnementet er aktivt eller ej
  • Filtre
    Her angives de filtre, som eventuelt er opsat til abonnementet

Ikke alle detaljer vises i oversigten for et hændelsesabonnement. Hvis der er et filter eller en geografisk udstrækning, kan de først ses, når man har klikke på enten Rediger filter eller Rediger geografisk afgrænsning.

Du har også mulighed for at slette dit abonnement her, ved at klikke på Slet.