Updated documentation with "kunstige institutioner" and apiOnly students via import api

Author: abodigital

architecture.md

@@ -33,7 +33,7 @@ Dataflow-arkitekturen er illusteret nedenfor
 
 ![Diagram describing the architecture](/assets/flow_udvidet.png)
 
-OS2skoledata fungerer som det centrale bindeled mellem nationale skoledata, lokale infrastrukturer og cloud-baserede tjenester. Systemet modtager som standard data fra Skolegrunddata via STIL's WS17-webservice. Disse data omfatter oplysninger om skoler, elever, klasser og ansatte, som behandles i OS2skoledata core og gemmes i en database, der svarer nogenlunde til datastrukturen i STIL. På baggrund af disse oplysninger oprettes, opdateres og nedlægges brugere, grupper og enheder automatisk i en række integrerede systemer. I stedet for at anvende WS17 til at styre data, kan kommunen importere data for ansatte og eksterne ind i OS2skoledata via importAPI’et. Hvis denne metode vælges vil det lokale data være styrende for alle oprettelser og sletninger, uanset hvad der sker i STIL. Det vil dog være muligt at berige en række felter med data fra STIL.
+OS2skoledata fungerer som det centrale bindeled mellem nationale skoledata, lokale infrastrukturer og cloud-baserede tjenester. Systemet modtager som standard data fra Skolegrunddata via STIL's WS17-webservice. Disse data omfatter oplysninger om skoler, elever, klasser og ansatte, som behandles i OS2skoledata core og gemmes i en database, der svarer nogenlunde til datastrukturen i STIL. På baggrund af disse oplysninger oprettes, opdateres og nedlægges brugere, grupper og enheder automatisk i en række integrerede systemer. I stedet for at anvende WS17 til at styre data, kan kommunen importere data for ansatte og eksterne ind i OS2skoledata via import-API’et. Hvis denne metode vælges vil det lokale data være styrende for alle oprettelser og sletninger, uanset hvad der sker i STIL. Det vil dog være muligt at berige en række felter med data fra STIL. Det er muligt at oprette "ApiOnly" elever via import-API'et. Disse elever opdateres ikke af STIL, da de ikke eksisterer deri, og de skal placeres på en "kunstig" institution, som kan oprettes via brugergrænsefladen (hvis modulet er slået til). 
 
 På lokalt niveau integrerer OS2skoledata med Active Directory (AD), hvor det kan styre brugere, grupper og enheder. Samtidig er der mulighed for at opretholde en lokal database gennem SQLSync (baseret på MySQL eller MariaDB), der spejler de relevante data fra OS2skoledata core til brug i f.eks. statistik og lokale integrationer. Derudover er der en integration, der vedligeholder en sikkerhedsgruppe med aktive ansættelser. Dette gøres via løndata (OPUS, SQL eller OS2sofd) for at validere og sikre, at kun personer med aktive ansættelser oprettes og tilknytning i STIL (via OS2skoledata) er medlemmer af sikkerhedsgruppen. Disse løndata bruges også til at opdatere OS2skoledata med information om aktuelle ansættelser.
 

configuration/core.md

@@ -45,4 +45,6 @@ has_children: false
 | os2skoledata.syncSettings. transitionMode | Kan sættes hvis syncFrom er API_AND_STIL.  <br>Hvis syncFrom er API_AND_STIL, tillader vi normalt ikke, at STIL opretter og sletter brugere,<br><br>men det kan være nødvendigt ved den første indlæsning eller under en testperiode, når kommunen implementerer mod import-API'et.<br><br>Hvis transitionMode er true, tillader vi, at STIL opretter alle brugere og sletter brugere, hvor source er forskellig fra localSource. Ingen opdateringer. | false |
 | os2skoledata.syncSettings.localSource | Den source der normal sættes på brugere indlæst via indlæsnings-API’et. Bruges så til at sikre at vi ikke sletter brugere fra localSource hvis transitionMode er true. | local |
 | os2skoledata.syncSettings.onlySaveNeededPropertiesFromSTIL | Gemmer kun felter fra STIL i databasen, som bruges af OS2skoledata. Det vil sige at fx kontaktpersoner og adresser ikke gemmes, hvis denne indstilling sættes til true. | false |
-| os2skoledata.syncSettings.thresholdPercentage | Den procentsats i decimal tal, der skal til før en ændring i antallet af personer tilknyttet en institution, registreres som en stor ændring. | 0.5 (50%) |
+| os2skoledata.syncSettings.thresholdPercentage | Den procentsats i decimal tal, der skal til før en ændring i antallet af personer tilknyttet en institution, registreres som en stor ændring. | 0.5 (50%) |
+| os2skoledata.syncSettings.handleAPIOnlyStudents | Bestemmer om der må oprettes apiOnly elever via Import API'et | false |
+| os2skoledata.nonSTILInstitutions.enabled | Bestemmer om man skal kunne oprette kunstige instituioner via Brugergrænsefladen. De kunstige institutioner kan bruges til at placere ApiOnly brugere. | false |

description.md

@@ -96,7 +96,7 @@ I dette afsnit gennemgåes de enkelte del-komponenter i OS2skoledata løsningen.
 
 Udlæsning af data fra skole-grunddata sker via snitfladen WS-17 (fuld myndighed). Det er muligt at lave op til 4 udlæsninger per dag for en given institution, og OS2skoledata sættes op til at foretage disse udlæsninger på optimale tidspunkter, for at sikre et effektivt flow af hændelser indenfor samme arbejdsdag.
 
-Data trækkes fra WS-17 ind i OS2skoledata Core, der er en central komponent driftet af Digital Identity. Alternativt kan kommunen vælge selv at indlæse data i OS2skoledata via Import API'et. Det er muligt at indlæse ansatte og eksterne via API'et. Hvis man vælger at administrere data via API'et, vil det være dette, der er styrende for oprettelser og sletninger uanset hvad der sker i STIL. Data fra lokal kilde vil dog blive beriget med data fra STIL. Det er muligt at konfigurere hvilke felter, der må vedligeholdes af STIL. Hvor der indlæses data fra (STIL eller API og STIL) og hvilke felter STIL må berige, styres via konfigurationen i OS2skoledata Core.
+Data trækkes fra WS-17 ind i OS2skoledata Core, der er en central komponent driftet af Digital Identity. Alternativt kan kommunen vælge selv at indlæse data i OS2skoledata via Import API'et. Det er muligt at indlæse ansatte og eksterne via API'et. Hvis man vælger at administrere data via API'et, vil det være dette, der er styrende for oprettelser og sletninger uanset hvad der sker i STIL. Data fra lokal kilde vil dog blive beriget med data fra STIL. Det er muligt at konfigurere hvilke felter, der må vedligeholdes af STIL. Hvor der indlæses data fra (STIL eller API og STIL) og hvilke felter STIL må berige, styres via konfigurationen i OS2skoledata Core. Det er muligt at oprette "ApiOnly" elever via import-API'et. Disse elever opdateres ikke af STIL, da de ikke eksisterer deri, og de skal placeres på en "kunstig" institution, som kan oprettes via brugergrænsefladen (hvis modulet er slået til).
 
 På baggrund af ændringer i data, dannes de respektive dataændringer som hændelsesbeskeder, der lægges i en udgående kø.
 
@@ -355,6 +355,8 @@ I brugergrænsefladen kan man
 
   - Teamsadministratorer. Hvis OS2skoledata skal stå for oprettelse af teams til medarbejdere på institutionerne, skal der opsættes hvem der skal være ejer på medarbejderteamet på institutionen.
 
+  - Kunstige institutioner. Hvis denne er slået til, er der mulighed for at oprette kunstige institutioner via brugergrænsefladen. Det vil sige institutioner, der ikke eksisterer i STIL og derfor ikke indgår i STIl sync'en. Disse kunstige institutioner kan fx bruges til at placere apiOnly brugere fra import-API'et på.
+
 ## Årsrul
 
 Ved årsrul beholdes enheder, grupper, drev og teams så vidt muligt. Der laves et decideret rul, så hvis OS2skoledata kan matche den gamle klasse med en ny klasse, vil navnet bare blive ændret - fx 2A i 23/24 til 3A i 24/25.\