UmsWiki - User contributions [en]

Configurator/SMS Server

2023-11-29T14:53:11Z

Cna: /* Prerequisites */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===

=== Prerequisites ===

Remember to create an account first. (in Danish)

# Opret en konto hos GatewayAPI.eu (Det er vigtigt I vælger .EU ved oprettelse)
# Kontakter deres support via Chat-funktionen og meddeler at I er '''Inlogic kunde''' (Reference udløser rabatten pr sms) - Support er på dansk, selv om chatbot er engelsk…
# Bed også GatewayAPI-support oprette jer som '''faktura-kunde''', med mindre I vil styre udgiften med betalingskort.
# Hvis I skal benytte indgående SMS funktion, vil et SMS-nummer også være fordelagtigt - Dette kan også bestilles via Keywords & Numbers på siden

=== SMS Server Settings ===
[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

=== URL Whitelisting ===
To make SMS password-reset work, the URL of UMS.yourdomain.dk needs to be whitelisted at GatewayAPI. This is done in their API settings.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

Configurator/SMS Server

2023-11-29T14:51:48Z

Cna: /* Prerequisites */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===

=== Prerequisites ===

Remember to create an account first. (in Danish)

# Opret en konto hos GatewayAPI.eu (Det er vigtigt I vælger .EU ved oprettelse)
# Kontakter deres support via Chat-funktionen og meddeler at I er '''Inlogic kunde''' (Reference udløser rabatten pr sms) - Support er på dansk, selv om chatbot er engelsk…
# Bed også GatewayAPI-support oprette jer som '''faktura-kunde''', med mindre I vil styre udgiften med betalingskort.
# Hvis I skal benytte indgående SMS funktion, vil et SMS-nummer også være fordelagtigt - Dette kan også bestilles via Keywords & Numbers på siden
[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

=== URL Whitelisting ===
To make SMS password-reset work, the URL of UMS.yourdomain.dk needs to be whitelisted at GatewayAPI. This is done in their API settings.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

Configurator/SMS Server

2023-11-29T14:51:17Z

Cna: /* Prerequisites */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===

=== Prerequisites ===

Remember to create an account first. (in Danish)

# Opret en konto hos GatewayAPI.eu (Det er vigtigt I vælger .EU ved oprettelse)
# Kontakter deres support via Chat-funktionen og meddeler at I er '''Inlogic kunde''' (Reference udløser rabatten pr sms) - Support er på dansk, selv om chatbot er engelsk…
# Bed også GatewayAPI-support oprette jer som '''faktura-kunde''', med mindre I vil styre udgiften med betalingskort.
# Hvis I skal benytte indgående SMS funktion, vil et SMS-nummer også være fordelagtigt - Dette kan også bestilles via Keywords & Numbers på siden

[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

=== URL Whitelisting ===
To make SMS password-reset work, the URL of UMS.yourdomain.dk needs to be whitelisted at GatewayAPI. This is done in their API settings.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

Configurator/SMS Server

2023-11-29T14:49:25Z

Cna: /* gatewayapi.eu */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===

=== Prerequisites ===

Remember to create an account first.


[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

=== URL Whitelisting ===
To make SMS password-reset work, the URL of UMS.yourdomain.dk needs to be whitelisted at GatewayAPI. This is done in their API settings.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

Merge Letters

2023-10-27T10:02:10Z

Cna: /* FAQ */

Merge Letters is an effective tool, which makes it easy to print standard documents for a variety of different purposes, e.g. class lists for attendance registration and welcome letters. By using the module, you save time and avoid having to insert data in standard documents manually. You also make sure the data is inserted in the right place and that the documents thereby reach the intended receiver. The module merges data variables you choose from UMS with the text you want. For example, it is easy to insert the students’ names and addresses into welcome letters.

==Prerequisites==

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

[[UMS Academic Web]]

===Testing after setup===
Test a newly created merge letter with variables

==Installation==
To use the merge letters, you’ll need to setup the search settings in the configurator.
[[File:Mergelettersetup.png|none|thumb|791x791px]]

 

==Technical settings==

==FAQ==

=== Examples of Merge Letters ===
[https://www.inlogic.dk/support/flettebreve/ On inlogic.dk you can find examples of different Merge Letter types]

SSO/Office365

2023-10-25T12:14:41Z

Cna: /* UMS Graph API connection in Office365 Tenant settings */

Configurator/SMS Server

2023-10-25T11:44:45Z

Cna: /* IP Filter notification */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===
Remember to create an account first.[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

=== URL Whitelisting ===
To make SMS password-reset work, the URL of UMS.yourdomain.dk needs to be whitelisted at GatewayAPI. This is done in their API settings.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

Configurator/SMS Server

2023-10-18T11:09:54Z

Cna: /* Configuration settings at Sinch.com */

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===
Remember to create an account first.[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

===Callback URL===
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

===Region===
Select the region to COM or EU.

===Sender===
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

===API Token===
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

===Keyword===
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

===Configuration settings at gatewayapi===
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

=== IP Filter notification ===
<nowiki>**</nowiki> If you filter IPs, note that we will call your webhook from the '''IPs 35.241.147.191 and 35.233.1.105'''. In the future we may add IPs.

==[https://www.sinch.com/ Sinch.com]==
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

MitIDErhverv

2023-10-18T09:36:25Z

Cna: /* Authenticators */

==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.

'''WARNING : If "Kodeviser", "Chip" or "Kodeoplæser" is chosen, it will result in immediately ordering of the hardware upon user creation.'''

'''The hardware costs money, so be careful to get approval from customer before enabling these choices.'''

===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.

SSO/Office365

2023-09-22T11:59:15Z

Cna: /* FAQ : */

SSO/Office365

2023-09-22T11:57:33Z

Cna:

SSO/Office365

2023-09-22T11:55:13Z

Cna: /* FAQ : */

'''This feature requires the SSO module included in License'''

'''You also need Office365 Tenant settings to be setup in configurator (Must be same tenant as users are synced with)'''

==How to use Office 365 as login provider instead of Active Directory==
You need to create an '''Enterprise application'''

Login into [https://portal.azure.com/#blade/Microsoft_AAD_IAM/StartboardApplicationsMenuBlade/AllApps/menuId/ portal.azure.com]

*Find '''Azure Active Directory'''
*Find '''Enterprise applications'''
*Click '''New application'''
*Click '''Create your own application'''
*Enter a name
*Choose '''Integrate any other application you don't find in the gallery (Non-gallery)'''
*Click Create (This will also create an '''App registration''')
*Find '''Properties''' for the Enterprise application you just created
*Set '''User assignment required?''' and '''Visible to users?''' to false
*Click '''Save'''
*Click '''Single sign-on'''
*Click '''SAML'''
**Click edit under '''Basic SAML Configuration'''
***Enter this in '''Identifier (Entity ID)'''
****Enter the URL '''<nowiki>https://{URL}/{CustomerID}</nowiki>''' replace {CustomerID} with you number. This can be found in the configurator program under license info
****Delete other URL's
***Enter this in '''Reply URL (Assertion Consumer Service URL)'''
****'''<nowiki>https://{URL}/SSO/AssertionConsumerServiceAzureAd.aspx</nowiki>'''
**Under '''SAML Signing Certificate'''
***Click download for '''Certificate (RAW)'''
***This file must be placed in the root directory of your UMS Academic installation (Normally C:\inetpub\wwwroot)
*Find '''Azure Active Directory'''
*Find '''App registrations'''
*Find your application that was created as an '''Enterprise applications'''
**Click '''API permissions'''
**Click '''Add a permission'''
***Click '''Microsoft Graph'''
****Click A'''pplication permissions'''
*****Add these permissions
******User.ReadWrite.All
******UserAuthenticationMethod.ReadWrite.All
**Click '''Grant admin consent for {Tenant}'''
***Click '''Yes'''
*Open '''SQL Management Studio''' connect to the database
**Run this SQL Command
***Update UMSWebGeneralSettings Set SetSSO = 1
*Open UMS web
**You will be redirected to SSO setup
***Click '''Add,''' enter a name and click '''Create'''
***Choose the name in the drop down and click '''Edit'''
***Click '''Add''' under the section '''Create new Single Sign On'''
****Choose '''Azure AD''' in the '''Type''' drop down
****In the boxes '''Name''', '''SingleSignOnServiceUrl''' and '''SingleLogoutServiceUrl''' replace '''{TenantID}''' with the application id of your Enterprise application
****The '''LocalCertificateFile''' must be entered with a PFX certificate. This file must be placed in the root directory of your UMS Academic installation (Normally C:\inetpub\wwwroot)
****The '''LocalCertificatePassword''' must be entered to be able to read the PFX certificate
****The '''PartnerCertificateFile''' is a certificate the is generated during Azure SSO setup (The file downloaded from '''Certificate (Raw)'''). Remember to include the filename extension
*****This file must be placed in the root directory of your UMS Academic installation (Normally C:\inetpub\wwwroot)
****Click '''Save'''
***Click '''Enable'''
***Click '''Save'''
***Click '''Add to website'''
***Choose website setting and click '''Add'''
**
*Open UMS '''Configurator''' program
**Click '''Web Setup'''
**Select '''General settings'''
***Select '''Azure AD''' in the '''Check login against''' drop down list
*Open SQL Management Studio on the UMS Server and connect to the database
**Run this SQL Command
***Update UMSWebGeneralSettings Set SetSSO = 0
*Restart IIS
*The changes above may take some time to be distributed into Client Tenant system
*
*

 

===Reset password for others===

*Go to '''Azure Active Directory'''
*Click '''Roles and administrators'''
*Find '''Password administrator'''
*Click '''Add assignments'''
*Find the name of the Enterprise application you created earlier
*Select it and click '''Add'''

=== Change password ===
See also [[Password Change Azure AD]] 

=== UMS Graph API connection in Office365 Tenant settings ===
When creating the Office365 tenant settings, just add the client_id and clientsecret from the SSO APP registration settings created above.

‎

=== Cross-origin token redemption is permitted only for the 'Single-Page Application' ===
If this error occurs, this is most likely the authentication settings on the UMS App registration. Web should be filled out with localhost as the image below displays and the Single-page application should be your UMS Web URL.

In most cases this would be something like <nowiki>https://ums.enterschoolnamehere.dk</nowiki>.

[[File:Azure_App_Registration_Authentication.png|frameless|300x300px]]

‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎ ‎

‎
==FAQ :==
If you get this message when trying to connect it might be a matter of waiting for Client tenant distribution
[[File:SSO login error message.png|left|thumb]]

Office 365

2023-06-09T12:32:43Z

Cna: /* Testing after setup */

Our Office 365 SharePoint Portal is a dedicated solution for school, which want an easy-to-use learning portal. Students and teachers are often presented with advanced and complex solutions that does everything they need and then some and as a result, they are difficult to use. We have decided to do things differently and therefore the Office 365 SharePoint Portal gives you the features you need to get the most out of SharePoint. Nothing more, nothing less. The portal is simple and easy to use. This way you avoid confusion and having to navigate yet another complex system. In terms of design, you have two options: the portal can use our standard skin, as pictured above, or our second skin, which we made for primary schools.

==Prerequisites==

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

===Testing after setup===
Users get created in Office 365

'''Then run these powershell commands'''

Install/Update Powershell 7

*Run in Powershell
iex "& { $(irm <nowiki>https://aka.ms/install-powershell.ps1</nowiki>) } -UseMSI"
*https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows

Run these commands in Powershell 7 administrator mode:

#'''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 -RequiredVersion 2.8.5.201 -Scope AllUsers -Force}

$ExchangeOnlineManagement = Get-Module -ListAvailable -Name ExchangeOnlineManagement -ErrorAction SilentlyContinue
if (!$ExchangeOnlineManagement) {Install-Module -Name ExchangeOnlineManagement -Scope AllUsers -Force}

'''Use this command only if no repository is available'''

Register-PSRepository -Default -Verbose

If by accident or due to prior install in Powershell 5, you may receive this error :

''Connecting to remote server outlook.office365.com failed with the following error message : For more information, see the about_Remote_Troubleshooting Help topic.''

Resolve by deleting this folder and rerun above commands in PS7 only.

[[File:Snip.png|567x567px]]

After reinstall use below command in scheduled task to run in correct PS-version.

=== Run Scheduled Task like this ===
"C:\Program Files\PowerShell\7\pwsh.exe" -c "& 'C:\Program Files\UserManagement\LiveAtEdu_Sync.exe'"

=== Office 365 permissions ===
These are only needed if specific options are selected as described below.

==== Exchange permissions ====

* Recipient Management
** Users
*** Mailbox language
*** Mailbox time zone
*** Calendar Rights
*** Address book policy
*** Forward mail *
** Groups
*** All group operations

===[[MSGraphPermissions|Graph permissions]]===
Updating specific attributes on Global admins is not allowed. https://docs.microsoft.com/en-us/graph/api/user-update?view=graph-rest-1.0&tabs=http

A solution to this problem is to make the App registration member of the Global Admin role.

==Installation==

===Office 365===
Enter Admin credentials for a service account with administrator privileges to access Office 365.
[[File:Office365 Setting.jpg|none|thumb|974x974px]]

===Credentials===

=====Tenant setting=====
Choose a tenant setting used for connection to Office 365-

=====Domain=====
Enter the domain that you want the users and groups to have when they are created. E.g. <Username>@<Domain>

===Users===

=====Login=====
Choose what the users shall use to log in to Office365.

======Mail Address======
Choose what to use as the users mail address.

=====Enable password never expires=====
When marked the password will never expire for the users.

=====Disable strong password=====
Use this to bypass the default password complexity.

==== Change password at next logon ====
This will force users to change password the first time they login. This is only set on users that are created.

=====Users are created through third party program=====
This normally means ADFS is used to synchronize users

=====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)

=====Use Active Directory for info=====
This tells UMS to take Department, Title and Organization from AD instead of AD Attributes in UMS.

=====Provision OneDrive=====
This will provision the users OneDrive after he has been created so the user will not have to wait for this when he accesses the OneDrive the first time.

You will need to setup permissions for this to work.

[[MSGraphPermissions#Setup SharePoint permissions]]

=====Usage location=====
This will tell UMS to set usage location when creating a user

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

=====Keep active before disabling x days=====
Specify a grace period where users are active before disabling.

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

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

=====Hide from address list=====
Hide the newly created item from address list.

=====Mailbox language=====
Specify which language is to be default for the users.

=====Mailbox time zone=====
Specify which time zone is to be default for the users.

=====Calendar Rights=====
Set the calendar rights on a user when he is created

=====Calendar object UPN=====
Specify the UPN to put on the users calendar with the rights specified below

If using a group then it must be of type "'''Mail enabled security'''".

====Group UPN for keep alive users====
Specify a group where users that is kept alive is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

====Group UPN for disabled users====
Specify a group where users that is disabled is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

===Template groups===

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

====Maintain extra groups====
This will create all the groups from the [[Configurator/Extra groups|extra groups]] template tab. All users will have direct group member ship.

===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.

====Only senders inside my organization====
With this marked only users in the domain will be able to send to distribution groups created by UMS.

Disabling this will allow the groups to be visible in OneDrive and Classroom

===Picture settings===
This takes the picture privacy setting that the user has set into consideration. The picture will not be uploaded if the user has chosen not to allow his picture to be shared. The picture will not be removed again if it has been uploaded.

====Student picture library====
Define where the pictures are for the students that uses this template. If this is not set, no pictures will be uploaded to Office 365.

====Employee picture library====
Define where the pictures are for the employees that uses this template. If this is not set, no pictures will be uploaded to Office 365.

===Timetable===

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

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

====Room setting====
Create rooms with timetable blocks.

=====Manage=====
[[File:Office365roomsettings.png|none|thumb|378x378px]]

=====Room displayname=====

=====Prefix=====
Text that can be added to the start of what is chosen in Generator.

=====Generator=====
Choose what is to define the room.

=====Suffix=====
Text that can be added to the end of what is chosen in Generator.

=====Resulting displayname=====
Summary of the chosen display name as it will be shown in Office 365.

=====Set rights to rooms=====
Sets the rights on rooms when created

This has to be a '''Distribution Group''' Otherwise it won't work
[[File:Office365roomsettings2.png|none|thumb|274x274px]]

======Owner======
Users will be able to create, read, modify and delete all items and files, and create sub-folders. As the folder owner, they can change the permission levels others have for the folder. (Does not apply to delegates.).

======Publishing Editor======
Users can create, read, modify and delete all items and files, and create sub-folders. (Does not apply to delegates.).

======Editor======
Users can create, read, modify and delete all items and files..

======Publishing Author======
Users can create and read items and files, create sub-folders, and modify and delete items and files they create. (Does not apply to delegates.).

======Author======
Users can create and read items and files and modify and delete items and files you create.

======Nonediting Author======
Users have full read details. Can create items and delete own items. Folder visible.

======Reviewer======
Users can read items and files only.

======Contributor======
Users can create items and files only. The contents of the folder does not appear. (Does not apply to delegates.).

'''''Note''''' ''With author or editor permissions, a delegate has send-on-behalf-of permission. Sent messages contain both the managers and delegates names. Message recipients see the managers name in the Sent On Behalf Of box and the delegates name in the From box.''

=====Define rooms to be created=====
Specify the rooms to be created based on a filter. If nothing is entered, every room will be created.
[[File:Office365criteria.png|none|thumb|202x202px]]

======Room number and Room name======
Can be found in the skemabrikker_rooms table in SQL.

===Office 365 SharePoint site setting===
This will create SharePoint sites
[[File:Office365sharepointsitesettings.png|none|thumb|720x720px]]
[[File:Office365sharepointsitesettings2.png|none|thumb|567x567px]]

====''Site settings''====

=====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.

=====Check if group rights match=====
When UMS looks for UMS-groups on the site, it will do so based on two criteria’s.

The correct rights and the correct name. Unchecking this will disable the first criteria and only look for a group with the right name. (This is when users change the UMS-group rights on a site manually)

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

=====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:Office365filters.png|none|thumb|507x507px]]

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.

=====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:Office365filterexample.png|none|thumb|401x401px]]

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:Office365filters.png|none|thumb|507x507px]]

=====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:Office365filter.png|none|thumb|416x416px]]

=====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.

After you have created the Office 365 setting you put in on a template.
[[File:Office365templateeditor.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===SharePoint settings===
Sites created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365template.png|none|thumb|422x422px]]

====Site URL====
Which site collection is used when creating sites

Language: The default language of the created site

Course Template

Standard SharePoint: Use a standard template from SharePoint

Course template: Enter a name of a template that resides in the site collection. If nothing is entered it will default to the Team site template

UMS SharePoint Portal: Create sites based on the UMS SharePoint Portal product

====OneNote Class Notebook setting====
Choose a Class Notebook setting. This will create a Class Notebook created in the SharePoint site.

====SQL Groups====

Members of these groups will be attached to all sites created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

OneNote Class Notebook setting

Define settings for OneNote Class Notebooks.
[[File:OneNotesections SharePoint.png|none|thumb|476x476px]]

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]Use Name instead of title for Notebooks (Last part of URL)

This will make the title of the NoteBook be the same as the last part of the URL of the SharePoint site that the NoteBook is created in. It never changes unless this is unchecked.

Never update Notebook title after creation

The NoteBook will never update the title after it has been created, even though the SharePoint site changes title. it will be created with the title that SharePoint site has at createin time.

===OneNote Class Notebook setting===
[[File:Office365onenoteclassnotebooksettings.png|none|thumb|720x720px]]
[[File:Office365onenoteclassnotebooksettings2.png|none|thumb|720x720px]]

====''Notebook settings''====

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

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

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

Finished on activity/course

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

====Delete Notebooks====
Auto delete

Notebooks will be delete when the last student has left the Notebook

Manual Delete

Notebooks 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 Notebook.

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

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

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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 Notebooks====

====Do not create====
It will not create any Notebooks 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 Notebooks based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as to or more Notebooks to be created as one Notebook.
[[File:Office365filterexample.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 Notebook 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 Notebook.

Set the settings as shown below
[[File:Office365filterexample.png|none|thumb|401x401px]]

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

====Course Notebooks====
Course URL’s will always be created as activity course.

====Do not create====
It will not create any Notebooks 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 Notebook based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as two or more Notebooks to be created as one Notebook.
[[File:Office365filter.png|none|thumb|416x416px]]

====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 Notebook 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 Notebook with an empty string.

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

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

After you have created the Office 365 setting you put in on a template.
[[File:Office365template2.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===OneNote Class Notebook settings===
Notebooks created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365settings.png|none|thumb|422x422px]]

====Site collection URL====
Which Notebook collection is used when creating Notebooks

====Language====
The default language of the created Notebook

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

===Organization Settings===
[[File:Office365organization.png|none|thumb|656x656px]]

====''Site settings''====

====Description====
Add a description to be able to identify the account.

====SharePoint administration URL====
URL of the SharePoint administration site for the tenant.

====''Credentials settings''====

====Username====
Username used to connect to SharePoint.

====Password====
Password used to connect to SharePoint.

==Parameters==
> LiveAtEdu.exe [<optional> Action]
Eg.
> LiveAtEdu.exe

> LiveAtEdu.exe UsersOnly
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|UpdateUsers
|Update users
|-
|DisableUsers
|Disable users
|-
|EnableUsers
|Enable users
|-
|DeleteUsers
|Delete users
|-
|CreateUsers
|Create users
|-
|UpdateImmutableID
|Update Immutable ID on users
|-
|UpdateOffice365SettingsIDForUsers
|Update Office 365 settings for users if they have changed template
|-
|UpdateUsersObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+User settings
!Parameter
!Description
|-
|RunUserSettings
|Runs all the parameters in this table
|-
|DisableStrongPassword
|Disable strong password for users
|-
|SetMailAddress
|Set mail address on users
|-
|Forward2OnPremiseMail
|Set forward to OnPremise mail on users
|-
|SetCalendarRights
|Set calendar rights on users
|-
|UpdateMailboxTimeZone
|Update timezone for mailbox users
|-
|UpdateMailboxLanguage
|Update language for mailbox users
|-
|EnablePasswordNeverExpires
|Enable password never expires for users
|-
|UpdatePictures
|Update pictures
|-
|Forward2PrivateMail
|Set forward to privatemail on users
|-
|UpdateReplyToAll
|Set Reply to all on users
|-
|ProvisionOneDrive
|Provision OneDrive to users
|-
|UpdateAddressBookPolicy
|Set address book policy on users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|RemoveGroupMembers
|Remove group members from groups
|-
|AddGroupMembers
|Add members to groups
|-
|DeleteGroups
|Delete groups
|-
|CreateGroups
|Create groups
|-
|UpdateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForGroups
|Get the UPN of template groups from Office 365
|}
{| 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
|-
|UpdateTemplateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForTemplateGroups
|Get the UPN of template security groups from Office 365
|}
{| class="wikitable"
|+Template extra groups
!Parameter
!Description
|-
|TemplateExtraGroupsOnly
|Runs all the parameters in this table
|-
|CreateTemplateExtraGroups
|Create groups from template extra group
|-
|DeleteTemplateExtraGroups
|Delete groups that are no longer in extra groups
|-
|AddTemplateExtraGroupMembers
|Add users to template extra groups
|-
|UpdateTemplateExtraGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+Keep alive groups
!Parameter
!Description
|-
|KeepAliveGroupsOnly
|Runs all the parameters in this table
|-
|CreateKeepAliveGroups
|Create keep alive groups
|-
|DeleteKeepAliveGroups
|Delete keep alive groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnKeepAliveGroups
|Update the mail address on keep alive groups
|-
|AddKeepAliveGroupMembers
|Add users to keep alive groups
|-
|RemoveKeepAliveGroupMembers
|Remove users from keep alive groups
|}
{| class="wikitable"
|+Disabled groups
!Parameter
!Description
|-
|DisabledGroupsOnly
|Runs all the parameters in this table
|-
|CreateDisabledGroups
|Create disabled groups
|-
|DeleteDisabledGroups
|Delete disabled groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnDisabledGroups
|Update the mail address on disabled groups
|-
|AddDisabledGroupMembers
|Add users to disabled groups
|-
|RemoveDisabledGroupMembers
|Remove users from disabled groups
|}
{| class="wikitable"
|+Teams
!Parameter
!Description
|-
|TeamsOnly
|Runs all the parameters in this table
|-
|AddTeams2DB
|Add Teams to UMS DB
|-
|CreateTeams
|Create Teams
|-
|AddTeamToGroup
|Add teams to groups
|-
|ActivateTeams
|Activate teams
|-
|UpdateTeams
|Update Teams
|-
|DeleteTeams
|Delete Teams
|-
|AddTeachers2TeamsDBTable
|Add teachers to Office365Teams_Teachers table in UMS DB
|-
|AddTeachers2Teams
|Add teachers to Teams
|-
|AddLearners2TeamsDBTable
|Add learners to Office365Teams_Learners table in UMS DB
|-
|AddLearners2Teams
|Add learners to Teams
|-
|TeamsDeleteTeachers
|Delete teachers in Teams
|-
|TeamsDeleteLearners
|Delete learners in Teams
|-
|TeamsUpdateNeedToBeUpdated
|Set update on next run flag
|-
|UpdateLearnersExternalID
|Retrieve the learners object id from Office 365 and save it in UMS DB
|-
|UpdateTeachersExternalID
|Retrieve the teachers object id from Office 365 and save it in UMS DB
|-
|UpdateSchoolsExternalID
|Retrieve the schools object id from Office 365 and save it in UMS DB
|-
|UpdateTeamsExternalID
|Retrieve the teams object id from Office 365 and save it in UMS DB
|}
{| class="wikitable"
|+SharePoint
!Parameter
!Description
|-
|SharepointOnly
|Runs all the parameters in this table
|-
|CreateSites
|Create sites
|-
|AddSites2DB
|Add sites in UMS DB
|-
|DeleteSites
|Delete sites
|-
|UpdateSites
|Update sites
|-
|AddLearners2SitesInDB
|Add learners to UMS DB
|-
|DeleteTeachers
|Delete teachers
|-
|AddTeachers2Sites
|Add teachers to sites
|-
|DeleteSiteGroups
|Delete site groups
|-
|AddTeachers2SitesInDB
|Add teachers to UMS DB
|-
|DeleteLearners
|Delete learners
|-
|AddLearners2Sites
|Add learners to sites
|-
|UpdateSiteURL
|Update sites with new URL
|-
|AddNoteBooks2Sites
|Add OneNote Class NoteBooks to sites
|-
|SharePointDeleteNoteBooks
|Delete OneNote Class NoteBooks from sites
|-
|UpdateNeedToBeUpdated
|Set the update on next run flag
|-
|UpdateSitesIsActive
|Update site active/inactive status
|-
|SharePoint_OneNoteClassNotebook_AddMissingTeachers
|Add missing Teachers to OneNote Class NoteBooks
|-
|SharePoint_OneNoteClassNotebook_AddMissingLearners
|Add missing Learners to OneNote Class NoteBooks
|-
|ReAddLearners2Sites
|Re-add learners to sites if ReAdd is true in DB
|-
|ReAddTeachers2Sites
|Re-add teachers to sites if ReAdd is true in DB
|}
{| class="wikitable"
|+OneNoteClassNoteBook
!Parameter
!Description
|-
|OneNoteClassNotebookOnly
|Runs all the parameters in this table
|-
|AddNotebooks2DB
|Add OneNote Class NoteBooks to UMS DB
|-
|CreateNotebooks
|Create OneNote Class NoteBooks
|-
|UpdateOneNotes
|Update OneNote Class NoteBooks
|-
|DeleteOneNotes
|Delete OneNote Class NoteBooks
|-
|AddTeachers2OneNotesInDB
|Add teachers to OneNote Class NoteBooks in UMS DB
|-
|AddTeachers2OneNotes
|Add teachers to OneNote Class NoteBooks
|-
|AddLearners2OneNotesInDB
|Add learners to OneNote Class NoteBooks in UMS DB
|-
|AddLearners2OneNotes
|Add learners to OneNote Class NoteBooks
|-
|OneNoteDeleteTeachers
|Delete teachers in OneNote Class NoteBooks
|-
|OneNoteDeleteLearners
|Delete learners in OneNote Class NoteBooks
|-
|OneNoteUpdateNeedToBeUpdated
|Set update on next run flag
|}

==Technical settings==

==Maintenance==

===portal.office.com===

====''Teams''====

Go to [http://portal.office.com Office Portal] and login with your admin account( the same UMS uses).

Select settings Services and add-ins and click Teams.
[[File:Office_365_Teams_activation.PNG|1350x1350px|thumb|Activate Teams for a license type, ie. Guest or Education-Student|none]]

==FAQ==

===Office 365 Licens (Unable to assign this license) How to troubleshoot this error===

====Error message from UMS Job log (LiveAtEdu)====

=====''Error = Unable to assign this license''=====
''Set-MsolUserLicense -UserPrincipalName 'khhi3275@ums.dk' -AddLicenses "inLogic:STANDARDWOFFPACK_IW_STUDENT" -LicenseOptions $MyO365Sku''

''Error = Unable to assign this license.''

''29-01-2019 13:23:00 - at Utilities.Office365.SetLicenseForUser(String UPN, List`1 Licenses, SqlConnection& LocalSQLDBConnection)''

'' at LiveAtEdu_Sync.LiveAtEdu_Sync.PerformFunctionUserSettings(String SQLStr, UserFunctions Office365Function, MethodInfo StackFrame)''

''29-01-2019 13:23:00 - khhi3275- UPN = khhi3275@ums.dk''

''29-01-2019 13:23:01 - (UpdateLicenseInfoOnUsers) Error. Could not set license for user - khhi3275@ums.dk ''

*Try adding the same licenses manually to a single user in office365. You could see if that is possible[[File:Licens.jpg|none|thumb|814x814px]]

*The error shows that it is not possible to put the same licenses together[[File:Licens Error.png|none|thumb|812x812px]] 
*Change your licenses in UMS and run the LiveAtEdu job again

===Groups===
How to get groups visible in OneDrive and Classroom

Remove the checkbox from Only senders inside my organization

Why do I not get the site created?

#Activity
##Is there a user on the activity with a primary template that has an office 365 setting attached
##Is the flag Aktivitet_LMS = True
#Course
##Is there a user on the course with a primary template that has an office 365 setting attached
##Is the flag Skolefag_LMS = True

===Disable or enabling user===
Error = Message: Insufficient privileges to complete the operation.

This could be the result of the user trying to be disabled/enabled has roles that does not allow the action like Global Administrator.

===The term 'Set-UnifiedGroup' is not recognized as a name of a cmdlet, function, script file, or executable program.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Set-UnifiedGroup

===A parameter cannot be found that matches parameter name 'type'.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps
[[File:Office365 ExchangeAdminRoleNeeded.jpg|none|thumb|1275x1275px]]

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Get-DistributionGroup

File:Snip.png

2023-06-09T12:29:00Z

Cna:

TimeEditFields

2023-03-24T08:51:58Z

Cna: /* Activity */

==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 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
|
|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'''".

InLogic SMS Gateway

2023-03-09T07:35:14Z

Cna: /* How to change IP settings */

==Important==
To be able to send SMS, the inLogic SMS Gateway requires GSM modems with USB interface. We recommend "HUAWEI LTE USB Stick Model: E3372".

===Hardware Compatibility List===
[http://consumer.huawei.com/en/mobile-broadband/e3531/specs/ Huawei E3531]

[http://consumer.huawei.com/en/mobile-broadband/e3372/ Huawei E3372] (inLogic's choice)

[http://consumer.huawei.com/lk/mobile-broadband/dongles/features/e3131-lk.htm Huawei E3131i]

[http://www.tp-link.com/la/products/details/cat-5090_MA260.html TP-Link MA260]

==Network Port Openings==

====TCP port openings from server to gateway. TCP port opening where UMS sms sever service run.====
{| class="wikitable"
!Port
!Usage
|-
|22
|SSH access
|-
|443
|HTTPS access
|}

====TCP port openings from gateway to server.====
{| class="wikitable"
!Port
!Usage
|-
|80
|HTTP access
|-
|443
|HTTPS access
|}

==Prepare Modem==
{|
![[File:20180516 104258-50%.jpg|none|thumb|800x800px]]
!Plug-in Modems

!
!
|-
|[[File:20180516 104358-50%.jpg|none|thumb|800x800px]]
|'''Plug-in Ethernet cable'''

'''Plug-in power cable'''
|
|
|-
|
|
|
|
|-
|
|
|
|
|}

==System Login==
Once the gateway is [[#Prepare Modem|prepared]] and booted, open a browser and go to http://192.168.1.2. Login through the 'Login' button in the top right corner.
[[File:Main Login button.png|none|thumb|1240x1240px]]
You will now see a login box where you can log in with with USERNAME: admin and PASSWORD: admin.
[[File:Login.png|none|thumb|1240x1240px]]

==Main Page==
After logging in, the system info page appears. This page shows the gateway's status.[[File:Main.png|none|thumb|1240x1240px]]
To open the menu, click on this icon: [[File:Foxbox menu button.png|frameless|23x23px]]
[[File:Main with menu.png|none|thumb|1240x1240px]]

==Network Configuration==
Click on menu tab 'Network config'.

Change the IP settings and press 'Save Configuration'. When you have saved your settings, [[InLogic SMS Gateway#Reboot|Reboot]] the gateway as instructed below in 'Modem Settings'.
[[File:Network Config.png|none|thumb|1240x1240px]]

==Modem Settings==

===Hostname and Frontend Settings===

====Hostname====
Open the menu and go to 'Modem Settings'.

Set 'Modem Hostname' as FQDN and save your changes. Your modem will now restart.[[File:Modem Settings Hostname.png|none|thumb|1240x1240px]]

====Frontend====
Open the menu and go to 'Modem Settings'.

If redirect is enable on iis set (HTTPS)

Change 'FrontEnd Address' to fit your configuration and save your settings.[[File:Modem Settings Frontend.png|none|thumb|1240x1240px]]

===Certificate Settings (https)===
Open the menu and go to 'Modem Settings'.

Click 'Choose File' and choose a .pfx certificate from your computer.

Entera a .pfx certificate password in the 'Certificate Password' field and click 'Save'.
[[File:Modem Settings Certificate.png|none|thumb|1240x1240px]]

===User Settings===
Open the menu and go to 'Modem Settings'.

The default admin user password is 'admin'. To change the default admin user password, write the new password in the 'Password' field just below the 'Username' field admin.

The default sendsms user password is 'sendsms'. To change the default sendsms user password, write the new password in the 'Password' field just below the 'Username' field sendsms.

Click 'Save' to confirm the password change.
[[File:Modem Settings User.png|none|thumb|1240x1240px]]

==Control Panel==
Open the menu and go to 'Control Panel'.

Here, you can see staus, as well as turn on and off, the SMS Engine.[[File:Control Panel.png|none|thumb|1240x1240px]]

==SMS==

===Inbox===
To see a log for incoming messages, open the menu and go to 'Inbox'.
[[File:Inbox.png|none|thumb|1240x1240px]]

===Outbox===
To see a log for outgoing messages, open the menu and go to 'Outbox'.
[[File:Outbox.png|none|thumb|1240x1240px]]

===Failed===
To see a log for failed messages, open the menu and go to 'Failed'.
[[File:Failed.png|none|thumb|1240x1240px]]
===Write New===
To write a new SMS, open the menu and go to 'Write New'.

Choose the modem you wish to send your message from in the drop down menu 'Outgoing channel'. If left blank, the system will choose the first available modem.

Enter the phone number you wish to send your SMS to in the 'To' field. Pleas note that international prefix is mandatory.

Write your message in the 'Message' field.

When you have finished, click 'Send'.[[File:Write New guide.png|none|thumb|1240x1240px]]

==Time Zone Settings==
Open the menu and go to 'Time Zone Settings'.

The NTP & Time Zone Settings is by default set to enable external NTP.

For internal NTP, uncheck the 'Enable External NTP' box and write a list of NTP servers separated by comma, in the 'Internal NTP' field.

To change your time zone, choose a time zone from the 'Time Zone' drop down menu.

Click 'Save' to change your settings.
[[File:Time Zone Settings.png|none|thumb|1240x1240px]]

==Tools==
Open the menu and go to 'Modem Settings'.

===Shell===
Use 'in browser' shell to change advanced settings.

Use with caution! Please note that if you make any changes without consulting us first, support will be charged accordingly with our hourly rate.
[[File:Modem Settings Shell.png|none|thumb|1240x1240px]]
===Root Settings===
Change of root password require putty.exe. Default root password can be requested from inlogic.

Use Putty.exe to connect to Inlogic Gateway, run command ''(sudo passwd root'') and follow the instructions on screen.
[[File:Modem Settings Root.png|none|thumb|1240x1240px]]

==Additional information==
Additional information about the product, users, and programs used in the tutorial.
====Usernames and passwords====
====SSH Clients====
{| class="wikitable"
|+A list of SSH Clients
!Program name
!URL
|-
|PuTTy
|https://www.putty.org/
|}

====Open source FTP Client====
{| class="wikitable"
|+A list of FTP clients
!Program name
!URL
|-
|WinSCP
|https://winscp.net/eng/index.php
|-
|FileZilla
|https://filezilla-project.org/
|}
==FAQ==

===Linux commands===

==== Update ubuntu ====
sudo apt-get update -y
sudo apt-get upgrade -y

====Update inLogic files and Database from command line====
rm -rf /mnt/Update/update
wget --no-check-certificate <nowiki>https://downloads.inlogic.dk/inlogicgatewaymodem/Update.zip</nowiki> -O /mnt/Update/Update.zip
unzip /mnt/Update/Update.zip -d /mnt/Update/update
chmod 777 /mnt/Update/update/mnt/flash/root/updateservice/update.sh
/mnt/Update/update/mnt/flash/root/updateservice/update.sh

'''Commands'''

*Commands shows Status of Apache (systemctl status apache2.service)
*update system ( apt-get udate apt-get update)

====Update ubuntu from 18 to 20====
Use default answers when running these commands.
sudo sed -i 's/bionic/focal/g' /etc/apt/sources.list
sudo sed -i 's/bionic/focal/g' /etc/apt/sources.list.d/odroid.list
sudo apt-get update -y
sudo apt-get upgrade -y
sudo apt-get dist-upgrade -y

====How to change IP settings====

*nano /etc/netplan/01-netconf.yaml
*reboot

====Logs====

=====Log viewers=====

*tail
*tail -f (this is similar to using cmtrace in windows)
*nano
*vim

=====Log files=====

*/var/log/smstools/smsd.log
*/var/log/syslog
*/var/log/mysql/error.log
*/var/log/apache2/error.log

=====See USB devices=====

*lsusb

==Rest API==
Theres a REST API to use, to send messages from the inLogic SMS Gateway.

===Send SMS===
{| class="wikitable"
!Title
!
|-
|URL
|source/send_sms.php
|-
|Method
|POST
|-
|URL Parameters
|Username

Password

To

Message
|-
|Success Response
|200 - Success
Returns ID of send SMS
|-
|Error Response
|401 - Unauthorized
|-
|Error Resposne
|403 - Forbidden
|-
|Error Response
|500 - Internal server error
|-
|Sample Request
|source/send_sms.php?username=smsuser&pwd=testpassword123&from=ums&to=22446688&message=Dette er en test besked
|-
|Notes
|
|}

Example
curl -X POST <nowiki>https://modem.ums.dk/source/send_sms.php?username=</nowiki><USERNAME>&pwd=<PASSWORD>&from=ums&to=<RECIEPIENT>&message=<MESSAGE>

===Check SMS Status===
{| class="wikitable"
!Title
!
|-
|URL
|webservice/getstatus.php
|-
|Method
|POST
|-
|URL Parameters
|Username

Password

ID
|-
|Success Response
|200 - Success
Returns status of send SMS

ScheduledToSend = -1

OK = 0

OK_WithError = 1

InUMSQueue = 2

InModemQueue = 3

Failed = 4

IDNotFound = 5

SentViaMail = 100

FailedSendingViaMail = 101
|-
|Error Response
|401 - Unauthorized
|-
|Error Resposne
|403 - Forbidden
|-
|Error Response
|500 - Internal server error
|-
|Sample Request
|webservice/getstatus.php?=smsuser&pwd=testpassword123&id=1
|-
|Notes
|
|}

Example
curl -X POST https://modem.ums.dk/webservice/getstatus.php?username=<USERNAME>&pwd=<PASSWORD>&id=<ID>

MSGraphPermissions

2023-02-24T13:07:03Z

Cna: /* Open Powershell 5 on the server running the program */

'''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( '''the same UMS uses''').

'''!!! ATTENTION !!! use service account that UMS uses'''

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 -RequiredVersion 2.8.5.201 -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]]

Configurator/SMS Server

2022-09-12T10:46:35Z

Cna: /* gatewayapi.com */ fjernet

=Choose the desired SMS Gateway solution=

==Stand alone==
This is a hardware box delivered by inLogic.

[[InLogic SMS Gateway]][[File:SMS Server StandAlone inLogic Modem.jpg|none|thumb|570x570px]]
====Gateway address====
Enter the full DNS name of the inLogic gateway

====User name====
This cannot be changed.

====Password====
Enter the password of a sendsms user. This password can be change on the gateway

==Gateway server==
This is a server program that can combine more inLogic gateways.[[File:SMS Server GateWayServer.jpg|none|thumb|570x570px]]

====Gateway address====
Enter the full DNS name of the gateway server

====User name====
Enter the username for the webservices. Default is "WebserviceUser" but can be changed.

====Password====
Enter the password for the user. This has to be setup at first install of the GateWay server program. The password generated at install is random.

==SMS Provider==
This option allows you to choose between a list of internet SMS providers that UMS integrates with.

===[https://gatewayapi.eu/ gatewayapi.eu]===
Remember to create an account first.[[File:SMS Server SMSProvider gatewayapi.jpg|none|thumb|570x570px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Region====
Select the region to COM or EU.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====API Token====
Used to authenticate when sending SMS to users.

It is found on the gatewayapi site under API->API keys->Get Key/Token

====Keyword====
This is used when your using a keyword in gatewayapi.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at gatewayapi====
Setup a REST web hook to catch incoming SMS and send them to UMS. This is setup under API->Web Hooks->Rest->Add new

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/gatewayapi.asmx/Incoming https://<Public DNS>/SMSServer/gatewayapi.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

Under keywords for the web hook assign the phone number and/or the keyword.

===[https://www.sinch.com/ Sinch.com]===
Remember to create an account first.
[[File:SMS Server SMSProvider Sinch.jpg|none|thumb|500x500px]]

====Callback URL====
Enter the URL of the UMS web server. This must be running https.

This is used for status updates when sending SMS from UMS.

====Sender====
Enter a phone number or 11 characters. This is what is displayed on the phone when receiving the SMS.

====Service plan id====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====API Token====
Used to authenticate when sending SMS to users.

This can be found https://dashboard.sinch.com/sms/api/rest

====Keyword====
This is used when your using a keyword in Sinch.com to identify where to send incoming SMS from users. This will remove the keyword at the start of the SMS.

This can be blank if you don't want to remove the keyword from the SMS or if your using a virtual number.

This is only used when using short codes instead of virtual numbers.

====Configuration settings at Sinch.com====
Setup a Callback URL for the virtual number to catch incoming SMS and send them to UMS. This is setup here https://dashboard.sinch.com/numbers/your-numbers/numbers. Choose the correct virtual number.

The web hook URL must be:[https://044e-87-48-162-154.ngrok.io/SMSServer/Sinch.asmx/Incoming https://<Public DNS>/SMSServer/Sinch.asmx/Incoming]

Change the public DNS to your UMS frontend servers URL.

=Default settings=
[[File:SMS Server Settings.jpg|none|thumb|518x518px]]

====Keep SMS log====
Set how many days to keep SMS entries in the database.

====Resend====
Set how many times the gateway will try to send the SMS, before sending the text in an e-mail.

====Country code====
This is used to identify the country where the SIM cards are registered.

====Max reply time====
Set the number of minutes the user has to answer a received mail.

====Local number length====
Define how long the phone numbers for the country code is.

====SMS Start time====
Choose time of day from when it is possible to send messages using UMS.

====SMS end time====
Choose time of day when it is no longer possible to send messages using UMS.

G Suite

2022-08-31T13:07:49Z

Cna:

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==

===Supported administrative systems===

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

===Additional functionality===

===Testing after setup===

===What to have ready===

===Is any physical item required===

===Should third party be contacted===

==Installation==
'''Google Apps'''
[[File:Googleappsadminsettings.png|none|thumb|577x577px]]

======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.

'''“Only senders inside my organization”'''

With this marked only users in the domain will be able to send to distribution groups created by UMS.

''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.

==='''<big>Drive</big>'''===
[[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|link=http://wiki.inlogic.dk/index.php/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 Classroomss”'''

'''“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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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 aswell. (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|link=http://wiki.inlogic.dk/index.php/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:Googleappsdrivesettings.png|none|thumb|429x429px]]

'''Path'''

The path where the drives are created

'''Create user specific subfolder'''

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)'''

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)'''

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|link=http://wiki.inlogic.dk/index.php/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]]

'''“SQL Groups”'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/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 <nowiki>https://console.developers.google.com</nowiki> with your Google Admin account.

Create a project
[[File:Googlesyncproject2.png|none|thumb|594x594px]]

When created choose project and click the newly created project.

Choose “Enable and manage APIs”. Enable these APIs
[[File:Googlesyncenableapi.png|none|thumb|463x463px]]

Click credentials

And choose “OAuth client ID”

Choose settings as show on below image. Name can be changed.
[[File:Googlesyncoauth.png|none|thumb|499x499px]]

Then choose “Create”

Which creates an OAuth 2.0 client ID

Enter Client ID and Client Secret into UMS
[[File:Googlesyncoauth2.png|none|thumb|513x513px]]

Go back to “Overview” and choose “Enabled APIs”

Click on each API you added and choose Quota
[[File:Googlesyncenableapi2.png|none|thumb|517x517px]]

Set the number as high as you can without “apply for higher quota”
[[File:Googlesyncapplyhighquota.png|none|thumb|439x439px]]

And you are done with this site.

Now Log on https://admin.google.com with your Google Admin account

Find “Other Google Services” - can be located under “More Controls” or under APPS aplaced at page bottom.

Click “add services” upper right corner

Then click “Add it now” on “Groups for Business”
[[File:Googlesyncservices.png|none|thumb|495x495px]]

Back to start and choose “Security”

Choose “API reference” and check “Enable API access”
[[File:Googlesyncsecurity.png|none|thumb|439x439px]]

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]]

GetTimetable/Ludus

2022-08-31T08:25:04Z

Cna: /* FAQ */

==Requirements for writing absence to LUDUS==
You will need to open this webservices in LUDUS (marked in yellow) if UMS is going to write absence back to LUDUS.

Link to Ludus Webservice Catalog - https://ludushelp.eg.dk/system/Web_services.htm

[[File:Ludus Absence Webservice.png]]
==Setup==
[[File:GetTimeTable LUDUS.jpg|none|thumb|783x783px]]

===[[GetTimetable/Format and content|Format and content]]===

===Description===
Name of the setting.
===[[GetTimetable/Absence_settings|Absence settings]]===

===[[GetTimetable/Export_settings|Export settings]]===

===Only write back test data to LUDUS===
This will only write information back to LUDUS if the activity starts with '''UMS'''.

===Ludus absence codes -> UMS Absence codes===
Specify how the Ludus absence codes translates to the absence codes in UMS.

'''This will also enable UMS to write the absence reason from the student back to Ludus.'''

===Write legal absence as illegal absence===
Normally legal absence will be written as attended. Checking this will write it as absent.

Absence reasons will still be written back to Ludus as legal absence.

===Write too late as illegal absence===
Normally too late will be written as the minutes that the person came too late. Checking this will write the full lesson as absent.

Absence reasons will still be written back to Ludus as too late absence.

===Append admin note to student reason (Only for webhold)===
This will append the note type admin note to the student reason when writing absence reasons to Ludus.

The admin note will still be written back to Ludus even though the student hasn't given a reason.

===Write back default reason if none exists in UMS===
This will write the default reason text from Ludus as an absence reason if the student reason or admin note (requires the above option the be checked) hasn't been submitted.

If this option is disabled no absence reason will be written until one is entered into UMS. (Student reason or admin note)

==FAQ==
If exportabsencetoadminsystem log contains error about absence_code not found in Ludus, it could missing "fraværskode" or a discrepancy in "tekst".
[[File:Fraværskoder.png|none|thumb|406x406px]]

To resend already sent absence_registrations , set export2adminsys = 1 in these tables

Absence_register (for todays registrations)

Absence_stat_register (for older registrations)

File:Fraværskoder.png

2022-08-31T08:21:12Z

Cna:

fraværskoder i Ludus

Timetable

2022-08-29T13:19:40Z

Cna: /* AllTimeTableEmployees */

Skemabrikker.exe is a small sync job that needs to run when timetables are created, updated, or deleted.

Example of timetable in UMS and Outlook:
[[File:Timetable in UMS and Outlook.png|none|thumb|600x600px]]

The following systems are supported:

*Office 365
*Exchange
*GSuite 

==Parameters==

===Usage===
> Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> Mail] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]]
Eg.
> Skemabrikker.exe Office365 teachersonly

> Skemabrikker.exe Office365 find tea@umsacademic.onmicrosoft.com 12-05-2019 13-05-2019 All

====Applyrights====
Only works for Exchange and Office365. Restores rights for a room if they have accidentally been deleted or changed. 

====Systems====
This parameter is used to define what system Skemabrikker.exe will populate the timetables to. We currently support timetable integration to these systems:

Exchange

Office365

GoogleApps

[[Timetable/itslearning|Itslearning]] 

=====Teachersonly=====
This parameter is used if the [action] parameter needs to affect only teachers.

=====Studentsonly=====
This parameter is used if the [action] parameter needs to affect only students.

=====Roomsonly=====
This parameter is used if the [action] parameter needs to affect only a given physical Classroom (When this parameter is used you need to add the ID for the given room ie. [Action] [Mail] 'Room_ID').

=====Activitiesonly=====
This parameter is used if the [action] parameter needs to only affect a given activity (When this parameter is used you need to add the ID for the given activity ie. [Action] [Mail] 'Activity_ID').

=====Coursesonly=====
This parameter is used if the [action] parameter needs to only affect a given course (When this parameter is used you need to add the ID for the given course ie. [Action] [Mail] 'Activity_ID_Course_ID').

====Action====

=====find=====
Used to display the timetables associated with the given [mail] parameter.

=====delete=====
Used to delete the timetables associated with the given [mail] parameter.

=====update=====
Used to update the timetables that needs to be updated and are associated with the given [mail] parameter.

=====cleanup=====
Used to find UMS appointments in users calendars and delete them if they are not found in UMS database.

====Mail====

=====mail/UPN=====
This parameter is used if the [action] parameter needs to affect a specific user.

=====AllTimeTableStudents=====
This will delete timetable blocks from all known students

'''Works with'''

Office 365

Exchange

=====AllTimeTableEmployees=====
This will delete timetable blocks from all known employees
{| class="wikitable"
|+
!Eg : Skemabrikker.exe Office365 delete AllTimeTableEmployees 01-08-2022 31-09-2022 UMS
|}
'''Works with'''

Office 365

Exchange

=====AllTimeTableRooms=====

This will delete timetable blocks from all known rooms.

'''Works with'''

Office 365

====StartDate====
This parameter is used to define the start date in which the find, delete, or update parameter will affect the timetables. The format for this parameter is dd-mm-yyyy.

====EndDate====
This parameter is used to define the end date in which the find, delete, or update parameter will affect the timetables The format for this parameter is dd-mm-yyyy. 

====Type====
UMS - This parameter is used to define that the timetables that have been generated by UMS, will be effected.

NonUMS - This parameter is used to define that the timetables that have not been generated by UMS, will be effected.

All - This parameter is used to define that timetables both from UMS and non UMS, will be effected. 

==External systems==

===[[Timetable/itslearning|itslearning]]===

===[[Timetable/Office365|Office 365]]===

===[[Timetable/GoogleGSuite|Google GSuite]]===

==FAQ==

====How do I find timetable blocks with skemabrikker.exe ?====
Example following the general parameters:
{| class="wikitable"
|skemabrikker.exe office365 find tea@umsacademic.onmicrosoft.com 12-05-2019 13-05-2019 All
|}
Inspect the skemabrikker.log. The long string value in the log file refers to the ID in the table '''SkemaBrikkerSavedEntries_Students, SkemaBrikkerSavedEntries_Teachers, SkemaBrikkerSavedEntries_Rooms, SkemaBrikkerSavedEntries_Activities'''.
[[File:Skemabrikkerlog.png|none|thumb|864x864px]]

====How do I find timetable blocks with SQL statements?====
{| class="wikitable"
|Select SkemaBrikkerNewEntries.*

From SkemaBrikkerNewEntries

Join SkemaBrikker_Students On SkemaBrikkerNewEntries.SkemaBegivenhed_ID = SkemaBrikker_Students.SkemaBegivenhed_ID And SkemaBrikkerNewEntries.SkemaBrikkerAdminServers_ID = SkemaBrikker_Students.SkemaBrikkerAdminServers_ID

And SkemaBrikkerNewEntries.Activity = SkemaBrikker_Students.Activity

Where

SkemaBrikker_Students.cpr In (Select Cpr from Students where studienr= 'xxxxxx')

and SkemaBrikkerNewEntries.Dato = '28-11-2018'

Order By RealStartDateTime
|}

====How do I change format and content of timetable blocks in Outlook?====
Open UMS Configurator, select Modules "TimeTable" and select your datasource, then edit Format And Content

Variables can be replaced as pictured below.
[[File:Timetable format and content.png|none|thumb|1152x1152px]]
 

===Run only for one user===

====Students====
Skemabrikker.exe studentsonly <username>

====Teachers====
Skemabrikker.exe teachersonly <username>

Studily

2022-08-24T09:17:43Z

Cna: /* UMS Configurator settings */

'''<big>The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams.</big>'''

 

===Requirements===
[[GetTimetable]] - This needs to be executed before export data is available 
===UMS Configurator settings===
[[File:Studily settings.png|none|thumb|664x664px]]

Description

* Insert a name or description for the setting

Tenant settings

* Select the tenant settings available from [[Office365 Tenant]]

ClientID

* Insert ClientID requested from Inlogic

ClientSecret

* Insert ClientSecret requested from Inlogic

Environment

* Choose the environment your Studily is running on (default production)

SQL Sentence

* insert parameters for filtering purposes 

==Studily FAQ==
 

====Why does Studily calender view contain more timetable blocks than personal calendar?====

*Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of.
*Your personal calendar only contains your own timetable blocks
*Therefore users may have differences in Calendar view of Studily and their personal calendar.

====Overlapping Timetable blocks shown in Studily====

*Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 

====How do I activate the Studily timetable module?====

*Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

File:Studily settings.png

2022-08-24T09:10:00Z

Cna: Cna uploaded a new version of File:Studily settings.png

Configurator module settings

File:Studily settings.png

2022-08-24T09:03:43Z

Cna:

Configurator module settings

Studily

2022-08-24T09:00:08Z

Cna: /* Studily FAQ */

Studily

2022-08-24T08:59:18Z

Cna: /* The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams. */

Studily

2022-08-24T08:58:43Z

Cna: /* The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams. */

===The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams.===
 

===Requirements===
[[GetTimetable]] - This needs to be executed before export data is available
 
===UMS Configurator settings===
? 

==Studily FAQ==
 

Why does Studily calender view contain more timetable blocks than personal calendar?

*Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of.
*Your personal calendar only contains your own timetable blocks
*Therefore users may have differences in Calendar view of Studily and their personal calendar.

Overlapping Timetable blocks shown in Studily

*Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 

How do I activate the Studily timetable module?

*Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

Studily

2022-08-24T08:58:02Z

Cna: /* UMS Configurator settings */

=== The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams. ===
 

==== Requirements ====
[[GetTimetable]] - This needs to be executed before export data is available
 
===UMS Configurator settings===
? 

==Studily FAQ==
 

Why does Studily calender view contain more timetable blocks than personal calendar?

*Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of.
*Your personal calendar only contains your own timetable blocks
*Therefore users may have differences in Calendar view of Studily and their personal calendar.

Overlapping Timetable blocks shown in Studily

*Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 

How do I activate the Studily timetable module?

*Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

Studily

2022-08-24T08:54:29Z

Cna: /* Studily FAQ */

The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams.

 

===UMS Configurator settings===
? 

==Studily FAQ==
 

Why does Studily calender view contain more timetable blocks than personal calendar?

*Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of.
*Your personal calendar only contains your own timetable blocks
*Therefore users may have differences in Calendar view of Studily and their personal calendar.

Overlapping Timetable blocks shown in Studily

*Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 

How do I activate the Studily timetable module?

*Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

Studily

2022-08-24T08:53:16Z

Cna: /* Studily FAQ */

Studily

2022-08-24T08:51:50Z

Cna: /* Studily FAQ */

The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams.

 

===UMS Configurator settings===
? 

==Studily FAQ==
 

Why does Studily calender view contain more timetable blocks than personal calendar?

* Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of.
* Your personal calendar only contains your own timetable blocks
* Therefore users may have differences in Calendar view of Studily and their personal calendar.

Overlapping Timetable blocks shown in Studily

* Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 

How do I activate the Studily timetable syncronization?

* Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

Studily

2022-08-24T08:45:12Z

Cna: FAQ added

The Studi.ly syncronization module exports timetable blocks to the Studi.ly APP in Teams.

 

=== UMS Configurator settings ===
?
 

== Studily FAQ ==
 

* Why does Studily calender view contain more timetable blocks than personal calendar? - Studily will per default show all timetable blocks for the ALL Teams you are a member or owner of. - Your personal calendar only contains your own timetable blocks - Therefore users may have differences in Calendar view of Studily and their personal calendar. 
* Overlapping Timetable blocks shown in Studily - Due to above mentioned presentation of Teams timetable blocks, there might be overlapping blocks in case teams are planned at the same time 
* How do I activate the Studily timetable syncronization? - Studi.ly timetable block sync requires the '''Studily''' module in your UMS License (please contact salg@inlogic.dk)

Username Generator

2022-06-21T12:15:26Z

Cna: /* AutoNumber */

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|656x656px]]

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

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

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 4 right and the username is AB it will return AB00.

====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]]

==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.

==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]]

AdminServers/TimeEdit

2022-06-13T13:13:16Z

Cna:

[[File:AdminServer TimeEdit.jpg|none|thumb|656x656px]]All connection information is provided by TimeEdit support. (Please contact them for this information.)

===URL (Endpoint)===
This URL specifies the endpoint that UMS connects to.

[https://cloud.timeedit.net/soap/3/ https://cloud.timeedit.net/soap/3/<customername@timeedit>]

===Certificate path===
Then XML file you receive from TimeEdit.

===Username===
Username to access the Webservice URL.

===Password===
Password to access the Webservice URL.

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

GetTimetable/Ludus

2022-01-27T18:35:32Z

Cna: /* Requirements for writing absence to LUDUS */

BOSS

2022-01-19T14:56:47Z

Cna: /* Template Setting */

The integration automatically creates and maintains the school's users in BOSS. BOSS is a barcode / RFID based registration system that links all loans directly to the individual student to the library. The BOSS integration allows BOSS to retrieve data from the UMS web server

==Prerequisites==

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

===What to have ready===
An opened firewall directly into the UMS. Typically port 80 or 443

==Installation==
See [[Configurator/Webservice]]
===Template Setting===
Create a BOSS setting than will be attached to a template. BOSS can only retrieve data from the templates that have an option attached.
[[File:Boss templateeditor.png|none|thumb]]

UMS will generate a department code when pressing Generate. department code must be used in BOSS API to retrieve data.

UMS Webservice information and departmentcode, must be transmitted to customer or BOSS responsible person @customer

==Technical settings==

==FAQ==

GetTimetable/Ludus

2022-01-17T10:51:57Z

Cna: /* Requirements for writing absence to LUDUS */

==Requirements for writing absence to LUDUS==
You will need to open this webservices in LUDUS (marked in red) if UMS is going to write absence back to LUDUS.

Link to Ludus Webservice Catalog - https://ludushelp.eg.dk/system/Web_services.htm

[[File:Ludus Absence Webservice.png]]
==Setup==
[[File:GetTimeTable LUDUS.jpg|none|thumb|783x783px]]

===[[GetTimetable/Format and content|Format and content]]===

===Description===
Name of the setting.
===[[GetTimetable/Absence_settings|Absence settings]]===

===[[GetTimetable/Export_settings|Export settings]]===

===Only write back test data to LUDUS===
This will only write information back to LUDUS if the activity starts with '''UMS'''.

===Ludus absence codes -> UMS Absence codes===
Specify how the Ludus absence codes translates to the absence codes in UMS.

'''This will also enable UMS to write the absence reason from the student back to Ludus.'''

==FAQ==

File:Ludus Absence Webservice.png

2022-01-17T10:17:16Z

Cna:

Moodle

2022-01-12T14:01:21Z

Cna: /* Moodle Site settings */

Our Moodle integration is developed for schools, which want to avoid hour-long administrative tasks. The integration automatically creates, maintains and deletes users, based on data from your student administrative system. It also creates and maintains group rooms, which teachers and students can use for teaching purposes. The rooms automatically use the language you require and can be categorized according to your needs, making them easier to find. Rooms that are no longer in use are deleted automatically.

===Configuration in UMS===
The integration makes it possible to upload pictures of the users to Moodle, making it easy for teachers and students to see whom they are interacting with. If these pictures are replaced in UMS, they are automatically updated in Moodle. Last, but not least, the module can integrate with the AD. This allows users to log into Moodle with the same password they use to access the school’s IT-system. The Moodle integration gives you an easy overview and ensures that the users’ data is always managed correctly, without requiring any manual updates. This frees up time for the IT-department, who can focus on other tasks instead.

If you want to make it easy for students and teachers to keep track of their timetables, you can embed our Web Timetable module in Moodle as an iframe. By doing this, users can access homework and notes that are registered on the various timetable blocks in the timetable. Please note: To embed Web Time Table, the Web Timetable and SSO modules are required. In order to see homework, the Homework module is required.

==Prerequisites==

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

===What to have ready===
Moodle

==Installation==
Open UMS Configurator and go to Modules > Moodle > Organization settings
[[File:Image.png|none|thumb|643x643px]]

Click Add.
[[File:Moodleorganizationsettings.png|none|thumb|593x593px]]

==Organization settings==
[[File:Moodle organization settings2.png|none|thumb|534x534px]]

'''Description'''

Give your Organization setting a name.

'''DatabaseServer'''

Name of database server hosting the Moodle database.

'''DatabaseName'''

Name of Moodle database.

'''Database TablesPrefix'''

Table prefix set when installing Moodle.

'''UserName'''

UserName of the user that can access the database.

'''Password'''

Password of the user that can access the database.

'''URL'''

URL for your Moodle installation ex. <nowiki>http://moodle.inlogic.dk</nowiki>

'''Webservice Token'''

Token created in Moodle siteadministration. [https://docs.moodle.org/24/en/Using_web_services Guide to create access and token] ( Remember: When adding functions to webservice, add all functions )

'''DataPath'''

'''This is only used for uploading pictures from pictures library'''

Moodle data path ex. \\moodle.inlogic.dk\c$\Moodle\server\moodledata\filedir.

The user running moodle exe must have access to this path.

'''DatabaseType'''

Choose Database type used for Moodle. can only be one in the list below. The selected SQL database, the port number must be open in the firewall, since UMS communicates on the database level

*Microsoft SQL (1433)
*MySQL (3306)
*Oracle SQL (1521)

==Moodle Site settings==
From Configurator, Edit existing template > Moodle > Manage > Add or Configurator > Modules > Moodle > Site Settings > Add
[[File:Moodle Settings.jpg|none|thumb|961x961px]]

==='''Description:'''===
Give the Site settings a name.

==='''Organization settings'''===
Choose the Organization setting you want to use for this site setting.

==='''Default country'''===
Choose default country. This is used when creating users.

==='''Authentication method'''===
Login method for the users

==='''Mail domain for new students'''===
The address appended to their username in Moodle to give them an email address

===Username for students===
Use a field from the UMS database as username for students

===Append mail domain to username===
Adds @ + "'''Mail domain for new students'''" to the username when creating Moodle user.

==='''Mail domain for new employees'''===
The address appended to their username in Moodle to give them an email address

===Username for '''employees'''===
Use a field from the UMS database as username for employees

===Append mail domain to username===
Adds @ + "'''Mail domain for new employees'''" to the username when creating Moodle user.

===Upload student information===
Check these boxes to send and update information on students

*Address
*Phone (Phone1)
*Mobile Phone (Phone 2)
*Mail from AD (This is taken from the local Active Directory account)

===Picture library===
Upload pictures of students

See [[Configurator/Picture_libraries|Picture libraries]]

===Upload employee information===
Check these boxes to send and update information on employees

*Address
*Phone (Phone1)
*Mobile Phone (Phone 2)
*Mail from AD (This is taken from the local Active Directory account)

===Picture library===
Upload pictures of employees

See [[Configurator/Picture_libraries|Picture libraries]]

===Course===

[[File:Moodle Course Settings.png|none|thumb|895x895px]]

See [[LMS Settings]] for options not descriped below

'''Language'''

The language set on a site when is it created.

'''Course category'''

The category the course is put on when the site is created. The course category is case sensitive and needs to match a category created in Moodle.

====Activity sites====
See [[Site selection settings]]

====Course sites====
See [[Site selection settings]]

===Cohort===

[[File:Moodle Cohort Settings.png|none|thumb|895x895px]]

See [[LMS Settings]] for options not descriped below
====Activity sites====
See [[Site selection settings]]

====Course sites====
See [[Site selection settings]]

==Template Settings==
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.
[[File:Moodle Template Cohort Settings.png|none|thumb|814x814px]]

'''Description'''

Enter a description for this setting

'''Cohort category'''

Enter a category that will be attached to the cohorts when they are created

'''SQL Groups'''

See [[LMS Settings]] for this option

==FAQ==
(CreateLearners) Error Webservice error. User = 010xxxx - Webservice error. ERRORCODE&gt;&lt;div&gt;<big>Adgangskoder skal indeholde mindst 1 små bogstaver</big>.&lt;/div&gt;&lt;/ERRORCODE&gt;

Password setting can be changed, see image below
[[File:Moodle.jpg|none|thumb|1054x1054px]]

Office 365

2021-12-15T14:04:50Z

Cna: /* A parameter cannot be found that matches parameter name 'type'. */

Our Office 365 SharePoint Portal is a dedicated solution for school, which want an easy-to-use learning portal. Students and teachers are often presented with advanced and complex solutions that does everything they need and then some and as a result, they are difficult to use. We have decided to do things differently and therefore the Office 365 SharePoint Portal gives you the features you need to get the most out of SharePoint. Nothing more, nothing less. The portal is simple and easy to use. This way you avoid confusion and having to navigate yet another complex system. In terms of design, you have two options: the portal can use our standard skin, as pictured above, or our second skin, which we made for primary schools.

==Prerequisites==

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

===Testing after setup===
Users get created in Office 365

===What to have ready===
Install latest version of [https://www.google.com/search?q=Windows+Management+Framework&oq=Windows+Management+Framework Windows Management Framework]

'''Then run these powershell commands'''

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 '''(to ensure TLS 1.2 enabled on Powershell commands)'''

Install-Module AzureAD

'''Use this command only if no repository is available'''

Register-PSRepository -Default -Verbose

===[[MSGraphPermissions|Graph permissions]]===

==Installation==

===Office 365===
Enter Admin credentials for a service account with administrator privileges to access Office 365.
[[File:Office365 Setting.jpg|none|thumb|838x838px]]

===Credentials===

=====Tenant setting=====
Choose a tenant setting used for connection to Office 365-

=====Domain=====
Enter the domain that you want the users and groups to have when they are created. E.g. <Username>@<Domain>

===Users===

=====Login=====
Choose what the users shall use to log in to Office365.

======Mail Address======
Choose what to use as the users mail address.

=====Enable password never expires=====
When marked the password will never expire for the users.

=====Disable strong password=====
Use this to bypass the default password complexity.

=====Users are created through third party program=====
This normally means ADFS is used to synchronize users

=====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)

=====Use Active Directory for info=====
This tells UMS to take Department, Title and Organization from AD instead of AD Attributes in UMS.

=====Usage location=====
This will tell UMS to set usage location when creating a user

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

=====Keep active before disabling x days=====
Specify a grace period where users are active before disabling.

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

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

=====Hide from address list=====
Hide the newly created item from address list.

=====Mailbox language=====
Specify which language is to be default for the users.

=====Mailbox time zone=====
Specify which time zone is to be default for the users.

=====Calendar Rights=====
Set the calendar rights on a user when he is created

=====Calendar object UPN=====
Specify the UPN to put on the users calendar with the rights specified below

If using a group then it must be of type "'''Mail enabled security'''".

====Group UPN for keep alive users====
Specify a group where users that is kept alive is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

====Group UPN for disabled users====
Specify a group where users that is disabled is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

===Template groups===

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

====Maintain extra groups====
This will create all the groups from the [[Configurator/Extra groups|extra groups]] template tab. All users will have direct group member ship.

===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.

====Only senders inside my organization====
With this marked only users in the domain will be able to send to distribution groups created by UMS.

Disabling this will allow the groups to be visible in OneDrive and Classroom

===Picture settings===
This takes the picture privacy setting that the user has set into consideration. The picture will not be uploaded if the user has chosen not to allow his picture to be shared. The picture will not be removed again if it has been uploaded.

====Student picture library====
Define where the pictures are for the students that uses this template. If this is not set, no pictures will be uploaded to Office 365.

====Employee picture library====
Define where the pictures are for the employees that uses this template. If this is not set, no pictures will be uploaded to Office 365.

===Timetable===

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

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

====Room setting====
Create rooms with timetable blocks.

=====Manage=====
[[File:Office365roomsettings.png|none|thumb|378x378px]]

=====Room displayname=====

=====Prefix=====
Text that can be added to the start of what is chosen in Generator.

=====Generator=====
Choose what is to define the room.

=====Suffix=====
Text that can be added to the end of what is chosen in Generator.

=====Resulting displayname=====
Summary of the chosen display name as it will be shown in Office 365.

=====Set rights to rooms=====
Sets the rights on rooms when created

This has to be a '''Distribution Group''' Otherwise it won't work
[[File:Office365roomsettings2.png|none|thumb|274x274px]]

======Owner======
Users will be able to create, read, modify and delete all items and files, and create sub-folders. As the folder owner, they can change the permission levels others have for the folder. (Does not apply to delegates.).

======Publishing Editor======
Users can create, read, modify and delete all items and files, and create sub-folders. (Does not apply to delegates.).

======Editor======
Users can create, read, modify and delete all items and files..

======Publishing Author======
Users can create and read items and files, create sub-folders, and modify and delete items and files they create. (Does not apply to delegates.).

======Author======
Users can create and read items and files and modify and delete items and files you create.

======Nonediting Author======
Users have full read details. Can create items and delete own items. Folder visible.

======Reviewer======
Users can read items and files only.

======Contributor======
Users can create items and files only. The contents of the folder does not appear. (Does not apply to delegates.).

'''''Note''''' ''With author or editor permissions, a delegate has send-on-behalf-of permission. Sent messages contain both the managers and delegates names. Message recipients see the managers name in the Sent On Behalf Of box and the delegates name in the From box.''

=====Define rooms to be created=====
Specify the rooms to be created based on a filter. If nothing is entered, every room will be created.
[[File:Office365criteria.png|none|thumb|202x202px]]

======Room number and Room name======
Can be found in the skemabrikker_rooms table in SQL.

===Office 365 SharePoint site setting===
This will create SharePoint sites
[[File:Office365sharepointsitesettings.png|none|thumb|720x720px]]
[[File:Office365sharepointsitesettings2.png|none|thumb|567x567px]]

====''Site settings''====

=====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.

=====Check if group rights match=====
When UMS looks for UMS-groups on the site, it will do so based on two criteria’s.

The correct rights and the correct name. Unchecking this will disable the first criteria and only look for a group with the right name. (This is when users change the UMS-group rights on a site manually)

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

=====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:Office365filters.png|none|thumb|507x507px]]

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.

=====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:Office365filterexample.png|none|thumb|401x401px]]

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:Office365filters.png|none|thumb|507x507px]]

=====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:Office365filter.png|none|thumb|416x416px]]

=====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.

After you have created the Office 365 setting you put in on a template.
[[File:Office365templateeditor.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===SharePoint settings===
Sites created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365template.png|none|thumb|422x422px]]

====Site URL====
Which site collection is used when creating sites

Language: The default language of the created site

Course Template

Standard SharePoint: Use a standard template from SharePoint

Course template: Enter a name of a template that resides in the site collection. If nothing is entered it will default to the Team site template

UMS SharePoint Portal: Create sites based on the UMS SharePoint Portal product

====OneNote Class Notebook setting====
Choose a Class Notebook setting. This will create a Class Notebook created in the SharePoint site.

====SQL Groups====

Members of these groups will be attached to all sites created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

OneNote Class Notebook setting

Define settings for OneNote Class Notebooks.
[[File:OneNotesections SharePoint.png|none|thumb|476x476px]]

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]Use Name instead of title for Notebooks (Last part of URL)

This will make the title of the NoteBook be the same as the last part of the URL of the SharePoint site that the NoteBook is created in. It never changes unless this is unchecked.

Never update Notebook title after creation

The NoteBook will never update the title after it has been created, even though the SharePoint site changes title. it will be created with the title that SharePoint site has at createin time.

===OneNote Class Notebook setting===
[[File:Office365onenoteclassnotebooksettings.png|none|thumb|720x720px]]
[[File:Office365onenoteclassnotebooksettings2.png|none|thumb|720x720px]]

====''Notebook settings''====

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

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

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

Finished on activity/course

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

====Delete Notebooks====
Auto delete

Notebooks will be delete when the last student has left the Notebook

Manual Delete

Notebooks 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 Notebook.

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

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

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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 Notebooks====

====Do not create====
It will not create any Notebooks 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 Notebooks based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as to or more Notebooks to be created as one Notebook.
[[File:Office365filterexample.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 Notebook 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 Notebook.

Set the settings as shown below
[[File:Office365filterexample.png|none|thumb|401x401px]]

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

====Course Notebooks====
Course URL’s will always be created as activity course.

====Do not create====
It will not create any Notebooks 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 Notebook based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as two or more Notebooks to be created as one Notebook.
[[File:Office365filter.png|none|thumb|416x416px]]

====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 Notebook 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 Notebook with an empty string.

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

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

After you have created the Office 365 setting you put in on a template.
[[File:Office365template2.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===OneNote Class Notebook settings===
Notebooks created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365settings.png|none|thumb|422x422px]]

====Site collection URL====
Which Notebook collection is used when creating Notebooks

====Language====
The default language of the created Notebook

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

===Organization Settings===
[[File:Office365organization.png|none|thumb|656x656px]]

====''Site settings''====

====Description====
Add a description to be able to identify the account.

====SharePoint administration URL====
URL of the SharePoint administration site for the tenant.

====''Credentials settings''====

====Username====
Username used to connect to SharePoint.

====Password====
Password used to connect to SharePoint.

==Parameters==
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|UpdateUsers
|Update users
|-
|DisableUsers
|Disable users
|-
|EnableUsers
|Enable users
|-
|DeleteUsers
|Delete users
|-
|CreateUsers
|Create users
|-
|UpdateImmutableID
|Update Immutable ID on users
|-
|UpdateOffice365SettingsIDForUsers
|Update Office 365 settings for users if they have changed template
|-
|UpdateUsersObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+User settings
!Parameter
!Description
|-
|RunUserSettings
|Runs all the parameters in this table
|-
|DisableStrongPassword
|Disable strong password for users
|-
|SetMailAddress
|Set mail address on users
|-
|Forward2OnPremiseMail
|Set forward to OnPremise mail on users
|-
|SetCalendarRights
|Set calendar rights on users
|-
|UpdateMailboxTimeZone
|Update timezone for mailbox users
|-
|UpdateMailboxLanguage
|Update language for mailbox users
|-
|EnablePasswordNeverExpires
|Enable password never expires for users
|-
|UpdatePictures
|Update pictures
|-
|Forward2PrivateMail
|Set forward to privatemail on users
|-
|UpdateReplyToAll
|Set Reply to all on users
|-
|ProvisionOneDrive
|Provision OneDrive to users
|-
|UpdateAddressBookPolicy
|Set address book policy on users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|RemoveGroupMembers
|Remove group members from groups
|-
|AddGroupMembers
|Add members to groups
|-
|DeleteGroups
|Delete groups
|-
|CreateGroups
|Create groups
|-
|UpdateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForGroups
|Get the UPN of template groups from Office 365
|}
{| 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
|-
|UpdateTemplateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForTemplateGroups
|Get the UPN of template security groups from Office 365
|}
{| class="wikitable"
|+Template extra groups
!Parameter
!Description
|-
|TemplateExtraGroupsOnly
|Runs all the parameters in this table
|-
|CreateTemplateExtraGroups
|Create groups from template extra group
|-
|DeleteTemplateExtraGroups
|Delete groups that are no longer in extra groups
|-
|AddTemplateExtraGroupMembers
|Add users to template extra groups
|-
|UpdateTemplateExtraGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+Keep alive groups
!Parameter
!Description
|-
|KeepAliveGroupsOnly
|Runs all the parameters in this table
|-
|CreateKeepAliveGroups
|Create keep alive groups
|-
|DeleteKeepAliveGroups
|Delete keep alive groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnKeepAliveGroups
|Update the mail address on keep alive groups
|-
|AddKeepAliveGroupMembers
|Add users to keep alive groups
|-
|RemoveKeepAliveGroupMembers
|Remove users from keep alive groups
|}
{| class="wikitable"
|+Disabled groups
!Parameter
!Description
|-
|DisabledGroupsOnly
|Runs all the parameters in this table
|-
|CreateDisabledGroups
|Create disabled groups
|-
|DeleteDisabledGroups
|Delete disabled groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnDisabledGroups
|Update the mail address on disabled groups
|-
|AddDisabledGroupMembers
|Add users to disabled groups
|-
|RemoveDisabledGroupMembers
|Remove users from disabled groups
|}
{| class="wikitable"
|+Teams
!Parameter
!Description
|-
|TeamsOnly
|Runs all the parameters in this table
|-
|AddTeams2DB
|Add Teams to UMS DB
|-
|CreateTeams
|Create Teams
|-
|AddTeamToGroup
|Add teams to groups
|-
|ActivateTeams
|Activate teams
|-
|UpdateTeams
|Update Teams
|-
|DeleteTeams
|Delete Teams
|-
|AddTeachers2TeamsDBTable
|Add teachers to Office365Teams_Teachers table in UMS DB
|-
|AddTeachers2Teams
|Add teachers to Teams
|-
|AddLearners2TeamsDBTable
|Add learners to Office365Teams_Learners table in UMS DB
|-
|AddLearners2Teams
|Add learners to Teams
|-
|TeamsDeleteTeachers
|Delete teachers in Teams
|-
|TeamsDeleteLearners
|Delete learners in Teams
|-
|TeamsUpdateNeedToBeUpdated
|Set update on next run flag
|-
|UpdateLearnersExternalID
|Retrieve the learners object id from Office 365 and save it in UMS DB
|-
|UpdateTeachersExternalID
|Retrieve the teachers object id from Office 365 and save it in UMS DB
|-
|UpdateSchoolsExternalID
|Retrieve the schools object id from Office 365 and save it in UMS DB
|-
|UpdateTeamsExternalID
|Retrieve the teams object id from Office 365 and save it in UMS DB
|}
{| class="wikitable"
|+SharePoint
!Parameter
!Description
|-
|SharepointOnly
|Runs all the parameters in this table
|-
|CreateSites
|Create sites
|-
|AddSites2DB
|Add sites in UMS DB
|-
|DeleteSites
|Delete sites
|-
|UpdateSites
|Update sites
|-
|AddLearners2SitesInDB
|Add learners to UMS DB
|-
|DeleteTeachers
|Delete teachers
|-
|AddTeachers2Sites
|Add teachers to sites
|-
|DeleteSiteGroups
|Delete site groups
|-
|AddTeachers2SitesInDB
|Add teachers to UMS DB
|-
|DeleteLearners
|Delete learners
|-
|AddLearners2Sites
|Add learners to sites
|-
|UpdateSiteURL
|Update sites with new URL
|-
|AddNoteBooks2Sites
|Add OneNote Class NoteBooks to sites
|-
|SharePointDeleteNoteBooks
|Delete OneNote Class NoteBooks from sites
|-
|UpdateNeedToBeUpdated
|Set the update on next run flag
|-
|UpdateSitesIsActive
|Update site active/inactive status
|-
|SharePoint_OneNoteClassNotebook_AddMissingTeachers
|Add missing Teachers to OneNote Class NoteBooks
|-
|SharePoint_OneNoteClassNotebook_AddMissingLearners
|Add missing Learners to OneNote Class NoteBooks
|-
|ReAddLearners2Sites
|Re-add learners to sites if ReAdd is true in DB
|-
|ReAddTeachers2Sites
|Re-add teachers to sites if ReAdd is true in DB
|}
{| class="wikitable"
|+OneNoteClassNoteBook
!Parameter
!Description
|-
|OneNoteClassNotebookOnly
|Runs all the parameters in this table
|-
|AddNotebooks2DB
|Add OneNote Class NoteBooks to UMS DB
|-
|CreateNotebooks
|Create OneNote Class NoteBooks
|-
|UpdateOneNotes
|Update OneNote Class NoteBooks
|-
|DeleteOneNotes
|Delete OneNote Class NoteBooks
|-
|AddTeachers2OneNotesInDB
|Add teachers to OneNote Class NoteBooks in UMS DB
|-
|AddTeachers2OneNotes
|Add teachers to OneNote Class NoteBooks
|-
|AddLearners2OneNotesInDB
|Add learners to OneNote Class NoteBooks in UMS DB
|-
|AddLearners2OneNotes
|Add learners to OneNote Class NoteBooks
|-
|OneNoteDeleteTeachers
|Delete teachers in OneNote Class NoteBooks
|-
|OneNoteDeleteLearners
|Delete learners in OneNote Class NoteBooks
|-
|OneNoteUpdateNeedToBeUpdated
|Set update on next run flag
|}

==Technical settings==

==Maintenance==

===portal.office.com===

====''Teams''====

Go to [http://portal.office.com Office Portal] and login with your admin account( the same UMS uses).

Select settings Services and add-ins and click Teams.
[[File:Office_365_Teams_activation.PNG|1350x1350px|thumb|Activate Teams for a license type, ie. Guest or Education-Student|none]]

==FAQ==

===Office 365 Licens (Unable to assign this license) How to troubleshoot this error===

====Error message from UMS Job log (LiveAtEdu)====

=====''Error = Unable to assign this license''=====
''Set-MsolUserLicense -UserPrincipalName 'khhi3275@ums.dk' -AddLicenses "inLogic:STANDARDWOFFPACK_IW_STUDENT" -LicenseOptions $MyO365Sku''

''Error = Unable to assign this license.''

''29-01-2019 13:23:00 - at Utilities.Office365.SetLicenseForUser(String UPN, List`1 Licenses, SqlConnection& LocalSQLDBConnection)''

'' at LiveAtEdu_Sync.LiveAtEdu_Sync.PerformFunctionUserSettings(String SQLStr, UserFunctions Office365Function, MethodInfo StackFrame)''

''29-01-2019 13:23:00 - khhi3275- UPN = khhi3275@ums.dk''

''29-01-2019 13:23:01 - (UpdateLicenseInfoOnUsers) Error. Could not set license for user - khhi3275@ums.dk ''

*Try adding the same licenses manually to a single user in office365. You could see if that is possible[[File:Licens.jpg|none|thumb|814x814px]]

*The error shows that it is not possible to put the same licenses together[[File:Licens Error.png|none|thumb|812x812px]] 
*Change your licenses in UMS and run the LiveAtEdu job again

===Groups===
How to get groups visible in OneDrive and Classroom

Remove the checkbox from Only senders inside my organization

Why do I not get the site created?

#Activity
##Is there a user on the activity with a primary template that has an office 365 setting attached
##Is the flag Aktivitet_LMS = True
#Course
##Is there a user on the course with a primary template that has an office 365 setting attached
##Is the flag Skolefag_LMS = True

===Disable or enabling user===
Error = Message: Insufficient privileges to complete the operation.

This could be the result of the user trying to be disabled/enabled has roles that does not allow the action like Global Administrator.

===The term 'Set-UnifiedGroup' is not recognized as a name of a cmdlet, function, script file, or executable program.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Set-UnifiedGroup

===A parameter cannot be found that matches parameter name 'type'.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps
[[File:Office365 ExchangeAdminRoleNeeded.jpg|none|thumb|1275x1275px]]

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Get-DistributionGroup

File:Office365 ExchangeAdminRoleNeeded.jpg

2021-12-15T14:03:49Z

Cna:

Set permission role for managing Unified Groups in Azure via Powershell

Office 365

2021-12-15T13:31:42Z

Cna: /* The term 'Set-UnifiedGroup' is not recognized as a name of a cmdlet, function, script file, or executable program. */

Our Office 365 SharePoint Portal is a dedicated solution for school, which want an easy-to-use learning portal. Students and teachers are often presented with advanced and complex solutions that does everything they need and then some and as a result, they are difficult to use. We have decided to do things differently and therefore the Office 365 SharePoint Portal gives you the features you need to get the most out of SharePoint. Nothing more, nothing less. The portal is simple and easy to use. This way you avoid confusion and having to navigate yet another complex system. In terms of design, you have two options: the portal can use our standard skin, as pictured above, or our second skin, which we made for primary schools.

==Prerequisites==

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

===Testing after setup===
Users get created in Office 365

===What to have ready===
Install latest version of [https://www.google.com/search?q=Windows+Management+Framework&oq=Windows+Management+Framework Windows Management Framework]

'''Then run these powershell commands'''

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 '''(to ensure TLS 1.2 enabled on Powershell commands)'''

Install-Module AzureAD

'''Use this command only if no repository is available'''

Register-PSRepository -Default -Verbose

===[[MSGraphPermissions|Graph permissions]]===

==Installation==

===Office 365===
Enter Admin credentials for a service account with administrator privileges to access Office 365.
[[File:Office365 Setting.jpg|none|thumb|838x838px]]

===Credentials===

=====Tenant setting=====
Choose a tenant setting used for connection to Office 365-

=====Domain=====
Enter the domain that you want the users and groups to have when they are created. E.g. <Username>@<Domain>

===Users===

=====Login=====
Choose what the users shall use to log in to Office365.

======Mail Address======
Choose what to use as the users mail address.

=====Enable password never expires=====
When marked the password will never expire for the users.

=====Disable strong password=====
Use this to bypass the default password complexity.

=====Users are created through third party program=====
This normally means ADFS is used to synchronize users

=====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)

=====Use Active Directory for info=====
This tells UMS to take Department, Title and Organization from AD instead of AD Attributes in UMS.

=====Usage location=====
This will tell UMS to set usage location when creating a user

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

=====Keep active before disabling x days=====
Specify a grace period where users are active before disabling.

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

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

=====Hide from address list=====
Hide the newly created item from address list.

=====Mailbox language=====
Specify which language is to be default for the users.

=====Mailbox time zone=====
Specify which time zone is to be default for the users.

=====Calendar Rights=====
Set the calendar rights on a user when he is created

=====Calendar object UPN=====
Specify the UPN to put on the users calendar with the rights specified below

If using a group then it must be of type "'''Mail enabled security'''".

====Group UPN for keep alive users====
Specify a group where users that is kept alive is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

====Group UPN for disabled users====
Specify a group where users that is disabled is a member of.

This must be a Microsoft 365 group.

UMS will create the group if it doesn't exist.

===Template groups===

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

====Maintain extra groups====
This will create all the groups from the [[Configurator/Extra groups|extra groups]] template tab. All users will have direct group member ship.

===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.

====Only senders inside my organization====
With this marked only users in the domain will be able to send to distribution groups created by UMS.

Disabling this will allow the groups to be visible in OneDrive and Classroom

===Picture settings===
This takes the picture privacy setting that the user has set into consideration. The picture will not be uploaded if the user has chosen not to allow his picture to be shared. The picture will not be removed again if it has been uploaded.

====Student picture library====
Define where the pictures are for the students that uses this template. If this is not set, no pictures will be uploaded to Office 365.

====Employee picture library====
Define where the pictures are for the employees that uses this template. If this is not set, no pictures will be uploaded to Office 365.

===Timetable===

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

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

====Room setting====
Create rooms with timetable blocks.

=====Manage=====
[[File:Office365roomsettings.png|none|thumb|378x378px]]

=====Room displayname=====

=====Prefix=====
Text that can be added to the start of what is chosen in Generator.

=====Generator=====
Choose what is to define the room.

=====Suffix=====
Text that can be added to the end of what is chosen in Generator.

=====Resulting displayname=====
Summary of the chosen display name as it will be shown in Office 365.

=====Set rights to rooms=====
Sets the rights on rooms when created

This has to be a '''Distribution Group''' Otherwise it won't work
[[File:Office365roomsettings2.png|none|thumb|274x274px]]

======Owner======
Users will be able to create, read, modify and delete all items and files, and create sub-folders. As the folder owner, they can change the permission levels others have for the folder. (Does not apply to delegates.).

======Publishing Editor======
Users can create, read, modify and delete all items and files, and create sub-folders. (Does not apply to delegates.).

======Editor======
Users can create, read, modify and delete all items and files..

======Publishing Author======
Users can create and read items and files, create sub-folders, and modify and delete items and files they create. (Does not apply to delegates.).

======Author======
Users can create and read items and files and modify and delete items and files you create.

======Nonediting Author======
Users have full read details. Can create items and delete own items. Folder visible.

======Reviewer======
Users can read items and files only.

======Contributor======
Users can create items and files only. The contents of the folder does not appear. (Does not apply to delegates.).

'''''Note''''' ''With author or editor permissions, a delegate has send-on-behalf-of permission. Sent messages contain both the managers and delegates names. Message recipients see the managers name in the Sent On Behalf Of box and the delegates name in the From box.''

=====Define rooms to be created=====
Specify the rooms to be created based on a filter. If nothing is entered, every room will be created.
[[File:Office365criteria.png|none|thumb|202x202px]]

======Room number and Room name======
Can be found in the skemabrikker_rooms table in SQL.

===Office 365 SharePoint site setting===
This will create SharePoint sites
[[File:Office365sharepointsitesettings.png|none|thumb|720x720px]]
[[File:Office365sharepointsitesettings2.png|none|thumb|567x567px]]

====''Site settings''====

=====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.

=====Check if group rights match=====
When UMS looks for UMS-groups on the site, it will do so based on two criteria’s.

The correct rights and the correct name. Unchecking this will disable the first criteria and only look for a group with the right name. (This is when users change the UMS-group rights on a site manually)

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

=====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:Office365filters.png|none|thumb|507x507px]]

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.

=====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:Office365filterexample.png|none|thumb|401x401px]]

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:Office365filters.png|none|thumb|507x507px]]

=====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:Office365filter.png|none|thumb|416x416px]]

=====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.

After you have created the Office 365 setting you put in on a template.
[[File:Office365templateeditor.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===SharePoint settings===
Sites created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365template.png|none|thumb|422x422px]]

====Site URL====
Which site collection is used when creating sites

Language: The default language of the created site

Course Template

Standard SharePoint: Use a standard template from SharePoint

Course template: Enter a name of a template that resides in the site collection. If nothing is entered it will default to the Team site template

UMS SharePoint Portal: Create sites based on the UMS SharePoint Portal product

====OneNote Class Notebook setting====
Choose a Class Notebook setting. This will create a Class Notebook created in the SharePoint site.

====SQL Groups====

Members of these groups will be attached to all sites created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

OneNote Class Notebook setting

Define settings for OneNote Class Notebooks.
[[File:OneNotesections SharePoint.png|none|thumb|476x476px]]

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]Use Name instead of title for Notebooks (Last part of URL)

This will make the title of the NoteBook be the same as the last part of the URL of the SharePoint site that the NoteBook is created in. It never changes unless this is unchecked.

Never update Notebook title after creation

The NoteBook will never update the title after it has been created, even though the SharePoint site changes title. it will be created with the title that SharePoint site has at createin time.

===OneNote Class Notebook setting===
[[File:Office365onenoteclassnotebooksettings.png|none|thumb|720x720px]]
[[File:Office365onenoteclassnotebooksettings2.png|none|thumb|720x720px]]

====''Notebook settings''====

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

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

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

Finished on activity/course

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

====Delete Notebooks====
Auto delete

Notebooks will be delete when the last student has left the Notebook

Manual Delete

Notebooks 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 Notebook.

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

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

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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 Notebooks====

====Do not create====
It will not create any Notebooks 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 Notebooks based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as to or more Notebooks to be created as one Notebook.
[[File:Office365filterexample.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 Notebook 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 Notebook.

Set the settings as shown below
[[File:Office365filterexample.png|none|thumb|401x401px]]

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

====Course Notebooks====
Course URL’s will always be created as activity course.

====Do not create====
It will not create any Notebooks 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 Notebook based on a filter that is specified per template.
[[File:Office365filters.png|none|thumb|507x507px]]

====All====
Create all Notebooks.

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

====Search filter and criteria====
This will enable you to concatenate Notebooks that would have been created as two or more Notebooks to be created as one Notebook.
[[File:Office365filter.png|none|thumb|416x416px]]

====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 Notebook 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 Notebook with an empty string.

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

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

After you have created the Office 365 setting you put in on a template.
[[File:Office365template2.png|none|thumb|720x720px]]

Setting: This will created the users with on this template in Office 365 with these settings

===OneNote Class Notebook settings===
Notebooks created with setting. If this is not specified no activities/courses on this template will be created.
[[File:Office365settings.png|none|thumb|422x422px]]

====Site collection URL====
Which Notebook collection is used when creating Notebooks

====Language====
The default language of the created Notebook

====Sections====
Define the section the Class Notebook will be created with. Students that are attached to this Class Notebook will have these sections.
[[File:Office365onenoteclassnotebooksettingedit.png|none|thumb|447x447px]]

====SQL Groups====

Members of these groups will be attached to all Notebooks created with this setting as teachers[[File:Office365sqlgroups.png|none|thumb|447x447px]]

====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

===Organization Settings===
[[File:Office365organization.png|none|thumb|656x656px]]

====''Site settings''====

====Description====
Add a description to be able to identify the account.

====SharePoint administration URL====
URL of the SharePoint administration site for the tenant.

====''Credentials settings''====

====Username====
Username used to connect to SharePoint.

====Password====
Password used to connect to SharePoint.

==Parameters==
{| class="wikitable"
|+Users
!Parameter
!Description
|-
|UsersOnly
|Runs all the parameters in this table
|-
|UpdateUsers
|Update users
|-
|DisableUsers
|Disable users
|-
|EnableUsers
|Enable users
|-
|DeleteUsers
|Delete users
|-
|CreateUsers
|Create users
|-
|UpdateImmutableID
|Update Immutable ID on users
|-
|UpdateOffice365SettingsIDForUsers
|Update Office 365 settings for users if they have changed template
|-
|UpdateUsersObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+User settings
!Parameter
!Description
|-
|RunUserSettings
|Runs all the parameters in this table
|-
|DisableStrongPassword
|Disable strong password for users
|-
|SetMailAddress
|Set mail address on users
|-
|Forward2OnPremiseMail
|Set forward to OnPremise mail on users
|-
|SetCalendarRights
|Set calendar rights on users
|-
|UpdateMailboxTimeZone
|Update timezone for mailbox users
|-
|UpdateMailboxLanguage
|Update language for mailbox users
|-
|EnablePasswordNeverExpires
|Enable password never expires for users
|-
|UpdatePictures
|Update pictures
|-
|Forward2PrivateMail
|Set forward to privatemail on users
|-
|UpdateReplyToAll
|Set Reply to all on users
|-
|ProvisionOneDrive
|Provision OneDrive to users
|-
|UpdateAddressBookPolicy
|Set address book policy on users
|}
{| class="wikitable"
|+Groups
!Parameter
!Description
|-
|GroupsOnly
|Runs all the parameters in this table
|-
|RemoveGroupMembers
|Remove group members from groups
|-
|AddGroupMembers
|Add members to groups
|-
|DeleteGroups
|Delete groups
|-
|CreateGroups
|Create groups
|-
|UpdateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForGroups
|Get the UPN of template groups from Office 365
|}
{| 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
|-
|UpdateTemplateGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|-
|GetUPNsForTemplateGroups
|Get the UPN of template security groups from Office 365
|}
{| class="wikitable"
|+Template extra groups
!Parameter
!Description
|-
|TemplateExtraGroupsOnly
|Runs all the parameters in this table
|-
|CreateTemplateExtraGroups
|Create groups from template extra group
|-
|DeleteTemplateExtraGroups
|Delete groups that are no longer in extra groups
|-
|AddTemplateExtraGroupMembers
|Add users to template extra groups
|-
|UpdateTemplateExtraGroupsObjectID
|Get the object ID from office 365 and save it in UMS DB
|}
{| class="wikitable"
|+Keep alive groups
!Parameter
!Description
|-
|KeepAliveGroupsOnly
|Runs all the parameters in this table
|-
|CreateKeepAliveGroups
|Create keep alive groups
|-
|DeleteKeepAliveGroups
|Delete keep alive groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnKeepAliveGroups
|Update the mail address on keep alive groups
|-
|AddKeepAliveGroupMembers
|Add users to keep alive groups
|-
|RemoveKeepAliveGroupMembers
|Remove users from keep alive groups
|}
{| class="wikitable"
|+Disabled groups
!Parameter
!Description
|-
|DisabledGroupsOnly
|Runs all the parameters in this table
|-
|CreateDisabledGroups
|Create disabled groups
|-
|DeleteDisabledGroups
|Delete disabled groups if they are no longer in UMS
|-
|UpdateSetMailAddressOnDisabledGroups
|Update the mail address on disabled groups
|-
|AddDisabledGroupMembers
|Add users to disabled groups
|-
|RemoveDisabledGroupMembers
|Remove users from disabled groups
|}
{| class="wikitable"
|+Teams
!Parameter
!Description
|-
|TeamsOnly
|Runs all the parameters in this table
|-
|AddTeams2DB
|Add Teams to UMS DB
|-
|CreateTeams
|Create Teams
|-
|AddTeamToGroup
|Add teams to groups
|-
|ActivateTeams
|Activate teams
|-
|UpdateTeams
|Update Teams
|-
|DeleteTeams
|Delete Teams
|-
|AddTeachers2TeamsDBTable
|Add teachers to Office365Teams_Teachers table in UMS DB
|-
|AddTeachers2Teams
|Add teachers to Teams
|-
|AddLearners2TeamsDBTable
|Add learners to Office365Teams_Learners table in UMS DB
|-
|AddLearners2Teams
|Add learners to Teams
|-
|TeamsDeleteTeachers
|Delete teachers in Teams
|-
|TeamsDeleteLearners
|Delete learners in Teams
|-
|TeamsUpdateNeedToBeUpdated
|Set update on next run flag
|-
|UpdateLearnersExternalID
|Retrieve the learners object id from Office 365 and save it in UMS DB
|-
|UpdateTeachersExternalID
|Retrieve the teachers object id from Office 365 and save it in UMS DB
|-
|UpdateSchoolsExternalID
|Retrieve the schools object id from Office 365 and save it in UMS DB
|-
|UpdateTeamsExternalID
|Retrieve the teams object id from Office 365 and save it in UMS DB
|}
{| class="wikitable"
|+SharePoint
!Parameter
!Description
|-
|SharepointOnly
|Runs all the parameters in this table
|-
|CreateSites
|Create sites
|-
|AddSites2DB
|Add sites in UMS DB
|-
|DeleteSites
|Delete sites
|-
|UpdateSites
|Update sites
|-
|AddLearners2SitesInDB
|Add learners to UMS DB
|-
|DeleteTeachers
|Delete teachers
|-
|AddTeachers2Sites
|Add teachers to sites
|-
|DeleteSiteGroups
|Delete site groups
|-
|AddTeachers2SitesInDB
|Add teachers to UMS DB
|-
|DeleteLearners
|Delete learners
|-
|AddLearners2Sites
|Add learners to sites
|-
|UpdateSiteURL
|Update sites with new URL
|-
|AddNoteBooks2Sites
|Add OneNote Class NoteBooks to sites
|-
|SharePointDeleteNoteBooks
|Delete OneNote Class NoteBooks from sites
|-
|UpdateNeedToBeUpdated
|Set the update on next run flag
|-
|UpdateSitesIsActive
|Update site active/inactive status
|-
|SharePoint_OneNoteClassNotebook_AddMissingTeachers
|Add missing Teachers to OneNote Class NoteBooks
|-
|SharePoint_OneNoteClassNotebook_AddMissingLearners
|Add missing Learners to OneNote Class NoteBooks
|-
|ReAddLearners2Sites
|Re-add learners to sites if ReAdd is true in DB
|-
|ReAddTeachers2Sites
|Re-add teachers to sites if ReAdd is true in DB
|}
{| class="wikitable"
|+OneNoteClassNoteBook
!Parameter
!Description
|-
|OneNoteClassNotebookOnly
|Runs all the parameters in this table
|-
|AddNotebooks2DB
|Add OneNote Class NoteBooks to UMS DB
|-
|CreateNotebooks
|Create OneNote Class NoteBooks
|-
|UpdateOneNotes
|Update OneNote Class NoteBooks
|-
|DeleteOneNotes
|Delete OneNote Class NoteBooks
|-
|AddTeachers2OneNotesInDB
|Add teachers to OneNote Class NoteBooks in UMS DB
|-
|AddTeachers2OneNotes
|Add teachers to OneNote Class NoteBooks
|-
|AddLearners2OneNotesInDB
|Add learners to OneNote Class NoteBooks in UMS DB
|-
|AddLearners2OneNotes
|Add learners to OneNote Class NoteBooks
|-
|OneNoteDeleteTeachers
|Delete teachers in OneNote Class NoteBooks
|-
|OneNoteDeleteLearners
|Delete learners in OneNote Class NoteBooks
|-
|OneNoteUpdateNeedToBeUpdated
|Set update on next run flag
|}

==Technical settings==

==Maintenance==

===portal.office.com===

====''Teams''====

Go to [http://portal.office.com Office Portal] and login with your admin account( the same UMS uses).

Select settings Services and add-ins and click Teams.
[[File:Office_365_Teams_activation.PNG|1350x1350px|thumb|Activate Teams for a license type, ie. Guest or Education-Student|none]]

==FAQ==

===Office 365 Licens (Unable to assign this license) How to troubleshoot this error===

====Error message from UMS Job log (LiveAtEdu)====

=====''Error = Unable to assign this license''=====
''Set-MsolUserLicense -UserPrincipalName 'khhi3275@ums.dk' -AddLicenses "inLogic:STANDARDWOFFPACK_IW_STUDENT" -LicenseOptions $MyO365Sku''

''Error = Unable to assign this license.''

''29-01-2019 13:23:00 - at Utilities.Office365.SetLicenseForUser(String UPN, List`1 Licenses, SqlConnection& LocalSQLDBConnection)''

'' at LiveAtEdu_Sync.LiveAtEdu_Sync.PerformFunctionUserSettings(String SQLStr, UserFunctions Office365Function, MethodInfo StackFrame)''

''29-01-2019 13:23:00 - khhi3275- UPN = khhi3275@ums.dk''

''29-01-2019 13:23:01 - (UpdateLicenseInfoOnUsers) Error. Could not set license for user - khhi3275@ums.dk ''

*Try adding the same licenses manually to a single user in office365. You could see if that is possible[[File:Licens.jpg|none|thumb|814x814px]]

*The error shows that it is not possible to put the same licenses together[[File:Licens Error.png|none|thumb|812x812px]] 
*Change your licenses in UMS and run the LiveAtEdu job again

===Groups===
How to get groups visible in OneDrive and Classroom

Remove the checkbox from Only senders inside my organization

Why do I not get the site created?

#Activity
##Is there a user on the activity with a primary template that has an office 365 setting attached
##Is the flag Aktivitet_LMS = True
#Course
##Is there a user on the course with a primary template that has an office 365 setting attached
##Is the flag Skolefag_LMS = True

===Disable or enabling user===
Error = Message: Insufficient privileges to complete the operation.

This could be the result of the user trying to be disabled/enabled has roles that does not allow the action like Global Administrator.

===The term 'Set-UnifiedGroup' is not recognized as a name of a cmdlet, function, script file, or executable program.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Set-UnifiedGroup

===A parameter cannot be found that matches parameter name 'type'.===
https://docs.microsoft.com/en-us/powershell/exchange/find-exchange-cmdlet-permissions?view=exchange-ps

Run this command to check which roletypes are needed
Get-ManagementRole -Cmdlet Get-DistributionGroup

Attendance Registration - QR

2021-12-15T09:16:08Z

Cna: /* Settings */

Attendance Registration QR is a system developed for schools, that functions along with the UMS App. The system allows students to register their own attendance by scanning a continuously-changing QR code. The students can scan the QR code when they arrive, and use the app to check out again when they leave again. The QR system makes it is easy to monitor the students’ attendance, as all registrations automatically will be available in UMS.

Through the user-friendly interface, the teacher can see if everyone have registered correctly and make corrections if necessary. This system does not integrate with any third parties. If you need integration to any system, please contact us for price and availability.

 

==Prerequisites==

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

[[App|UMS App]]
 

===Testing after setup===
Students can check in by scanning the UMS-generated QR code, and check out, using the UMS App
 

===Is any physical items required===
A student (or school personnel that can log in as a test-student) must have an Android or iOS smartphone, with their schools UMS app installed
 

==Installation==

===Configurations===
Settings can be found under 'Web Setup -> Absence -> ''Scroll to bottom'' -> Check in/out settings'

[[File:Attendance QR Setup.png|frameless]] 

==Settings==
[[File:QR settings.png|frameless]]
 

*Refresh timer: How many seconds a QR code should stay, before it refreshes
*Timer deadzone: How many seconds, after a QR code expires, it should still remain usable behind the scenes. 
*URL = 'https://<UMS_URL>/auth/absence/QR/QRview.aspx'
*It is important that students both check in AND out, otherwise UMS will perform check-out in the evening and absence will be registered. 

==Student Pauses==
QR Registration handles students having pauses, down to the minute without the students having to do anything.
If a student is too late, but some of that time was during a pause, they will only get absence for the minutes they where actually absencet.
If a student has a pause in the middle of the class, and they check out and then check in again before the pause ends, the QR system will not give them any absence for that.

==FAQ==
 

*''Why have a deadzone?''

The deadzone was made to facilitate the scenario where there's 1 second left of the QR code, the user scans the QR code, but before the server receives the request, the code has expired and the user gets an error saying 'Expired/invalid QR code'.

G Suite

2021-12-07T08:21:36Z

Cna: /* Installation */

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==

===Supported administrative systems===

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

===Additional functionality===

===Testing after setup===

===What to have ready===

===Is any physical item required===

===Should third party be contacted===

==Installation==
'''Google Apps'''
[[File:Googleappsadminsettings.png|none|thumb|577x577px]]

======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.

'''“Only senders inside my organization”'''

With this marked only users in the domain will be able to send to distribution groups created by UMS.

''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.

==='''<big>Drive</big>'''===
[[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|link=http://wiki.inlogic.dk/index.php/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 Classroomss”'''

'''“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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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 aswell. (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|link=http://wiki.inlogic.dk/index.php/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
[[File:Googleappsdrivesettings.png|none|thumb|429x429px]]

'''“Path”'''

The path where the drives are created

'''Create user specific subfolder'''

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)'''

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)'''

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|link=http://wiki.inlogic.dk/index.php/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]]

'''“SQL Groups”'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/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 <nowiki>https://console.developers.google.com</nowiki> with your Google Admin account.

Create a project
[[File:Googlesyncproject2.png|none|thumb|594x594px]]

When created choose project and click the newly created project.

Choose “Enable and manage APIs”. Enable these APIs
[[File:Googlesyncenableapi.png|none|thumb|463x463px]]

Click credentials

And choose “OAuth client ID”

Choose settings as show on below image. Name can be changed.
[[File:Googlesyncoauth.png|none|thumb|499x499px]]

Then choose “Create”

Which creates an OAuth 2.0 client ID

Enter Client ID and Client Secret into UMS
[[File:Googlesyncoauth2.png|none|thumb|513x513px]]

Go back to “Overview” and choose “Enabled APIs”

Click on each API you added and choose Quota
[[File:Googlesyncenableapi2.png|none|thumb|517x517px]]

Set the number as high as you can without “apply for higher quota”
[[File:Googlesyncapplyhighquota.png|none|thumb|439x439px]]

And you are done with this site.

Now Log on https://admin.google.com with your Google Admin account

Find “Other Google Services” - can be located under “More Controls” or under APPS aplaced at page bottom.

Click “add services” upper right corner

Then click “Add it now” on “Groups for Business”
[[File:Googlesyncservices.png|none|thumb|495x495px]]

Back to start and choose “Security”

Choose “API reference” and check “Enable API access”
[[File:Googlesyncsecurity.png|none|thumb|439x439px]]

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.

==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.'''
[[File:Fgd.png|left|thumb|935x935px]]

G Suite

2021-12-07T08:19:32Z

Cna: /* Installation */

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==

===Supported administrative systems===

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

===Additional functionality===

===Testing after setup===

===What to have ready===

===Is any physical item required===

===Should third party be contacted===

==Installation==
'''Google Apps'''
[[File:Googleappsadminsettings.png|none|thumb|577x577px]]

====== Organization settings ======
See description how to create/setup further [[=== Organization Settings ==|down]].

''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.

'''“Only senders inside my organization”'''

With this marked only users in the domain will be able to send to distribution groups created by UMS.

''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.

==='''<big>Drive</big>'''===
[[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|link=http://wiki.inlogic.dk/index.php/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 Classroomss”'''

'''“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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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|link=http://wiki.inlogic.dk/index.php/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 aswell. (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|link=http://wiki.inlogic.dk/index.php/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
[[File:Googleappsdrivesettings.png|none|thumb|429x429px]]

'''“Path”'''

The path where the drives are created

'''Create user specific subfolder'''

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)'''

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)'''

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|link=http://wiki.inlogic.dk/index.php/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]]

'''“SQL Groups”'''

Members of these groups will be attached to all sites created with this setting as teachers
[[File:Googleappssqlgroups.png|link=http://wiki.inlogic.dk/index.php/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 <nowiki>https://console.developers.google.com</nowiki> with your Google Admin account.

Create a project
[[File:Googlesyncproject2.png|none|thumb|594x594px]]

When created choose project and click the newly created project.

Choose “Enable and manage APIs”. Enable these APIs
[[File:Googlesyncenableapi.png|none|thumb|463x463px]]

Click credentials

And choose “OAuth client ID”

Choose settings as show on below image. Name can be changed.
[[File:Googlesyncoauth.png|none|thumb|499x499px]]

Then choose “Create”

Which creates an OAuth 2.0 client ID

Enter Client ID and Client Secret into UMS
[[File:Googlesyncoauth2.png|none|thumb|513x513px]]

Go back to “Overview” and choose “Enabled APIs”

Click on each API you added and choose Quota
[[File:Googlesyncenableapi2.png|none|thumb|517x517px]]

Set the number as high as you can without “apply for higher quota”
[[File:Googlesyncapplyhighquota.png|none|thumb|439x439px]]

And you are done with this site.

Now Log on https://admin.google.com with your Google Admin account

Find “Other Google Services” - can be located under “More Controls” or under APPS aplaced at page bottom.

Click “add services” upper right corner

Then click “Add it now” on “Groups for Business”
[[File:Googlesyncservices.png|none|thumb|495x495px]]

Back to start and choose “Security”

Choose “API reference” and check “Enable API access”
[[File:Googlesyncsecurity.png|none|thumb|439x439px]]

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.

==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.'''
[[File:Fgd.png|left|thumb|935x935px]]

Google app API

2021-12-07T08:14:05Z

Cna: New screenshots from Google setup

==Steps to make UMS syne work with Google Apps.==
 
Log on https://console.developers.google.com with your Google Admin account and create a new project[[File:2.jpg|thumb|1162x1162px|none]]

Enter Project Name, select organization and domain from dropdown. [[File:Google Project.jpg|none|thumb|525x525px]]

Be aware that you have chosen the right project and then click on " + ENABLE APIS SERVICES "
[[File:4.jpg|none|thumb|899x899px]]

Google automatically opens the API Library where you can search for services.
[[File:5.jpg|none|thumb|902x902px]]
 

*Notice that the "Drive SDK" does not exist in the new API
*Enable the foliowing APls (Remember that you can search for each API)

Admin SDK

Google Calendar API

Google Drive API

Service Control API

Google Cloud Storage JSON API

Group Settings API

Site Verification API
[[File:64.jpg|none|thumb|800x800px]]

This is what it should look like in the end.

[[File:API Dashboard.png|frameless|1250x1250px]]

==Create API Credentials==

Click on " OAuth consent screen "

Enter " Appliation Name " , a User Support email and developer contact info (mandatory).

Click "save"

[[File:OAuth Concent screen.png|frameless|1037x1037px]]
Click on "Credentials" and Create "OAuth Client ID"

[[File:Oauth Credentials.png|frameless|1060x1060px]]

Select Desktop APP and enter a name, then Click Create

[[File:Desktop APP.png|frameless|870x870px]]

[[File:Desktop APP2.png|frameless|860x860px]]

Copy Client ID and Client Secret for it to be used in UMS Configurator under Google organization settings

[[File:ID and Key.png|frameless|510x510px]]
And the "Client ID" and "Client Secret" is to be entered in UMS Configurator
[[File:15.jpg|none|thumb|487x487px]]

File:ID and Key.png

2021-12-07T08:11:47Z

Cna:

ID and Key

File:Desktop APP2.png

2021-12-07T08:10:30Z

Cna:

Desktop APP2

File:Desktop APP.png

2021-12-07T08:09:11Z

Cna:

desktop APP