ProCapita Databas

Övergripande

Procapita Databas är en utläsningstyp som läser direkt från ProCapitas databas. Denna lösning kräver att den körs i kundens miljö och kommer läsa ut information om de skolor som finns samt vilka lärare och elever som finns kopplade till dessa skolor. Vi läser även ut vilka klasser och undervisningsgrupper som finns registrerade.

• Fjärråtkomst (VPN) till server att lägga integrationen på.
• Konto som är lokal administratör på denna integrationsserver.
• Åtkomst till SQL-databasen från denna server. Port 1433 behöver vara öppen.
• SQL-konto som får läsa i Procapita-databasen.
• Servicekonto som får köra schemalagt jobb på integrationsservern (logon as batch job)
• Port 443 måste vara öppet utåt från integrationsservern.

Om e-postadress saknas i Procapita behövs en mappningstabell med Procapita-id (guid) eller personnummer och e-postadress. Denna kan med fördel hämtas från AD.

Krav på miljö

Följande krav ställs på den maskin som programvaran kommer köras från.

• Maskin med .Net Framework 4.7 Runtime
  • Kunden ansvarar för att en maskin som kan köra minst .Net Framework 4.7 finns tillgänglig
  • Vi rekommenderar minst Windows Server 2012 men gärna Windows Server 2016 eller Windows Server 2019
• Öppet för utgående trafik på TCP-port 443 (https)
  • Kunden ansvarar för att det är möjligt att skicka underlaget via https till en molntjänst i Eventfuls Azure
• Permanent fjärråtkomst för Eventful till den maskin som kör programvaran
  • Kunden ansvarar för att Eventful har permanent åtkomst till maskinen där programvaran körs
  • Om Eventful saknar permanent åtkomst kan ingen SLA på denna utläsning ges
• Möjlighet till att schemalägga körningar med Windows inbyggda schemaläggare
  • Kunden ansvarar för att Eventful har tillgång till ett konto med behörigheten Logon as Batch Job
• Databas åtkomst till ProCapita
  • Kunden ansvarar för att Eventful har aktuell information kring hur uppkoppling mot databasen ska ske

Krav på underlag

Denna rubrik och dess underrubriker beskriver de krav som finns i våra produkter för att vi ska kunna läsa ut vissa typer av data.

Skola

För att en skola ska kunna läsas ut i konfigurationen krävs det att skolan finns angiven i vår lista över skolor att läsa ut. Denna lista innehåller information om vilken skola samt dess skolform som ska läsas ut. Utöver att skolan ska finnas i listan så måste den även ha ett start- och slut-datum som anger att skolan är aktiv just nu.

• Skolan och dess skolform måste vara aktiv och finnas angiven i konfigurationen
• Skolan måste vara aktiv vid det tillfälle då synken körs

Elev

För att en elev ska läsas ut krävs att eleven har en aktiv klassplacering på en skola som finns i konfigurationen. Det är även så att om eleven är markerad som att ha någon form av skyddad identitet så läses den inte ut, detsamma gäller även om eleven är avregistrerad eller har avlidit.

• Elever måste ha en aktiv klassplacering på enheten för att komma med i utläsningen. Med aktiv klassplacering menas att eleven ligger med i en klass där startdatum passerats och ett slutdatum som infaller före synkdatum. Fältet slutdatum kan också lämnas tom
• Eleven har inte skyddad adress/identitet
• Aktiv klassplacering på en skola som finns angiven i konfigurationen
• Inte markerad med skyddad identitet
• Inte markerad som avregistrerad
• Inte markerad som avliden

Lärare

För att en lärare ska läsas ut krävs att läraren har en aktiv anställning på en skola som finns i konfigurationen. Det är även så att läraren inte heller får ha någon form av skyddad identitet eller för den delen vara markerad som avliden.

• All personal som ska tas med i utläsningen måste ha en aktiv anställning på enheten. Aktiv betyder att det finns en anställning, där slutdatum är tomt eller inte har passerats. Observera att personal inte kan ha ett Slutdatum som infaller före synkdatum för att exporten skall fungera. Fältet Slutdatum kan lämnas tomt.
• Läraren har inte skyddad adress/identitet
• Inte markerad som avliden

Klass

För att en klass ska läsas ut så krävs att klassen är aktiv just nu, d.v.s. att start- och slut-datum finns angivna och ligger inom aktuell period. Klassen måste dessutom vara kopplad till en skola som finns angiven i konfigurationen.

• Aktiv klass kopplad till en skola som finns angiven i konfigurationen
• Lärare måste finnas kopplad till klass för att det ska skapas en klass, elever behöver inte vara kopplade för att gruppen ska skapas
• Klass skapas 14 dagar före start med lärare, eleverna läggs till dagen innan klassen startar

Undervisningsgrupp

För att en undervisningsgrupp ska läsas ut så krävs att den är markerad med texten PORTAL i fältet övrigt. Dessutom måste undervisningsgruppen vara kopplad till en aktiv grupp eller en aktiv klass, d.v.s. en klass/grupp som har start- och slut-datum angivna och där dessa ligger inom aktuell period vid körningen. Undervisningsgruppen måste dessutom vara kopplad till en skola är aktiv och som finns angiven i konfigurationen.

• Personal kopplas till undervisningsgrupper via Aktiviteter. Det måste finnas koppling till klass eller grupp och eventuellt ämne och funktion. Aktiviteter tas i regel med 14 dagar innan startdatum. Slutdatum måste vara satt till senare än dagens datum alternativt vara blankt
• Aktiviteten måste ha texten PORTAL angiven i fältet övrigt
• Aktiviteten måste vara kopplad till en aktiv klass eller en aktiv grupp
• Aktiviteten inklusive dess klasser eller grupper måste vara kopplade till en aktiv skola som finns angiven i konfigurationen
• Lärare måste finnas kopplad till grupp för att det ska skapas en klass, elever behöver inte vara kopplade för att gruppen ska skapas
• Grupp skapas 14 dagar före start med lärare, eleverna läggs till dagen innan gruppen startar

Kundanpassningar

Nedan listats kundanpassningar som kan beställas av kunder som har minst ett silveravtal.

Undervisningsgrupper baserat på prefix eller suffix

Om man inte kan eller vill använda sig av markering av undervisningsgrupper via fältet övrigt och texten PORTAL kan man istället välja att läsa ut undervisningsgrupper genom att filtrera baserat på deras namn och ett prefix eller ett suffix. Exempelvis skulle man kunna välja att läsa ut undervisningsgrupper via suffixet ” Teams” så att alla grupper som har ett namn som slutar på ” Teams” ska läsas ut.

• Aktiviteten måste börja eller sluta på det angivna prefixet eller suffixet
• Aktiviteten måste vara kopplad till en aktiv klass eller en aktiv grupp
• Aktiviteten inklusive dess klasser eller grupper måste vara kopplade till en aktiv skola som finns angiven i konfigurationen

Vanliga frågor

Nedan följer några vanliga frågor och samt våra rekommendationer.

• Hur ofta läser Eventful ut underlag från ProCapita?
  1. Normalt sett läser Eventful ut underlag från ProCapita en gång per dygn och allt som ofta efter avslutad arbetsdag
• Måste e-postadressen finnas angiven på elever och lärare?
  1. Vår rekommendation är att man har e-postadressen för elever och lärare angiven i ProCapita
  2. För kunder som använder sig av vårt bronspaket är detta ett krav
• Måste personnummer läsas ut från ProCapita?
  1. Vår rekommendation är att inte läsa ut personnummer från ProCapita men vissa integrationer kräver personnummer och då måste vi såklart läsa ut det. Vi försöker dock eftersträva att i så få fall som möjligt ha ett krav till personnummer
• Vilken information läses ut för lärare och elever?
  1. Vår standard läser ut följande attribut
     • Förnamn
     • Efternamn
     • E-postadress

Kontrollerad 20231019