Dokumenthistorik

Referencer

Indholdsfortegnelse
1 Introduktion
1.1 Begreber
2 Fildownloads
2.1 Typer af fildownloads
2.2 Filformater
2.3 Udtræksnumre
2.3.1 Sammenhæng mellem total- og deltaudtræk
2.3.2 Spring i udtræksnumre
2.4 Navngivning af fildownloads
2.5 Skema for generering af fildownloads
2.6 Sådan hentes fildownloads
2.6.1 Metode: GetAvailableFiledownloads
2.6.2 Metode: GetFile
3 Transition fra filudtræk til fildownloads
3.1 Indhold i filer
3.1.1 Sammenligning mellem nuværende og moderne GML og Geopackage filer
3.2 Geografisk filtrering i fildownloads
3.3 Eksempel på transition hos en anvender
3.3.1 Situationsbeskrivelse
3.3.2 Transition
3.4 Eksempel på anden transition hos anvender
3.4.1 Situationsbeskrivelse
3.4.2 Transition
4 Bilag 1 - FAQ
5 Bilag 2 – Overførsel af filudtræk til fildownloads

Introduktion

Dette dokument er en guide i anvendernes transition fra de abonnementsbaserede filudtræk over til entitetsbaserede fildownloads.
Dokumentet er opdelt i to dele:

1. Første del af dokumentet beskriver hvad fildownloads er, samt hvordan funktionaliteten anvendes.
2. Anden del af dokumentet forklarer forskelle, samt hvordan anvendere i forskellige situationer kan komme i gang med at anvende fildownloads.

Dokumentet er tiltænkt følgende læsere:

1. Eksisterende anvendere af Datafordeleren der henter filudtræk på Datafordeleren, som ønsker at komme i gang med at bruge fildownloads i stedet for.
2. Nye anvendere, der vil i gang med at bruge fildownloads på Datafordeleren.

Begreber

I dette dokument bruges begreberne i Tabel 1. Bemærk at begreberne også er yderligere forklaret i løbet af dokumentet med eksempler.

Tabel 1: Begrebsliste.

Fildownloads

Fildownloads er en funktionalitet på Datafordeleren til udstilling af data, men skal ikke misforstås som værende det samme som de abonnementsbaserede filudtræk, der også er på Datafordeleren. Fildownloads tilbydes som prædefinerede entitetsbaserede fildownloads og baserer sig på de datamodeller som registrene har på Datafordeleren.
En entitet svarer til en tabel i Grunddatamodellen som er defineret i registrenes datamodel: https://grunddatamodel.datafordeler.dk/. En entitet kan eksempelvis være en "Adresse" fra DAR, en "Bygning" fra BBR eller et "Jordstykke" fra MAT. Det at fildownloads er entitetsbaserede betyder at et fildownload indeholder data for en enkelt type af entitet. Der leveres entitetsbaserede fildownloads på tabulære data og ikke for rasterdata (billeddata). Tabulære data forstås som strukturerede data der kan opbevares i tabeller som f.eks. adresser men ikke billedtyper som skærmkort.
Fildownloads genereres løbende i bestemte intervaller for en række registre, hvorefter filerne kan hentes gennem et REST-API, der udstiller de genererede fildownloads. Det eneste krav til at hente fildownloads er, at man har en tjenestebruger med brugernavn og adgangskode. Fildownloads bruger ikke abonnementer, da de allerede ligger klar til at blive hentet. REST-API'et beskrives nærmere i afsnit 2.6, mens skema for generering samt frekvenser for generering beskrives nærmere i afsnit 2.5.

Figur 1: Opsummering af fildownloads-funktionaliteten.
En opsummering hvad fildownloads består af, kan ses i Figur 1. Figuren viser 3 registre:

• Register A, som har 5 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret og har også en enkelt reference til en entitet i register C udenfor registeret.
• Register B, som har 6 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret og har også en enkelt reference til en entitet i register A udenfor registeret.
• Register C, som har 6 entiteter. Registerets entiteter refererer til hinanden indbyrdes indenfor registeret.

Registrenes entiteter har alle fildownloads, som både består af totaludtræk og deltaudtræk. Det skal her bemærkes at Register C har fravalgt at der bliver genereret fildownloads for deres entitet nr. 5 og 6 i dette eksempel.

Typer af fildownloads

Datafordeleren udstiller flere typer af entitetsbaserede fildownloads. Der findes 2 typer af fildownloads, nemlig totaldownloads og deltadownloads. Datafordeleren opbevarer ét totaldownload pr. type pr. entitet, mens der opbevares deltaudtræk 14 dage fra de blev genereret.
Hvis der genereres fildownloads for en entitet, bliver der altid genereret både totaldownloads og deltadownloads. Udover at der findes flere typer af fildownloads, findes der også flere typer af filtreringer på den data som de genererede fildownloads indeholder. Dette skyldes at delmængder af data på Datafordeleren er bitemporal og at der dermed kan være flere forekomster af det samme objekt over tid i to tidsdimensioner https://confluence.sdfi.dk/display/DML/Grunddata+-+bitemporalitet.

• Fuldt bitemporalt fildownload: Et fuldt bitemporalt fildownload inkluderer alt, hvad angår både registreringstid og virkningstid.
• Temporalt fildownload: Et temporalt fildownload filtrerer registreringsdimensionen fra, men beholder virkningsdimensionen.
• Fildownload med aktuelle data: Både registreringstiden og virkningstiden er sat til at være på det pågældende tidspunkt fildownload blev lavet.

Det er muligt at kombinere en type fildownload med en type af bitemporal filtrering og filformat. En opsummering af, hvilke fildownloads der eksisterer kan ses i Tabel 2.

Tabel 2: Oversigt over understøttede typer af fildownloads på Datafordeleren.

Filformater

Tabel 3 nedenfor viser, hvilke registre der har fildownloads på deres entiteter, samt hvilke filformater der er tilgængelige for registrenes entiteter. Et kryds i en række i tabellen indikerer at filformatet generelt er understøttet for det givne registers entiteter.

Tabel 3: Oversigt over understøttede filformater per register.
Det skal bemærkes det ikke er alle entiteter for et register der har fildownloads i GPKG og GML-format, selvom dette er indikeret i Tabel 3. Der skal gøre sig følgende gældende for at en entitet understøttes i GPKG eller GML-format:

• GPKG-formatet understøttes på en entitet hvis entiteten indeholder 0 eller 1 geometrier.
• GML-formatet understøttes på en entitet hvis entiteten indeholder minimum 1 geometri.

Udtræksnumre

Udtræksnumre er en fortløbende talrække der beskriver tidsmæssig sammenhæng mellem data i et register. Hver gang der genereres fildownloads for et register, påsættes alle fildownloads ved samme generering det samme udtræksnummer. Dette bevirker at fildownloads med det samme udtræksnummer indeholder konsistente data indenfor registerets egen data. Denne egenskab er særlig relevant hvis man som anvender er interesseret i at sammensætte data fra flere entiteter i et register.
Det er her vigtigt at understrege, at udtræksnumrene kun er fortløbende per register, og at hvert register derfor har sin egen fortløbende talrække, der er uafhængig af andre registre. Udtræksnumre kan derfor ikke garantere referentiel integritet på tværs af registrenes data, da dette afhænger af registrenes indlæsningstidspunkter, samt indlæsningsfrekvens.

Sammenhæng mellem total- og deltaudtræk

Det er muligt at vedligeholde en lokal kopi af registrenes data som findes på Datafordeleren ved at hente totaludtræk – og herefter løbende hente deltaudtræk.
Kopien etableres først lokalt, ved at hente et totaldownload for den/de entiteter der er interesse for. Idet totaludtrækket hentes, skal det bemærkes hvilket udtræksnummer totaludtrækket har, da udtræksnummeret skal bruges til at identificere hvilke deltaudtræk der er relevante at hente, for at opdatere den initiale kopi af data. Et totaldownload og deltadownload med det samme udtræksnummer indeholder data fra samme generation. Dette betyder at deltaudtræk med samme udtræksnummer som et totaludtræk indeholder dermed ingen data som ikke også er indeholdt i totaludtrækket. Det udtræksnummer der skal bruges til at opdatere kopien af data, er dermed det næste udtræksnummer i talrækken.
Et eksempel på dette kan ses i Figur 2, som viser en række genererede deltaudtræk, samt et genereret totaludtræk. Hver generering har resulteret i, at der enten er blevet genereret et deltaudtræk og/eller et totaludtræk. Det kan ses på figuren, at der eksisterer både et totaludtræk, samt et deltaudtræk med udtræksnummeret 3. Såfremt det ønskes at etablere en kopi af data fra entiteten, kan totaludtrækket med udtræksnummeret 3 først hentes – og så herefter hente deltaudtrækkene med udtræksnummer 4, 5 og 6 for at vedligeholde datakopien. Det er således ikke nødvendigt at hente deltaudtrækket med udtræksnummer 3, da deltaudtrækket blev genereret på samme tid som totaludtrækket.
\\
!worddavd8967592534deed3ce828b17892164eb.png|height=465,width=576!
<ac:structured-macro ac:name="anchor" ac:schema-version="1" ac:macro-id="89425dfc-788f-4f7c-bee1-003ac81a467e"><ac:parameter ac:name="">_Ref166500737</ac:parameter></ac:structured-macro>Figur 2: Overblik over hvordan udtræksnumre hænger sammen mellem total- og deltaudtræk.
Yderligere detaljer og eksempelscenarier kan findes i *\[Kopiregister Guide\]{*}.

Spring i udtræksnumre

Der kan i sjældne tilfælde forekomme et spring i udtræksnumre. Dette skyldes, at der eksisterer et nyere udtræksnummer for det pågældende register, og at generering af fildownloads, derfor, vil bruge det nyere udtræksnummer for at sikre konsistente data inden for registeret.
Processen for indhentning af deltaudtræk bør, på baggrund af ovenstående, følge følgende logik:

1. Tjek hvilket udtræksnummer der er påsat senest indhentede deltaudtræk.
2. Indhent deltaudtræk med udtræksnumre der er større end det sidst indhentede deltaudtræks udtræksnummer.
   1. Dette sikrer at alle nyere deltaudtræk altid hentes uden at der springes nogle over, selvom der sker spring i udtræksnummeret på deltaudtrækkene.

Navngivning af fildownloads

De fildownloads der genereres på Datafordeleren følger alle en navnestandard, der hjælper med at beskrive hvad indholdet af filen er. Navnestandarden ser ud som set på Figur 3.

Figur 3: Overblik over navnestandard på fildownloads.
Et fildownload som følger navnestandarden kan derfor eksempelvis have navn som følgende:

1. DAR_1_Adresse_TotalDownload_JSON_Bitemporal_10.zip
2. DAR_1_Adresse_DeltaDownload_JSON_Bitemporal_11.zip
3. BBR_1_Bygning_TotalDownload_JSON_Temporal_123.zip
4. MAT_1_Lodflade_TotalDownload_GPKG_Current_7.zip
5. DAGI_1_Kommuneinddeling_TotalDownload_GML_Current_42.zip

Man kan ud fra navngivningen af ovenstående fildownloads udlede følgende:

1. Fildownload nr. 1 indeholder et fuldt bitemporalt totaludtræk af Adresse-entiteten som ligger i DAR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Filen har generationsnummer 10.

1. Fildownload nr. 2 indeholder et fuldt bitemporalt deltaudtræk af Adresse-entiteten som ligger i DAR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Deltafilen har generationsnummer 11 og ville derfor indeholde alle ændringer der var sket for Adresse-entiteten siden generationsnummer 10. Denne deltafil ville derfor kunne bruges til at opdatere en datakopi der havde indlæst fildownload nr. 1, som har generationsnummer 10.

1. Fildownload nr. 3 indeholder et temporalt totaludtræk af Bygning-entiteten som ligger i BBR. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en JSON-fil. Filen har generationsnummer 123.

1. Fildownload nr. 4 indeholder et totaludtræk med aktuelle data af Lodflade-entiteten som ligger i MAT. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en GPKG-fil. Filen har generationsnummer 7.

1. Fildownload nr. 5 indeholder et totaludtræk med aktuelle data af Kommuneinddeling-entiteten som ligger i DAGI. Filen der downloades er en ZIP-fil, men ZIP-filen indeholder en GML-fil. Filen har generationsnummer 42.

Skema for generering af fildownloads

Skemaet i Tabel 3 viser, hvornår der genereres fildownloads for registrene på Datafordeleren. Bemærk at et register kan have frabedt sig, at få genereret fildownloads for bestemte entiteter i deres datamodel og vil således ikke blive genereret efter skemaet.

Tabel 4: Oversigt over hvornår fildownloads bliver genereret.
Såfremt der genereres et deltaudtræk, men at der ikke er sket nogle dataændringer siden sidste gang der blev genereret et deltaudtræk for en pågældende entitet, vil deltaudtrækket være tomt. Hvis der genereres et totaludtræk uden at der er sket dataændringer siden sidste gang, det blev genereret, vil det nye totaludtræk i JSON-, GML- eller GPKG-format have et ældre generationsnummer i sit filnavn end den zip-fil den er indeholdt i.
Eksempelvis er det muligt at hente en fil med følgende navn:

• DAR_1_Adresse_Total_JSON_Bitemporal_10.zip

Her er udtræksnummeret på ZIP-filen 10, men ZIP-filen kan godt indeholde en JSON-fil med følgende navn:

• DAR_1_Adresse_Total_JSON_Bitemporal_9.json

JSON-filen har et lavere udtræksnummer end ZIP-filen, da der ikke er sket nogen ændringer i data siden sidste totaludtræk blev genereret for Adresse-entiteten. Såfremt der heller ikke sker nogen ændringer i Adresse-entiteten inden næste generering, vil ZIP-filen få udtræksnummer 11, mens den indeholdte JSON-fil stadig vil have udtræksnummer 9.

Sådan hentes fildownloads

Fildownloads på Datafordeleren tilgås via et REST-API. Dette afsnit beskriver, hvordan det vil være muligt at danne et overblik over hvilke fildownloads der kan hentes, samt hvorledes relevante fildownloads herefter hentes. REST-API'et indeholder to metoder som kan kaldes. REST-API'et kræver at man først har oprettet en tjenestebruger med brugernavn og password.

Figur 4: Overblik over samlet anvendelsesmønster for fildownloads.
Figur 4 viser hvordan REST-API'et overordnet set anvendes. Her kaldes metoden "GetAvailableFileDownloads" først for at danne et overblik over mulige filer der er tilgængelige, hvorefter relevante filer hentes, ved at kalde metoden "GetFile".

Metode: GetAvailableFiledownloads

Parametre

Returværdier

Metoden returnerer metadata om fildownloads, der følger strukturen beskrevet i Tabel 4.

Tabel 5: Overblik over returværdier for GetAvailableFiledownloads metoden.

Eksempler på brug af metoden

Se tilgængelige fildownloads for DAGI:

Se tilgængelige fildownloads for "Bygning"-entiteten

Se tilgængelige fildownloads i version 1 i EBR:

Metode: GetFile

Parametre

Returværdier

Denne metode returnerer altid en eller flere filer ved HTTP 200 - OK.

Eksempler på brug af metoden

Hent en specifik deltafil fra Danske Stednavne registeret:

Kaldet returnerer en enkelt fil i en ZIP-fil.
Hent alle totaludtræk fra BBR i JSON-format:

Kaldet returnerer flere filer i en samlet ZIP-fil.
Hent totaludtræk med aktuelle data i GML-format for en bestemt entitet i Fikspunkt-registeret:

Kaldet returnerer en enkelt fil i en ZIP-fil.

Transition fra filudtræk til fildownloads

Dette afsnit beskriver forskelle mellem abonnementsbaserede filudtræk og prædefinerede entitetsbaserede fildownloads, samt hvordan man som anvender af filudtræk, kan komme i gang med at bruge entitetsbaserede fildownloads i stedet for. Det skal bemærkes at filudtræk og fildownloads driftes parallelt i en periode, så anvendere af Datafordeleren har mulighed for at skifte til fildownloads.
Følgende er blevet observeret for filudtræk, som har dannet grundlaget for målene med den Moderniserede Datafordelers fildownloads:

• Specificeret enkeltvist af registrene i Dataleverancespecifikationen (DLS https://confluence.sdfi.dk/display/DML/DLS-udstilling). Specificeringen er fordelt over potentielt mange dokumenter og er omkostningsfulde og tager lang tid at implementere og vedligeholde på længere sigt.
• Implementeringen af filudtrækkene sker altid manuelt.
• Der er fundet uhensigtsmæssige designvalg i filudtræk, som har medført potentielt datatab og inkonsistens i data.

Moderniseringen introducerer fildownloads, som har følgende egenskaber:

• Det er ikke nødvendigt at oprette abonnement på fildownloads. Filer bliver genereret løbende og ligger klar til download når der er behov for det.
• Der er fildownloads for alle entiteter i et register, såfremt registeret ikke har fravalgt at de genereres.
• Fildownloads specificeres ikke længere manuelt i DLS'en, men genereres automatisk ud fra den datamodel som registeret afleverer til Datafordeleren.
• Datakonsistens er sikret indenfor registrene selv og sikrer referentiel integritet for at modvirke datatab og inkonsistens i data.

Indhold i filer

Totaludtræk på den Nuværende Datafordeler indeholder normalt hele registerets data, hvor alle registerets entiteter blev fordelt i lister og derefter samlet i én samlet fil. Dette kan ses i venstre side i Figur 5, som indeholder 4 lister med entiteter i. Den Moderniserede Datafordeler tager disse lister der hver især indeholder en entitet og opdeler så disse i hver deres filer i stedet for. Dette kan ses i højre side i Figur 5. Det er altså det samme data der udstilles i filerne sammenlagt, men hvor forskellen er at fildownloads hver især indeholder en delmængde af det samlede registers datasæt.

Figur 5: Sammenligning af data i filudtræk og fildownloads.
Den Moderniserede Datafordeler udstiller på denne måde den samme data i fildownloads, som bliver udstillet i filudtræk på den Nuværende Datafordeler, dog med den ændring, at filerne er opdelt per entitet.

Figur 6: Sammenligning af data i filudtræk og fildownloads.
Da fildownloads bliver genereret på entitetsniveau, betyder det også at hele entiteten udstilles, og at der ikke filtreres felter fra i det udstillede data, da dette er det samme som det der indlæses på Datafordeleren. Hvis man som anvender gerne vil vide præcis hvilke felter der eksisterer i fildownloads for en given entitet, skal man konsultere registrenes Dataleverancespecifikation (DLS), der i dens Bilag 3 (navn på det bilag skal stå her) beskriver hvilke felter hvert registers entiteter består af.

Sammenligning mellem nuværende og moderne GML og Geopackage filer

Dette afsnit er under udarbejdelse ifm. Story 537: Functional scenarios 537: Udvidet sammenligning af eksisterende og moderne GML og geopackage filer til inklusion af transitionsguiden.

Geografisk filtrering i fildownloads

Følgende afsnit beskriver, hvordan man, som anvender, kan postprocessere fildownloads på forskellige geografiske egenskaber. Man kan lave geografisk filtrering på registerdata ved at filtrere på de egenskaber der ses i Tabel 5. For data, som kan filtreres geografisk, gælder det, at et datapunkt er associeret med:

• En afledt geografisk identifikator, e.g. kommunekode. Et datapunkt kan filtreres på baggrund af denne kode.
• En geometri, i.e. en polygon med EPSG referencekode. Polygonen kan sammenlignes med en referencegeometri, e.g. en kommune, og på baggrund af det geometriske overlap kan datapunktet filtreres.

Såfremt et datapunkt ikke har en reference til nogen af ovennævnte, kan det være tilfældet at datapunktet har en reference til en entitet der er associeret med enten en geometrisk identifikator eller geometri. Det er derfor ikke altid muligt direkte at foretage geografisk filtrering på en entitet uden først at behæfte entiteten med en geografisk identifikator først. Bemærk også at tabellen kun dækker de registre der har fildownloads. Der er i moderniseringens Udviklingsleverance 1 ikke implementeret generisk geografisk filtrering på fildownloads, idet det ville kræve, at Datafordeleren gør sig adskillige antagelser om, hvordan data anvendes i den anden ende. Såfremt disse antagelser ikke stemmer overens med den faktuelle brug, kan Datafordeleren fejlagtigt lave geografiske filtreringer, der er anderledes end anvenderens faktiske antagelse.

Tabel 6: Overblik over hvilke geografiske egenskaber der skal filtreres på for forskellige registre.

Eksempel på transition hos en anvender

Dette afsnit giver et eksempel på, hvordan en eksisterende anvender på Datafordeleren kan overgå fra at bruge filudtræk i sit system til at bruge fildownloads. Afsnittet påbegyndes med en situationsbeskrivelse efterfulgt af konkrete trin der beskriver transitionen.

Situationsbeskrivelse

Dette eksempel antager at en anvender allerede har etableret en kopi af DAR og skal i gang med at bruge fildownloads.
Anvenderen har først etableret sin datakopi af DAR ved at opsætte et abonnement på et brugerdefineret totaludtræk fra DAR med følgende parametre:

• SincePrevious = True
• RegistreringFra = 2021-03-01
• VirkningFra = 2021-03-01
• Format = JSON
• Dagligt udtræk

Anvenderen henter filudtræk fra Datafordeleren via sin SSH2-tjenestebruger dagligt og indlæser deltafilen i sin datakopi.

Transition

For at anvenderen kan komme i gang med at bruge fildownloads, skal anvenderen beslutte om:

1. Anvenderen ønsker at etablere en ny datakopi med fildownloads.
2. Anvenderen ønsker at indlæse data oveni en eksisterende datakopi med fildownloads.

Anvenderen gør herefter følgende

1. Anvenderen opretter en tjenestebruger med brugernavn og password på selvbetjeningen.
2. Anvenderen kalder metoden GetAvailableFiledownloads med sin nye tjenestebruger som følger:
   1. https://api.datafordeler.dk/FileDownloads/GetAvailableFileDownloads?Register=DAR&username=username&password=password
3. Da anvender nu ved, hvilke fildownloads der eksisterer, kalder anvender metoden GetFile, for at hente totaludtræk for alle entiteter i DAR:
   1. https://api.datafordeler.dk/FileDownloads/GetFile?Register=DAR&username=username&password=password
4. Anvender er nu i besiddelse af et totaludtræk i DAR. Anvenderen kan nu vælge at sammensætte alle filerne til én stor fil og postprocessere denne, eller postprocessere filerne enkeltvis. Postprocesseringen filtrerer data fra, der har RegistreringFra og VirkningFra ældre end 2021-03-01.
5. Hvis anvenderen valgte mulighed A), skal anvenderen etablere sin lokale datakopi ved at indlæse data fra filerne. I dette eksempel har totaludtrækket fra DAR udtræksnummer 14.
   1. Hvis anvenderen valgte mulighed B) i stedet, skal anvender finde forskellen mellem sin lokale datakopi og den data der findes i totaludtrækket fra DAR som anvenderen netop har hentet.
6. Anvender sætter herefter en vedligeholdelse op af sin datakopi. Vedligeholdelsen består i at hente deltaudtræk ind fra DAR, som genereres dagligt. Anvenderen bemærker, at totaludtrækket har udtræksnummer 14, hvilket betyder at anvenderen skal hente deltaudtræk fra DAR med udtræksnummer 15 og højere for at sørge for at datakopien holdes opdateret. Anvenderen kalder igen GetAvailableFiledownloads for at se, hvilke deltafiler der findes for DAR.
   1. https://api.datafordeler.dk/FileDownloads/GetAvailableFileDownloads?Register=DAR&username=username&password=password
7. Anvenderen ser at der findes deltaudtræk for samtlige entiteter i DAR med udtræksnumrene 15 og 16. Anvenderen ved derfor, at det vil være nødvendigt at hente alle deltaudtræk for alle entiteter i DAR med de ovenstående udtræksnumre. Dette gør anvenderen ved at kalde GetFile for alle entiteterne i DAR med både udtræksnumre 15 og 16:
   1. https://api.datafordeler.dk/FileDownloads/GetFile?Filename=filename&username=username&password=password
8. Anvenderen holder løbende øje med genereringen af DAR deltaudtræk der genereres hver dag og sørger for at hente disse og indlæse dem i deres lokale datakopi.
9. Anvenderen har nu sat sit system op til at bruge fildownloads.

Figur 7: Opsummering af transitionsskridt for en anvender.
Transitionen i ovenstående skridt er opsummeret i Figur 7.

Eksempel på anden transition hos anvender

Dette eksempel tager udgangspunkt i en anvender som allerede har etableret en kopi af BBR, som skal i gang med at bruge fildownloads.

Situationsbeskrivelse

I dette eksempel henter anvenderen daglige totaludtræk hvor registreringshistorikken ikke er nødvendig, og derfor filtreres fra. Anvenderen har sat følgende abonnement op:

• SincePrevious = False
• RegistreringFra = NOW()
• Format = JSON
• Dagligt udtræk

Anvenderen bruger en tjenestebruger med brugernavn og password til at tilgå filudtræk.

Transition

1. Anvenderen kalder metoden GetAvailableFiledownloads med sin eksisterende tjenestebruger som følger:
   1. https://api.datafordeler.dk/FileDownloads/GetAvailableFileDownloads?Register=BBR&username=username&password=password
2. Da anvender nu ved hvilke fildownloads der eksisterer, kalder anvender nu metoden GetFile for at hente totaludtræk for alle entiteter i BBR:
   1. https://api.datafordeler.dk/FileDownloads/GetFile?Register=BBR&username=username&password=password
3. Anvender er nu i besiddelse af et totaludtræk af BBR, heriblandt et totaludtræk med temporale data, dvs. registreringshistorikken er filtreret fra. Anvenderen kan nu vælge at sammensætte alle filerne til én stor fil og postprocessere denne, eller postprocessere filerne enkeltvis.
4. Anvenderen etablerer herefter den samme vedligeholdelsesproces som blev beskrevet i afsnit 3.3.2. Da anvenderen her ikke er interesseret i registreringshistorikken, skal anvender dog huske at postprocessere deltaudtrækkene og filtrere denne historik fra, inden den data indlæses oveni den lokale datakopi.

Bilag 1 - FAQ

1. Er min IP-adresse stadig godkendt?
   1. Ja det er den.
2. Hvilken zone udstilles fildownloads i?
   1. Fildownloads udstilles i zone 0.
3. Hvilken type bruger skal jeg bruge for at hente fildownloads?
   1. En tjenestebruger med brugernavn og password er påkrævet for at tilgå fildownloads.
4. Hvordan hentes fildownloads?
   1. Dette sker ved at kalde REST-API'et der udstiller fildownloads. Se afsnit 2.6 for en uddybende beskrivelse.
5. Hvilke tidspunkter bliver fildownloads genereret?
   1. Dette sker som udgangspunkt mellem kl. 3 og 6 om natten. Se skemaet i afsnit 2.5 der giver et overblik over hvornår der genereres fildownloads for hvert register.
6. Er der fildownloads for alle registre?
   1. Nej, det er der ikke. Det er kun de registre som står anført i Tabel 2 som får fildownloads i de filformater der står angivet i tabellen.
7. Skal jeg, som register, foretage mig noget for at få fildownloads på mine data?
   1. Som register kræves det at JSON-filen "Automated_Predefined_Filedownloads.json" er udfyldt korrekt i DLS'en.

Bilag 2 – Overførsel af filudtræk til fildownloads