UmsWiki - User contributions [en]

Configurator/Encryption

2024-02-06T14:57:23Z

Kia: /* FAQ */

This will allow UMS to encrypt connection information in the database
[[File:Configurator - Encryption.jpg|none|thumb]]

=== Encrypt logins ===
Tells UMS to mange certain fields in database as encrypted.

Enabling this will require you to reenter information into the UMS again so it can be saved as encrypted text.

Disabling this will require you to reenter information into the UMS again so it can be saved as clear text. 

==FAQ==

===Which fields are encrypted===
Office 365 tenant settings

* Password
* Client secret
Office 365 SharePoint

* Client secret
UniSync settings

* DataproviderPassword

Canvas Organization Settings

* AccessToken

App PushNotification Settings

* ManageEndpoint
* ListenEndpoint

Configurator/Encryption

2024-02-06T09:12:47Z

Kia: /* FAQ */

Configurator/Encryption

2024-02-05T07:48:45Z

Kia:

File:Configurator - Encryption.jpg

2024-02-05T07:44:42Z

Kia:

Configurator - Encryption

Configurator/Encryption

2024-02-05T07:44:04Z

Kia: Created page with "==Installation== In order for external partners to retrieve data from UMS, use the web service username and password that can be found here Settings -> Web services 301x301px Enter a username and a password (must be at least 16 characters). This defines the username and password used for all UMS web services. If this changes, all systems retrieving from UMS Web Services must be updated. All communication will run through the url..."

==Installation==
In order for external partners to retrieve data from UMS, use the web service username and password that can be found here Settings -> Web services
[[File:Boss websetup.png|none|thumb|301x301px]]

Enter a username and a password (must be at least 16 characters).

This defines the username and password used for all UMS web services. If this changes, all systems retrieving from UMS Web Services must be updated.

All communication will run through the url "https://<UMS URL>/WebServicesAnonymous/<Partner file>"

The <Partner file> is the name of the system that connects to UMS i.e. Elevplan.asmx and not something that the customer normally needs to know.

Test URL by typing full URL in a browser, i.e.: [https://ums.demo.inlogic.dk/WebServicesAnonymous/Elevplan.asmx?WSDL https://ums.demo.inlogic.dk/WebServicesAnonymous/Elevplan.asmx?WSDL]

 
==FAQ==

===How do I know what webservices I have ?===
Most of the webservices are visible from UMS controlpanel using the "Test webservice" menu item.
[[File:Testwebservice.png|alt=Webservice Reindex test|left|thumb|Webservice Reindex test]]

SMS Alert

2024-01-23T11:39:06Z

Kia: /* Locations - and how they work */

SMS Alert provides fast and effective warnings in case of fire, bomb threats, school shootings and other emergency situations. When a crisis arises, everyone needs to be informed of it. And it needs to be done in a simple and transparent way. The SMS Alert module is separate from our other SMS modules, to avoid confusion with other SMS templates.

==Benefits==
There are many benefits of having SMS Alert. The module:

*Supports direct message to the appropriate authorities
*Immediately notifies everyone via their mobile phones
*Creates a sense of security for everyone at the school and their relatives
*Gives you an easy editor with predefined texts, which are almost ready to be sent out
*Lets you defines who has access to SMS Alert
*Turns your entire screen red, when you open the open the module to issue an alarm

==Requirement==

This module is already installed with the standard UMS installation. It requires a valid license for the module, which can be checked under “Help/License info”:
[[File:SmsAlertMenuLicenseInfo.png|none|thumb|827x827px]]

The required license is called “SMS Alert”:
[[File:SmsAlertLicenseInfo.png|none|thumb|651x651px]]

After the license has been verified, UMS is ready to be configured.

==Settings==
All settings regarding this module are located in Template settings, just as “ordinary” users that UMS maintains.
The concept is that each template (group of users), has a location attached to them. This could be the same location for all users/templates->All users on the school is alerted at the same time. Or it could be different locations (a large school with multiple addresses).
[[File:SmsAlertTemplateEditor.png|none|thumb|822x822px]]

Simply edit an existing template and click “Manage…” under location.

[[File:SmsAlertLocation.png|354x354px]]
[[File:SmsAlertAccessGroup.jpg|none|thumb]]
The settings for a location is:

=== Description ===
A descriptive name for the location (this is the name that the users are shown)

=== Access group ===
Members of the chosen group will have the rights to publish an alert for this location

=== Extra numbers ===
Insert extra phone numbers that will receive this message first (ex. The local police station)

=== Extra mailing lists ===
Insert extra emails that will receive the message

=== SMS Alerts ===
Choose/design the alert messages

=== Send to all employees ===
This will send SMS alert to all employees in UMS and not just the ones connected to this location.

==Locations - and how they work==
When you stand on a template, it's only possible to select one location, but you can set the same location on all of your templates to give you a "Select all option".

The selected location in the dropdown is the only one that are visible to the selected users in the AD Group

==SMS Alerts==

Its possible to define multiple alert messages:
[[File:SmsAlertSmsTemplateEditor.png|none|thumb|467x467px]]

Each alert needs a telling display name, and a short and easy to understand text.

 

==SMS sending order==
1. Custom number from UMS Configurator. (E.g., fire brigade and/or police)

2. Learn who has teaching now. (If the alarm is at 11 o'clock, everyone who teaches at 11 o'clock will be notified first.)

3. Teachers that have timetable blocks on that day.

4. Guest users and multiple users.

5. Students that have an active schema for today. (If the alarm is at 11 o'clock, everyone who has class at 11 o'clock will be notified first.)

6. Students that have scheduled timetable blocks later that day.

7. Other students at school.

8. Other students.

==Push Notification for SMS Alert App==
To add push notification go to Web Setup -> SMS Alert

Select "Send App push notification"

It requires UMS School App.
[[File:Smsalertpushnotification.png|none|thumb|804x804px]]

File:SmsAlertAccessGroup.jpg

2024-01-23T11:36:52Z

Kia:

SmsAlertAccessGroup

STIL UNI Login

2024-01-04T11:20:43Z

Kia: /* Errors = InstitutionPerson ikke indlæst! CPR er skiftet i databasen og skal skiftes i XML-data: */

UNI•Login er et digitalt ID for børn, unge og ansatte på institutioner, som giver adgang til nationale tjenester og en lang række pædagogiske services og online læremidler. UNI•Login kan bruges både til gratis webtjenester og til webtjenester, som institutionerne kan abonnere på. Institutionerne benytter ofte UNI•Login til adgangsstyring på lokalnet, intranet, trådløse net, skytjenester og andre webløsninger, hvor brugerne skal sikres nem adgang. UNI-Login leveres af STIL, Styrelsen for IT og Læring, der tidligere hed Uni-C.

==Prerequisites==

===Supported administrative systems===
Alle

===Module requirements===
[[UMS]]

===Should third party be contacted===
Kræver en adgang til WS17 ved STIL som skal bestilles.

https://viden.stil.dk/display/STILVIDENOFFENTLIG/Tilslutning#expand-Sdanopretterduentilslutningsaftale

OLD LINK (http://www.stil.dk/It-og-administration/Brugere-og-adgangsstyring/Udbyder-UNILogin/UNI-Login-Eksport)

==UNI-C Dataprovider==
Sender UNI-Login’s til STIL

For at sende disse data til STIL skal man aktiverer servicen '''UNILogin Upload'''. Se mere her [[Configurator/Services]]

Når det er indtastet vil servicen hvert 5 minut se efter om der er kommet en ny students tabel og sende nye data til STIL.

Når man har indtastet navnet og gemt skal man starte servicen "'''UMS UNILogin Upload'''" eller genstarte serveren.

Sættes op på den enkelte template under UNI-C noden
[[File:STIL Account setting.jpg|none|thumb|485x485px]]

===Account settings===
Her bestemmes hvor man vil sende brugerne fra den pågældende template hen.

===Institution number===
Det institutions nummer hvor data skal sendes hen.

===Upload UNI Logins to STIL===
Tells UMS that all templates using this setting will be uploaded to STIL. This will create/add users to the institution number.

===Create new UNI login when CPR changes===
When a CPR changes UMS will tell STIL that it has to create a new UNI login.

If this checkbox is not checked, then you must manually change the UNI Login at https://ba.emu.dk at the same time you change it in the administrative system.

===Access group===
Members of this Active Directory group will have access to this account in UMS Web.

The module is called STIL Settings and can be found under the Control Panel in UMS Web.

===Write back webservice pincode===
Bruges til kommunikation med elevplan hvis fraværs beskeder skal sendes til dem

===Elevplan Institution number===
Det elevplans institutions nummer hvor data skal sendes hen.

===Elevplan keyord===
SMS keyword som UMS reagerer på når det sendes ind til UMS gateway. Når det står først i Sms’en vil den blive sendt videre til elevplan. Man vil modtage en SMS fra elevplan om at den er modtaget hvis ikke man får den indenfor 30 minutter, skal man gensende Sms’en.

===Company mail address for employees===
Det bruges når der laves en upload af data til STIL til unilogin generering (UNILogin Upload). Man kan bestemme den adresse man har ved uddannelses institutionen. Bruges f.eks. til SDBF systemet.

===Company mail address for students===
Det bruges når der laves en upload af data til STIL til unilogin generering (UNILogin Upload). Man kan bestemme den adresse man har ved uddannelses institutionen.

===Mail===
Lister felterne fra students tabellen hvis man lader den stå i <Not Used> vil den automatisk bruge brugernavnet som man har i AD.

===Mail Domain===
Her indtaster man f.eks. inlogic.dk

Hvis ikke man vælger at indtaste noget i feltet mail domain men kun sætter mail feltet vil mail feltet skulle indeholde hele mail adressen.

==UNI-Login Settings==
[[File:Stiluniloginsettings.png|none|thumb|569x569px]]

===Use UNI-Login===
Her sættes der op om denne template skal bruge UNI-Login

===Force update UNI-Login===
Hvis man ændrer UNI-Login skal det så slå igennem i UMS. Dette vil betyde at brugeren bliver nedlagt og en ny oprettet.

==Upload af data==
For at kunne uploade data som sendes til STIL skal man have et Onlinetjeneste-abonnement. Informationer om dette kan findes her.

http://www.stil.dk/It-og-administration/Brugere-og-adgangsstyring/Udbyder-UNILogin/Onlinetjenester

For at bestille skal man sende en mail til [[Mailto:uniloginudbyder@STIL.dk| uniloginudbyder@STIL.dk]] med teksten og bestillingsformularen.

===Bestillingsformular===
Vi vil gerne have en konto som har adgang til WS10 upload og WS17 download af UNI-Logins. inLogic løsning.
Oplysninger
IP:
Institutions numre:
Dette findes under Modules -> UNI-Sync
[[File:STIL UNISync setup.jpg|none|thumb|368x368px]]

===Activate UNI-Sync===
Skal vi sende/hente data fra STIL

===Institution numbers===
Indtast hvilke institutions numre der skal hentes fra

===Data provider settings (Onlinetjeneste-abonnement)===
Indstillinger som skal bruges til WS10 (Sende data) og WS17 (hente data)

http://www.stil.dk/~/media/STIL/Filer/PDF13_14/140521%20UNI%20Login%20Import%20WS10%20v31.pdf

http://www.stil.dk/~/media/STIL/Filer/Publikationer/Tekniske%20vejledninger/UNI-ogin%20Eksport%20WS17%20v1.3.pdf

===Username===
Username need to access webservice.

===Password===
Password need to access webservice.

==Opsætning på brugeradministrationen==
For at kunne hente fra STIL og sende data til STIL skal man give lov til det. Det sætter man op i <nowiki>https://ba.emu.dk</nowiki>

En vejledning for opsætningen af WS17 kan findes her.

<nowiki>http://www.stil.dk/~/media/STIL/Filer/PDF15/150714%2017ws%20afsend%20og%20godkend%20Dataforspoergsel%20til%20skoler.pdf</nowiki>

UMS vil hente alle WS10

===Pakke===
Man skal som minimum have adgang til en fuld eller mellem pakke. Specifikationerne for de enkelte pakker kan ses nedenunder.

Dataaftale for UNI-Login Eksport

(UNI-Login webservice ws17)

Udbydere med ws17 dataadgang kan trække nedenstående information afhængigt af den valgte pakke.
{| class="wikitable"
| colspan="8" | - Den fulde pakke: Alle data i skemaet - markeret F

- Mellem pakken: Data i skemaet, som er markeret M

- Den lille pakke: Data i skemaet, som er markeret L

Data om ansatte, elever, værger og andre kontaktpersoner
|-
| colspan="3" | - CPR-nummer
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Fornavn(e)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Efternavn
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Privatadresse (Se adresseinformation)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Hjemmetelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Arbejdstelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Mobiltelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - E-mail
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Fødselsdag
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Køn
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - PhotoId
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Adresseinformation:
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Om adressen er beskyttet
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Adressens vejnavn, nr. og etage
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Postnummer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - By
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Landekode
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Land
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kommunekode
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kommunenavn
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Telefonnummer-information:
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Om telefonnummeret er beskyttet
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Telefonnummer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Supplerende data om elever
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Studietype (elev eller stud)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Studienummer
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Elevens niveau (for grundskoleelever)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Elevens hovedgruppe (klasse)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Yderligere grupper elever er tilknyttet
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Kontaktlærer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kontaktperson(er)s relation (mor, far osv.)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Om kontaktperson(er) har forældremyndighed
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Afdeling, bygning eller værelsesnummer på efterskoler
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - ID i det lokale studieadministrative system
| colspan="2" |F
| colspan="2" |M
|L
|}
{| class="wikitable"
|Supplerende data om ansatte
|
|
|
|-
|<nowiki>- Ansættelsestype (lærer, tap, pæd eller gæst)</nowiki>
|F
|M
|L
|-
|<nowiki>- Initialer</nowiki>
|F
|M
|L
|-
|<nowiki>- Stilling</nowiki>
|F
|M
|L
|-
|<nowiki>- Afdeling, bygning eller værelsesnummer på efterskoler</nowiki>
|F
|M
|L
|-
|<nowiki>- Grupper medarbejderen er tilknyttet</nowiki>
|F
|M
|L
|-
|<nowiki>- ID i det lokale studieadministrative system</nowiki>
|F
|M
|
|-
|
|
|
|
|-
|Data om UNI-Login for ansatte og elever
|
|
|
|-
|<nowiki>- UNI-Login brugernavn (brugerID)</nowiki>
|F
|M
|L
|-
|<nowiki>- Initialpassword</nowiki>
|F
|M
|
|-
|<nowiki>- Om inititalpassword er gældende password</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens navn i UNI-Login</nowiki>
|F
|M
|
|-
|<nowiki>- SkoleKom-navn</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens selvvalgte email-adresse i UNI-Login</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens selvvalgte mobilnummer i UNI-Login</nowiki>
|F
|M
|
|-
|
|
|
|
|-
|Data om grupper på institutionen
|
|
|
|-
|<nowiki>- Gruppeid</nowiki>
|F
|M
|L
|-
|<nowiki>- Gruppenavn</nowiki>
|F
|M
|L
|-
|<nowiki>- Gruppetype</nowiki>
|F
|M
|L
|-
|<nowiki>- Niveau</nowiki>
|F
|M
|L
|-
|<nowiki>- Spor</nowiki>
|F
|M
|L
|-
|<nowiki>- Startdato</nowiki>
|F
|M
|L
|-
|<nowiki>- Slutdato</nowiki>
|F
|M
|L
|}

==FAQ==

===Hvordan checker jeg om min IP er åbnet hos STIL?===
Man kan teste adgangen via denne url:

<nowiki>https://ws04.infotjeneste.uni-c.dk/infotjenesteunilogin-ws/ws?WSDL</nowiki>

Den skulle gerne returnere et xml. Dokument – hvis i får en Access denied, så er der ikke åbnet for jeres IP.

===Hvilke CPR numre sendes til STIL (Gammel ordning)===
Alle rigtige CPR numre

Alle Fiktive CPR numre begyndende med 6,7,8 eller 9 og som overholder modulus 11

===Hvilke CPR numre bliver ikke sendt til STIL (Gammel ordning)===
Alle CPR numre som ikke overholder modulus 11

Alle CPR numre som indeholder bogstaver

===Hvilke CPR numre sendes til STIL (Ny ordning)===
Numerisk værdi der overholder modulus 11

Hvis cpr numre indeholder bogstaver opretter UMS Uni-login på baggrund af SLI id.

===Hvis man skifter CPR nummer beholder man så sit UNI Login===
Ja

===Må der kører andre importer end den fra inLogic===
Nej, det vil ødelægge automatikken med at beholde sit unilogin hvis man skifter CPR.

===Kan man få generet UNI-Login’s med det samme===
Ikke helt, men næsten.

Det kræver 2 kørsler af GetStudents med en upload af data imellem (UNILogin Upload servicen skal have kørt). Inden man kører anden kørsel af GetStudents skal STIL have haft nok tid til at lægge data fra deres back end miljø ud til de webservice’s hvor man henter data. En tommel finger regel kunne være 20-30 minutter.

===Skal Easy-C jobs slåes fra (C001 og C002)===
Ja de må ikke køre sammen med vores

===Skal LUDUS jobs slåes fra===
Ja kun upload man kan stadig download til ludus

===InstitutionPerson ikke indlæst! Ikke forventet CPR til localPersonID - skal omidentificeres: LocalPersonId====
Read this [[STIL UNI Login#Create new UNI login when CPR changes]] 

===Errors = Fejl 8: Gruppen blev sat til en anden GroupType end Hovedgruppe===
Errors = Fejl 8: Gruppen blev sat til en anden GroupType end Hovedgruppe, men der findes 1 Student med gruppen som MainGroupId fra en anden importkilde! Fjern f.rst alle elever fra hovedgruppen i den anden kilde: GroupId=20amu006

Fejlen rettes ved at sikre at der ikke køres nogen andre imports end fra UMS. Derefter skal man rydde op i manuelt tilknyttede brugere som stadig har denne gruppe som stamklasse.

 

===Initial user password.===
It is not possible to change the initial password in the STIL/UNi-C Administrative website.

'''Find Unilogin på bruger i SQL UniSync.'''

select * from UniSync

where CivilRegistrationNumber =' '

 

===Errors Duplicate unique value = double space in name===
(UploadToUniSync) Error uploading XML. Institution number = 661015 - Username = ws661015 - Password = xYhrNhixLQSg Errors = org.xml.sax.SAXParseException; Duplicate unique value '''[Ekstra mat for..r 2022 (2hf)'''] declared for identity constraint of element "Institution".

UMS.UMSException: org.xml.sax.SAXParseException; Duplicate unique value [Ekstra mat for..r 2022 (2hf)] declared for identity constraint of element "Institution". at UNILogin_Upload.Worker.UploadWS10_Net5(XmlImport Institution) at UNILogin_Upload.Worker.UploadToUniSync(CancellationToken stoppingToken)

=== Errors = InstitutionPerson ikke indlæst! CPR er skiftet i databasen og skal skiftes i XML-data: ===
CPR has been changed at STIL but not in the administrative system.

=== Upload for only 1 institution to STIL ===
Run UNILogin_Upload from commandline with this parameter

UNILogin_Upload <Institution number>

=== Upload empty to STIL ===
Run UNILogin_Upload from commandline with these parameters

UNILogin_Upload <Institution number> <Empty>

STIL UNI Login

2024-01-04T10:15:56Z

Kia: /* Bestillingsformular */

File:STIL UNISync setup.jpg

2024-01-04T10:12:02Z

Kia: Kia uploaded a new version of File:STIL UNISync setup.jpg

STIL UNISync setup

STIL UNI Login

2024-01-04T10:10:36Z

Kia: /* Username */

STIL UNI Login

2024-01-04T10:10:15Z

Kia: /* Password synchronization (UNI-Sync abonnement) */

UNI•Login er et digitalt ID for børn, unge og ansatte på institutioner, som giver adgang til nationale tjenester og en lang række pædagogiske services og online læremidler. UNI•Login kan bruges både til gratis webtjenester og til webtjenester, som institutionerne kan abonnere på. Institutionerne benytter ofte UNI•Login til adgangsstyring på lokalnet, intranet, trådløse net, skytjenester og andre webløsninger, hvor brugerne skal sikres nem adgang. UNI-Login leveres af STIL, Styrelsen for IT og Læring, der tidligere hed Uni-C.

==Prerequisites==

===Supported administrative systems===
Alle

===Module requirements===
[[UMS]]

===Should third party be contacted===
Kræver en adgang til WS17 ved STIL som skal bestilles.

https://viden.stil.dk/display/STILVIDENOFFENTLIG/Tilslutning#expand-Sdanopretterduentilslutningsaftale

OLD LINK (http://www.stil.dk/It-og-administration/Brugere-og-adgangsstyring/Udbyder-UNILogin/UNI-Login-Eksport)

==UNI-C Dataprovider==
Sender UNI-Login’s til STIL

For at sende disse data til STIL skal man aktiverer servicen '''UNILogin Upload'''. Se mere her [[Configurator/Services]]

Når det er indtastet vil servicen hvert 5 minut se efter om der er kommet en ny students tabel og sende nye data til STIL.

Når man har indtastet navnet og gemt skal man starte servicen "'''UMS UNILogin Upload'''" eller genstarte serveren.

Sættes op på den enkelte template under UNI-C noden
[[File:STIL Account setting.jpg|none|thumb|485x485px]]

===Account settings===
Her bestemmes hvor man vil sende brugerne fra den pågældende template hen.

===Institution number===
Det institutions nummer hvor data skal sendes hen.

===Upload UNI Logins to STIL===
Tells UMS that all templates using this setting will be uploaded to STIL. This will create/add users to the institution number.

===Create new UNI login when CPR changes===
When a CPR changes UMS will tell STIL that it has to create a new UNI login.

If this checkbox is not checked, then you must manually change the UNI Login at https://ba.emu.dk at the same time you change it in the administrative system.

===Access group===
Members of this Active Directory group will have access to this account in UMS Web.

The module is called STIL Settings and can be found under the Control Panel in UMS Web.

===Write back webservice pincode===
Bruges til kommunikation med elevplan hvis fraværs beskeder skal sendes til dem

===Elevplan Institution number===
Det elevplans institutions nummer hvor data skal sendes hen.

===Elevplan keyord===
SMS keyword som UMS reagerer på når det sendes ind til UMS gateway. Når det står først i Sms’en vil den blive sendt videre til elevplan. Man vil modtage en SMS fra elevplan om at den er modtaget hvis ikke man får den indenfor 30 minutter, skal man gensende Sms’en.

===Company mail address for employees===
Det bruges når der laves en upload af data til STIL til unilogin generering (UNILogin Upload). Man kan bestemme den adresse man har ved uddannelses institutionen. Bruges f.eks. til SDBF systemet.

===Company mail address for students===
Det bruges når der laves en upload af data til STIL til unilogin generering (UNILogin Upload). Man kan bestemme den adresse man har ved uddannelses institutionen.

===Mail===
Lister felterne fra students tabellen hvis man lader den stå i <Not Used> vil den automatisk bruge brugernavnet som man har i AD.

===Mail Domain===
Her indtaster man f.eks. inlogic.dk

Hvis ikke man vælger at indtaste noget i feltet mail domain men kun sætter mail feltet vil mail feltet skulle indeholde hele mail adressen.

==UNI-Login Settings==
[[File:Stiluniloginsettings.png|none|thumb|569x569px]]

===Use UNI-Login===
Her sættes der op om denne template skal bruge UNI-Login

===Force update UNI-Login===
Hvis man ændrer UNI-Login skal det så slå igennem i UMS. Dette vil betyde at brugeren bliver nedlagt og en ny oprettet.

==Upload af data==
For at kunne uploade data som sendes til STIL skal man have et Onlinetjeneste-abonnement. Informationer om dette kan findes her.

http://www.stil.dk/It-og-administration/Brugere-og-adgangsstyring/Udbyder-UNILogin/Onlinetjenester

For at bestille skal man sende en mail til [[Mailto:uniloginudbyder@STIL.dk| uniloginudbyder@STIL.dk]] med teksten og bestillingsformularen.

===Bestillingsformular===
Vi vil gerne have en konto som har adgang til WS10 upload og WS17 download af UNI-Logins. inLogic løsning.
Oplysninger
IP:
Institutions numre:
Dette findes under Modules -> UNI-Sync
[[File:STIL UNISync setup.jpg|none|thumb|368x368px]]

===Activate UNI-Sync===
Skal vi sende/hente data fra STIL

===Institution numbers===
Indtast hvilke institutions numre der skal hentes fra

===Data provider settings (Onlinetjeneste-abonnement)===
Indstillinger som skal bruges til WS10 (Sende data) og WS17 (hente data)

http://www.stil.dk/~/media/STIL/Filer/PDF13_14/140521%20UNI%20Login%20Import%20WS10%20v31.pdf

http://www.stil.dk/~/media/STIL/Filer/Publikationer/Tekniske%20vejledninger/UNI-ogin%20Eksport%20WS17%20v1.3.pdf

===Username===
Username need to access webservice.

===Password===
Password need to access webservice.

===Username===
Username need to access webservice.

===Password===
Password need to access webservice.

==Opsætning på brugeradministrationen==
For at kunne hente fra STIL og sende data til STIL skal man give lov til det. Det sætter man op i <nowiki>https://ba.emu.dk</nowiki>

En vejledning for opsætningen af WS17 kan findes her.

<nowiki>http://www.stil.dk/~/media/STIL/Filer/PDF15/150714%2017ws%20afsend%20og%20godkend%20Dataforspoergsel%20til%20skoler.pdf</nowiki>

UMS vil hente alle WS10

===Pakke===
Man skal som minimum have adgang til en fuld eller mellem pakke. Specifikationerne for de enkelte pakker kan ses nedenunder.

Dataaftale for UNI-Login Eksport

(UNI-Login webservice ws17)

Udbydere med ws17 dataadgang kan trække nedenstående information afhængigt af den valgte pakke.
{| class="wikitable"
| colspan="8" | - Den fulde pakke: Alle data i skemaet - markeret F

- Mellem pakken: Data i skemaet, som er markeret M

- Den lille pakke: Data i skemaet, som er markeret L

Data om ansatte, elever, værger og andre kontaktpersoner
|-
| colspan="3" | - CPR-nummer
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Fornavn(e)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Efternavn
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Privatadresse (Se adresseinformation)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Hjemmetelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Arbejdstelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Mobiltelefon (Se telefonnummer-information)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - E-mail
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Fødselsdag
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - Køn
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" | - PhotoId
| colspan="2" |F
| colspan="2" |M
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Adresseinformation:
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Om adressen er beskyttet
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Adressens vejnavn, nr. og etage
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Postnummer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - By
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Landekode
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Land
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kommunekode
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kommunenavn
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Telefonnummer-information:
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Om telefonnummeret er beskyttet
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Telefonnummer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" |Supplerende data om elever
| colspan="2" |
| colspan="2" |
|
|-
| colspan="3" | - Studietype (elev eller stud)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Studienummer
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Elevens niveau (for grundskoleelever)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Elevens hovedgruppe (klasse)
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Yderligere grupper elever er tilknyttet
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - Kontaktlærer
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Kontaktperson(er)s relation (mor, far osv.)
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Om kontaktperson(er) har forældremyndighed
| colspan="2" |F
| colspan="2" |
|
|-
| colspan="3" | - Afdeling, bygning eller værelsesnummer på efterskoler
| colspan="2" |F
| colspan="2" |M
|L
|-
| colspan="3" | - ID i det lokale studieadministrative system
| colspan="2" |F
| colspan="2" |M
|L
|}
{| class="wikitable"
|Supplerende data om ansatte
|
|
|
|-
|<nowiki>- Ansættelsestype (lærer, tap, pæd eller gæst)</nowiki>
|F
|M
|L
|-
|<nowiki>- Initialer</nowiki>
|F
|M
|L
|-
|<nowiki>- Stilling</nowiki>
|F
|M
|L
|-
|<nowiki>- Afdeling, bygning eller værelsesnummer på efterskoler</nowiki>
|F
|M
|L
|-
|<nowiki>- Grupper medarbejderen er tilknyttet</nowiki>
|F
|M
|L
|-
|<nowiki>- ID i det lokale studieadministrative system</nowiki>
|F
|M
|
|-
|
|
|
|
|-
|Data om UNI-Login for ansatte og elever
|
|
|
|-
|<nowiki>- UNI-Login brugernavn (brugerID)</nowiki>
|F
|M
|L
|-
|<nowiki>- Initialpassword</nowiki>
|F
|M
|
|-
|<nowiki>- Om inititalpassword er gældende password</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens navn i UNI-Login</nowiki>
|F
|M
|
|-
|<nowiki>- SkoleKom-navn</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens selvvalgte email-adresse i UNI-Login</nowiki>
|F
|M
|
|-
|<nowiki>- Brugerens selvvalgte mobilnummer i UNI-Login</nowiki>
|F
|M
|
|-
|
|
|
|
|-
|Data om grupper på institutionen
|
|
|
|-
|<nowiki>- Gruppeid</nowiki>
|F
|M
|L
|-
|<nowiki>- Gruppenavn</nowiki>
|F
|M
|L
|-
|<nowiki>- Gruppetype</nowiki>
|F
|M
|L
|-
|<nowiki>- Niveau</nowiki>
|F
|M
|L
|-
|<nowiki>- Spor</nowiki>
|F
|M
|L
|-
|<nowiki>- Startdato</nowiki>
|F
|M
|L
|-
|<nowiki>- Slutdato</nowiki>
|F
|M
|L
|}

==FAQ==

===Hvordan checker jeg om min IP er åbnet hos STIL?===
Man kan teste adgangen via denne url:

<nowiki>https://ws04.infotjeneste.uni-c.dk/infotjenesteunilogin-ws/ws?WSDL</nowiki>

Den skulle gerne returnere et xml. Dokument – hvis i får en Access denied, så er der ikke åbnet for jeres IP.

===Hvilke CPR numre sendes til STIL (Gammel ordning)===
Alle rigtige CPR numre

Alle Fiktive CPR numre begyndende med 6,7,8 eller 9 og som overholder modulus 11

===Hvilke CPR numre bliver ikke sendt til STIL (Gammel ordning)===
Alle CPR numre som ikke overholder modulus 11

Alle CPR numre som indeholder bogstaver

===Hvilke CPR numre sendes til STIL (Ny ordning)===
Numerisk værdi der overholder modulus 11

Hvis cpr numre indeholder bogstaver opretter UMS Uni-login på baggrund af SLI id.

===Hvis man skifter CPR nummer beholder man så sit UNI Login===
Ja

===Må der kører andre importer end den fra inLogic===
Nej, det vil ødelægge automatikken med at beholde sit unilogin hvis man skifter CPR.

===Kan man få generet UNI-Login’s med det samme===
Ikke helt, men næsten.

Det kræver 2 kørsler af GetStudents med en upload af data imellem (UNILogin Upload servicen skal have kørt). Inden man kører anden kørsel af GetStudents skal STIL have haft nok tid til at lægge data fra deres back end miljø ud til de webservice’s hvor man henter data. En tommel finger regel kunne være 20-30 minutter.

===Skal Easy-C jobs slåes fra (C001 og C002)===
Ja de må ikke køre sammen med vores

===Skal LUDUS jobs slåes fra===
Ja kun upload man kan stadig download til ludus

===InstitutionPerson ikke indlæst! Ikke forventet CPR til localPersonID - skal omidentificeres: LocalPersonId====
Read this [[STIL UNI Login#Create new UNI login when CPR changes]] 

===Errors = Fejl 8: Gruppen blev sat til en anden GroupType end Hovedgruppe===
Errors = Fejl 8: Gruppen blev sat til en anden GroupType end Hovedgruppe, men der findes 1 Student med gruppen som MainGroupId fra en anden importkilde! Fjern f.rst alle elever fra hovedgruppen i den anden kilde: GroupId=20amu006

Fejlen rettes ved at sikre at der ikke køres nogen andre imports end fra UMS. Derefter skal man rydde op i manuelt tilknyttede brugere som stadig har denne gruppe som stamklasse.

 

===Initial user password.===
It is not possible to change the initial password in the STIL/UNi-C Administrative website.

'''Find Unilogin på bruger i SQL UniSync.'''

select * from UniSync

where CivilRegistrationNumber =' '

 

===Errors Duplicate unique value = double space in name===
(UploadToUniSync) Error uploading XML. Institution number = 661015 - Username = ws661015 - Password = xYhrNhixLQSg Errors = org.xml.sax.SAXParseException; Duplicate unique value '''[Ekstra mat for..r 2022 (2hf)'''] declared for identity constraint of element "Institution".

UMS.UMSException: org.xml.sax.SAXParseException; Duplicate unique value [Ekstra mat for..r 2022 (2hf)] declared for identity constraint of element "Institution". at UNILogin_Upload.Worker.UploadWS10_Net5(XmlImport Institution) at UNILogin_Upload.Worker.UploadToUniSync(CancellationToken stoppingToken)

=== Errors = InstitutionPerson ikke indlæst! CPR er skiftet i databasen og skal skiftes i XML-data: ===
CPR has been changed at STIL but not in the administrative system.

Powersave

2023-10-19T07:38:14Z

Kia:

Automatically reduces your electricity expenses. Power Save reduces the school’s electricity expenses and CO2- emissions, without influencing the school’s service to students and staff. Power Save can automatically turn off computers, which have not been used in a while. You decide which computers Power Save is allowed to turn off and when. It is possible to use different settings for different departments. By customising the settings, you can avoid that students and staff, who work on the school’s computers and sign off to have lunch, loose their work because the computer switches off.

== Prerequisites ==

=== Supported administrative systems ===
All

=== Module requirements ===
[[UMS]]

[[UMS Academic Web]]

=== Testing after setup ===
Make sure the UMS Server are able to ping the computers you want to turn off.

Setup a job to turn off one or more computers and verify they do turn off.

=== What to have ready ===
Active Directory

WMI port on all computers that needs to be turn off (tcp 135, tcp 4168, udp 9256)

== Installation ==

== Technical settings ==

== FAQ ==

Powersave

2023-10-19T07:37:55Z

Kia:

[[File:Kia.jpg|none|thumb|300x300px]]
Automatically reduces your electricity expenses. Power Save reduces the school’s electricity expenses and CO2- emissions, without influencing the school’s service to students and staff. Power Save can automatically turn off computers, which have not been used in a while. You decide which computers Power Save is allowed to turn off and when. It is possible to use different settings for different departments. By customising the settings, you can avoid that students and staff, who work on the school’s computers and sign off to have lunch, loose their work because the computer switches off.

== Prerequisites ==

=== Supported administrative systems ===
All

=== Module requirements ===
[[UMS]]

[[UMS Academic Web]]

=== Testing after setup ===
Make sure the UMS Server are able to ping the computers you want to turn off.

Setup a job to turn off one or more computers and verify they do turn off.

=== What to have ready ===
Active Directory

WMI port on all computers that needs to be turn off (tcp 135, tcp 4168, udp 9256)

== Installation ==

== Technical settings ==

== FAQ ==

Powersave

2023-10-19T07:34:54Z

Kia:

Powersave

2023-10-19T07:34:38Z

Kia:

Automatically reduces your electricity expenses. Power Save reduces the school’s electricity expenses and CO2- emissions, without influencing the school’s service to students and staff. Power Save can automatically turn off computers, which have not been used in a while. You decide which computers Power Save is allowed to turn off and when. It is possible to use different settings for different departments. By customising the settings, you can avoid that students and staff, who work on the school’s computers and sign off to have lunch, loose their work because the computer switches off.

== Prerequisites ==

=== Supported administrative systems ===
All

=== Module requirements ===
[[UMS]]

[[UMS Academic Web]]

=== Testing after setup ===
Make sure the UMS Server aree able to ping the computers you want to turn off.

Setup a job to turn off one or more computers and verify they do turn off.

=== What to have ready ===
Active Directory

WMI port on all computers that needs to be turn off (tcp 135, tcp 4168, udp 9256)

== Installation ==

== Technical settings ==

== FAQ ==

Username Generator

2023-09-14T12:55:36Z

Kia: /* Replace all non alphanumeric */

This is used to generate usernames for users in UMS.

==Steps==
First you need to create some options for the setting your going to create later on.

Then add the database replacements.

Then create a setting with a list of prioritized options.

Finally add a username setting to the template that needs this.

==Options==

====AddString====
This option lets you add a fixed string to the username
[[File:UsernameGenerator Options AddString.jpg|none|thumb|765x765px]]

===== Append =====
Append string to end.

=====Start index=====
This lets you specify the position in the string to insert "'''String to add'''". "'''String to add'''" will be appended if start index is larger than the length of the string.

====AutoNumber====
This option lets you add a number to the username.
[[File:UsernameGenerator Options AutoNumber.jpg|none|frame]]

You can define the starting number and pad left to make sure it has the correct length.

If you set the start number to 1 and set pad left to 4, the number will be 0001

If you check "'''Skip number on first occurence'''" it will not add the generated number string to the first username.

This number will automatically increase when a duplicate string is found in username.

'''eg - If the username starts with AB then it will return AB0001'''

'''AB0001 (first instance autonumber)'''

'''AC0001 (first instance autonumber)'''

'''AD0001 (first instance autonumber)'''

'''AB0002 (next instance autonumber)'''

The username number is stored in the database in the table "UsernameGenerator_Numbers"

====DBField====
This option lets you take a field from the database table ImportFromDB and use as a starting string.
[[File:UsernameGenerator Options DBField.jpg|none|thumb|656x656px]]

====LowerCase====
This lowercases the username.
[[File:UsernameGenerator Options LowerCase.jpg|none|thumb|656x656px]]

====Pad====
This lets you pad the username either left or right with a character you specify and a length.
[[File:UsernameGenerator Options Pad.jpg|none|thumb|656x656px]]
If you pad 12 right and the username is AB it will return ABkkkkkkkkkk.

====Replace====
This lets you replace characters in the username with new characters or blank.
[[File:UsernameGenerator Options Replace.jpg|none|thumb|656x656px]]

If you check "Use replace from database table" it will use this feature "Database replacements".
[[File:UsernameGenerator Options DBReplace.jpg|none|thumb|656x656px]]
 

====Replace all non alphanumeric====
This will replace all characters in the username that are not within these ranges with the new string or blank

a-z

A-Z

0-9

-

.
[[File:UsernameGenerator Options ReplaceAllNonAlphanumeric.jpg|none|thumb|765x765px]]

====Substring====
This will replace a part of the username with a new string or blank.
[[File:UsernameGenerator Options SubString.jpg|none|thumb|656x656px]]
====Uppercase====
This uppercases the username.
[[File:UsernameGenerator Options UpperCase.jpg|none|thumb|656x656px]]

====Add random string of chars====
This option lets you add a fixed string to the username
[[File:UsernameGenerator Options AddRandomChars.jpg|none|frame]]

===== Characters to use from =====
Enter the characters to choose from when generating the string

===== Number of Characters =====
Choose the length of string

===== Append =====
Append string to end.

=====Start index=====
This lets you specify the position in the string to insert "'''String to add'''". "'''String to add'''" will be appended if start index is larger than the length of the string.

==== UniLogin ====
[[File:UsernameGenerator Options UniLogin.jpg|none|frame]]The value of UniLogin/UniID is only used if its 8 characters long.

The options added after this is in the setting will not be processed if it is 8 charaters long.

If the user does not have a UniLogin/UniID they will not get a username in UMS.

If UniLogin is found for user UMS will not check in SLI table for an existing username.

'''Pseudo logic'''

If <unilogin> is null -> Stop processing this user

If <unilogin> is 8 characters long, take <unilogin> as username and stop processing any other rules.

if <unilogin> is 10 characters long, does nothing with <unilogin> and start username generator logic

==Database replacements==
Define the strings you want to have replace with new or blank string.
[[File:UsernameGenerator Database replacements.jpg|none|thumb|492x492px]]
When it looks at a username it will run through all the rows and replace them if they are found.

 

==Example as uni-login==

===2 first letters of first name followed by 2 first letters of last name and Autonumber.===

===Create these Option:===

*First name: Create option that retrieves first name from DBfield
*Last Name : Create option that retrieves last name from DBfield
*AutoNumber : Create option autonumber. As shown below in Autonumber picture
*DB Replace: Create option DB replace, which change å, ø, å etc. As shown below in DB Replacement picture.
*First 2 characters : Create option take first 2 characters. As shown below in first 2 characters picture.
*First 4 characters : Create option take first 4 characters. As shown below in first 4 characters picture.
*Pad Right 2: Create option Pad Right 2. As shown below in Pad Right 2 picture.
*Pad Right 4: Create option Pad Right 4. As shown below in Pad Right 4 picture.
*Replace all non alphanumeric
*LowerCase ALL

Vicktor Jeppesen : VIJE0123

Tonny Thomsen : TOTH0124

Sultan Kirkegård SUKI0125

Autonumber starts at 123 and runs up. Padding character 0 and pad length 4. e.g. Sultan Kirkegård S U K I 0 1 2 3
[[File:Skærmbillede 2022-07-06 090457.png|none|thumb|489x489px]]

DB Replacement.
[[File:Replacement.png|none|thumb|491x491px]]

First 2 characters.
[[File:First2chara.png|none|thumb|491x491px]]

First 4 characters
[[File:First4.png|none|thumb|495x495px]]
Pad right 2 (J Hansen) Username = JFHA
[[File:Imagesdf.png|none|thumb|514x514px]]

Pad Right 4 (Jan H) Username = JAHF
[[File:Sds.png|none|thumb|520x520px]]

==Settings==
This is where you create a prioritized list options. This setting is then attached to a template.
[[File:UsernameGenerator Settings.jpg|none|thumb|383x383px]]

MSGraphPermissions

2023-08-08T07:29:12Z

Kia: /* Creating App Registration */

'''MS graph permissions are required by these UMS modules'''

*'''LiveAtEdu'''
*'''OneNote'''
*'''SharePoint'''
*'''Office 365 Time blocks'''
*'''MS Teams'''

==Creating App Registration==
Go to [http://portal.azure.com Azure Portal] and login with you admin account.

When logged in go to Azure Active Directory:[[File:Graph1.jpg|left|thumb|832x832px]]

Go to App registrations
[[File:Graph2.jpg|none|thumb|831x831px]]

Click on New application registration
[[File:Graph3.jpg|none|thumb|909x909px]]

Give the new App a name ex. "UMSGraph", Choose "Web app / API" in Application type, set "Sign-on URL" to "http://localhost". After setting Application Permission values click "Create"
[[File:Graph43.jpg|none|thumb|913x913px]]

You will return to previous screen, here click "your new app"
[[File:Grahp5.jpg|none|thumb|905x905px]]

Click "Certificates & secrets"

Click "New Client Secret"

Enter a "Description" and set "Expires" to the interval that suits your needs.

Click "Add"
[[File:Graph6.jpg|none|thumb|908x908px]]

Copy "Value ID" We will use this later

'''!!! ATTENTION !!! the key value will never be visible again so ensure to copy it.''' [[File:Graph7.png|none|thumb|790x790px]]

Copy the "VALUE Key into "UMS Configurator" field Client Secret

[[File:Tewxddf.png|frameless|566x566px]]

Copy the "Directory Tenant ID " into "UMS Configurator" Field Tenant ID

Copy the "Appplication Client ID " into "UMS Configurator" Field Client ID
[[File:Id.jpg|none|thumb|1120x1120px]]

Click "Api permissions"

Click "Add a permission"
[[File:Graph8.png|none|thumb|780x780px]]

==Setup SharePoint, OneNote Class Notebook or Onedrive provisioning==
'''You do not need to fill out the settings in UMS (This was done in the above text) when using OneDrive provisioning.''' Only the "Add SharePoint App permissions" chapter.

In the UMS Configurator go to Modules->Office 365 and click "SharePoint organization settings"
[[File:UMSConfiguratorSharepointOrganizationSettings.png|none|thumb|600x600px]]
Choose your SharePoint organization setting and click "Edit..."
[[File:UMSConfiguratorSharepointOrganizationSettingsEdit.png|none|thumb|600x600px]]
Input your "Tenant Name" ex. "cortenso'''.onmicrosoft.com'''", insert Application ID into "Client ID" field, insert "Client secret" and "Tenant ID" and click "Ok"
[[File:SharepointOrganization SettingsEdit.jpg|none|thumb|585x585px]]

===Add SharePoint App permissions===

*Go to https://'''<tenantname>'''-admin.sharepoint.com/_layouts/15/appinv.aspx
*Enter app Id (AKA Client Id) and press lookup.
*Copy paste the below text in Permission Request XML and save

<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
<AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
</AppPermissionRequests>

[[File:SharePoint Organization Settings App permission.jpg|none|thumb|389x389px|Enter anything you like into Title]]

====Open newest installed Powershell on the server running the program====
'''Minimum requirement is Powershell 5'''
#Enable TLS 1.2 for Powershell commands
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

$NugetPackageProvider = Get-PackageProvider -ListAvailable -Name NuGet -ErrorAction SilentlyContinue
if (!$NugetPackageProvider) {Install-PackageProvider -Name NuGet -Scope AllUsers -Force}

Install-Module -Name Microsoft.Online.SharePoint.PowerShell -Force
Import-Module Microsoft.Online.SharePoint.PowerShell
Connect-SPOService -Url https://'''<tenantname>'''-admin.sharepoint.com
Set-SPOTenant -DisableCustomAppAuthentication $false

===Remove SharePoint App permissions===
If you want to remove existing app permission use this link. Maybe you are not using the module anymore.
https://'''<tenantname>'''-admin.sharepoint.com/_layouts/15/TA_AllAppPrincipals.aspx

==Permissions overview==

===Microsoft Graph===
{| class="wikitable sortable"
|+Default permissions
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|User.ReadWrite.All
|Application
|Microsoft Graph
|Setting attributes on the user in Office 365
|Live_at_edu.exe
|-
|Group.ReadWrite.All
|Application
|Microsoft Graph
|Setting group attributes on Office 365 groups
|Live_at_edu.exe
|-
|GroupMember.ReadWrite.All
|Application
|Microsoft Graph
|Manage GroupMembers in Office 365
|Live_at_edu.exe
|-
|Directory.ReadWrite.All
|Application
|Microsoft Graph
|Setting attributes on the user in Azure Active Directory
|Live_at_edu.exe
|-
|MailboxSettings.ReadWrite
|Application
|Microsoft Graph
|Used to set mailbox settings in Office 365.
Used to get/create categories
|Live_at_edu.exe
Skemabrikker.exe
|-
|Calendars.ReadWrite
|Application
|Microsoft Graph
|Used to allow UMS to sync calendar events to Office 365
|Skemabrikker.exe
|-
|Files.ReadWrite.All
|Application
|Microsoft Graph
|Used to provision OneDrive for users
|Live_at_edu.exe
|}

===Teams sync permissions===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|EduRoster.ReadWrite.All
|Application
|Microsoft Graph
|Allows the UMS to handle users on roster
|Live_at_edu.exe
|-
|Member.Read.Hidden
|Application
|Microsoft Graph
|Allows the UMS to handle users on roster
|Live_at_edu.exe
|-
|TeamMember.ReadWrite.All
|Application
|Microsoft Graph
|Used to add or remove users from Team
|Live_at_edu.exe
|-
|TeamsTab.ReadWrite.All
|Application
|Microsoft Graph
|Used to create tabs in teams
|Live_at_edu.exe
|-
|TeamsAppInstallation.ReadForTeam.All
|Application
|Microsoft Graph
|Used to install app in teams
|Live_at_edu.exe
|-
|Team.Create
|Application
|Microsoft Graph
|Used to create Teams
|Live_at_edu.exe
|-
|Team.ReadBasic.All
|Application
|Microsoft Graph
|Used to read teams
|Live_at_edu.exe
|}

===Change Password when using Azure AD as login===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Directory.AccessAsUser.All
|Delegated
|Microsoft Graph
|
|UMS Web
|-
|User.Read
|Delegated
|Microsoft Graph
|
|UMS Web
|}
See also [[Password Change Azure AD]]

===Password Sync===
{| class="wikitable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Roles and Administrators
|Application
|Microsoft Graph
|Reset password for Users
|Password_Sync
|}

===SharePoint===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Sites.FullControl.All
|Application
|Microsoft Graph
|Have full control of all site collections
|Office365_SP_OneNote.exe
|-
|User.ReadWrite.All
|Application
|Microsoft Graph
|Read and write user profiles
|Office365_SP_OneNote.exe
|}

===OneNote===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Notes.ReadWrite.All
|Application
|Microsoft Graph
|
|Office365_SP_OneNote.exe
|} 
===Password Administrator===

To Add Password administrator roles. Click '''Roles and administrator'''
[[File:Passwordd.png|thumb|1167x1167px|none]]

*Click Add Assignments and Search for App Registrations name and Click Add.

[[File:Password1.png|1167x1167px|thumb|none]]
 

==FAQ :==
If you get this message when trying to reset password in Office365 using MS Graph Api. This is because user is global Admin and therefore MS graph can not Reset password
[[File:Passwordsync.png|none|thumb|1245x1245px]]

AdminServers/KMDStudica

2023-06-22T11:03:14Z

Kia: /* FAQ */

[[File:AdminServer KMD Studica.jpg|none|thumb|656x656px]]

====API Key====
API key to access the webservice.

====Client ID====
Client ID to access the webservice.

====Client secret====
Client secret to access the webservice.

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
Employees
!Admin system
!UMS
!Remarks
|-
|Employee ID
|UMS_IDFromAdministrativeSystem
|
|-
|Employee ID
|IDFromAdministrativeSystem
|
|-
|GivenName
|Fornavn
|
|-
|Surname
|EFTERNAVN
|
|-
|Initials
|StudieNr
|
|-
|CivilRegistrationNumber
|CPR
|
|-
|AdUsername
|AlternativID
|
|-
|ProtectedGivenName
|PublicRegisteredFirstName
|
|-
|ProtectedSurname
|PublicRegisteredSurName
|
|-
|Email
|WorkMail
|
|-
|PhoneNumber
|WorkPhoneNumber
|
|-
|MobileNumber
|MobilePhone
|
|-
|MobileNumber
|WorkMobilePhone
|
|-
|PrivatePhoneNumber
|PrivateMobilePhone
|
|-
|JobTitle
|Employee_Description
|
|-
|Department ID
|DepartmentID
|
|-
|Department Name
|Department
|
|-
|AddressLine
|Adresse
|
|-
|PostalCode
|PostNummer
|
|-
|Place
|Sted
|
|-
|CareOfAddressLine
|COAddress
|
|-
|ProtectedNameAndAddress
|SecretAddress
|
|-
|Department ID
|AktivitetsID
|
|-
|Department Name
|Aktivitet
|
|-
|Department Name
|ActivityDisplayName
|
|-
|Department Name
|ActivityDescription
|
|-
|Department Name
|Kort_Betegnelse
|
|-
|EmploymentStartDate
|StartDato
|If department start date is after employment start date then department start date is used if not then employment start date is used
|-
|EmploymentResignationDate
|SlutDato
|If department end date is before employment resignation date then department end date is used if not then employment resignation date is used
|-
|Department ValidFrom
|Aktiviteter_StartDato
|
|-
|Department ValidTo
|Aktiviteter_SlutDato
|
|-
|EmploymentStartDate
|Employement_StartDate
|
|-
|EmploymentResignationDate
|Employement_EndDate
|
|-
|AreasOfResponsibility.Name
|Education_ResponsibilityAreaName
|Used by EducationalProgrammes
|-
|School code
|ExtraField1
|
|}
{| class="wikitable"
|+
Students
!Admin system
!UMS
!Remarks
|-
|Students ID
|UMS_IDFromAdministrativeSystem
|
|-
|Students ID
|IDFromAdministrativeSystem
|
|-
|GivenName
|Fornavn
|
|-
|Surname
|EFTERNAVN
|
|-
|CivilRegistrationNumber
|CPR
|
|-
|AdUsername
|StudieNr
|
|-
|ProtectedGivenName
|PublicRegisteredFirstName
|
|-
|ProtectedSurname
|PublicRegisteredSurName
|
|-
|Email
|PrivateMail
|
|-
|PhoneNumber
|PrivateMobilePhone
|
|-
|PhoneNumber
|MobilePhone
|
|-
|StudyStartDate
|StudyStart_Education
|
|-
|StudyEndDate
|StudyEnd_Education
|
|-
|StudyExpectedCompletionDate
|Expected_EducationEndDate
|
|-
|Department ID
|DepartmentID
|
|-
|Department Name
|Department
|
|-
|AddressLine
|Adresse
|
|-
|PostalCode
|PostNummer
|
|-
|Place
|Sted
|
|-
|CareOfAddressLine
|COAddress
|
|-
|ProtectedNameAndAddress
|SecretAddress
|
|-
|DepartmentEducation ID
|EducationDepartmentID
|
|-
|DepartmentEducation Name
|EducationDepartmentname
|
|-
|Student Studies EducationId
|EducationID
|
|-
|Student Studies EducationName
|Education
|
|-
|Student Studies EducationVersion
|EducationVersion
|
|-
|Student Studies Coesa
|COSA_FORMAL
|
|-
|Student Studies DsDepartmentNumber
|Skolekode
|
|-
|Guardian information
|Guardian information
|This is copied to the guardian fields in UMS
|-
|EducationId
|Activity_EducationID
|From education on EducationalProgrammes
|-
|EducationCoesaNumber
|Activity_Education
|From education on EducationalProgrammes
|-
|EducationVersion
|Activity_EducationVersion
|From education on EducationalProgrammes
|-
|EducationName
|Activity_EducationDescription
|From education on EducationalProgrammes
|-
|Name
|Activity_EducationDescriptionShort
|From education on EducationalProgrammes
|-
|School code
|ExtraField1
|
|}
{| class="wikitable"
|+Extra fields when extracting students with rowtype Student
!Admin system
!UMS
!Remarks
|-
|SubjectCourse ID
|AktivitetsID
|
|-
|SubjectCourse Designation
|Aktivitet
|
|-
|SubjectCourse Designation
|ActivityDisplayName
|
|-
|SubjectCourse Name
|ActivityDescription
|
|-
|SubjectCourse Designation
|Kort_Betegnelse
|
|-
|SubjectCourse LmsIndicator
|Aktivitet_LMS
|
|-
|Subject Course Enrollment StartDate
|StartDato
|
|-
|Subject Course Enrollment EndDate
|SlutDato
|
|-
|SubjectCourse StartDate
|Aktiviteter_StartDato
|
|-
|SubjectCourse EndDate
|Aktiviteter_SlutDato
|
|-
|UVM Course ID
|Course_ID
|
|-
|UVM Course Subject
|Skolefag
|
|-
|UVM Course Description
|Skolefag_Betegnelse
|
|-
|UVM Course Level
|CourseLevel
|If Level is a - then Null is written to UMS
|-
|
|SkoleFag_LMS
|Is set to true if there is a UVM course connected
|}
{| class="wikitable"
|+Extra fields when extracting students with rowtype EducationProgram
!Admin system
!UMS
!Remarks
|-
|EducationalProgrammes ID
|AktivitetsID
|
|-
|EducationalProgrammes Designation
|Aktivitet
|
|-
|EducationalProgrammes Designation
|ActivityDisplayName
|
|-
|EducationalProgrammes Name
|ActivityDescription
|
|-
|EducationalProgrammes Designation
|Kort_Betegnelse
|
|-
|
|Aktivitet_LMS
|True
|-
|EducationalProgrammes StartDate
|StartDato
|
|-
|EducationalProgrammes EndDate
|SlutDato
|
|-
|EducationalProgrammes StartDate
|Aktiviteter_StartDato
|
|-
|EducationalProgrammes EndDate
|Aktiviteter_SlutDato
|
|}

===Template criteria mapping===
{| class="wikitable"
|+Employees
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Institutions kode
|School Code
|
|
|-
|Afdelings navn
|Department
|
|
|-
|Ansvarsområde
|Responsibility area
|
|
|}
{| class="wikitable"
|+Students
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Institutions kode
|SchoolCode
|
|
|-
|Afdelings navn
|Department
|
|
|-
|Uddannelses kode
|COSA_FORMAL
|
|
|-
|Uddannelsesforløbs kode
|ActivityDisplayName
|
|
|-
|Ansvarsområde
|Education_ResponsibilityAreaName
|
|
|-
|Uddannelsesområde (udennalsesforløb)
|Activity_Education
|
|
|-
|Uddannelses navn
|Education
|
|Student and Bridging student differs
|}

==FAQ==

===What is needed for students to be extracted===
They need CPR number and an active Educational program

===What is needed for employees to be extracted===
They need CPR number

GetUsers/SIS

2023-06-21T08:52:51Z

Kia: /* Field mappings */

[[File:GetUsers SIS.jpg|none|thumb|656x656px]]

===Field to use as username===
Choose a field from the administrative system to use as username in UMS.

===Export Student notes===
Export students notes from SIS.

===[[GetUsers/ExportPictureSettings|Export picture settings]]===

===[[GetUsers/Export Settings|Export settings]]===

==Field mappings==
{| class="wikitable"
|+Employees
!SIS table
!SIS column
!UMS Table
!UMS column
|-
|Medarbejdere
|FORNAVN
|Students
|ForNavne
|-
|Medarbejdere
|EFTERNAVN
|Students
|EFTERNAVN
|-
|Medarbejdere
|CPR_NUMMER
|Students
|CPR
|-
|Medarbejdere
|EKSTERN_STILLINGSBETEGNELSE
|Students
|Employee_Description
|-
|Medarbejdere
|Gade
|Students
|Adresse
|-
|Medarbejdere
|StedNavn
|Students
|Sted
|-
|Medarbejdere
|FIRMA_OPLYSNINGER
|Students
|Employee_company_info
|-
|Medarbejdere
|FOLKEREGISTERNAVN
|Students
|PublicRegisteredFirstName
|-
|Medarbejdere
|FOLKEREGISTERNAVN
|Students
|PublicRegisteredSurName
|-
|Medarbejdere
|Meda_ID_Leder
|Students
|Manager_ID
|-
|Medarbejdere
|Initialer
|Students
|IDFromAdministrativeSystem
|-
|ANSETTELSESFORHOLD
|FORNAVN
|Students
|PrimaryEmployment
|-
|ANSETTELSESFORHOLD
|BESKRIVELSE
|Students
|Employee_JobEmployment_Description
|-
|ANSETTELSESFORHOLD
|LOBENUMMER
|Students
|EmploymentNumber
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_FRA
|Students
|STARTDATO
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_TIL
|Students
|SLUTDATO
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_FRA
|Students
|Aktiviteter_StartDato
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_TIL
|Students
|Aktiviteter_SlutDato
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|AFSPADSERINGSTILLEG
|Students
|ExtraWorkTimeCredit
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|EasyEmployeeAfdelingsKode
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|Aktivitet
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|ActivityDisplayName
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSNAVN
|Students
|AFDELINGSNAVN
|-
|AFDELINGER_FOR_MEDARBEJDERE
|KORTNAVN
|Students
|KORT_BETEGNELSE
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFME_ID
|Students
|DepartmentID
|-
|AFDELINGER_FOR_MEDARBEJDERE
|STEDNAVN
|Students
|EmployeeDepartmentPlace
|-
|AFDELINGER_FOR_MEDARBEJDERE
|Gade
|Students
|EmployeeDepartmentStreet
|-
|PostNr
|PostNr
|Students
|PostNummer
|-
|PostNr
|PostDistrikt
|Students
|City
|-
|PostNr
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|PostNr
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|Kontakter
|KODE_NR
|Students
|KontaktKode
|-
|Kontakter
|KOMMENTAR
|Students
|KontaktKommentar
|-
|Kontakter
|KONT_TYPE
|Students
|KontaktType
|-
|ANSVARSOMRADER
|KORT_BETEGNELSE
|Students
|Employee_JobResponsibility_ShortDescription
|-
|ANSVARSOMRADER
|BETEGNELSE
|Students
|Employee_JobResponsibility_Description
|-
|ANSVARSOMRADER
|ANSVARSOMRADE
|Students
|Employee_ResponsibilityArea
|-
|MEDARBEJDERTYPER
|MEDARBEJDERTYPE
|Students
|Employee_Type
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|ElevAfdelingsKode
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|Skolekode
|-
|INSTITUTIONER
|Navn
|Students
|AktivitetsAfdeling
|-
|Lokaler
|LokaleNr
|Students
|Employee_Office_Number
|-
|Lokaler
|LokaleNavn
|Students
|Employee_Office_Description
|-
|Lokaler
|Kort_Betegnelse
|Students
|Employee_Office_ShortDescription
|-
|AKTIVITETSGRUPPER
|GRUPPE
|Students
|ActivityDepartmentNumber
|-
|AKTIVITETSGRUPPER
|BETEGNELSE
|Students
|ActivityDepartmentName
|-
|AKTIVITETSGRUPPER
|KORT_BETEGNELSE
|Students
|ActivityDepartmentNameShort
|-
|ARBEJDSTIDSAFTALER
|KODE
|Students
|Employee_Worktime_code
|-
|ARBEJDSTIDSAFTALER
|BETEGNELSE
|Students
|Employee_Worktime_description
|-
|ARBEJDSTIDSAFTALER
|KORT_BETEGNELSE
|Students
|Employee_Worktime_short_description
|-
|MEDARBEJDERNOTER
|NOTETEKST
|Students
|Employee_Note
|-
|MEDARBEJDERNOTETYPER
|KODE
|Students
|Employee_NoteType
|-
|MEDARBEJDERNOTETYPER
|BETEGNELSE
|Students
|Employee_NoteTypeDescription
|-
|MEDARBEJDERNOTETYPER
|KORT_BETEGNELSE
|Students
|Employee_NoteTypeShortDescription
|-
|KONTOOPLYSNINGER
|StartDato
|Students
|AccountingStartDate
|-
|KONTOOPLYSNINGER
|SlutDato
|Students
|AccountingEndDate
|-
|KONTOOPLYSNINGER
|FINANSKONTO
|Students
|FinanceAccount
|-
|KONTOOPLYSNINGER
|FORMALSKONTO
|Students
|PurposeAccount
|-
|KONTOOPLYSNINGER
|ANSVARSKONTO
|Students
|ResponsebilityAccount
|-
|KONTOOPLYSNINGER
|PROJEKTKONTO
|Students
|ProjectAccount
|-
|KONTOOPLYSNINGER
|Dim5
|Students
|ExtraField5
|-
|KONTOOPLYSNINGER
|Dim6
|Students
|ExtraField6
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|GYLDIG_FRA
|Students
|SCL_STARTDATO
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|GYLDIG_TIL
|Students
|SCL_SLUTDATO
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|OSE_ANSVAR
|Students
|OSE_ANSVAR
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|DELLONSTELLER
|Students
|Employee_Part_salary_counter
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|DELLONSNEVNER
|Students
|Employee_Part_salary_denominator
|-
|SCL_STILLINGSKODER
|STILLINGSKODE
|Students
|Employee_Description_Number
|-
|SCL_STILLINGSKODER
|BETEGNELSE
|Students
|Employee_Description2
|-
|SCL_PERSONALEKATEGORIER
|PERSONALEKATEGORI
|Students
|Employee_Category_Number
|-
|SCL_PERSONALEKATEGORIER
|BETEGNELSE
|Students
|Employee_Category
|-
|Medarbejdere
|ALT_Gade
|Students
|AlternativeStreet
|-
|Medarbejdere
|ALT_STEDNAVN
|Students
|AlternativeAddress_Place
|-
|Medarbejdere
|ALT_ADRESSAT
|Students
|AlternativeAddress
|}
{| class="wikitable"
|+Students
!SIS table
!SIS column
!UMS Table
!UMS column
|-
|Personer
|ADR_PA_UDSKRIFT
|Students
|SecretAddress
|-
|Personer
|FORNAVN_VERGE
|Students
|Guardian1Name
|-
|Personer
|EFTERNAVN_VERGE
|Students
|Guardian1SurName
|-
|Personer
|TELEFON_VERGE
|Students
|Guardian1PhoneNumber
|-
|Personer
|ALTERNATIVT_ID
|Students
|AlternativID
|-
|Personer
|Gade
|Students
|Adresse
|-
|Personer
|Sted
|Students
|Sted
|-
|Personer
|Pers_ID
|Students
|UMS_IDFromAdministrativeSystem
|-
|GRUPPERINGSKODER
|GRUPPERINGSKODE
|Students
|ActivityType
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|AE_REKVIRENT
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|ElevAfdelingsKode
|-
|INSTITUTIONER
|Navn
|Students
|AfdelingsNavn
|-
|INSTITUTIONER
|Adresse
|Students
|EmployeeDepartmentStreet
|-
|INSTITUTIONER
|STEDNAVN
|Students
|EmployeeDepartmentPlace
|-
|INSTITUTIONER
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|INSTITUTIONER
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|Skolekode
|-
|INSTITUTIONSKODE
|INSTITUTIONSKODE
|Students
|ActivityDepartmentNumber
|-
|elever
|IndmeldelsesDato
|Students
|EnrollmentDate
|-
|elever
|FORNAVN
|Students
|ForNavne
|-
|elever
|EFTERNAVN
|Students
|EFTERNAVN
|-
|elever
|AFGANGSDATO
|Students
|AFGANGSDATO
|-
|elever
|CPR_NR
|Students
|CPR
|-
|elever
|StudieNummer
|Students
|SISStudieNr
|-
|elever
|ELEV_ID
|Students
|AlternateAdminSystem_ID
|-
|elever
|Pers_ID
|Students
|StudieNr
|-
|elever
|StudieNummer
|Students
|IDFromAdministrativeSystem
|-
|elever
|Pers_ID
|Students
|IDFromAdministrativeSystem
|-
|elever
|StudieNummer
|Students
|StudieNr
|-
|elever
|studiestart_pa_afd
|Students
|StudyStart_Department
|-
|elever
|studiestart_pa_institutionen
|Students
|StudyStart_Education
|-
|elever
|FORVENTET_AFSLUTNINGSTIDSPUNKT
|Students
|Expected_EducationEndDate
|-
|STUDIESTARTER
|FORVENTET_AFSLUTNINGSTIDSPUNKT
|Students
|Expected_EducationEndDate
|-
|UDDANNELSER
|Version
|Students
|EducationVersion
|-
|UDDANNELSER
|UDDA_ID
|Students
|EducationID
|-
|UDDANNELSER
|Betegnelse
|Students
|Education
|-
|UDDANNELSER
|Betegnelse
|Students
|EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|EducationDescriptionShort
|-
|UDDANNELSER
|UDDA_ID
|Students
|Activity_EducationID
|-
|UDDANNELSER
|Betegnelse
|Students
|Activity_EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|Activity_EducationDescShort
|-
|COSA_FORMAL
|COSA_FORMAL
|Students
|COSA_FORMAL
|-
|COSA_FORMAL
|Betegnelse
|Students
|Betegnelse
|-
|COSA_FORMAL
|COSA_FORMAL
|Students
|Activity_Education
|-
|HOLDPLACERINGER
|STARTDATO
|Students
|STARTDATO
|-
|HOLDPLACERINGER
|SLUTDATO
|Students
|SLUTDATO
|-
|AKTIVITETER
|Akti_ID
|Students
|AktivitetsID
|-
|AKTIVITETER
|AKTIVITET
|Students
|AKTIVITET
|-
|AKTIVITETER
|AKTIVITET
|Students
|ActivityDisplayName
|-
|AKTIVITETER
|BETEGNELSE
|Students
|ActivityDescription
|-
|AKTIVITETER
|KORT_BETEGNELSE
|Students
|KORT_BETEGNELSE
|-
|AKTIVITETER
|StartDato
|Students
|Aktiviteter_StartDato
|-
|AKTIVITETER
|SlutDato
|Students
|Aktiviteter_SlutDato
|-
|AKTIVITETER
|TREKNINGSTYPE
|Students
|Activity_PullType
|-
|AKTIVITETER
|Publicering
|Students
|Activity_PublicationCode
|-
|ANSVARSOMRADER
|ANSVARSOMRADE
|Students
|Employee_ResponsibilityArea
|-
|ANSVARSOMRADER
|KORT_BETEGNELSE
|Students
|Employee_JobResponsibility_ShortDescription
|-
|ANSVARSOMRADER
|BETEGNELSE
|Students
|Employee_JobResponsibility_Description
|-
|PROJEKTOMRADER
|POM_ID
|Students
|Activity_ProjectID
|-
|PROJEKTOMRADER
|PROJEKTOMRADE
|Students
|Activity_ProjectCode
|-
|PROJEKTOMRADER
|BETEGNELSE
|Students
|Activity_ProjectDescription
|-
|PROJEKTOMRADER
|KORT_BETEGNELSE
|Students
|Activity_ProjectDescriptionShort
|-
|PostNr
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|PostNr
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|PostNr
|PostNr
|Students
|PostNummer
|-
|PostNr
|PostDistrikt
|Students
|City
|-
|AKTIVITETSGRUPPER
|Gruppe
|Students
|AktivitetsAfdeling
|-
|AKTIVITETSGRUPPER
|BETEGNELSE
|Students
|ActivityDepartmentName
|-
|AKTIVITETSGRUPPER
|KORT_BETEGNELSE
|Students
|ActivityDepartmentNameShort
|-
|AKTIVITETER
|Akti_ID
|Students
|ParentActivityID
|-
|AKTIVITETER
|AKTIVITET
|Students
|ParentActivity
|-
|AKTIVITETER
|BETEGNELSE
|Students
|ParentActivityDescription
|-
|AKTIVITETER
|KORT_BETEGNELSE
|Students
|ParentActivityShortDescription
|-
|AKTIVITETER
|StartDato
|Students
|ParentActivity_StartDate
|-
|AKTIVITETER
|SlutDato
|Students
|ParentActivity_EndDate
|-
|Cosa_Formal
|COSA_FORMAL
|Students
|Activity_Education
|-
|UDDANNELSER
|UDDA_ID
|Students
|Activity_EducationID
|-
|UDDANNELSER
|BETEGNELSE
|Students
|Activity_EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|Activity_EducationDescShort
|-
|INDSKRIVNINGSFORMER
|INDSKRIVNINGSFORM
|Students
|RegistrationForm_Code
|-
|INDSKRIVNINGSFORMER
|BETEGNELSE
|Students
|RegistrationForm_Description
|-
|INDSKRIVNINGSFORMER
|KORT_BETEGNELSE
|Students
|RegistrationForm_Short_Description
|-
|AFGANGSARSAGER
|AFGANGSARSAG
|Students
|DepartureCauseCode
|-
|AFGANGSARSAGER
|BETEGNELSE
|Students
|DepartureCause_Description
|-
|AFGANGSARSAGER
|KORT_BETEGNELSE
|Students
|DepartureCause_Short_Description
|-
|OrlovsPerioder
|STARTDATO
|Students
|LeaveOfAbsenceStartDate
|-
|OrlovsPerioder
|SLUTDATO
|Students
|LeaveOfAbsenceEndDate
|-
|KONTOOPLYSNINGER
|StartDato
|Students
|Activity_AccountingStartDate
|-
|KONTOOPLYSNINGER
|SlutDato
|Students
|Activity_AccountingEndDate
|-
|KONTOOPLYSNINGER
|FINANSKONTO
|Students
|Activity_FinanceAccount
|-
|KONTOOPLYSNINGER
|FORMALSKONTO
|Students
|Activity_PurposeAccount
|-
|KONTOOPLYSNINGER
|ANSVARSKONTO
|Students
|Activity_ResponsebilityAccount
|-
|KONTOOPLYSNINGER
|PROJEKTKONTO
|Students
|Activity_ProjectAccount
|-
|KONTOOPLYSNINGER
|Dim5
|Students
|ExtraField5
|-
|KONTOOPLYSNINGER
|Dim6
|Students
|ExtraField6
|-
|MEDARBEJDERE
|CPR_NUMMER
|Students
|StudyCounselorSSN
|-
|MEDARBEJDERE
|FORNAVN
|Students
|StudyCounselor_Name
|-
|MEDARBEJDERE
|EFTERNAVN
|Students
|StudyCounselor_SurName
|-
|MEDARBEJDERE
|CPR_NUMMER
|Students
|Internship_CounselorSSN
|-
|MEDARBEJDERE
|FORNAVN
|Students
|Internship_ContactName
|-
|MEDARBEJDERE
|EFTERNAVN
|Students
|Internship_ContactSurName
|-
|SKOLEFAG
|SKFA_ID
|Students
|Course_ID
|-
|SKOLEFAG
|Skolefag
|Students
|Skolefag
|-
|SKOLEFAG
|Skolefag_Betegnelse
|Students
|Skolefag_Betegnelse
|-
|SKOLEFAG
|SkoleFag_Kort_Betegnelse
|Students
|SkoleFag_Kort_Betegnelse
|-
|SKOLEFAG
|NIVEAU
|Students
|CourseLevel
|-
|SKOLEFAG
|KOMMENTAR
|Students
|CourseComment
|-
|SKOLEFAG
|FAGTYPE
|Students
|CourseType
|-
|NOTER
|datering
|Students
|NoteDate
|-
|NOTER
|relevans
|Students
|NoteRelevans
|-
|NOTER
|tekst
|Students
|NoteText
|-
|NOTETYPER
|notetype
|Students
|NoteType
|-
|Kontakter
|Kont_Type
|Students
|Kont_Type
|-
|Kontakter
|KODE_NR
|Students
|PhoneNumber
|-
|Kontakter
|KODE_NR
|Students
|WorkPhoneNumber
|-
|Kontakter
|KODE_NR
|Students
|MobilePhone
|-
|Kontakter
|KODE_NR
|Students
|PrivateMobilePhone
|-
|Kontakter
|KODE_NR
|Students
|PrivateMail
|-
|Kontakter
|KODE_NR
|Students
|OtherInfo
|}

GetUsers/SIS

2023-06-21T08:52:15Z

Kia: /* Field mappings */

[[File:GetUsers SIS.jpg|none|thumb|656x656px]]

===Field to use as username===
Choose a field from the administrative system to use as username in UMS.

===Export Student notes===
Export students notes from SIS.

===[[GetUsers/ExportPictureSettings|Export picture settings]]===

===[[GetUsers/Export Settings|Export settings]]===

==Field mappings==
{| class="wikitable"
|+Employees
!SIS table
!SIS column
!UMS Table
!UMS column
|-
|Medarbejdere
|FORNAVN
|Students
|ForNavne
|-
|Medarbejdere
|EFTERNAVN
|Students
|EFTERNAVN
|-
|Medarbejdere
|CPR_NUMMER
|Students
|CPR
|-
|Medarbejdere
|EKSTERN_STILLINGSBETEGNELSE
|Students
|Employee_Description
|-
|Medarbejdere
|Gade
|Students
|Adresse
|-
|Medarbejdere
|StedNavn
|Students
|Sted
|-
|Medarbejdere
|FIRMA_OPLYSNINGER
|Students
|Employee_company_info
|-
|Medarbejdere
|FOLKEREGISTERNAVN
|Students
|PublicRegisteredFirstName
|-
|Medarbejdere
|FOLKEREGISTERNAVN
|Students
|PublicRegisteredSurName
|-
|Medarbejdere
|Meda_ID_Leder
|Students
|Manager_ID
|-
|Medarbejdere
|Initialer
|Students
|IDFromAdministrativeSystem
|-
|ANSETTELSESFORHOLD
|FORNAVN
|Students
|PrimaryEmployment
|-
|ANSETTELSESFORHOLD
|BESKRIVELSE
|Students
|Employee_JobEmployment_Description
|-
|ANSETTELSESFORHOLD
|LOBENUMMER
|Students
|EmploymentNumber
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_FRA
|Students
|STARTDATO
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_TIL
|Students
|SLUTDATO
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_FRA
|Students
|Aktiviteter_StartDato
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|GYLDIG_TIL
|Students
|Aktiviteter_SlutDato
|-
|ANSETTELSESFORHOLD_SKOLE_OPLYS
|AFSPADSERINGSTILLEG
|Students
|ExtraWorkTimeCredit
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|EasyEmployeeAfdelingsKode
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|Aktivitet
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSKODE
|Students
|ActivityDisplayName
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFDELINGSNAVN
|Students
|AFDELINGSNAVN
|-
|AFDELINGER_FOR_MEDARBEJDERE
|KORTNAVN
|Students
|KORT_BETEGNELSE
|-
|AFDELINGER_FOR_MEDARBEJDERE
|AFME_ID
|Students
|DepartmentID
|-
|AFDELINGER_FOR_MEDARBEJDERE
|STEDNAVN
|Students
|EmployeeDepartmentPlace
|-
|AFDELINGER_FOR_MEDARBEJDERE
|Gade
|Students
|EmployeeDepartmentStreet
|-
|PostNr
|PostNr
|Students
|PostNummer
|-
|PostNr
|PostDistrikt
|Students
|City
|-
|PostNr
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|PostNr
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|Kontakter
|KODE_NR
|Students
|KontaktKode
|-
|Kontakter
|KOMMENTAR
|Students
|KontaktKommentar
|-
|Kontakter
|KONT_TYPE
|Students
|KontaktType
|-
|ANSVARSOMRADER
|KORT_BETEGNELSE
|Students
|Employee_JobResponsibility_ShortDescription
|-
|ANSVARSOMRADER
|BETEGNELSE
|Students
|Employee_JobResponsibility_Description
|-
|ANSVARSOMRADER
|ANSVARSOMRADE
|Students
|Employee_ResponsibilityArea
|-
|MEDARBEJDERTYPER
|MEDARBEJDERTYPE
|Students
|Employee_Type
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|ElevAfdelingsKode
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|Skolekode
|-
|INSTITUTIONER
|Navn
|Students
|AktivitetsAfdeling
|-
|Lokaler
|LokaleNr
|Students
|Employee_Office_Number
|-
|Lokaler
|LokaleNavn
|Students
|Employee_Office_Description
|-
|Lokaler
|Kort_Betegnelse
|Students
|Employee_Office_ShortDescription
|-
|AKTIVITETSGRUPPER
|GRUPPE
|Students
|ActivityDepartmentNumber
|-
|AKTIVITETSGRUPPER
|BETEGNELSE
|Students
|ActivityDepartmentName
|-
|AKTIVITETSGRUPPER
|KORT_BETEGNELSE
|Students
|ActivityDepartmentNameShort
|-
|ARBEJDSTIDSAFTALER
|KODE
|Students
|Employee_Worktime_code
|-
|ARBEJDSTIDSAFTALER
|BETEGNELSE
|Students
|Employee_Worktime_description
|-
|ARBEJDSTIDSAFTALER
|KORT_BETEGNELSE
|Students
|Employee_Worktime_short_description
|-
|MEDARBEJDERNOTER
|NOTETEKST
|Students
|Employee_Note
|-
|MEDARBEJDERNOTETYPER
|KODE
|Students
|Employee_NoteType
|-
|MEDARBEJDERNOTETYPER
|BETEGNELSE
|Students
|Employee_NoteTypeDescription
|-
|MEDARBEJDERNOTETYPER
|KORT_BETEGNELSE
|Students
|Employee_NoteTypeShortDescription
|-
|KONTOOPLYSNINGER
|StartDato
|Students
|AccountingStartDate
|-
|KONTOOPLYSNINGER
|SlutDato
|Students
|AccountingEndDate
|-
|KONTOOPLYSNINGER
|FINANSKONTO
|Students
|FinanceAccount
|-
|KONTOOPLYSNINGER
|FORMALSKONTO
|Students
|PurposeAccount
|-
|KONTOOPLYSNINGER
|ANSVARSKONTO
|Students
|ResponsebilityAccount
|-
|KONTOOPLYSNINGER
|PROJEKTKONTO
|Students
|ProjectAccount
|-
|KONTOOPLYSNINGER
|Dim5
|Students
|ExtraField5
|-
|KONTOOPLYSNINGER
|Dim6
|Students
|ExtraField6
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|GYLDIG_FRA
|Students
|SCL_STARTDATO
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|GYLDIG_TIL
|Students
|SCL_SLUTDATO
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|OSE_ANSVAR
|Students
|OSE_ANSVAR
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|DELLONSTELLER
|Students
|Employee_Part_salary_counter
|-
|ANSETTELSESFORHOLD_SCL_OPLYSNI
|DELLONSNEVNER
|Students
|Employee_Part_salary_denominator
|-
|SCL_STILLINGSKODER
|STILLINGSKODE
|Students
|Employee_Description_Number
|-
|SCL_STILLINGSKODER
|BETEGNELSE
|Students
|Employee_Description2
|-
|SCL_PERSONALEKATEGORIER
|PERSONALEKATEGORI
|Students
|Employee_Category_Number
|-
|SCL_PERSONALEKATEGORIER
|BETEGNELSE
|Students
|Employee_Category
|-
|Medarbejdere
|ALT_Gade
|Students
|AlternativeStreet
|-
|Medarbejdere
|ALT_STEDNAVN
|Students
|AlternativeAddress_Place
|}
{| class="wikitable"
|+Students
!SIS table
!SIS column
!UMS Table
!UMS column
|-
|Personer
|ADR_PA_UDSKRIFT
|Students
|SecretAddress
|-
|Personer
|FORNAVN_VERGE
|Students
|Guardian1Name
|-
|Personer
|EFTERNAVN_VERGE
|Students
|Guardian1SurName
|-
|Personer
|TELEFON_VERGE
|Students
|Guardian1PhoneNumber
|-
|Personer
|ALTERNATIVT_ID
|Students
|AlternativID
|-
|Personer
|Gade
|Students
|Adresse
|-
|Personer
|Sted
|Students
|Sted
|-
|Personer
|Pers_ID
|Students
|UMS_IDFromAdministrativeSystem
|-
|GRUPPERINGSKODER
|GRUPPERINGSKODE
|Students
|ActivityType
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|AE_REKVIRENT
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|ElevAfdelingsKode
|-
|INSTITUTIONER
|Navn
|Students
|AfdelingsNavn
|-
|INSTITUTIONER
|Adresse
|Students
|EmployeeDepartmentStreet
|-
|INSTITUTIONER
|STEDNAVN
|Students
|EmployeeDepartmentPlace
|-
|INSTITUTIONER
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|INSTITUTIONER
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|INSTITUTIONER
|INSTITUTIONSKODE
|Students
|Skolekode
|-
|INSTITUTIONSKODE
|INSTITUTIONSKODE
|Students
|ActivityDepartmentNumber
|-
|elever
|IndmeldelsesDato
|Students
|EnrollmentDate
|-
|elever
|FORNAVN
|Students
|ForNavne
|-
|elever
|EFTERNAVN
|Students
|EFTERNAVN
|-
|elever
|AFGANGSDATO
|Students
|AFGANGSDATO
|-
|elever
|CPR_NR
|Students
|CPR
|-
|elever
|StudieNummer
|Students
|SISStudieNr
|-
|elever
|ELEV_ID
|Students
|AlternateAdminSystem_ID
|-
|elever
|Pers_ID
|Students
|StudieNr
|-
|elever
|StudieNummer
|Students
|IDFromAdministrativeSystem
|-
|elever
|Pers_ID
|Students
|IDFromAdministrativeSystem
|-
|elever
|StudieNummer
|Students
|StudieNr
|-
|elever
|studiestart_pa_afd
|Students
|StudyStart_Department
|-
|elever
|studiestart_pa_institutionen
|Students
|StudyStart_Education
|-
|elever
|FORVENTET_AFSLUTNINGSTIDSPUNKT
|Students
|Expected_EducationEndDate
|-
|STUDIESTARTER
|FORVENTET_AFSLUTNINGSTIDSPUNKT
|Students
|Expected_EducationEndDate
|-
|UDDANNELSER
|Version
|Students
|EducationVersion
|-
|UDDANNELSER
|UDDA_ID
|Students
|EducationID
|-
|UDDANNELSER
|Betegnelse
|Students
|Education
|-
|UDDANNELSER
|Betegnelse
|Students
|EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|EducationDescriptionShort
|-
|UDDANNELSER
|UDDA_ID
|Students
|Activity_EducationID
|-
|UDDANNELSER
|Betegnelse
|Students
|Activity_EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|Activity_EducationDescShort
|-
|COSA_FORMAL
|COSA_FORMAL
|Students
|COSA_FORMAL
|-
|COSA_FORMAL
|Betegnelse
|Students
|Betegnelse
|-
|COSA_FORMAL
|COSA_FORMAL
|Students
|Activity_Education
|-
|HOLDPLACERINGER
|STARTDATO
|Students
|STARTDATO
|-
|HOLDPLACERINGER
|SLUTDATO
|Students
|SLUTDATO
|-
|AKTIVITETER
|Akti_ID
|Students
|AktivitetsID
|-
|AKTIVITETER
|AKTIVITET
|Students
|AKTIVITET
|-
|AKTIVITETER
|AKTIVITET
|Students
|ActivityDisplayName
|-
|AKTIVITETER
|BETEGNELSE
|Students
|ActivityDescription
|-
|AKTIVITETER
|KORT_BETEGNELSE
|Students
|KORT_BETEGNELSE
|-
|AKTIVITETER
|StartDato
|Students
|Aktiviteter_StartDato
|-
|AKTIVITETER
|SlutDato
|Students
|Aktiviteter_SlutDato
|-
|AKTIVITETER
|TREKNINGSTYPE
|Students
|Activity_PullType
|-
|AKTIVITETER
|Publicering
|Students
|Activity_PublicationCode
|-
|ANSVARSOMRADER
|ANSVARSOMRADE
|Students
|Employee_ResponsibilityArea
|-
|ANSVARSOMRADER
|KORT_BETEGNELSE
|Students
|Employee_JobResponsibility_ShortDescription
|-
|ANSVARSOMRADER
|BETEGNELSE
|Students
|Employee_JobResponsibility_Description
|-
|PROJEKTOMRADER
|POM_ID
|Students
|Activity_ProjectID
|-
|PROJEKTOMRADER
|PROJEKTOMRADE
|Students
|Activity_ProjectCode
|-
|PROJEKTOMRADER
|BETEGNELSE
|Students
|Activity_ProjectDescription
|-
|PROJEKTOMRADER
|KORT_BETEGNELSE
|Students
|Activity_ProjectDescriptionShort
|-
|PostNr
|PostNr
|Students
|EmployeeDepartmentPostalCode
|-
|PostNr
|PostDistrikt
|Students
|EmployeeDepartmentCity
|-
|PostNr
|PostNr
|Students
|PostNummer
|-
|PostNr
|PostDistrikt
|Students
|City
|-
|AKTIVITETSGRUPPER
|Gruppe
|Students
|AktivitetsAfdeling
|-
|AKTIVITETSGRUPPER
|BETEGNELSE
|Students
|ActivityDepartmentName
|-
|AKTIVITETSGRUPPER
|KORT_BETEGNELSE
|Students
|ActivityDepartmentNameShort
|-
|AKTIVITETER
|Akti_ID
|Students
|ParentActivityID
|-
|AKTIVITETER
|AKTIVITET
|Students
|ParentActivity
|-
|AKTIVITETER
|BETEGNELSE
|Students
|ParentActivityDescription
|-
|AKTIVITETER
|KORT_BETEGNELSE
|Students
|ParentActivityShortDescription
|-
|AKTIVITETER
|StartDato
|Students
|ParentActivity_StartDate
|-
|AKTIVITETER
|SlutDato
|Students
|ParentActivity_EndDate
|-
|Cosa_Formal
|COSA_FORMAL
|Students
|Activity_Education
|-
|UDDANNELSER
|UDDA_ID
|Students
|Activity_EducationID
|-
|UDDANNELSER
|BETEGNELSE
|Students
|Activity_EducationDescription
|-
|UDDANNELSER
|Kort_Betegnelse
|Students
|Activity_EducationDescShort
|-
|INDSKRIVNINGSFORMER
|INDSKRIVNINGSFORM
|Students
|RegistrationForm_Code
|-
|INDSKRIVNINGSFORMER
|BETEGNELSE
|Students
|RegistrationForm_Description
|-
|INDSKRIVNINGSFORMER
|KORT_BETEGNELSE
|Students
|RegistrationForm_Short_Description
|-
|AFGANGSARSAGER
|AFGANGSARSAG
|Students
|DepartureCauseCode
|-
|AFGANGSARSAGER
|BETEGNELSE
|Students
|DepartureCause_Description
|-
|AFGANGSARSAGER
|KORT_BETEGNELSE
|Students
|DepartureCause_Short_Description
|-
|OrlovsPerioder
|STARTDATO
|Students
|LeaveOfAbsenceStartDate
|-
|OrlovsPerioder
|SLUTDATO
|Students
|LeaveOfAbsenceEndDate
|-
|KONTOOPLYSNINGER
|StartDato
|Students
|Activity_AccountingStartDate
|-
|KONTOOPLYSNINGER
|SlutDato
|Students
|Activity_AccountingEndDate
|-
|KONTOOPLYSNINGER
|FINANSKONTO
|Students
|Activity_FinanceAccount
|-
|KONTOOPLYSNINGER
|FORMALSKONTO
|Students
|Activity_PurposeAccount
|-
|KONTOOPLYSNINGER
|ANSVARSKONTO
|Students
|Activity_ResponsebilityAccount
|-
|KONTOOPLYSNINGER
|PROJEKTKONTO
|Students
|Activity_ProjectAccount
|-
|KONTOOPLYSNINGER
|Dim5
|Students
|ExtraField5
|-
|KONTOOPLYSNINGER
|Dim6
|Students
|ExtraField6
|-
|MEDARBEJDERE
|CPR_NUMMER
|Students
|StudyCounselorSSN
|-
|MEDARBEJDERE
|FORNAVN
|Students
|StudyCounselor_Name
|-
|MEDARBEJDERE
|EFTERNAVN
|Students
|StudyCounselor_SurName
|-
|MEDARBEJDERE
|CPR_NUMMER
|Students
|Internship_CounselorSSN
|-
|MEDARBEJDERE
|FORNAVN
|Students
|Internship_ContactName
|-
|MEDARBEJDERE
|EFTERNAVN
|Students
|Internship_ContactSurName
|-
|SKOLEFAG
|SKFA_ID
|Students
|Course_ID
|-
|SKOLEFAG
|Skolefag
|Students
|Skolefag
|-
|SKOLEFAG
|Skolefag_Betegnelse
|Students
|Skolefag_Betegnelse
|-
|SKOLEFAG
|SkoleFag_Kort_Betegnelse
|Students
|SkoleFag_Kort_Betegnelse
|-
|SKOLEFAG
|NIVEAU
|Students
|CourseLevel
|-
|SKOLEFAG
|KOMMENTAR
|Students
|CourseComment
|-
|SKOLEFAG
|FAGTYPE
|Students
|CourseType
|-
|NOTER
|datering
|Students
|NoteDate
|-
|NOTER
|relevans
|Students
|NoteRelevans
|-
|NOTER
|tekst
|Students
|NoteText
|-
|NOTETYPER
|notetype
|Students
|NoteType
|-
|Kontakter
|Kont_Type
|Students
|Kont_Type
|-
|Kontakter
|KODE_NR
|Students
|PhoneNumber
|-
|Kontakter
|KODE_NR
|Students
|WorkPhoneNumber
|-
|Kontakter
|KODE_NR
|Students
|MobilePhone
|-
|Kontakter
|KODE_NR
|Students
|PrivateMobilePhone
|-
|Kontakter
|KODE_NR
|Students
|PrivateMail
|-
|Kontakter
|KODE_NR
|Students
|OtherInfo
|}

TimeEditFields

2023-06-21T06:50:07Z

Kia: /* AbsenceRegistration */

==Metadata configuration==
{| class="wikitable"
|'''Important information'''

TimeEdit has a limit in the database, a maximum of 20 data fields on a timeblock can be returned. If you map too many metadata the integration will fail.
|}
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.

Create metadata configurations for (if needed)

*employees
*activities
*courses
*students
*groups

Students are predefined by UMS, no setup is needed.

Some fields are predefined for the metadata settings while other are required if you are extracting [[GetTimetable/TimeEdit|Timetable blocks]].

All fields are from the '''Students''' table.[[File:TimeEdit Settings Metadata.jpg|none|thumb|902x902px]]

===Key name===
The name of the field in TimeEdit.

===Static text before database field===
The text you write in this field will be suffixed to the UMS database field value.

===UMS database field===
The database field in the UMS table Students.

===Static text after database field===
The text you write in this field will be postfixed to the UMS database field value.

===Required===
UMS will not send the record to TimeEdit If this field is empty when it generates the data to send. This will also be logged in to TimeEdit.Log file.

==TimeEdit field information when uploading to TimeEdit==
'''Predefined fields''' are done by UMS and can not be changed and are not needed to enter into Configurator.

'''Required fields''' has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended.

All predefined and required fields has to be there for the extraction of [[GetTimetable/TimeEdit|Timetable blocks]] to work correctly.

All fields in TimeEdit are case sensitive.

===Students===
TimeEdit's extid for this object type is "student.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|StudieNr
|student.username
|Username for TimeEdit
|X
|-
|
|general.email
|UMS will fill this field with <Username@Students mail domain>
This can be overwritten by manual configuration.
|X
|} 
===Employees===
TimeEdit's extid for this object type is "teacher.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|
|general.email
|UMS will fill this field with <Username@Employee mail domain>
This can be overwritten by manual configuration.
|X
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
!Unique
|-
|
|person.init
|Username for TimeEdit
|X
|}
{| class="wikitable"
|+Best practice fields
!UMS
!TimeEdit
!Unique
|-
|MobilePhone
|general.phone
|
|-
|WorkMail
|general.email
|X
|}

====Example====
[[File:Map metadatafields Employees.png|none|thumb|915x915px]]

===Activity===
TimeEdit's extid for this object type is "studentclass.<Aktivitet>" unless "Use ActivityID" is set
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|studentclass.code
|X
|-
|Aktivitet
|studentclass.name
|
|-
|
|studentclass.no_of_students
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|ActivityDescription
|studentclass.longdescript
|Long description
|-
|Kort_Betegnelse
|studentclass.shortname
|Short description
|}

====Example====
[[File:Map metadatafields Activity.png|none|thumb|915x915px]]

===Courses===
TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet_Skolefag
|course.code
|X
|-
|Aktivitet_Skolefag
|course.name
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|SkoleFag_Kort_Betegnelse
|course.shortname
|Short description
|-
|SkoleFag_betegnelse
|course.LongDescript
|Long description
|}

====Example====
[[File:Map metadatafields Courses.png|none|thumb|916x916px]]

===Groups===
TimeEdit's extid for this object type is "group.<AktivitetsID>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|group.name
|X
|-
|
|group.number_of_members
|
|}
There are no required fields

==Required TimeEdit fields when extracting timetable blocks==

===Fields UMS uses when extracting timetable blocks.===
{| class="wikitable"
|+
!TimeEdit Name
!TimeEdit object type
!UMS object
!Description
|-
|studentclass
|Object
|Activity
|Used as activities that are class related
|-
|description
|Object
|Activity
|Used as activities that are not class related
|-
|description
|string
|Label
|This is a field on the reservation in TimeEdit
|-
|BlockType
|Object
|BlockType
|This is a field on the reservation in TimeEdit
|-
|location
|Object
|Room
|Room or location somewhere in the world
|-
|person
|Object
|Teacher or Student
|This can be a student or teacher
|-
|comment
|string
|Comment
|This is a field on the reservation in TimeEdit
|-
|AbsenceRegistration
|bit
|AbsenceRegistration
|This is a field on the reservation in TimeEdit
Allow this timetable block to be seen in UMS absence registration
|-
|Exam
|bit
|ExamEvent
|This is a field on the reservation in TimeEdit
Tells UMS that this is an exam event
|-
|teacher
|Object
|Teacher
|Needs to be created as person in TimeEdit
|-
|student
|Object
|Student
|Needs to be created as person in TimeEdit
|-
|group
|Object
|
|Can contain students or teachers
|-
|course
|Object
|Course
|Used as courses that are class related
|}

===studentclass===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|studentclass.code
|Activity
|
|-
|studentclass.name
|
|
|-
|studentclass.longdescript
|ActivityDescription
|
|-
|studentclass.shortname
|ActivityShortDescription
|
|}

===description (Object)===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|ActivityDescription
|X
|-
|activity.name
|Activity
|
|}

===Location===
This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.id
|Room ID
|X
|-
|general.id
|Room number
|
|-
|general.title
|Room name
|
|}

===person===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===teacher===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===student===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|}

===Course===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|course.code
|Course
|
|-
|course.name
|CourseDescription
|X
|-
|course.shortname
|CourseShortDescription
|
|-
|extid
|CourseID
|
|}

===Groups===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|Not used in UMS
|X
|-
|general.id
|Not used in UMS
|
|}Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.

===Timetable block===
These 2 fields must be set on the timetable block.

====AbsenceRegistration====
UMS supports Absence information from TimeEdit.

This is achieved by creating a True/False column on the timetable blocks called "'''AbsenceRegistration'''"

When set to True UMS will see the timetable block as [[Attendance Registration]] enabled.

==== Exam ====
This will mark the block as an exam event in UMS.

====Comment====
This will be put in the comment field in UMS

====All other fields====
All other fields on a reservation will be added to the comment field in UMS.

Except these to fields that are ignored "'''r.note'''" and "'''r.reservation_text_ref'''".

AdminServers/KMDStudica

2023-05-24T09:28:22Z

Kia: /* Data mapping */

[[File:AdminServer KMD Studica.jpg|none|thumb|656x656px]]

====API Key====
API key to access the webservice.

====Client ID====
Client ID to access the webservice.

====Client secret====
Client secret to access the webservice.

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
Employees
!Admin system
!UMS
!Remarks
|-
|Employee ID
|UMS_IDFromAdministrativeSystem
|
|-
|Employee ID
|IDFromAdministrativeSystem
|
|-
|GivenName
|Fornavn
|
|-
|Surname
|EFTERNAVN
|
|-
|Initials
|StudieNr
|
|-
|CivilRegistrationNumber
|CPR
|
|-
|AdUsername
|AlternativID
|
|-
|ProtectedGivenName
|PublicRegisteredFirstName
|
|-
|ProtectedSurname
|PublicRegisteredSurName
|
|-
|Email
|WorkMail
|
|-
|PhoneNumber
|WorkPhoneNumber
|
|-
|MobileNumber
|MobilePhone
|
|-
|MobileNumber
|WorkMobilePhone
|
|-
|PrivatePhoneNumber
|PrivateMobilePhone
|
|-
|JobTitle
|Employee_Description
|
|-
|Department ID
|DepartmentID
|
|-
|Department Name
|Department
|
|-
|AddressLine
|Adresse
|
|-
|PostalCode
|PostNummer
|
|-
|Place
|Sted
|
|-
|CareOfAddressLine
|COAddress
|
|-
|ProtectedNameAndAddress
|SecretAddress
|
|-
|Department ID
|AktivitetsID
|
|-
|Department Name
|Aktivitet
|
|-
|Department Name
|ActivityDisplayName
|
|-
|Department Name
|ActivityDescription
|
|-
|Department Name
|Kort_Betegnelse
|
|-
|EmploymentStartDate
|StartDato
|If department start date is after employment start date then department start date is used if not then employment start date is used
|-
|EmploymentResignationDate
|SlutDato
|If department end date is before employment resignation date then department end date is used if not then employment resignation date is used
|-
|Department ValidFrom
|Aktiviteter_StartDato
|
|-
|Department ValidTo
|Aktiviteter_SlutDato
|
|-
|EmploymentStartDate
|Employement_StartDate
|
|-
|EmploymentResignationDate
|Employement_EndDate
|
|-
|AreasOfResponsibility.Name
|Education_ResponsibilityAreaName
|Used by EducationalProgrammes
|-
|School code
|ExtraField1
|
|}
{| class="wikitable"
|+
Students
!Admin system
!UMS
!Remarks
|-
|Students ID
|UMS_IDFromAdministrativeSystem
|
|-
|Students ID
|IDFromAdministrativeSystem
|
|-
|GivenName
|Fornavn
|
|-
|Surname
|EFTERNAVN
|
|-
|CivilRegistrationNumber
|CPR
|
|-
|AdUsername
|StudieNr
|
|-
|ProtectedGivenName
|PublicRegisteredFirstName
|
|-
|ProtectedSurname
|PublicRegisteredSurName
|
|-
|Email
|PrivateMail
|
|-
|PhoneNumber
|PrivateMobilePhone
|
|-
|PhoneNumber
|MobilePhone
|
|-
|StudyStartDate
|StudyStart_Education
|
|-
|StudyEndDate
|StudyEnd_Education
|
|-
|StudyExpectedCompletionDate
|Expected_EducationEndDate
|
|-
|Department ID
|DepartmentID
|
|-
|Department Name
|Department
|
|-
|AddressLine
|Adresse
|
|-
|PostalCode
|PostNummer
|
|-
|Place
|Sted
|
|-
|CareOfAddressLine
|COAddress
|
|-
|ProtectedNameAndAddress
|SecretAddress
|
|-
|DepartmentEducation ID
|EducationDepartmentID
|
|-
|DepartmentEducation Name
|EducationDepartmentname
|
|-
|Student Studies EducationId
|EducationID
|
|-
|Student Studies EducationName
|Education
|
|-
|Student Studies EducationVersion
|EducationVersion
|
|-
|Student Studies Coesa
|COSA_FORMAL
|
|-
|Student Studies DsDepartmentNumber
|Skolekode
|
|-
|Guardian information
|Guardian information
|This is copied to the guardian fields in UMS
|-
|EducationId
|Activity_EducationID
|From education on EducationalProgrammes
|-
|EducationCoesaNumber
|Activity_Education
|From education on EducationalProgrammes
|-
|EducationVersion
|Activity_EducationVersion
|From education on EducationalProgrammes
|-
|EducationName
|Activity_EducationDescription
|From education on EducationalProgrammes
|-
|Name
|Activity_EducationDescriptionShort
|From education on EducationalProgrammes
|-
|School code
|ExtraField1
|
|}
{| class="wikitable"
|+Extra fields when extracting students with rowtype Student
!Admin system
!UMS
!Remarks
|-
|SubjectCourse ID
|AktivitetsID
|
|-
|SubjectCourse Designation
|Aktivitet
|
|-
|SubjectCourse Designation
|ActivityDisplayName
|
|-
|SubjectCourse Name
|ActivityDescription
|
|-
|SubjectCourse Designation
|Kort_Betegnelse
|
|-
|SubjectCourse LmsIndicator
|Aktivitet_LMS
|
|-
|Subject Course Enrollment StartDate
|StartDato
|
|-
|Subject Course Enrollment EndDate
|SlutDato
|
|-
|SubjectCourse StartDate
|Aktiviteter_StartDato
|
|-
|SubjectCourse EndDate
|Aktiviteter_SlutDato
|
|-
|UVM Course ID
|Course_ID
|
|-
|UVM Course Subject
|Skolefag
|
|-
|UVM Course Description
|Skolefag_Betegnelse
|
|-
|UVM Course Level
|CourseLevel
|If Level is a - then Null is written to UMS
|-
|
|SkoleFag_LMS
|Is set to true if there is a UVM course connected
|}
{| class="wikitable"
|+Extra fields when extracting students with rowtype EducationProgram
!Admin system
!UMS
!Remarks
|-
|EducationalProgrammes ID
|AktivitetsID
|
|-
|EducationalProgrammes Designation
|Aktivitet
|
|-
|EducationalProgrammes Designation
|ActivityDisplayName
|
|-
|EducationalProgrammes Name
|ActivityDescription
|
|-
|EducationalProgrammes Designation
|Kort_Betegnelse
|
|-
|
|Aktivitet_LMS
|True
|-
|EducationalProgrammes StartDate
|StartDato
|
|-
|EducationalProgrammes EndDate
|SlutDato
|
|-
|EducationalProgrammes StartDate
|Aktiviteter_StartDato
|
|-
|EducationalProgrammes EndDate
|Aktiviteter_SlutDato
|
|}

===Template criteria mapping===
{| class="wikitable"
|+Employees
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Institutions kode
|School Code
|
|
|-
|Afdelings navn
|Department
|
|
|-
|Ansvarsområde
|Responsibility area
|
|
|}
{| class="wikitable"
|+Students
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Institutions kode
|SchoolCode
|
|
|-
|Afdelings navn
|Department
|
|
|-
|Uddannelses kode
|COSA_FORMAL
|
|
|-
|Uddannelsesforløbs kode
|ActivityDisplayName
|
|
|-
|Ansvarsområde
|Education_ResponsibilityAreaName
|
|
|-
|Uddannelsesområde (udennalsesforløb)
|Activity_Education
|
|
|-
|Uddannelses navn
|Education
|
|
|}

==FAQ==

===What is needed for students to be extracted===
They need CPR number and an active Educational program

===What is needed for employees to be extracted===
They need CPR number

TimeEditFields

2023-05-04T12:16:40Z

Kia: /* Fields UMS uses when extracting timetable blocks. */

==Metadata configuration==
{| class="wikitable"
|'''Important information'''

TimeEdit has a limit in the database, a maximum of 20 data fields on a timeblock can be returned. If you map too many metadata the integration will fail.
|}
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.

Create metadata configurations for (if needed)

*employees
*activities
*courses
*students
*groups

Students are predefined by UMS, no setup is needed.

Some fields are predefined for the metadata settings while other are required if you are extracting [[GetTimetable/TimeEdit|Timetable blocks]].

All fields are from the '''Students''' table.[[File:TimeEdit Settings Metadata.jpg|none|thumb|902x902px]]

===Key name===
The name of the field in TimeEdit.

===Static text before database field===
The text you write in this field will be suffixed to the UMS database field value.

===UMS database field===
The database field in the UMS table Students.

===Static text after database field===
The text you write in this field will be postfixed to the UMS database field value.

===Required===
UMS will not send the record to TimeEdit If this field is empty when it generates the data to send. This will also be logged in to TimeEdit.Log file.

==TimeEdit field information when uploading to TimeEdit==
'''Predefined fields''' are done by UMS and can not be changed and are not needed to enter into Configurator.

'''Required fields''' has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended.

All predefined and required fields has to be there for the extraction of [[GetTimetable/TimeEdit|Timetable blocks]] to work correctly.

All fields in TimeEdit are case sensitive.

===Students===
TimeEdit's extid for this object type is "student.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|StudieNr
|student.username
|Username for TimeEdit
|X
|-
|
|general.email
|UMS will fill this field with <Username@Students mail domain>
This can be overwritten by manual configuration.
|X
|} 
===Employees===
TimeEdit's extid for this object type is "teacher.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|
|general.email
|UMS will fill this field with <Username@Employee mail domain>
This can be overwritten by manual configuration.
|X
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
!Unique
|-
|
|person.init
|Username for TimeEdit
|X
|}
{| class="wikitable"
|+Best practice fields
!UMS
!TimeEdit
!Unique
|-
|MobilePhone
|general.phone
|
|-
|WorkMail
|general.email
|X
|}

====Example====
[[File:Map metadatafields Employees.png|none|thumb|915x915px]]

===Activity===
TimeEdit's extid for this object type is "studentclass.<Aktivitet>" unless "Use ActivityID" is set
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|studentclass.code
|X
|-
|Aktivitet
|studentclass.name
|
|-
|
|studentclass.no_of_students
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|ActivityDescription
|studentclass.longdescript
|Long description
|-
|Kort_Betegnelse
|studentclass.shortname
|Short description
|}

====Example====
[[File:Map metadatafields Activity.png|none|thumb|915x915px]]

===Courses===
TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet_Skolefag
|course.code
|X
|-
|Aktivitet_Skolefag
|course.name
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|SkoleFag_Kort_Betegnelse
|course.shortname
|Short description
|-
|SkoleFag_betegnelse
|course.LongDescript
|Long description
|}

====Example====
[[File:Map metadatafields Courses.png|none|thumb|916x916px]]

===Groups===
TimeEdit's extid for this object type is "group.<AktivitetsID>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|group.name
|X
|-
|
|group.number_of_members
|
|}
There are no required fields

==Required TimeEdit fields when extracting timetable blocks==

===Fields UMS uses when extracting timetable blocks.===
{| class="wikitable"
|+
!TimeEdit Name
!TimeEdit object type
!UMS object
!Description
|-
|studentclass
|Object
|Activity
|Used as activities that are class related
|-
|description
|Object
|Activity
|Used as activities that are not class related
|-
|description
|string
|Label
|This is a field on the reservation in TimeEdit
|-
|BlockType
|Object
|BlockType
|This is a field on the reservation in TimeEdit
|-
|location
|Object
|Room
|Room or location somewhere in the world
|-
|person
|Object
|Teacher or Student
|This can be a student or teacher
|-
|comment
|string
|Comment
|This is a field on the reservation in TimeEdit
|-
|AbsenceRegistration
|bit
|AbsenceRegistration
|This is a field on the reservation in TimeEdit
Allow this timetable block to be seen in UMS absence registration
|-
|teacher
|Object
|Teacher
|Needs to be created as person in TimeEdit
|-
|student
|Object
|Student
|Needs to be created as person in TimeEdit
|-
|group
|Object
|
|Can contain students or teachers
|-
|course
|Object
|Course
|Used as courses that are class related
|}

===studentclass===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|studentclass.code
|Activity
|
|-
|studentclass.name
|
|
|-
|studentclass.longdescript
|ActivityDescription
|
|-
|studentclass.shortname
|ActivityShortDescription
|
|}

===description (Object)===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|ActivityDescription
|X
|-
|activity.name
|Activity
|
|}

===Location===
This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.id
|Room ID
|X
|-
|general.id
|Room number
|
|-
|general.title
|Room name
|
|}

===person===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===teacher===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===student===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|}

===Course===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|course.code
|Course
|
|-
|course.name
|CourseDescription
|X
|-
|course.shortname
|CourseShortDescription
|
|-
|extid
|CourseID
|
|}

===Groups===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|Not used in UMS
|X
|-
|general.id
|Not used in UMS
|
|}Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.

===Timetable block===
These 2 fields must be set on the timetable block.

====AbsenceRegistration====
UMS supports Absence information from TimeEdit.

This is achieved by creating a True/False column on the timetable blocks called "'''AbsenceRegistration'''"

When set to True UMS will see the timetable block as [[Attendance Registration]] enabled.

====Comment====
This will be put in the comment field in UMS

====All other fields====
All other fields on a reservation will be added to the comment field in UMS.

Except these to fields that are ignored "'''r.note'''" and "'''r.reservation_text_ref'''".

AdminServers/Ludus

2023-04-27T09:14:07Z

Kia: /* Data mapping */

[[File:AdminServer Ludus.jpg|none|thumb|656x656px]]

===Server===
DNS or IP address for the Sybase database server

===Database===
Name of the LUDUS database - Usually this is "VUC"

===Port number===
The port number of the Sybase database server

===Username===
Sybase Username to access the database.

===Password===
Sybase to access the database.

===Webservice connection===
This is used for the new webservices in Ludus

====URL====
URL of the LUDUS web service

====Username====
Username to access the webservice.

====Password====
Password to access the webservice.

===Activity = HoldID + Holdstart===
Hold vil blive få holdstart sat ind som en del af holdnavnet. Dette er et krav hvis man genbruger sine hold i LUDUS. Ellers kan man få hold der er sammensat af det nye og det tidligere hold.

===Insert an underscore between HoldID + Holdstart. E.g. HoldID + _ + Holdstart===
This puts an underscore between '''HoldID + _ + Holdstart'''

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
Students
!Admin system
!UMS
!Remarks
|-
|Kursist.sps
|SPS
|Nej = 0 
Ja = 1 
Ikke taget stilling = 2 
null = 2
|}

{| class="wikitable"
|+
DU Students
!Admin system
!UMS
!Remarks
|-
|Kursist.duRetSlutDato
|ExtraDateField1
|
|-
|DuBetaling.beregnetTabtDato
|ExtraDateField2
|
|}

===Template criteria mapping===
This is somewhat found in the column '''RowType''' in Students table.

====Students====

{| class="wikitable"
|+Other (Ludus Kerne)
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+OBU - FVU - DU - Kursist
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|This is used from table WebHoldHoldType in Ludus DB
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+Exam
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|ActivityDescription
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+UddannelsesAftaler
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not used
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus web -> Activity type
|
|
|Not used
|}

{| class="wikitable"
|+IDV
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|
|
|Not used
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|COSA_FORMAL
EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+AMU
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
Activity_Education
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+UM - Kursus
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|Not stored in UMS DB
|}

{| class="wikitable"
|+UddannelsesForloeb
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not stored in UMS DB
|-
|Hold Institution code
|
|
|Not stored in UMS DB
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+ProeveHold
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AfdelingsNavn

AktivitetsAfdeling
|
|
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|
|
|Not used
|}

AdminServers/Ludus

2023-04-27T09:13:40Z

Kia: /* Data mapping */

[[File:AdminServer Ludus.jpg|none|thumb|656x656px]]

===Server===
DNS or IP address for the Sybase database server

===Database===
Name of the LUDUS database - Usually this is "VUC"

===Port number===
The port number of the Sybase database server

===Username===
Sybase Username to access the database.

===Password===
Sybase to access the database.

===Webservice connection===
This is used for the new webservices in Ludus

====URL====
URL of the LUDUS web service

====Username====
Username to access the webservice.

====Password====
Password to access the webservice.

===Activity = HoldID + Holdstart===
Hold vil blive få holdstart sat ind som en del af holdnavnet. Dette er et krav hvis man genbruger sine hold i LUDUS. Ellers kan man få hold der er sammensat af det nye og det tidligere hold.

===Insert an underscore between HoldID + Holdstart. E.g. HoldID + _ + Holdstart===
This puts an underscore between '''HoldID + _ + Holdstart'''

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
Students
!Admin system
!UMS
!Remarks
|-
|Kursist.sps
|SPS
|Nej = 0
Ja = 1
Ikke taget stilling = 2
null = 2
|}

{| class="wikitable"
|+
DU Students
!Admin system
!UMS
!Remarks
|-
|Kursist.duRetSlutDato
|ExtraDateField1
|
|-
|DuBetaling.beregnetTabtDato
|ExtraDateField2
|
|}

===Template criteria mapping===
This is somewhat found in the column '''RowType''' in Students table.

====Students====

{| class="wikitable"
|+Other (Ludus Kerne)
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+OBU - FVU - DU - Kursist
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|This is used from table WebHoldHoldType in Ludus DB
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+Exam
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|ActivityDescription
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+UddannelsesAftaler
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not used
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus web -> Activity type
|
|
|Not used
|}

{| class="wikitable"
|+IDV
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|
|
|Not used
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|COSA_FORMAL
EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+AMU
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
Activity_Education
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+UM - Kursus
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|Not stored in UMS DB
|}

{| class="wikitable"
|+UddannelsesForloeb
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not stored in UMS DB
|-
|Hold Institution code
|
|
|Not stored in UMS DB
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+ProeveHold
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AfdelingsNavn

AktivitetsAfdeling
|
|
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|
|
|Not used
|}

AdminServers/Ludus

2023-04-27T09:10:33Z

Kia: /* Data mapping */

[[File:AdminServer Ludus.jpg|none|thumb|656x656px]]

===Server===
DNS or IP address for the Sybase database server

===Database===
Name of the LUDUS database - Usually this is "VUC"

===Port number===
The port number of the Sybase database server

===Username===
Sybase Username to access the database.

===Password===
Sybase to access the database.

===Webservice connection===
This is used for the new webservices in Ludus

====URL====
URL of the LUDUS web service

====Username====
Username to access the webservice.

====Password====
Password to access the webservice.

===Activity = HoldID + Holdstart===
Hold vil blive få holdstart sat ind som en del af holdnavnet. Dette er et krav hvis man genbruger sine hold i LUDUS. Ellers kan man få hold der er sammensat af det nye og det tidligere hold.

===Insert an underscore between HoldID + Holdstart. E.g. HoldID + _ + Holdstart===
This puts an underscore between '''HoldID + _ + Holdstart'''

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
Students
!Admin system
!UMS
!Remarks
|-
|Kursist.sps
|SPS
|Nej = 0
Ja = 1
Ikke taget stilling = 2
null = 2
|}

{| class="wikitable"
|+
DU Students
!Admin system
!UMS
!Remarks
|-
|duRetSlutDato
|ExtraDateField1
|
|-
|beregnetTabtDato
|ExtraDateField2
|
|}

===Template criteria mapping===
This is somewhat found in the column '''RowType''' in Students table.

====Students====

{| class="wikitable"
|+Other (Ludus Kerne)
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+OBU - FVU - DU - Kursist
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|This is used from table WebHoldHoldType in Ludus DB
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+Exam
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|ActivityDescription
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+UddannelsesAftaler
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not used
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus web -> Activity type
|
|
|Not used
|}

{| class="wikitable"
|+IDV
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|
|
|Not used
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|COSA_FORMAL
EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+AMU
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
Activity_Education
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+UM - Kursus
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|Not stored in UMS DB
|}

{| class="wikitable"
|+UddannelsesForloeb
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not stored in UMS DB
|-
|Hold Institution code
|
|
|Not stored in UMS DB
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+ProeveHold
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AfdelingsNavn

AktivitetsAfdeling
|
|
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|
|
|Not used
|}

AdminServers/Ludus

2023-04-27T09:08:30Z

Kia: /* Data mapping */

[[File:AdminServer Ludus.jpg|none|thumb|656x656px]]

===Server===
DNS or IP address for the Sybase database server

===Database===
Name of the LUDUS database - Usually this is "VUC"

===Port number===
The port number of the Sybase database server

===Username===
Sybase Username to access the database.

===Password===
Sybase to access the database.

===Webservice connection===
This is used for the new webservices in Ludus

====URL====
URL of the LUDUS web service

====Username====
Username to access the webservice.

====Password====
Password to access the webservice.

===Activity = HoldID + Holdstart===
Hold vil blive få holdstart sat ind som en del af holdnavnet. Dette er et krav hvis man genbruger sine hold i LUDUS. Ellers kan man få hold der er sammensat af det nye og det tidligere hold.

===Insert an underscore between HoldID + Holdstart. E.g. HoldID + _ + Holdstart===
This puts an underscore between '''HoldID + _ + Holdstart'''

===[[AdminServers/Export Settings|Export settings]]===

===Data mapping===
{| class="wikitable"
|+
DU Students
!Admin system
!UMS
!Remarks
|-
|duRetSlutDato
|ExtraDateField1
|
|}

{| class="wikitable"
|+
DU Students
!Admin system
!UMS
!Remarks
|-
|duRetSlutDato
|ExtraDateField1
|
|}

===Template criteria mapping===
This is somewhat found in the column '''RowType''' in Students table.

====Students====

{| class="wikitable"
|+Other (Ludus Kerne)
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+OBU - FVU - DU - Kursist
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|This is used from table WebHoldHoldType in Ludus DB
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+Exam
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|ActivityDescription
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|ActivityType
|
|
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|Not used
|}

{| class="wikitable"
|+UddannelsesAftaler
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not used
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus web -> Activity type
|
|
|Not used
|}

{| class="wikitable"
|+IDV
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|
|
|Not used
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|COSA_FORMAL
EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+AMU
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
Activity_Education
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+UM - Kursus
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|Holdstart is appended if chosen in configurator
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|AktivitetsAfdeling
AfdelingsNavn
|
|
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|Not stored in UMS DB
|}

{| class="wikitable"
|+UddannelsesForloeb
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|
|
|Not stored in UMS DB
|-
|Hold Institution code
|
|
|Not stored in UMS DB
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|
|
|Not used
|-
|Undervisningssted navn
|
|
|Not stored in UMS DB
|-
|Ludus web -> FKB Number
|EducationDirection
|
|
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not stored in UMS DB
|-
|Ludus web -> Activity type
|ActivityType
|
|
|}

{| class="wikitable"
|+ProeveHold
!Admin system
!UMS
!Picture from admin system
!Remarks
|-
|Activity name
|Aktivitet
|
|
|-
|Hold Institution code
|ElevAfdelingsKode
|
|
|-
|Ludus kerne -> Activity type
|
|
|Not used
|-
|CØSA Number
|COSA_FORMAL
|
|
|-
|Henvisnings kategori kode
|Internship_CategoryCode
|
|
|-
|Undervisningssted navn
|AfdelingsNavn

AktivitetsAfdeling
|
|
|-
|Ludus web -> FKB Number
|
|
|Not used
|-
|Ludus web -> Elevorløb Institution code
|
|
|Not used
|-
|Ludus web -> Activity type
|
|
|Not used
|}

TimeEditFields

2023-04-21T11:16:21Z

Kia: /* TimeEdit field information when uploading to TimeEdit */

==Metadata configuration==
{| class="wikitable"
|'''Important information'''

TimeEdit has a limit in the database, a maximum of 20 data fields on a timeblock can be returned. If you map too many metadata the integration will fail.
|}
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.

Create metadata configurations for (if needed)

*employees
*activities
*courses
*students
*groups

Students are predefined by UMS, no setup is needed.

Some fields are predefined for the metadata settings while other are required if you are extracting [[GetTimetable/TimeEdit|Timetable blocks]].

All fields are from the '''Students''' table.[[File:TimeEdit Settings Metadata.jpg|none|thumb|902x902px]]

===Key name===
The name of the field in TimeEdit.

===Static text before database field===
The text you write in this field will be suffixed to the UMS database field value.

===UMS database field===
The database field in the UMS table Students.

===Static text after database field===
The text you write in this field will be postfixed to the UMS database field value.

===Required===
UMS will not send the record to TimeEdit If this field is empty when it generates the data to send. This will also be logged in to TimeEdit.Log file.

==TimeEdit field information when uploading to TimeEdit==
'''Predefined fields''' are done by UMS and can not be changed and are not needed to enter into Configurator.

'''Required fields''' has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended.

All predefined and required fields has to be there for the extraction of [[GetTimetable/TimeEdit|Timetable blocks]] to work correctly.

All fields in TimeEdit are case sensitive.

===Students===
TimeEdit's extid for this object type is "student.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|StudieNr
|student.username
|Username for TimeEdit
|X
|-
|
|general.email
|UMS will fill this field with <Username@Students mail domain>
This can be overwritten by manual configuration.
|X
|} 
===Employees===
TimeEdit's extid for this object type is "teacher.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Description
!Unique
|-
|ForNavne
|person.first_name
|First name
|
|-
|Efternavn
|person.last_name
|Last name
|
|-
|
|general.email
|UMS will fill this field with <Username@Employee mail domain>
This can be overwritten by manual configuration.
|X
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
!Unique
|-
|
|person.init
|Username for TimeEdit
|X
|}
{| class="wikitable"
|+Best practice fields
!UMS
!TimeEdit
!Unique
|-
|MobilePhone
|general.phone
|
|-
|WorkMail
|general.email
|X
|}

====Example====
[[File:Map metadatafields Employees.png|none|thumb|915x915px]]

===Activity===
TimeEdit's extid for this object type is "studentclass.<Aktivitet>" unless "Use ActivityID" is set
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|studentclass.code
|X
|-
|Aktivitet
|studentclass.name
|
|-
|
|studentclass.no_of_students
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|ActivityDescription
|studentclass.longdescript
|Long description
|-
|Kort_Betegnelse
|studentclass.shortname
|Short description
|}

====Example====
[[File:Map metadatafields Activity.png|none|thumb|915x915px]]

===Courses===
TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet_Skolefag
|course.code
|X
|-
|Aktivitet_Skolefag
|course.name
|
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|SkoleFag_Kort_Betegnelse
|course.shortname
|Short description
|-
|SkoleFag_betegnelse
|course.LongDescript
|Long description
|}

====Example====
[[File:Map metadatafields Courses.png|none|thumb|916x916px]]

===Groups===
TimeEdit's extid for this object type is "group.<AktivitetsID>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
!Unique
|-
|Aktivitet
|group.name
|X
|-
|
|group.number_of_members
|
|}
There are no required fields

==Required TimeEdit fields when extracting timetable blocks==

===Fields UMS uses when extracting timetable blocks.===
{| class="wikitable"
|+
!TimeEdit Name
!TimeEdit object type
!UMS object
!Description
|-
|studentclass
|Object
|Activity
|Used as activities that are class related
|-
|description
|Object
|Activity
|Used as activities that are not class related
|-
|description
|string
|Label
|This is a field on the reservation in TimeEdit
|-
|BlockType
|string
|BlockType
|This is a field on the reservation in TimeEdit
|-
|location
|Object
|Room
|Room or location somewhere in the world
|-
|person
|Object
|Teacher or Student
|This can be a student or teacher
|-
|comment
|string
|Comment
|This is a field on the reservation in TimeEdit
|-
|AbsenceRegistration
|bit
|AbsenceRegistration
|This is a field on the reservation in TimeEdit
Allow this timetable block to be seen in UMS absence registration
|-
|teacher
|Object
|Teacher
|Needs to be created as person in TimeEdit
|-
|student
|Object
|Student
|Needs to be created as person in TimeEdit
|-
|group
|Object
|
|Can contain students or teachers
|-
|course
|Object
|Course
|Used as courses that are class related
|}

===studentclass===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|studentclass.code
|Activity
|
|-
|studentclass.name
|
|
|-
|studentclass.longdescript
|ActivityDescription
|
|-
|studentclass.shortname
|ActivityShortDescription
|
|}

===description (Object)===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|ActivityDescription
|X
|-
|activity.name
|Activity
|
|}

===Location===
This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.id
|Room ID
|X
|-
|general.id
|Room number
|
|-
|general.title
|Room name
|
|}

===person===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===teacher===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|-
|person.init
|Initials
|
|}

===student===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|person.first_name
|FirstName
|X
|-
|person.last_name
|LastName
|
|}

===Course===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|
|X
|-
|course.code
|Course
|
|-
|course.name
|CourseDescription
|X
|-
|course.shortname
|CourseShortDescription
|
|-
|extid
|CourseID
|
|}

===Groups===
{| class="wikitable"
!TimeEdit name
!UMS
!Mandatory
|-
|general.title
|Not used in UMS
|X
|-
|general.id
|Not used in UMS
|
|}Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.

===Timetable block===
These 2 fields must be set on the timetable block.

====AbsenceRegistration====
UMS supports Absence information from TimeEdit.

This is achieved by creating a True/False column on the timetable blocks called "'''AbsenceRegistration'''"

When set to True UMS will see the timetable block as [[Attendance Registration]] enabled.

====Comment====
This will be put in the comment field in UMS

====All other fields====
All other fields on a reservation will be added to the comment field in UMS.

Except these to fields that are ignored "'''r.note'''" and "'''r.reservation_text_ref'''".

MitIDErhverv

2023-04-12T10:55:16Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

You can test it by using this SQL command and appending your own SQL sentence.

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> <nowiki>''</nowiki>'')
And (Efternavn Is Not Null)
And (Efternavn <> <nowiki>''</nowiki>'')
And (WorkMail Is Not Null)
And (WorkMail <> <nowiki>''</nowiki>'')
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID))
'''<Your SQL Sentence>'''

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

MitIDErhverv

2023-04-12T10:55:00Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

You can test it by using this SQL command and appending your own SQL sentence.

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> '')
And (Efternavn Is Not Null)
And (Efternavn <> '')
And (WorkMail Is Not Null)
And (WorkMail <> '')
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID))
'''<Your SQL Sentence>'''

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

AdminServers/MitIDErhverv

2023-03-21T09:09:04Z

Kia: /* Requirements */

=== Requirements ===
Minimum Windows 2019

Users must have work mail.

=== Recommandations ===
It could be good idea to make sure the Administrators are not a part of the synchronization. Leave them out be entering their usernames in the SQL sentence.

Or create a new user with a unique mail address to have as a backup if your automatic user is somehow disabled.

StudieNr Not In ('Username')
=== How to get MitID Erhverv customer account ===
https://mitid-erhverv.dk/[[File:AdminServer MitID Erhverv.jpg|none|thumb|765x765px]]

===[[AdminServers/Export Settings|Export settings]]===

===Certificate file===
The certificate used to access the webservices.

====How to order test certificate====
Creating new certificate:

===== Expand "Systemrettigheder (frivilligt) Trin 2 af 4" =====
If this step is not shown, then you need to perform these steps. (Could take a couple of days before a return answer)

* https://mitid-erhverv.dk/avanceret/lokal-idm/
** Write a mail and ask for
**# Lokal IdM light

[[File:AdminServer MitID Erhverv IDM Light.jpg|none|thumb]]

check "'''Adgang til IdM services i MitID Erhverv'''"

See picture below for example

Or

*"Typer af cerfikater"
**Oces organisationscertifikat
*"Metode til identifikation"
**Bruger-login
*"Ja, gå direkte til udstedelse efter bestilling"
**Check this
*"Metode til udstedelse"
**Internetbrowser

 
[[File:MitId Erhverv Order certificate picture.jpg|none|thumb|1102x1102px]]

===Certificate password===
Password for the certificate file.

This will be given to you when you login after completing the order.

==FAQ==

===Test enviroment setup===

====Create====
https://www.nemlog-in.dk/vejledningertiltestmiljo/forside/vejledning-til-tjenesteudbydere-tilslut-jeres-tjeneste-til-test-miljoet/

====Login URL's====
https://erhvervsadministration.devtest4-nemlog-in.dk/login?returnUrl=%2Fusers

https://administration.devtest4-nemlog-in.dk/

====Log viewer Only for SSO and logins:====
https://www.nemlog-in.dk/media/q2wicxi3/nemlog-in2-log-viewer.pdf

https://logviewer.test-nemlog-in.dk/

==== Other documentation ====
https://migrering.nemlog-in.dk/mitid-erhverv/test-og-dokumentation/

=== Why are my users not created ===
They must have work mail, firstname, lastname and CPR.

AdminServers/MitIDErhverv

2023-03-20T13:57:43Z

Kia: /* Recommandations */

=== Requirements ===
Minimum Windows 2019

Users must have work mail.

=== Recommandations ===
It could be good idea to make sure the Administrators are not a part of the synchronization. Leave them out be entering their usernames in the SQL sentence.

Or create a new user with a unique mail address to have as a backup if your automatic user is somehow disabled.

StudieNr Not In ('Username')
You must set your invoice settings to this.[[File:MitID Erhverv invoice setting.png|none|frame]]
=== How to get MitID Erhverv customer account ===
https://mitid-erhverv.dk/[[File:AdminServer MitID Erhverv.jpg|none|thumb|765x765px]]

===[[AdminServers/Export Settings|Export settings]]===

===Certificate file===
The certificate used to access the webservices.

====How to order test certificate====
Creating new certificate:

===== Expand "Systemrettigheder (frivilligt) Trin 2 af 4" =====
If this step is not shown, then you need to perform these steps. (Could take a couple of days before a return answer)

* https://mitid-erhverv.dk/avanceret/lokal-idm/
** Write a mail and ask for
**# Lokal IdM light

[[File:AdminServer MitID Erhverv IDM Light.jpg|none|thumb]]

check "'''Adgang til IdM services i MitID Erhverv'''"

See picture below for example

Or

*"Typer af cerfikater"
**Oces organisationscertifikat
*"Metode til identifikation"
**Bruger-login
*"Ja, gå direkte til udstedelse efter bestilling"
**Check this
*"Metode til udstedelse"
**Internetbrowser

 
[[File:MitId Erhverv Order certificate picture.jpg|none|thumb|1102x1102px]]

===Certificate password===
Password for the certificate file.

This will be given to you when you login after completing the order.

==FAQ==

===Test enviroment setup===

====Create====
https://www.nemlog-in.dk/vejledningertiltestmiljo/forside/vejledning-til-tjenesteudbydere-tilslut-jeres-tjeneste-til-test-miljoet/

====Login URL's====
https://erhvervsadministration.devtest4-nemlog-in.dk/login?returnUrl=%2Fusers

https://administration.devtest4-nemlog-in.dk/

====Log viewer Only for SSO and logins:====
https://www.nemlog-in.dk/media/q2wicxi3/nemlog-in2-log-viewer.pdf

https://logviewer.test-nemlog-in.dk/

==== Other documentation ====
https://migrering.nemlog-in.dk/mitid-erhverv/test-og-dokumentation/

=== Why are my users not created ===
They must have work mail, firstname, lastname and CPR.

MitIDErhverv

2023-03-16T07:53:18Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

You can test it by using this SQL command and appending your own SQL sentence.

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> '')''
And (Efternavn Is Not Null)
And (Efternavn <> '')''
And (WorkMail Is Not Null)
And (WorkMail <> '')''
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID))
'''<Your SQL Sentence>'''

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

MitIDErhverv

2023-03-16T07:52:55Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

You can test it by using this SQL command and appending your own SQL sentence.

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> '')''
And (Efternavn Is Not Null)
And (Efternavn <> '')''
And (WorkMail Is Not Null)
And (WorkMail <> '')''
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID))
<Your SQL Sentence>

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

MitIDErhverv

2023-03-16T07:52:44Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

You can test it by using this SQL command and appending your own SQL sentence.

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> '')''
And (Efternavn Is Not Null)
And (Efternavn <> '')''
And (WorkMail Is Not Null)
And (WorkMail <> '')''
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID))

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

MitIDErhverv

2023-03-16T07:51:40Z

Kia: /* SQL Sentence */

==UMS Configurator settings==
[[File:MitID Erhverv Settings.jpg|none|frame]]

===Description===
Insert a name or description for the setting

===Admin servers===
Choose the admin server created here [[AdminServers/MitIDErhverv|MitID Erhverv]]

===Maintain groups===
This will created/update and delete groups.

It will also add users and remove them again.

These groups can be used to add security to users based on group membership.

=== Authenticators ===
Choose the authenticators to add to users.

===SQL Sentence===
Insert parameters for filtering purposes

Select Distinct Students.SLI_ID, Students.Fornavne As GivenName, Students.Efternavn As SurName, Students.CPR As CivilRegistrationNumber
, Students.WorkMail
From Students
Where
(StudieNr Is Not Null)
And (UserTypes_ID = 0)
And (SLI_ID Is Not Null)
And (CPR Is Not Null)
And (BirthDay Is Not Null)
And (Fornavne Is Not Null)
And (Fornavne <> '')
And (Efternavn Is Not Null)
And (Efternavn <> '')
And (WorkMail Is Not Null)
And (WorkMail <> '')
And (Not Exists (Select SLI_ID From MitIDErhverv_Users Where MitIDErhverv_Users.SLI_ID = Students.SLI_ID And MitIDErhverv_Users.MitIDErhvervSettings_ID = {(int)SettingsRow["ID"]}))
Order By SLI_ID

=== Parameters ===
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateUsers
|Create users
|-
|UpdateUsers
|Update users. This will also add authenticators if they are missing from the users.
|-
|DeleteUsers
|Delete users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|Create groups
|-
|UpdateGroups
|Update groups
|-
|DeleteGroups
|Delete groups
|-
|AddGroupMembers
|Add new members to groups
|-
|RemoveGroupMembers
|Remove members from groups if they are no longer member of the group in the source data
|}

==FAQ==

=== Find existing users ===
The user must be active for UMS to find the user otherwise it will create a new user.

G Suite

2023-03-15T08:33:58Z

Kia: /* Description */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

===== Automation type'=====
Full: Means that classroom maintenance will be fully automated.

===== Remove learner method =====
'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

===== Delete classrooms =====
'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a classroom.

===== Create x days before =====
Choose how many days before start that the classroom s are to be created.

===== Delete x days after end =====
Choose how many days after end that the classroom s are to be deleted.

===== SQL Groups =====
Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Classrooms =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

====== Description ======
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

===== Course Classrooms =====
Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

====== Description ======
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks ======
This is just for description purposes.

====== Course Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Activity Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:33:30Z

Kia: /* Search filter and criteria */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

===== Automation type'=====
Full: Means that classroom maintenance will be fully automated.

===== Remove learner method =====
'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

===== Delete classrooms =====
'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a classroom.

===== Create x days before =====
Choose how many days before start that the classroom s are to be created.

===== Delete x days after end =====
Choose how many days after end that the classroom s are to be deleted.

===== SQL Groups =====
Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Classrooms =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

===== Description =====
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

===== Course Classrooms =====
Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

====== Description ======
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks ======
This is just for description purposes.

====== Course Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Activity Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:32:44Z

Kia: /* Classroom */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

===== Automation type'=====
Full: Means that classroom maintenance will be fully automated.

===== Remove learner method =====
'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

===== Delete classrooms =====
'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a classroom.

===== Create x days before =====
Choose how many days before start that the classroom s are to be created.

===== Delete x days after end =====
Choose how many days after end that the classroom s are to be deleted.

===== SQL Groups =====
Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Classrooms =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

===== Description =====
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

===== Course Classrooms =====
Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

====== Description ======
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

====== Search filter and criteria ======
This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks ======
This is just for description purposes.

====== Course Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Activity Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the classroom with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:31:46Z

Kia: /* Classroom */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

===== '''Automation type''' =====
Full: Means that classroom maintenance will be fully automated.

===== '''Remove learner method''' =====
'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

===== Delete classrooms =====
'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

===== '''Send mail to teacher(s)''' =====
Send mail notification to teachers when they are attached to a classroom.

===== '''Create x days before''' =====
Choose how many days before start that the classroom s are to be created.

===== '''Delete x days after end''' =====
Choose how many days after end that the classroom s are to be deleted.

===== '''SQL Groups''' =====
Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== '''Group name''' ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

===== '''Activity Classrooms''' =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

===== '''Description''' =====
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the classroom with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

===== '''Course Classrooms''' =====
Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

====== '''Description''' ======
Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

====== '''Search filter and criteria''' ======
This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Course Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the classroom with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Activity Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the classroom with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:29:51Z

Kia: /* Use replace string with empty */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:29:37Z

Kia: /* Search filter and criteria */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:28:50Z

Kia: /* Description */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

=====Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:28:29Z

Kia: /* Description */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== Description =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:28:15Z

Kia: /* Activity Drives */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== Activity Drives =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== '''Description''' =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:28:04Z

Kia: /* Group name */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== Group name ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== '''Activity Drives''' =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== '''Description''' =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:27:43Z

Kia: /* Finished on activity/course */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== Finished on activity/course =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== '''Group name''' ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== '''Activity Drives''' =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== '''Description''' =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:27:26Z

Kia: /* Activity Sites */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

====Activity Sites====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== '''Finished on activity/course''' =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== '''Group name''' ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== '''Activity Drives''' =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== '''Description''' =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2023-03-15T08:27:12Z

Kia: /* Search filter and criteria */

UMS integrates to G Suite with the module G Suite Sync which:

*Creates users and their e-mail accounts
*Maintains users in G Suite, i.e. data changes are synchronised to UMS
*Synchronises passwords
*Deletes users who no longer attend the school

Integration to G Suite quickly becomes profitable. With UMS, the school saves resources by automating many manual tasks

*Avoid having to program scripts to synchronise the data
*Users are automatically created with data from your student administration system
*It reduces the workload for the IT-department

==Prerequisites==

===Module requirements===
[[Google app API]]

==Installation==
[[File:Googleappsadminsettings.png|none|frame]]

=== Organization settings ===
See description how to create/setup further down this page

=== Users ===

==== Mail Alias ====
Choose what to use as the users mail address (login).

====Disable users====
When marked the users will be disabled when they are no longer attending classes.

====Delete users====
Choose if users are to be deleted after grace period has ended.

====Forward mail to on premise mail server====
This will forward the users Office 365 mail to the primary mail address from AD (If user does not have a proxy address it will read it from the mail attribute)

====Keep inactive before deleting x days====
Specify a grace period where users are disabled.

==== Distribution lists ====

=====Maintain lists=====
Mark this to create distribution groups in Office 365. The groups will be created, updated and deleted if this is specified.

=====Delete lists=====
Mark this to delete distributions groups when they are no longer active in the administrative system. Check the data export manuals too when this happens

=====Delete unused lists after x days=====
Specify in days how long the distribution groups are to be kept alive in Office 365 before deletion.

==== Template security groups ====

=====Maintain=====
This will create the security group entered in the field “template security group” in the destination node in the template settings.

==== Timetable ====

=====Maintain=====
Mark this to create timetable blocks in Google Apps. They will be created, updated and deleted.

=====Delete old=====
Mark this to delete old timetable blocks from calendars.

===Site===
[[File:Googleappssite.png|none|thumb|720x720px]]

====Automation type====
'''Full'''

Means that site maintenance will be fully automated.

====Remove learner method====
'''Deleted in AD'''

Users will be removed from site when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

====Delete sites====
'''Auto delete'''

Sites will be delete when the last student has left the site

'''Manual Delete'''

Sites will not be deleted by UMS. This has to be done by an administrator

====Send mail to teacher(s)====
Send mail notification to teachers when they are attached to a site.

====Create x days before====
Choose how many days before start that the sites are to be created.

====Delete x days after end====
Choose how many days after end that the sites are to be deleted.

====Teacher rights on sites====
Rights the teacher will have on the site when attached.

====Learner rights on sites====
Rights the student/learner will have on the site when attached.

==== SQL Groups ====
Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

=====Group name=====
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

===='''Activity Sites'''====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]'''All'''

Create all sites.

====='''Title'''=====
Title of the site. Changing this after a site has been created will cause it to be updated.

====='''Description'''=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria =====
This will enable you to concatenate sites that would have been created as to or more sites to be created as one site.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== Remarks ======
This is just for description purposes.

====== Filter ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll ======

====== Use replace string with empty ======
This will replace a section of the site with an empty string.

====== Start index ======
Determine where to start in string to remove.

====== Length ======
How many characters will be removed from the string.

====== Add activity short description to node ID ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

====== Examples ======
If you have three activities named English1, English2, English3 and you only want one SharePoint site.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Sites'''

Course URL’s will always be created as “Activity_Course”.

'''Do not create'''

It will not create any sites based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “'''True'''”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

===== All=====
Create all sites.

===== Title=====
Title of the site. Changing this after a site has been created will cause it to be updated.

===== Description=====
Description of the site. Changing this after a site has been created will cause it to be updated.

===== Search filter and criteria=====
This will enable you to concatenate sites that would have been created as two or more sites to be created as one site.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

====== Remarks======
This is just for description purposes.

====== Course Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

====== Activity Filter======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== Semester roll======

====== Use replace string with empty======
This will replace a section of the site with an empty string.

====== Start index======
Determine where to start in string to remove.

====== Length======
How many characters will be removed from the string.

==== Drive ====
[[File:Googleappsdrive.png|none|thumb|720x720px]]

===== Automation type=====
<big>'''Full'''</big>

Means that drive maintenance will be fully automated.

===== <big>Remove learner method</big> =====

===== Deleted in AD =====
Users will be removed from drive when they are not active in UMS anymore

===== '''Finished on activity/course''' =====
Users will be removed when they have finished with the course.

===== <big>Delete drives</big> =====
'''Auto delete'''

Drives will be delete when the last student has left the drive

'''Manual Delete'''

Drives will not be deleted by UMS. This has to be done by an administrator

===== Send mail to teacher(s) =====
Send mail notification to teachers when they are attached to a drive.

===== Create x days before =====
Choose how many days before start that the drives are to be created.

===== Delete x days after end =====
Choose how many days after end that the drives are to be deleted.

===== Teacher rights on drives =====
Rights the teacher will have on the drive when attached.

===== Learner rights on drives =====
Rights the student/learner will have on the drive when attached.

===== SQL Groups =====
Members of these groups will be attached to all drives created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

====== '''Group name''' ======
This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:

Select Distinct Aktivitet As Activity From Students Order By Activity

===== '''Activity Drives''' =====
'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

===== '''Description''' =====
Description of the drive. Changing this after a drive has been created will cause it to be updated.

===== '''Search filter and criteria''' =====
This will enable you to concatenate drives that would have been created as to or more drives to be created as one drive.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

====== '''Remarks''' ======
This is just for description purposes.

====== '''Filter''' ======
The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

====== '''Semester roll''' ======

====== '''Use replace string with empty''' ======
This will replace a section of the drive with an empty string.

====== '''Start index''' ======
Determine where to start in string to remove.

====== '''Length''' ======
How many characters will be removed from the string.

====== '''Add activity short description to node ID''' ======
This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint drive.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Drives'''

Course URL’s will always be created as “activity_course”.

'''Do not create'''

It will not create any drives based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create drives based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all drives.

'''Description'''

Description of the drive. Changing this after a drive has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate drives that would have been created as two or more drives to be created as one drive.

[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]
'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the drive with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

==== Classroom ====
There can only be a maximum of 990 classrooms in total in one organization.

'''Google designed features (Not UMS)'''

If a teacher leaves the school, the material that he has put into classrooms will be deleted as well.

If a user has too many classrooms it will be very slow for this user.
[[File:Googleappsclassroomsettings.png|none|thumb|720x720px]]

'''Automation type'''

Full: Means that classroom maintenance will be fully automated.

'''Remove learner method'''

'''Deleted in AD'''

Users will be removed from classroom when they are not active in UMS anymore

'''Finished on activity/course'''

Users will be removed when they have finished with the course.

'''Delete classrooms'''

'''Auto delete'''

Classrooms will be delete when the last student has left the classroom

'''Manual Delete'''

Classrooms will not be deleted by UMS. This has to be done by an administrator

'''Send mail to teacher(s)'''

Send mail notification to teachers when they are attached to a classroom.

'''Create x days before'''

Choose how many days before start that the classroom s are to be created.

'''Delete x days after end'''

Choose how many days after end that the classroom s are to be deleted.

'''SQL Groups'''

Members of these groups will be attached to all classrooms created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Activity Classrooms'''

'''Do not create'''

It will not create any sites based on activities.

'''LMS has to be checked'''

The field Aktivitet_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create sites based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as to or more classrooms to be created as one classroom.
[[File:Googleappssearchfilters.png|none|thumb|401x401px]]

'''Remarks'''

This is just for description purposes.

'''Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Add activity short description to node ID'''

This will add the field Kort_Betegnelse (Short Description) from the students table to the node id.

Node id is the URL.

'''Examples'''

If you have three activities named English1, English2, English3 and you only want one SharePoint classroom.

Set the settings as shown below
[[File:Googleappsseachfilters2.png|none|thumb|413x413px]]

This filter ensures that it is only applied to activities that matches this SQL sentence.

'''Course Classrooms'''

Course URL’s will always be created as “activity course”.

'''Do not create'''

It will not create any classrooms based on courses.

'''LMS has to be checked'''

The field Skolefag_LMS in the students table has to be “True”. (Look in the documentation for the specific administrative system to see how this is set)

'''Based on template filter'''

Create classrooms based on a filter that is specified per template.
[[File:Googleappsactivitysites.png|none|thumb|493x493px]]

'''All'''

Create all classrooms.

'''Description'''

Description of the classroom. Changing this after a classroom has been created will cause it to be updated.

'''Search filter and criteria'''

This will enable you to concatenate classrooms that would have been created as two or more classrooms to be created as one classroom.
[[File:Googleappsseachfilters3.png|none|thumb|427x427px]]

'''Remarks'''

This is just for description purposes.

'''Course Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll.

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

'''Activity Filter'''

The SQL like filter (regular expression). If an activity matches, it will be subject to the settings below in semester roll

'''Semester roll'''

'''Use replace string with empty'''

This will replace a section of the classroom with an empty string.

'''Start index'''

Determine where to start in string to remove.

'''Length'''

How many characters will be removed from the string.

=== Organization Settings ===
When creating Google API refer to this lInk

[[Google app API|http://wiki.inlogic.dk/index.php/Google_app_API]] [[File:Googleappsorganizationsettings.png|none|thumb|378x378px]]

'''Description'''

Add a description to be able to identify the account.

'''Admin login'''

Mail address of an administrative user

'''Password'''

Password for the admin login specified

'''Domain'''

The google domain that is used.

'''Client ID, Client Secret'''

This is obtained when following the instructions in the PDF document

'''Refresh token'''

This will be generated the first time google synchronization is started. If this is reset UMS will asked for it again when the next synchronization is run.

'''Timetable Users'''

This can be used when creating timetable blocks. Look in timetable documentation for this feature.

'''Template Settings'''

This is where you specify which templates are synchronized with Google and how.
[[File:Googleappstemplateeditor.png|none|thumb|687x687px]]

'''Setting'''

This is the setting described above

'''Organization setting'''

Specify where the users are created
[[File:Googleappsaosettings.png|none|thumb|422x422px]]

'''Path'''

This is where all users is placed

'''Use this path when below 13 years of age'''

This is where users that are under 13 years is placed. If this is not specified everyone will be placed under the path setting. (This is helpful when it comes to Google+)

'''OU Description'''

The description that is set on the OU when it is created.

'''Site settings'''

Settings used when creating sites from this template
[[File:Googleappssitesettings.png|none|thumb|422x422px]]

'''Site category'''

A list of categories added to the site when creating it separated with a ;

A category called UMS will be added as well. (This cannot be change)

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Drive settings'''

Settings used when creating drives from this template

'''Careful, do not name any of these type of subfolders with the same name.'''
[[File:GoogleApps Drive Settings.jpg|none|frame]]
'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

Can only be used with learner rights set to viewer.

Create a folder for each student that is attached to each drive

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read)'''

Can only be used with learner rights set to viewer.

A folder where teachers can upload data that students can only read

'''Suffix'''

A text string that is appended to the folder name

'''Create subfolder (Teacher Read/Write - Student Read/Write)'''

Can only be used with learner rights set to viewer.

A folder where teachers and students can share data both with read/write

'''Suffix'''

A text string that is appended to the folder name

'''Example'''
[[File:Googleappsstudents.png|none|thumb|279x279px]]

'''SQL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity
'''Classroom settings'''

Settings used when creating classrooms from this template
[[File:Googleappsclassroomsettings2.png|none|thumb]] S'''QL Groups'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|none|thumb|458x458px]]

'''Group name'''

This can only be a group that is found in UMS

You get a list of these groups by running this SQL command:
Select Distinct Aktivitet As Activity From Students Order By Activity

==Installation G Suite Sync==
Steps to make UMS sync work with G Suite.

Log on https://console.developers.google.com with your Google Admin account.

[[Google app API]]

Go to the UMS “usermanagement folder” and run “GoogleApps_Sync.exe” manually.

Login to Google using credentials from Google Organization settings.

When logged in succesfully, “Accept” the following
[[File:Googlesyncaccept.png|none|thumb|578x578px]]
If you get a “This page can’t be displayed”
[[File:Googlesyncpagenotfound.png|none|thumb|315x315px]]

Do not be alarmed. The job has been activated and you can check your GoogleApps_Sync.log to confirm that the job has completed running.

==Parameters==
> GoogleApps_Sync.exe [<optional> Action]
Eg.
> GoogleApps_Sync.exe

> GoogleApps_Sync.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|CreateLearners
|
|-
|CreateStaff
|
|-
|UpdateLearners
|
|-
|UpdateStaff
|
|-
|RenameLearners
|Rename the learners with a new mail/Login
|-
|RenameTeachers
|Rename the teachers with a new mail/Login
|-
|DeleteLearners
|
|-
|DeleteStaff
|
|-
|DisableLearners
|
|-
|EnableLearners
|
|-
|DisableStaff
|
|-
|EnableStaff
|
|-
|UpdateLearnerOU
|Move the learners to the correct OU
|-
|UpdateTeacherOU
|Move the teachers to the correct OU
|-
|UpdateTeacherMailForward
|
|-
|UpdateLearnerMailForward
|
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|CreateGroups
|
|-
|CleanUpGroups
|
|-
|AddTeachersToGroups
|
|-
|RemoveTeachersFromGroups
|
|-
|AddLearnersToGroups
|
|-
|RemoveLearnersFromGroups
|
|}
{| class="wikitable"
|+Template groups
!Parameter
!Description
|-
|TemplateGroupsOnly
|Runs all the parameters in this table
|-
|RemoveUsersFromTemplateGroups
|Remove users from template security groups
|-
|AddUsers2TemplateGroups
|Add users to template security groups
|-
|DeleteTemplateGroups
|Delete groups that are no longer template security groups
|}
{| class="wikitable"
|+Web sites
!Parameter
!Description
|-
|WebSitesOnly
|Runs all the parameters in this table
|-
|AddSites2DB
|Add new sites to UMS DB
|-
|CreateSites
|
|-
|UpdateSites
|
|-
|DeleteSites
|
|-
|AddTeachers2Site
|
|-
|AddLearners2Site
|
|-
|DeleteTeachersWebSites
|
|-
|DeleteLearnersWebSites
|
|}
{| class="wikitable"
|+Classroom
!Parameter
!Description
|-
|ClassroomOnly
|Runs all the parameters in this table
|-
|AddClassrooms2DB
|Add new classrooms to UMS DB
|-
|CreateClassrooms
|
|-
|UpdateClassrooms
|
|-
|DeleteClassrooms
|
|-
|AddTeachers2Classroom
|
|-
|AddLearners2Classroom
|
|-
|DeleteTeachersClassroom
|
|-
|DeleteLearnersClassroom
|
|}
==Technical settings==

==FAQ==
Why do I not get the drive/site created?

1. Activity

a. Is there a user on the activity with a primary template that has an office 365 setting attached

b. Is the flag Aktivitet_LMS = True

2. Course

a. Is there a user on the course with a primary template that has an office 365 setting attached

b. Is the flag Skolefag_LMS = True

===CreateGroups Error===
''Get root folders [Inlogic_Alle 1e-elever]''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403] Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

''Get root folders''

''(CreateGroups) Error Google.Apis.Requests.RequestError''

''Not Authorized to access this resource/api [403]''

''Errors [ Message[Not Authorized to access this resource/api] Location[ - ] Reason[forbidden] Domain[global]''

'''The reason why that error occurs is that the mail adr. is used by another group or user. Test by manually creating a group in google admin portal. The image below shows the error.'''

'''To correct this error''': create a '''USER''' with the same email address and then delete it again. After this, it will be possible to create the Group.
[[File:Fgd.png|left|thumb|935x935px]]