Indhold
Introduktion
Formål
Denne guide har som formål at give et overblik over Batchmotoren.
Beskrivelse
Batchmotoren anvendes til oprettelse af rekvisitioner og afsendelse af breve på baggrund af modtagne lister med CPR numre. De leverede lister med CPR numre indeholder også et ark med kontrol data som styrer håndteringen i batchmotoren.
Læsevejledning og forudsætninger
Dette dokument er henvendt til SSI ansatte der skal levere lister med CPR numre til Batchmotoren.
Sikkerhed
| Service udstil type | CPR batches leveres i SFTP foldere |
| Krævede adgange | Adgang til en konfigureret SFTP folder |
| Whitelisting | - |
| Krævet sikkerhedsniveau | - |
| Forudsætninger for anvendelse | - |
| Logning | Det logges når et CPR batch modtages |
Definitioner og referencer
Reference | Beskrivelse |
|---|---|
| NSP | Den nationale service platform |
| SFTP | Secure File Transfer Protocol |
Dokument historik
Dato | Ansvarlig | Beskrivelse |
|---|---|---|
| 23/07-2020 | Mikael Jørgensen | Initiel version |
| 31/8 - 2020 | Mads Haargaard | v3.0 template |
| 26/11-2020 | Jannik Steen | Tidligere flyttet fra COVID19 space. Tilføjet afsnit om versionering af templates. Oprydning. |
Adgang, brug og snitflader
Adgang
| Tilgængelig | NSP SFTP server |
| Endpoint(s) | Hver bruger der leverer CPR batches har fået udleveret adgang til deres personlige SFTP folder hvori CPR batches skal afleveres Der udstilles en enkelt SFTP folder til vedligehold af brev skabeloner. Der udstilles en enkelt SFTP folder til levering af dagligt opdateret statistik suno: |
Snitfladebeskrivelse og brug
CPR Batch
CPR batches leveres i en af nedenstående templates. Der findes i øjeblikket 2 typer af den gældende template. Én for regioner og én for alt andet. Der bør så vidt muligt anvendes nyeste version af disse templates, da det understøtter de eksisterende behov. Begge typer af templates indeholder kontrol information på 1. ark og listen af CPR numre der skal behandles på 2. ark. Et CPR batch leveres ved at anvender lægger CPR batches som en .xlsx fil i den tildelte SFTP folder, hvorefter den inden for få sekunder vil blive hentet og slettet af Batchmotoren. Repository for templates er: https://dksund.sharepoint.com/sites/covid19-testkapacitet, hvor alle versioner findes.
Versionering af templates
Det er nødvendigt, at styre versioneringen af templates efter en aftalt standard. Angivelsen af version på template-filer er på følgende format: x.y.z, hvor x,y og z repræsenterer et ciffer. Et eksempel på navnet for en template-fil er SSI_Indberetning_Template_4.0.0.xltx. Betydningen af cifre kan aflæses i følgende tabel:
| Ciffer position | Beskrivelse |
|---|---|
| x | Dette kaldes major version. Når der foretages ændringer i en template på 1. ark ('Batch information'), i kontrol information, eller ændring af strukturel karakter skal denne position øges med én. I det tilfælde nulstilles position y og z. |
| y | Dette kaldes minor version. Når der foretages ændringer i andre ark end 1. ark, f.eks. ændring til batch-typer, skal denne position øges med én. |
z | Dette kaldes micro version. Når der foretages kosmetiske ændringer, f.eks. ændring af feltfarve eller skrifttype, skal denne position øges med én. |
Det er vigtigt, at versionen opdateres både på 1. ark i template-filen under feltet 'Version' og i det filnavn, som template'en gemmes under.
Flow for behandling af CPR Batch
Nedenstående figur beskriver flowet gennem batchmotoren med udgangspunkt i v. 2.0 batch templaten (v. 3.0 har yderligere mulighed for også at specificere om modtagerne af breve udelukkende skal have fysiske breve - dette gøres med "Send breve til eboks" optionen).
Daglig statistik
Batchmotoren vil på daglig basis tilføje statistik fra dagens kørte CPR Batches til et statistik regneark og levere dette til en angivet SFTP folder.
Statistikken leveres på formen
Den opdaterede statistik har navnet Statistik_<yyyy-MM-dd_HHmms>.xlsx, f.eks. Statistik_2020-07-23_013054.xlsx. Derved sikres det at en ny statistik ikke kommer til at overskrive en tidligere statistik.
Brevskabelon
Brevskabeloner skal indlæses i Batchmotoren for at de kan refereres fra et leveret CPR Batch.
Der kan tilføjes nye brevskabeloner ved at lægge dem som en .docx fil i den angivne SFTP folder. Herefter vil Batchmotoren indlæse brevskabelonen og gemme den internt men ikke fjerne den fra SFTP folderen. Derved kan anvendere se hvilke skabeloner der er til rådighed ved at inspirere indholdet af SFTP folderen.
Hvis en brevskabelon fjernes fra SFTP folderen bliver den ikke fjernet fra Batchmotoren.
I tvivlstilfæld eller hvis der er behov for at fjerne en brevskabelon fra Batchmotoren skal NSP kontaktes da de har mulighed for at se hvilke skabeloner der ligger internt i Batchmotoren og kan redigere dette indhold.
Flettefelter i brevskabeloner
Hver brevskabelon vil indeholde flettefelter som refererer til de fletteværdier som leveres til Strålfors.
De mulige flettefelter der kan anvendes er:
| Flettefelt | Værdi |
|---|---|
| ConnectAfsendelseIdentifikator | Unik værdi for informationslinjen - anvendes internt af Strålfors |
| ConnectForsendelsesType | Angivelse af forsendelsestype - anvendes internt af Strålfors |
| ConnectCPR | CPR nummer for brevmodtager |
| ConnectNavn | Fulde navn for brevmodtager |
| ConnectAdresse1 | Adresse linje 1 for brevmodtager |
| ConnectAdresse2 | Adresse linje 2 for brevmodtager |
| ConnectAdresse3 | Adresse linje 3 for brevmodtager |
| ConnectAdresse4 | Adresse linje 4 for brevmodtager |
| ConnectPostnummer | Postnummer for brevmodtager |
| ConnectLandekode | Landekode for brevmodtager |
| ConnectSkabelon | Reference til brevskabelon der skal flettes - anvendes internt af Strålfors |
Hvis Batchtemplaten angiver at der skal udsendes et spørgeskema, vil disse flettefelter også være til rådighed:
| Flettefelt | Værdi |
|---|---|
| UndersoegelseLink | Brevmodtagers link til undersøgelsen |
| UndersoegelseBruger | Brevmodtagers bruger til undersøgelsen |
| UndersoegelseKode | Brevmodtagers kode til undersøgelsen |
Fejlbeskeder
Prøvebestillingsindlæseren er designet til at gøre opmærksom på hvis et modtaget CPR batch indeholder fejl der umuliggør behandling af filen.
Hvis der detekteres fejl lægges der en fil tilbage i SFTP folderen der hedder det samme som den modtagne fil men med endelsen .fejl. F.eks. hvis der leveres en fejlbehæftet fil med navnet SSI_Indberetning_20200601.xlsx vil der efter behandling af filen ligge i fil med navnet SSI_Indberetning_20200601.fejl i SFTP folderen som indeholder en beskrivelse af den detekterede fejl.
De fejlsituationer der håndteres er:
Der er tidligere modtaget et CPR batch med samme navn
Hvis der modtages et CPR batch med samme navn som en tidligere behandlet fil, vil fejl filen indeholde følgende beskrivelse:
CPR filen SSI_Indberetning_20200601.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: En CPR liste med filnavnet SSI_Indberetning_20200601.xlsx er behandlet tidligere.Når fejlen er rettet kan filen forsøges behandlet igen.
CPR batchet anvender en ukendt brevskabelon
Informationen på 1. faneblad skal udpege de brevskabeloner der skal anvendes til udsendelse af breve til de angivne CPR numre.
Hvis de angivne skabelon navne ikke matcher en kendt brevskabelon og der derfor ikke kan sendes de korrekte oplysninger til Strålfors, vil fejl filen indeholde følgende beskrivelse:
CPR filen SSI_Indberetning_20200601.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: Der eksisterer ikke nogen brev-skabelon der matcher ønskede skabeloner XXXX og/eller YYYY i filen SSI_Indberetning_20200601.xlsx.Når fejlen er rettet kan filen forsøges behandlet igen.
CPR batchet indeholder ikke nogen valide CPR numre
Hvis der ikke kan fremfindes nogen CPR numre i filen, vil fejl filen indeholde følgende beskrivelse:
CPR filen SSI_Indberetning.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: Filen SSI_Indberetning.xlsx - indeholder ikke nogen valide CPR numre.
CPR batches er korrupt
Hvis CPR filen er beskadiget og derfor ikke kan indlæses, vil fejl filen indeholde følgende beskrivelse:
CPR filen SSI_Indberetning_20200601.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: Filen SSI_Indberetning_20200601.xlsx kan ikke indlæses som et Excel regneark.Når fejlen er rettet kan filen forsøges behandlet igen.
CPR batchet mangler kontrol data
Informationen på 1. faneblad skal styre behandlingen af rekvisitioner og breve. Hvis ikke alle oplysningerne er udfyldt kan det betragtes som en fejl.
Hvis der mangler kontrol data i filen, vil fejl filen indeholde følgende beskrivelse (afhængig af hvilke kontrol data der mangler):
CPR filen SSI_Indberetning.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: Filen SSI_Indberetning.xlsx- indeholder ikke en angivelse af "Batch ID"- indeholder ikke en angivelse af "Prøvetype"- indeholder ikke en angivelse af "Send breve til gr1"- indeholder ikke en angivelse af "Send breve til gr2+"- indeholder ikke en angivelse af "Rekvisition til gr2+"
Når fejlen er rettet kan filen forsøges behandlet igen.
eller
CPR filen SSI_Indberetning.xlsx er fejlet og der er IKKE oprettet rekvisitioner eller afsendt breve på baggrund af denne fil.Årsagen til fejlen er: Filen SSI_Indberetning.xlsx- indeholder ikke en angivelse af "Prøvetype"- indeholder ikke en angivelse af "Rekvisition til gr2+"- indeholder ikke en angivelse af "Brevskabelon til gr2+"
Når fejlen er rettet kan filen forsøges behandlet igen.
Test
Ved aftestning af templates osv. henstilles til at anvende NSPs testmiljø, hvor der kan anvendes testborgere af forskellige typer.
Der findes således en test sftp-server, hvor hele flowet omkring ibrugtagning af nye brevskabeloner, "ikke funktionelle" ændringer i excel-templaten osv. kan prøves af. Det anbefales derfor at arbejdsgangen for ibrugtagning af brevskabeloner og ny template er nogenlunde som følger (set i henhold til NSP snitfladerne):
- opret/ret brevskabeloner og tilføj nyt timestamp til disses filnavne
- test brevskabeloner med test-csv-fil fra NSP, således flettefelterne bliver verificeret.
- tilret template med nye skabelonnavne
- upload brevskabeloner til testmiljøets SFTP brevskabelon-folder
- Find testcprnumre, der dækker de ønskede udfaldsrum (her tænkes sortering i gr1 og gr2, således inputtet matcher med den nye skabelon). Indsæt disse i en excelfil lavet med ny template.
- Upload denne til testmiljøets SFTP batch-folder
- Verificer at der ikke kommer fejlbeskeder tilbage på ny skabelon og template
- Få evt. NSP support til at verificere det videre flow (frembringelse af csv-filer etc.).
- Gentag pkt. 3 på produktionsmiljøet - den nye excel template kan således tages i brug.
Test borgere
NSP stiller muligheden for at oprette testborgere til rådighed via den Dynamiske Testdatagenerator (DTG).
Denne findes via dette link: https://stamdata.nspop.dk/ (kræver oprettet bruger)
For denne findes der en anvenderguide her: https://www.nspop.dk/display/public/web/DTG+-+Guide+til+anvendere
Alternativt kan medcoms test-cprnumre også anvendes, idet de også er oprettet på NSP (de kan søges frem i DTG også, så relationer/adresser osv kan verificeres her).
Disse kan findes her: https://www.medcom.dk/opslag/koder-tabeller-ydere/tabeller/nationale-test-cpr-numre (der er på siden et link til et excel ark indeholdende testpersonerne).