UmsWiki - User contributions [en]

SSO UMS

2022-09-16T09:52:30Z

Cbe:

Our Single Sign-on (SSO) module is designed for schools that would like to make it easy for employees and students to use the school's various electronic systems. With the SSO module, users get one login and password that logs them into all the associated services at once.

For example, students can Access the school's LMS system, library system, digital dictionaries and databases with scientific publications - all by signing in with SSO once and for all.

This saves time and effort whenever users need to use one of the school's systems. At the same time, it gives users a simpler everyday life because they do not have to worry about having to keep in mind several logins.

 
==Prerequisite==
This requires that:

*An installed Active Directory federation services (AD FS) server.
*Access to configuration snap in. Either via Remote PowerShell or directly on the server.
*An UMS installation, licensed to SSO from inLogic.
*A star or new certificate for the address that the AD FS server needs.

 

==Installation==

=====Log on Web & ADFS Servers=====
 

=====Open AD FS Management on the primary ADFS Server.=====

#Retrieve necessary ADFS information from '''"Edit Federation Service Properties"'''
##Name:
##SingleSignOnServiceURL
##[[File:SSO_Federation.png|center|thumb|581x581px]]SingleLogoutServiceURL
#Export token-signing Certificate
##Click on "'''Service'''" > "'''Certificates'''" - Right click on the primary under "'''Token-Signing'''"
##[[File:SSO_Certificate.png|center|frameless|625x625px]][[File:Export_Certificate_SSO.png|center|thumb|635x635px]]Click on "'''View Certificate'''" > "'''Details'''" > "'''Copy to File'''" - export without the Private Key > Chose destination of Certificate
#Copy files to IIS Server at the desktop for now.

 

=====Open "Internet Information Services (IIS) Manager"=====

#Create Selfsigned Certificate
##Click on the Server Name on the IIS > "'''Server Certificates'''" > "'''Create Self-Signed Certificate'''"
##Specify a friendly name for the certificate: UMS-SSO <Year>
##Export the Certificate to the desktop as ums-sso.pfx - '''REMEMBER THE PASSWORD'''
#Copy certificates to wwwroot folder (default path: C:\inetpub\wwwroot\bin)

 

=====Log on UMS Web=====

#Enter the settings in the Web
##Click on "'''Controlpanel'''" > "'''UMS Login Setup'''"
##Click on "'''Single Sign On'''"
##Click on "'''Add'''" and give it a name. For example SSO
##Chose the created Single Sign On Setting and press Edit > Edit
###Change '''Name''':
###Change '''SingleSignOnServiceUrl''' & '''SingleLogoutServiceUrl'''
###Select Token Certificate file at: '''PartnerCertificateFile'''
###Select Self-signed Certificate at: '''LocalCertificateFile''' & Password to the PFX in '''LocalCertificatePassword'''

[[File:UMS_WEB_SSO_Settings.png|center|thumb|582x582px]]

SSO UMS

2022-09-16T09:01:41Z

Cbe:

Our Single Sign-on (SSO) module is designed for schools that would like to make it easy for employees and students to use the school's various electronic systems. With the SSO module, users get one login and password that logs them into all the associated services at once.

For example, students can Access the school's LMS system, library system, digital dictionaries and databases with scientific publications - all by signing in with SSO once and for all.

This saves time and effort whenever users need to use one of the school's systems. At the same time, it gives users a simpler everyday life because they do not have to worry about having to keep in mind several logins.

 
==Prerequisite==
This requires that:

*An installed Active Directory federation services (AD FS) server.
*Access to configuration snap in. Either via Remote PowerShell or directly on the server.
*An UMS installation, licensed to SSO from inLogic.
*A star or new certificate for the address that the AD FS server needs.

 

== Installation ==

===== Log on Web & ADFS Servers =====
 

===== Open AD FS Management on the primary ADFS Server. =====

# Retrieve necessary ADFS information from '''"Edit Federation Service Properties"'''
## Name:
## SingleSignOnServiceURL
## SingleLogoutServiceURL [[File:SSO Federation.png|frameless|581x581px]]
# Export token-signing Certificate
## Click on "'''Service'''" > "'''Certificates'''" - Right click on the primary under "'''Token-Signing'''"
## Click on "'''View Certificate'''" > "'''Details'''" > "'''Copy to File'''" - export without the Private Key > Chose destination of Certificate [[File:SSO Certificate.png|frameless|625x625px]] [[File:Export Certificate SSO.png|frameless|635x635px]]
# Copy files to IIS Server at the desktop for now.

 

===== Open "Internet Information Services (IIS) Manager" =====

# Create Selfsigned Certificate
## Click on the Server Name on the IIS > "'''Server Certificates'''" > "'''Create Self-Signed Certificate'''"
## Specify a friendly name for the certificate: UMS-SSO <Year>
## Export the Certificate to the desktop as ums-sso.pfx - '''REMEMBER THE PASSWORD'''
# Copy certificates to wwwroot folder (default path: C:\inetpub\wwwroot\bin)

 

===== Log on UMS Web =====

# Enter the settings in the Web
## Click on "'''Controlpanel'''" > "'''UMS Login Setup'''"
## Click on "'''Single Sign On'''"
## Click on "'''Add'''" and give it a name. For example SSO
## Chose the created Single Sign On Setting and press Edit > Edit
### Change '''Name''':
### Change '''SingleSignOnServiceUrl''' & '''SingleLogoutServiceUrl'''
### Select Token Certificate file at: '''PartnerCertificateFile'''
### Select Self-signed Certificate at: '''LocalCertificateFile''' & Password to the PFX in '''LocalCertificatePassword'''

[[File:UMS WEB SSO Settings.png|frameless|582x582px]]

File:SSO Federation.png

2022-09-16T09:01:03Z

Cbe:

SSO_Federation

File:SSO Certificate.png

2022-09-16T08:59:45Z

Cbe:

SSO_Certificate

File:Export Certificate SSO.png

2022-09-16T08:58:15Z

Cbe:

Export_Certificate_SSO

File:UMS WEB SSO Settings.png

2022-09-16T08:54:51Z

Cbe:

UMS_WEB_SSO_Settings

SSO UMS

2022-09-16T08:22:08Z

Cbe:

SSO UMS

2022-09-16T08:21:19Z

Cbe: Created page with "Our Single Sign-on (SSO) module is designed for schools that would like to make it easy for employees and students to use the school's various electronic systems. With the SSO..."

Configurator/SMS Server

2022-09-12T14:09:02Z

Cbe:

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