Difference between revisions of "SMS Welcome"

From UmsWiki
Jump to: navigation, search
Line 1: Line 1:
The automatically sends a SMS to users when they are created in Active Directory.
+
The system automatically sends an SMS notification to users when they are created in Active Directory.
  
If the phone number is international or there is no number, it will send a mail to the users private mail address found in UMS.
+
If the user has an international phone number or there is no number, the system will send an e-mail to the registered e-mail address in UMS.
  
No notification will be send if there is no phone number and no private mail.
+
There will not be sent any notification, if neither phone number nor e-mail address is registered.
  
The phone number is found during Active Directory creation while the mail is found when it tries to send it.
+
While the phone number is found during Active Directory creation, the e-mail address is found when attempting to send an SMS.
  
The notification is send by the SMS Server program.
+
The notification is sent through the SMS Server program.
  
 
== Prerequisites ==
 
== Prerequisites ==
Line 20: Line 20:
  
 
=== Template Setting ===
 
=== Template Setting ===
Create a welcome setting than will be attached to a template. Only users on this template will recieve a welcome notice.  
+
To get started, you must create a welcome setting that will be connected to a template. Only users registered on this template will receive the welcome notice. Select manage and add a setting, as shown below.  
[[File:Configurator SMS Welcome.png|none|thumb|791x791px]]Select manage and add a setting.[[File:SMS Welcome.png|none|thumb|807x807px]]'''Display name'''
+
[[File:Configurator SMS Welcome.png|none|thumb|791x791px|Configurator SMS Welcome]]'''Display name'''
  
Description for this setting
+
Please enter the name or a description of the setting, i.e. Welcome.
  
 
'''Confidential'''
 
'''Confidential'''
  
Wether or not this setting can be seen on UMS Web SMS log. Since this contains sensitive data.
+
As the SMS contains sensitive data, you can choose not to show the setting on UMS Web's SMS log. Check the box if the information should be kept confidential.
  
 
'''Text message'''
 
'''Text message'''
  
Enter the message to send to the user.
+
Enter the welcome message that will be sent to the user.
  
 
'''Days before start'''
 
'''Days before start'''
  
Send the message to the user x days before their first active activity. This is calculated from the startdate of the user on an activity.
+
Please select how many days before a user should receive the message. The sending date will be calculated from the start date for the user or their first activity.  
  
You can find the start date it calculates from using this SQL statement in SQL Server Management Studio. Remember to replace username in the text below.
+
You can find the start date it calculates from by using the SQL statement below in SQL Server Management Studio. Remember to replace 'Username' with the user.
  
 
<nowiki>-----------------------------------------------------------------------------------------------</nowiki>
 
<nowiki>-----------------------------------------------------------------------------------------------</nowiki>
Line 61: Line 61:
 
'''At creation'''
 
'''At creation'''
  
The SMS will be send at time of Active Directory creation
+
Check this box if the SMS should be sent when a user is created in Active Directory.
  
 
'''Variables'''
 
'''Variables'''
[[File:SMS Welcome Variables.png|none|thumb|410x410px|This shows a subset of the variables you can use on a setting.
+
 
You can use any field from the Students table. Just remember the column name is case sensitive
+
This shows a subset of the variables you can use in a setting. You can use any field from the 'Students table'. Please remember the column name is case sensitive.
 +
[[File:SMS Welcome Variables.png|none|thumb|410x410px|SMS variables
 
]]
 
]]
 
'''Test'''
 
'''Test'''
  
Send a test message from the configurator program to a number. The variables will not be replaced.
+
You can send a test message from the configurator program to a selected number. Please notice that the variables will not be replaced in the test message.[[File:SMS Welcome.png|none|thumb|807x807px|SMS template settings, SMS Welcome]]

Revision as of 09:12, 12 March 2018

The system automatically sends an SMS notification to users when they are created in Active Directory.

If the user has an international phone number or there is no number, the system will send an e-mail to the registered e-mail address in UMS.

There will not be sent any notification, if neither phone number nor e-mail address is registered.

While the phone number is found during Active Directory creation, the e-mail address is found when attempting to send an SMS.

The notification is sent through the SMS Server program.

Prerequisites

Module requirements

UMS

What to have ready

An inLogic SMS Modem

Installation

Template Setting

To get started, you must create a welcome setting that will be connected to a template. Only users registered on this template will receive the welcome notice. Select manage and add a setting, as shown below.

Configurator SMS Welcome

Display name

Please enter the name or a description of the setting, i.e. Welcome.

Confidential

As the SMS contains sensitive data, you can choose not to show the setting on UMS Web's SMS log. Check the box if the information should be kept confidential.

Text message

Enter the welcome message that will be sent to the user.

Days before start

Please select how many days before a user should receive the message. The sending date will be calculated from the start date for the user or their first activity.

You can find the start date it calculates from by using the SQL statement below in SQL Server Management Studio. Remember to replace 'Username' with the user.

-----------------------------------------------------------------------------------------------

Select Top 1 Convert(Datetime, StartDato, 105) As StartDate

From Students

Where

Action = 'Add'

And StartDato Is Not Null

And Convert(Datetime, StartDato, 105) >= Convert(Date, GetDate())

And StudieNr = '<Username>'

Order By Convert(Datetime, StartDato, 105)

-----------------------------------------------------------------------------------------------

At creation

Check this box if the SMS should be sent when a user is created in Active Directory.

Variables

This shows a subset of the variables you can use in a setting. You can use any field from the 'Students table'. Please remember the column name is case sensitive.

SMS variables

Test

You can send a test message from the configurator program to a selected number. Please notice that the variables will not be replaced in the test message.

SMS template settings, SMS Welcome