Dokumenthistorik

Indhold

Elevdatabasen

Elevdatabasen er et nyt grunddatasystem i Styrelsen for It og Læring (STIL) indeholdende grunddata om elever på uddannelser under Børne- og Undervisningsministeriets (BUVM) resortområde. De konkrete grunddata omfatter oplysninger om elevers aktuelle tilknytning til institutioner og uddannelser, herunder trin, start- og slutdatoer mv. samt elevernes årsager til afgang fra de enkelte uddannelsesforløb. De overordnede dataområder Elevdatabasen opererer med er persondata, institutionsdata og uddannelsesdata.

...

Indberetninger til Elevdatabasen sker fra uddannelsesinstitutionernes studieadministrative systemer (SA-systemer) via en webservice udstillet på STIL’s integrationsplatform (Integrationsplatformen). Integrationsplatformen er knudepunktet for STIL’s eksternt rettede webservices. Den er en infrastrukturkomponent som via autentificering, autorisering, logning og kryptering (https) understøtter en sikker, ensartet og effektiv udveksling af data mellem STIL's centrale systemer og eksterne systemer. Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for Integrationsplatformen. Det overordnede flow kan ses i diagrammet nedenfor:

Indberetning til Elevdatabasen

Grunddata om elever

Følgende sektion beskriver i overordnede træk de tre dataområder i Elevdatabasen, der til sammen udgør grunddata om elever, og mod hvilke kilder denne data valideres.

...

Håndtering af indberetninger, der ikke overholder valideringsreglerne, beskrives i afsnittet Fejlhåndtering.

Grundlæggende principper for indberetning

1. En indberetning skal indeholde gældende data for en elev pr. indberetningsdatoen.
2. En indberetning skal indeholde historisk data frem til indberetningsdatoen
3. Ved ændringer til data på eleven skal indberetning ske senest dagen efter, at ændringen træder i kraft
4. En indberetning må ikke indeholde forventede ændringer
5. Brobygningselever og prøvedeltagere skal ikke indberettes

Omfattede uddannelser

I første omgang er det alene grunddata om elever på det gymnasiale område der skal indberettes. Det gymnasiale område defineres af de uddannelser der til enhver tid fremgår under formålsgruppe 2 og 33 i Uddannelsesmodellen.

...

Integrationsmønstre

Følgende sektion beskriver de krav det SA-systemet skal opfylde ved integration til Elevdatabasen. Kravene er vigtige for at sikre en stabil service og data af høj kvalitet.

Sikring af stabil drift

For at sikre stabil drift af Elevdatabasen, skal integrationen designes så der maksimalt sendes 20 requests i sekundet per SA-system.

...

Hvis en indberetning fejler, og der automatisk prøves igen, skal disse indberetninger stadig ske kontrolleret jf. dette krav. Det anbefales ydermere, at man ved gentagende fejl øger forsinkelsen for hvornår der prøves igen, da fejlen kan være relateret til en overbelastning internt i Elevdatabasen.

Håndtering af samtidighed

Da beskeder kan skifte rækkefølge i både netværk og på Integrationsplatformen (IPL), giver det en risiko for, at ændringer kan bliver overhalet, og dermed bliver data i Elevdatabasen forskellig fra den faktiske data i SA-systemet.

...

Ønsker man at parallelisere indberetninger er det vigtigt, at paralleliseringen sker grupperet på CPR-nummer eller institution.

Håndtering af udfald i netværk og infrastruktur

Alle indberetninger skal påsættes et IndberetningsID af typen GUID, for at undgå dobbeltindberetninger ved fejl i netværk elleranden infrastruktur.

...

Se tabellen i afsnittet Fejlhåndtering for yderligere detaljer om hvornår man forventes at gensende- eller generere en nyt IndberetningsID.

Webservice

Denne sektion beskriver den webservice der skal anvendes til brug for indberetning.

Anker
Adgang til webservice Adgang til webservice

Adgang til webservice

Elevdatabasens webservice udstilles på STIL's integrationsplatform (Integrationsplatformen). Integrationsplatformen anvender STIL's system Tilslutning til brug for oprettelse, administration og vedligehold af tilslutninger og dataadgange mellem institutioner og systemleverandører (udbydere).

...

Yderligere oplysninger om tilslutning samt tekniske detaljer kan findes på STIL’s supportside for Integrationsplatformen.

Operationer

Der findes følgende 3 operationer i Elevdatabasen, Indberet, Status og Ping.

Anker
Indberet Indberet

Indberet

Indberetning af data til Elevdatabasen sker med operationen Indberet for én elev af gangen.

...

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Anker
Status Status

Status

Anvendes til at hente - eller genhente - status for en indberetning ud fra det ID som indberetningen er foretaget på. Ved status FAILED , vil responset indeholde valideringsfejlene, der efterfølgende kan behandles af afhenter. Svaret fra Status-operationen er identisk med svaret på en indberetning, og kan benyttes ved tvivl om hvorvidt en indberetning er gået godt.

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Ping

Anvendes til at pinge Elevdatabasen.

De tekniske detajler, og eksempel på request/response kan findes i afsnittet Teknisk beskrivelse af operationer

Anker
Fejlhåndtering Fejlhåndtering

Fejlhåndtering

Elevdatabasen opererer med 3 typer af fejlkoder, Elevdb-XXXX, Indb-XXXX og Pers-1000. Elevdb-XXXX fejlkoderne dækker over interne fejl på Elevdatabasen. Indb-XXXX fejlkoderne dækker over fejl i indberetningen fra de studieadministrative systemer til Elevdatabasen. Pers-XXXX dækker over fejl i forbindelse med validering af CPR-oplysninger og kommunikation med CPR-registeret. 

...

SoapFaults

Elevdatabasen returnere både Interne fejl, og ugyldig datafejl som SoapFaults. Elevdatabasens Soapfaults er bygget op omkring 2 overordnede elementer:

...

<soap:Detail> - Indeholder en exception og en mere detaljeret beskrivelse af fejlen samt errorcode. I tilfælde af valideringsfejl indeholder den en liste med valideringsfejlkoder og dertilhørende fejlbeskrivelser.

Parametre for SoapFault besked ved interne fejl

Ved interne fejl benyttes følgende format

Parametre for SoapFault besked ved valideringsfejl

Ved valideringsfejl benyttes ved følgende format

Indberetningsdetalje

Fault eksempel

Følgende viser et eksempel på en SoapFault ved indberetning af validt request, men hvor der er valideringsfejl.

<soap:Fault>
    	<soap:Code>
        		<soap:Value>soap:Receiver<Sender</soap:Value>
    	</soap:Code>
    	<soap:Reason>
        		<soap:Text xml:lang="en">Indberetningen på indberetningsid 7814 er ugyldig<>Input error</soap:Text>
    <	</soap:Reason>
    	<soap:Detail>
        <InvalidIndberetning xmlns		<ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns=">
            <ErrorCode>Indb-2004</ErrorCode>
            <ErrorMessage>Data på indberetningen er ugyldig.</ErrorMessage>
            <Status>FAILED</Status>
            <Indberetningsdetaljer>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-01</Fejlkode>
                    <Fejlbeskrivelse>Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig</Fejlbeskrivelse>
                </Indberetningsdetalje>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-04</Fejlkode>
                    <Fejlbeskrivelse>Skoleperioden 5 gælder ikke for uddannelsen 3017 i version 2</Fejlbeskrivelse>
                </Indberetningsdetalje>
                <Indberetningsdetalje>
                    <Fejlkode>Udd-06</Fejlkode>
                    <Fejlbeskrivelse>Elevens startdato 2022-01-01 ligger efter slutdato for uddannelsen med Uddannelseskoden 3017 og Uddannelsesversionen 2 hvor uddannelsen er lukket for optag</Fejlbeskrivelse>
                </Indberetningsdetalje>
				<Indberetningsdetalje>
					<Fejlkode>Udd-13</Fejlkode>
					<Fejlbeskrivelse>Adgangsvejen TD er ugyldig for skoleperioderne (5)</Fejlbeskrivelse>
                </Indberetningsdetalje>
			</Indberetningsdetaljer>
        </InvalidIndberetning>
    </soap:Detail>
</soap:Fault>

...

Nedenfor er listet de valideringer, der foretages på Elevdatabasen. Valideringerne er delt op i tre dele: Persondata, Institutionsdata og Uddannelsesdata.

Ved brud på valideringsregler returneres en liste af valideringsfejl som Indberetningsdetaljer i en SoapFault.

Persondata

...

Fejlkode

...

Fejltekst

...

Institutionsdata

...

Afhængig af #Flyttekode.

(#Flyttekode=1): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.

(#Flyttekode=2): Institution #Institutionsnummer er flyttet til institution #NyInstitutionsnummer.

...

Institutionen #Hovedinstitution er indberettet som en institution uden afdelinger, men institutionen er registreret som en afdeling eller hovedinstitution.

Uddannelsesdata

...

Den indberettede kombination af uddannelseskode, uddannelsesversion, speciale og skoleperioder er ikke gyldig

...

http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
			<CorrelationID>21519f93-f730-49cf-b5cb-3c36bc7b0522</CorrelationID>
			<Timestamp>2022-04-07T12:38:15</Timestamp>
			<ErrorCode>IPL171003</ErrorCode>
			<ErrorMessage>Indberetning is invalid</ErrorMessage>
			<Details>Indberetningen på indberetningsid b9b7516a-9e20-4833-869c-23d8b2b374e1 er ugyldig</Details>
			<SourceSystemError>
				<SourceSystemName>Elevdatabasen</SourceSystemName>
				<ErrorCode>Indb-2004</ErrorCode>
				<DetailsList>
					<Detail>
						<Code>Inst-04</Code>
						<Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med afdelinger</Description>
					</Detail>
					<Detail>
						<Code>Udd-13</Code>
						<Description>Adgangsvejen TD er ugyldig for skoleperioderne (5)</Description>
					</Detail>
				</DetailsList>
			</SourceSystemError>
		</ServiceFaultDetailerV2>
	</soap:Detail>
</soap:Fault>

Anker
Valideringsregler Valideringsregler

Valideringsregler

Nedenfor er listet de valideringer, der foretages på Elevdatabasen. Valideringerne er delt op i tre dele: Persondata, Institutionsdata og Uddannelsesdata.

Ved brud på valideringsregler returneres en liste af valideringsfejl som Indberetningsdetaljer i en SoapFault.

Persondata

Institutionsdata

Uddannelsesdata

Anker
Teknisk beskrivelse af operationer Teknisk beskrivelse af operationer

Teknisk beskrivelse af operationer

Dette afsnit beskriver de tekniske detaljer for hver Operation på Elevdatabasens webservice.

Anker
Indberet Indberet

Indberet

Operationen har følgende struktur for request og response:

Parametre for request

IndberetElevRequest

IndberetElev

...

Dette afsnit beskriver de tekniske detaljer for hver Operation på Elevdatabasens webservice.

...

Operationen har følgende struktur for request og response:

...

IndberetElevRequest

PersonoplysningerIndberetElev

Personoplysninger

...

Parametre for response

...

<IndberetElevResponse xmlns="http://serviceipl.elevdatabasenstil.stil.dk/services/elevdatabasen/indberetning/v1.0">
	<Status>COMPLETE</Status>
</IndberetElevResponse>

Anker
Status Status

Status

Status-operationen er stadig under udarbejdelse, og vi forventer response-strukturen kommer til at matche response-strukturen for Indberet-operationen

Parametre for request

...

Parametre for response

StatusResponse

...

StatusResponse

Indberetningsdetalje

<ser:StatusRequest>
	<ser:Institutionsoplysninger>  			
		<ser:Hovedinstitution>961851</ser:Hovedinstitution>
		<ser:Afdeling>961851</ser:Afdeling>     
	</ser:Institutionsoplysninger>
	<ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
</ser:StatusRequest>

<StatusResponse xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
    <Status>COMPLETE</Status>
</StatusResponse>

<soap:Fault>
         <soap:Code>
            <soap:Value>soap:Sender</soap:Value>
         </soap:Code>
         <soap:Reason>
            <soap:Text xml:lang="en">Input error</soap:Text>
         </soap:Reason>
         <soap:Detail>
            <ServiceFaultDetailerV2 xmlns:ns2="http://service.elevdatabasen.stil.dk/" xmlns="http://ipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
               <CorrelationID>b7618eba-a992-4460-81c5-4b39660d9450</CorrelationID>
               <Timestamp>2022-04-07T06:54:22</Timestamp>
               <ErrorCode>IPL171003</ErrorCode>
               <ErrorMessage>Indberetning is invalid</ErrorMessage>
               <Details>Indberetningen på indberetningsid a40d3166-e0ca-4530-8374-285a6f81b75b er ugyldig</Details>
               <SourceSystemError>
                  <SourceSystemName>Elevdatabasen</SourceSystemName>
                  <ErrorCode>Indb-2004</ErrorCode>
                  <DetailsList>
    

Indberetningsdetalje

...

<ser:StatusRequest>
	<ser:Institutionsoplysninger>  			
		<ser:Hovedinstitution>961851</ser:Hovedinstitution>
		<ser:Afdeling>961851</ser:Afdeling>     
	</ser:Institutionsoplysninger>
	<ser:IndberetningsId>32ed0545-b6a0-4e91-bf7b-0fc0dff8ef73</ser:IndberetningsId>
</ser:StatusRequest>

<StatusResponse xmlns="http://service.elevdatabasen.stil.dk/">
    <Status>COMPLETE</Status>
</StatusResponse>

<soap:Fault>
    <soap:Code>
        <soap:Value>soap:Receiver</soap:Value>
    </soap:Code>
    <soap:Reason>
        <soap:Text xml:lang="en">Indberetningen på indberetningsid 7814 er ugyldig</soap:Text>
    </soap:Reason><Detail>
    <soap:Detail>
        <InvalidIndberetning xmlns="http://service.elevdatabasen.stil.dk/">
            <ErrorCode>Indb<Code>Inst-2004<04</ErrorCode>Code>
              <ErrorMessage>Data   på indberetningen er ugyldig.</ErrorMessage>
    <Description>Hovedinstitutionen 961851 er registreret som en hovedinstitution med <Status>FAILED</Status>        
afdelinger</Description>
                     <Indberetningsdetaljer>
		</Detail>
          <Indberetningsdetalje>
			        <Fejlkode>Inst-01<</Fejlkode>DetailsList>
			        <Fejlbeskrivelse>Institutionsnummeret 213213 findes ikke</Fejlbeskrivelse>
		    </SourceSystemError>
    </Indberetningsdetalje>
	        </Indberetningsdetaljer>ServiceFaultDetailerV2>
         </InvalidIndberetning>
    </soap:Detail>
      </soap:Fault>

Ping

Operationen har følgende struktur for request og response

Parametre for request

Parametre for response

<ser<v1:Ping/>

<PingResponse xmlns="http://service.elevdatabasenipl.stil.dk/services/elevdatabasen/indberetning/v1.0">
	    <Status>up</Status>
</PingResponse>